Name

MakeProposal — Make proposal for installation.

Synopsis

map MakeProposal(boolean  force_reset,
 boolean  language_changed);

Parameters

boolean force_reset

If 'true', discard anything that may be cached and start over from scratch. If 'false', use cached values from the last invocation if there are any.

boolean language_changed

The installation language has changed since the last call of "MakeProposal". This is important only if there is a language change mechanism in one of the other submodules. If this parameter is "true", any texts the user can see in the proposal need to be retranslated. The internal translator mechanism will take care of this itself if the corresponding strings are once more put through it (the _("...") function). Only very few submodules that translate any strings internally based on internal maps (e.g., keyboard etc.) need to take more action.

Return Values

MakeProposal() returns a map containing:

list<string> links

A list of additional hyperlink ids used in summaries returned by this section. All possible values must be included.

Example: ["device_enable", "device_test"]

string preformatted_proposal (optional)

Human readable proposal preformatted in HTML.

[Tip]Tip

Use the HTML:: module for such formatting.

list raw_proposal

(only used if 'preformatted_proposal' is not present in the result map)

Human readable proposal, not formatted yet. The caller will format each list item (string) as a HTML list item ( "<li> ... </li>" ).

The proposal can contain hyperlinks with ids listed in the list links.

The caller will make a HTML unsorted list of this, e.g.:

	    <ul>
	    <li>string from list element #1</li>
	    <li>string from list element #2</li>
	    <li>string from list element #3</li>
	    ...
	    </ul>
	  
string warning (optional)

Warning in human readable format without HTML tags other than <br>.

The warning will be embedded in appropriate HTML format specifications according to 'warning_level' below.

symbol warning_level (optional)

Determines the severity and the visual display of the warning. Valid values:

  • `notice
  • `warning (default)
  • `error
  • `blocker
  • `fatal

`blocker will prevent the user from continuing the installation. If any proposal contains a `blocker warning, the "accept" button in the proposal dialog will be disabled - the user needs to fix that blocker before continuing.

`fatal is like `blocker but also stops building the proposal

boolean language_changed (optional)

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

boolean mode_changed (optional)

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

boolean rootpart_changed (optional)

This module just caused a change of the root partition. This is only relevant for the "root part" module.