Skip to content

Commit

Permalink
MDL-21695 Help strings use Markdown format from now on
Browse files Browse the repository at this point in the history
  • Loading branch information
mudrd8mz committed May 3, 2010
1 parent 00ab45e commit 4be9b12
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 3 deletions.
2 changes: 1 addition & 1 deletion help.php
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@

echo $OUTPUT->heading(format_string(get_string($identifier, $component)), 1, 'helpheading');
// Should be simple wiki only MDL-21695
echo format_text(get_string($identifier.'_help', $component), FORMAT_MOODLE, $options);
echo format_text(get_string($identifier.'_help', $component), FORMAT_MARKDOWN, $options);

if ($sm->string_exists($identifier.'_link', $component)) { // Link to further info in Moodle docs
$link = get_string($identifier.'_link', $component);
Expand Down
1 change: 1 addition & 0 deletions lang/en/moodle.php
Original file line number Diff line number Diff line change
Expand Up @@ -722,6 +722,7 @@
$string['forgotteninvalidurl'] = 'Invalid password reset URL';
$string['format'] = 'Format';
$string['format_help'] = 'The course format determines the layout of the course page.
* SCORM format - For displaying a SCORM package in the first section of the course page (as an alternative to using the SCORM/AICC module)
* Social format - A forum is displayed on the course page
* Topics format - The course page is organised into topic sections
Expand Down
6 changes: 5 additions & 1 deletion mod/forum/lang/en/forum.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
$string['aggregatetype_help'] = 'Forum aggregation defines how all the ratings given to posts in a forum are combined to form the final grade (for each post and for the whole forum activity).
There are 5 aggregate types:
* Average - The mean of all the ratings given to posts in the forum (useful with peer grading when there are a lot of ratings being made)
* Count - The number of rated posts becomes the final grade (useful when the number of posts is important). Note that the total cannot exceed the maximum grade for the forum.
* Max - The highest rating is returned as the final grade (useful for emphasising the best post)
Expand Down Expand Up @@ -191,6 +192,7 @@
$string['forumtrackednot'] = 'Unread posts are not being tracked';
$string['forumtype'] = 'Forum type';
$string['forumtype_help'] = 'There are 5 forum types:
* A single simple discussion - A single discussion topic which everyone can reply to
* Each person posts one discussion - Each student can post exactly one new discussion topic, which everyone can then reply to
* Q and A forum - Students must first post their perspectives before viewing other students\' posts
Expand Down Expand Up @@ -387,6 +389,7 @@
$string['subscriptionmode_help'] = 'When a participant is subscribed to a forum it means they will receive email copies of forum posts.
There are 4 subscription mode options:
* Optional subscription - Participants can choose whether to be subscribed
* Forced subscription - Everyone is subscribed and cannot unsubscribe
* Auto subscription - Everyone is subscribed initially but can choose to unsubscribe at any time
Expand All @@ -405,9 +408,10 @@
$string['trackingon'] = 'On';
$string['trackingoptional'] = 'Optional';
$string['trackingtype'] = 'Read tracking for this forum?';
$string['trackingtype_help'] = 'If enabled, participants can track read and unread messages in the forum and in discussions.
$string['trackingtype_help'] = 'If enabled, participants can track read and unread messages in the forum and in discussions.
There are three options:
* Optional - Participants can choose whether to turn tracking on or off
* On - Tracking is always on
* Off - Tracking is always off';
Expand Down
1 change: 1 addition & 0 deletions mod/glossary/lang/en/glossary.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@
$string['destination_help'] = 'Entries can either be imported and added to the current glossary or to a new glossary, in which case a new glossary will be created based on information in the XML file.';
$string['displayformat'] = 'Display format';
$string['displayformat_help'] = 'There are 7 display formats:
* Simple, dictionary style - No authors are displayed and attachments are shown as links
* Continuous without author - Entries are displayed one after another without any separation apart from the editing icons
* Full with author - A forum-like display format showing the author\'s data and with attachments shown as links
Expand Down
1 change: 1 addition & 0 deletions mod/lesson/lang/en/lesson.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
$string['accesscontrol'] = 'Access control';
$string['actionaftercorrectanswer'] = 'Action after correct answer';
$string['actionaftercorrectanswer_help'] = 'After answering a question correctly, there are 3 options for the following page:
* Normal - Follow lesson path
* Show an unseen page - Pages are shown in a random order with no page shown twice
* Show an unanswered page - Pages are shown in a random order, with pages containing unanswered questions shown again';
Expand Down
5 changes: 4 additions & 1 deletion mod/quiz/lang/en/quiz.php
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@
$string['bothattempts'] = 'Show students with and without attempts';
$string['braceerror'] = 'Could not find {...} around answers';
$string['browsersecurity'] = 'Browser security';
$string['browsersecurity_help'] = 'If "Full screen pop-up with some JavaScript security" is selected,
$string['browsersecurity_help'] = 'If "Full screen pop-up with some JavaScript security" is selected,
* The quiz will only start if the student has a JavaScript-enabled web-browser
* The quiz appears in a full screen popup window that covers all the other windows and has no navigation controls
* Students are prevented, as far as is possible, from using facilities like copy and paste';
Expand Down Expand Up @@ -265,6 +266,7 @@
$string['editingquestion'] = 'Editing a question';
$string['editingquiz'] = 'Editing quiz';
$string['editingquiz_help'] = 'When creating a quiz, the main concepts are:
* The quiz, containing questions over one or more pages
* The question bank, which stores copies of all questions organised into categories
* Random questions - A student gets different questions each time they attempt the quiz and different students can get different questions';
Expand Down Expand Up @@ -375,6 +377,7 @@
$string['gradehighest'] = 'Highest grade';
$string['grademethod'] = 'Grading method';
$string['grademethod_help'] = 'When multiple attempts are allowed, the following methods are available for calculating the final quiz grade:
* Highest grade of all attempts
* Average (mean) grade of all attempts
* First attempt (all other attempts are ignored)
Expand Down
1 change: 1 addition & 0 deletions mod/scorm/lang/en/scorm.php
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@
$string['grademethod_help'] = 'The grading method defines how a final grade for the activity is determined.
There are 4 grading methods:
* Learning objects - The number of completed/passed learning objects
* Highest grade - The highest score obtained in all passed learning objects
* Average grade - The mean of all the scores
Expand Down

0 comments on commit 4be9b12

Please sign in to comment.