AskUser

AskUser
	Proposal API Reference

Name

AskUser — Run an interactive workflow

Synopsis

`map AskUser(`	boolean	`has_next`,
	string	`chosen_id)`;

Parameters

boolean has_next: Use a "next" button even if the module by itself has only one step, thus would normally have an "OK" button - or would rename the "next" button to something like "finish" or "accept".
string chosen_id: If a section proposal contains hyperlinks and user clicks on one of them, this defines the id of the hyperlink. All hyperlink IDs must be set in the map retuned by Description. If a user didn't click on a proposal hyperlink, this parameter is not defined.

Description

Run an interactive workflow - let user decide upon values he might want to change. May contain one single dialog, a sequence of dialogs or one master dialog with one or more "expert" dialogs. The module is responsible for controlling the workflow sequence (i.e., "next", "back" buttons etc.).

Submodules don't provide an "abort" button to abort the entire installation. If the user wishes to do that, he can always go back to the main dialog (the installation proposal) and choose "abort" there.

Return Values

AskUser() returns a map containing:

symbol workflow_sequence

`next (default): Everything OK - continue with the next step in workflow sequence.
`back: User requested to go back in the workflow sequence.
`again: Call this submodule again (i.e., re-initialize the submodule)
`auto: Continue with the workflow sequence in the current direction - forward if the last submodule returned `next, backward otherwise.
`finish: Finish the installation. This is specific to "inst_mode.ycp" when the user selected "boot system" there.

boolean language_changed (optional)

This module just caused a change of the installation language. This is only relevant for the "language" module.


MakeProposal		Description