Help strings: Difference between revisions
Helen Foster (talk | contribs) (stringname_link stuff copied from dev chat) |
|||
| Line 37: | Line 37: | ||
==Words for roles== | ==Words for roles== | ||
The following words should be used in the en help strings to refer to people with particular roles | The following words should be used in the en help strings whenever it is necessary to refer to people with particular roles in a generic sense. | ||
* Participants - all people with a role | * Participants - all people with a role | ||
| Line 43: | Line 43: | ||
* Students - people primarily there to learn | * Students - people primarily there to learn | ||
* Users - people across the site | * Users - people across the site | ||
([[User:Martin Dougiamas|Martin Dougiamas]] 16:13, 20 April 2010 (UTC): I'm not entirely comfortable with this choice even though I just re-confirmed it, as I'd prefer to be using words like facilitator/moderator to subtly and continually promote a less transmissionist pedgagogy and I know many Moodle users would agree. However, I think these terms are far more commonly used in the community and in discussion, and from the point of view that we need to build a consistent system for usability they are less distracting and better for documentation.) | |||
[[Category:Language]] | [[Category:Language]] | ||
Revision as of 16:13, 20 April 2010
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, 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 whenever it is necessary to refer to people with particular roles in a generic sense.
- 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
(Martin Dougiamas 16:13, 20 April 2010 (UTC): I'm not entirely comfortable with this choice even though I just re-confirmed it, as I'd prefer to be using words like facilitator/moderator to subtly and continually promote a less transmissionist pedgagogy and I know many Moodle users would agree. However, I think these terms are far more commonly used in the community and in discussion, and from the point of view that we need to build a consistent system for usability they are less distracting and better for documentation.)
