Method: Installation::ProposalClient#description

Defined in:
library/general/src/lib/installation/proposal_client.rb

#description ⇒ Hash (protected)

An abstract method to return human readable titles both for the RichText (HTML) widget and for menu entries. It also specifies an ID which is used when the user selects the module.

Returns:

  • (Hash) —

    containing:

    • "rich_text_title" [String] --- A 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 do not include any & characters.

    • "menu_title" [String] --- A translated human readable menu entry for this section. It must contain a keyboard shortcut (&). It should NOT contain a trailing ellipsis (...), the caller will add it.

    • "id" [String] --- A programmer-readable unique identifier for this section. This is not auto-generated to keep the log file readable.

    • "help" [String, nil] --- Help text for this module which appears in the standard dialog help (particular helps for modules sorted by presentation order).

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

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

Raises:

  • (NotImplementedError) 


283
284
285
 
# File 'library/general/src/lib/installation/proposal_client.rb', line 283

def description
  raise NotImplementedError, "Calling abstract method 'description'"
end