Description

Description
	Proposal API Reference

Name

Description — Return human readable titles both for the RichText (HTML) widget and for menuentries.

Synopsis

map Description(void);

Return Values

Returns a map containing:

string rich_text_title

(Translated) human readable title for this section in the RichText widget without any HTML formatting. This will be embedded in

	  <h3><a href="???"> ... </a></h3>

so make sure not to add any additional HTML formatting.

Keyboard shortcuts are not (yet?) supported, so don't include any '&' characters.

Example: "Input devices"

string menu_title

(Translated) human readable menuentry for this section. Must contain a keyboard shortcut ('&'). Should NOT contain trailing periods ('...') - the caller will add them.

Example: "&Input devices"

string id

Programmer readable unique identifier for this section. This is not auto-generated to keep the log file readable.

Example: "input_dev"

This map may be empty. In this case, this proposal section will silently be ignored. Proposals modules may use this if there is no useful proposal at all. Use with caution - this may be confusing for the user.

Note: In this case, all other proposal functions must return a useful success value so they can be called without problems.


AskUser		Write