Help strings

Note: This article is a work in progress. Please use the page comments or an appropriate moodle.org forum for any recommendations/suggestions for improvement.

Plantilla:Infobox Project Plantilla:Moodle 2.0In Moodle 2.0, help files will be converted to strings.

String names

Help strings names will start with the string name of the setting to which they apply, so that they are kept together in the language file.

• stringname
• stringname_help
• stringname_link (optional string naming a path in Moodle docs, only if required, calculated just like the link in the footer to go to the right language etc, and shown after the help text in the popup as a link, possibly with an icon, to "More info...")

For example:

$string['submissionsize'] = 'Submission size';
$string['submissionsize_help'] = 'Blah blah blah some useful text using simple wiki-like syntax';
$string['submissionsize_link'] = 'mod/workshop/submission';

Note: The stringname_link strings don't need to be in the translator interface.

Help string formatting

Help string text will be short and simple - two small paragraphs maximum (150 words?) with no headings, no links, no bold, no tables etc.

Simple wiki syntax will be used:

• paragraphs - new lines
• bullet points - *
• numbered lists - #

Words for roles

The following words should be used in the en help strings to refer to people with particular roles:

• Participants - all people with a role
• Teachers - people with some sort of a facilitation/editing role
• Students - people primarily there to learn
• Users - people across the site