Help strings
From MoodleDocs
Note: This page is a work-in-progress. Feedback and suggested improvements are welcome. Please join the discussion on moodle.org or use the page comments.
| 2.0 help strings | |
|---|---|
| Project state | Specification |
| Tracker issue | MDL-21695 |
| Discussion | |
| Assignee | Helen Foster |
Moodle 2.0
In 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, 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 to "More info...")
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
