Skip to content

Commit

Permalink
MDL-32925 lang: Add extended help texts for all modules
Browse files Browse the repository at this point in the history
Thanks to Mary Cooch & Martin Dougiamas who contributed to this
rewording.

AMOS BEGIN
   REM These module help texts are going to be displayed more prominently in the Moodle interface
AMOS END
  • Loading branch information
wildgirl authored and danpoltawski committed May 17, 2012
1 parent bc449b1 commit 2e6b68f
Show file tree
Hide file tree
Showing 20 changed files with 200 additions and 30 deletions.
7 changes: 6 additions & 1 deletion mod/assign/lang/en/assign.php
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,12 @@
$string['manageassignsubmissionplugins'] = 'Manage assignment submission plugins';
$string['messageprovider:assign_updates'] = 'Assignment notifications';
$string['modulename'] = 'Assignment';
$string['modulename_help'] = 'Assignments enable the teacher to specify a task either on or offline which can then be graded.';
$string['modulename_help'] = 'The assignment activity module enables a teacher to assess students’ learning by setting work and then reviewing it and providing feedback and grades.
Students can submit any digital content (files), such as word-processed documents, spreadsheets, images, audio and video clips. Alternatively, or in addition, the assignment may require students to type text directly into a field using the text editor. An assignment can also be used to remind students of \'real-world\' assignments they need to complete, such as art work, and thus not require any digital content.
When reviewing assignments, teachers can leave feedback comments and upload files, such as marked-up student submissions, documents with comments or spoken audio feedback. Assignments can be graded using a numerical or custom scale or an advanced grading method such as a rubric. Final grades are recorded in the gradebook.';
$string['modulename_link'] = 'mod/assignment/view';
$string['modulenameplural'] = 'Assignments';
$string['mysubmission'] = 'My submission: ';
$string['newsubmissions'] = 'Assignments submitted';
Expand Down
14 changes: 12 additions & 2 deletions mod/chat/lang/en/chat.php
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,18 @@
$string['methodnormal'] = 'Normal method';
$string['methodajax'] = 'Ajax method';
$string['modulename'] = 'Chat';
$string['modulename_help'] = 'The chat module allows participants to have a real-time synchronous discussion via the web. This is a useful way to get a different understanding of each other and the topic being discussed - the mode
of using a chat room is quite different from the asynchronous forums.';
$string['modulename_help'] = 'The chat activity module enables participants to have real-time synchronous discussions.
The chat may be a one-off activity or it may be repeated at the same time each day or each week. Chat sessions are saved and can be made available for everyone to view or restricted to users with the capability to view chat session logs.
Chats are especially useful when the group chatting is not able to meet face-to-face, such as
* Regular meetings of students doing online courses to enable them to share experiences with others on the same course but in a different city (or country)
* A student temporarily unable to attend in person chatting with their teacher to catch up with work
* Students out on work experience getting together to discuss their experiences with each other and their teacher
* Younger children using chat at home in the evenings as a controlled (monitored) introduction to the world of social networking
* A question and answer session with an invited speaker in a different location';
$string['modulename_link'] = 'mod/chat/view';
$string['modulenameplural'] = 'Chats';
$string['neverdeletemessages'] = 'Never delete messages';
$string['nextsession'] = 'Next scheduled session';
Expand Down
11 changes: 10 additions & 1 deletion mod/choice/lang/en/choice.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,16 @@
$string['limit'] = 'Limit';
$string['limitanswers'] = 'Limit the number of responses allowed';
$string['modulename'] = 'Choice';
$string['modulename_help'] = 'The choice module enables the teacher to ask a question and specify a choice of multiple responses.';
$string['modulename_help'] = 'The choice activity module enables a teacher to ask a question and specify a choice of responses.
Choice results may be published after students have answered, or after a certain date, or not at all. Results may be published together with student names or anonymously.
A choice activity may be used
* As a quick poll to stimulate thinking about a topic
To quickly test students\' understanding
* To facilitate student decision-making, for example allowing students to vote on a direction for the course';
$string['modulename_link'] = 'mod/choice/view';
$string['modulenameplural'] = 'Choices';
$string['mustchooseone'] = 'You must choose an answer before saving. Nothing was saved.';
$string['noguestchoose'] = 'Sorry, guests are not allowed to make choices.';
Expand Down
14 changes: 13 additions & 1 deletion mod/data/lang/en/data.php
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,19 @@
$string['missingdata'] = 'Data id or object must be provided to field class';
$string['missingfield'] = 'Programmer error: You must specify field and/or data when defining field class.';
$string['modulename'] = 'Database';
$string['modulename_help'] = 'The database activity module enables participants to create, maintain and search a bank of record entries. The format and structure of these entries can be almost unlimited, including images, files, URLs, numbers and text amongst other things.';
$string['modulename_help'] = 'The database activity module enables participants to create, maintain and search a collection of entries (i.e. records).  The structure of the entries is defined by the teacher as a number of fields. Field types include checkbox, radio buttons, dropdown menu, text area, URL, picture and uploaded file.
The visual layout of information when listing, viewing or editing database entries may be controlled by database templates. Database activities may be shared between courses as presets and a teacher may also import and export database entries.
If the database auto-linking filter is enabled, any entries in a database will be automatically linked to where the words or phrases appear within the course.
A teacher can allow comments on entries. Entries can also be rated by teachers or students (peer evaluation). Ratings are aggregated to form a final grade which is recorded in the gradebook.
Database activities have many uses, such as
* A collaborative collection of web links/books/journal references
* For displaying student-created photos/posters/websites/poems for peer comment and review';
$string['modulename_link'] = 'mod/data/view';
$string['modulenameplural'] = 'Databases';
$string['more'] = 'More';
$string['moreurl'] = 'More URL';
Expand Down
12 changes: 11 additions & 1 deletion mod/feedback/lang/en/feedback.php
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,17 @@
$string['messageprovider:submission'] = 'Feedback notifications';
$string['mode'] = 'Mode';
$string['modulename'] = 'Feedback';
$string['modulename_help'] = 'The feedback modules enables custom surveys to be created.';
$string['modulename_help'] = 'The feedback activity module enables a teacher to create a custom survey for collecting feedback from participants using a variety of question types including multiple choice, yes/no or text input.
Feedback responses may be anonymous if desired, and results may be shown to all participants or restricted to teachers only. Any feedback activities on the site front page may also be completed by non-logged-in users.
Feedback activities may be used
* For course evaluations, helping improve the content for later participants
* To enable participants to sign up for course modules, events etc.
* For guest surveys of course choices, school policies etc.
* For anti-bullying surveys in which students can report incidents anonymously';
$string['modulename_link'] = 'mod/feedback/view';
$string['modulenameplural'] = 'Feedback';
$string['movedown_item'] = 'Move this question down';
$string['move_here'] = 'Move here';
Expand Down
7 changes: 7 additions & 0 deletions mod/folder/lang/en/folder.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@
$string['folder:view'] = 'View folder content';
$string['foldercontent'] = 'Files and subfolders';
$string['modulename'] = 'Folder';
$string['modulename_help'] = 'The folder module enables a teacher to display a number of related files inside a single folder, reducing scrolling on the course page. A zipped folder may be uploaded and unzipped for display, or an empty folder created and files uploaded into it.
A folder may be used
* For a series of files on one topic, for example a set of past examination papers in pdf format
* To provide a shared uploading space for teachers on the course page (keeping the folder hidden so that only teachers can see it)';
$string['modulename_link'] = 'mod/folder/view';
$string['modulenameplural'] = 'Folders';
$string['neverseen'] = 'Never seen';
$string['page-mod-folder-x'] = 'Any folder module page';
Expand Down
21 changes: 19 additions & 2 deletions mod/forum/lang/en/forum.php
Original file line number Diff line number Diff line change
Expand Up @@ -231,8 +231,25 @@
$string['modenested'] = 'Display replies in nested form';
$string['modethreaded'] = 'Display replies in threaded form';
$string['modulename'] = 'Forum';
$string['modulename_help'] = 'The forum module enables participants to have asynchronous discussions.';
$string['modulename_link'] = 'forum';
$string['modulename_help'] = 'The forum activity module enables participants to have asynchronous discussions.
There are several forum types to choose from, such as a standard forum where anyone can start a new discussion at any time, a forum where each student can post exactly one discussion, or a question and answer forum where students must first post before being able to view other students\' posts. A teacher can allow files to be attached to forum posts. Attached images are displayed in the forum post.
Participants can subscribe to a forum to receive notifications of new forum posts. A teacher can set the subscription mode to optional, forced or auto, or prevent subscription completely. If required, students can be blocked from posting more than a given number of posts in a given time period to prevent individuals from dominating discussions.
Forum posts can be rated by teachers or students (peer evaluation). Ratings are aggregated to form a final grade which is recorded in the gradebook.
Forums have many uses, such as
* An introductory space for students on the course to get to know each other
* A place for course announcements (using a news forum with forced subscription)
* A help centre where tutors and students can give advice
* An informal method of sharing (and potentially peer assessing) documents between students
* For continuing online an issue raised previously in a face-to-face session
* A place for teacher-only discussions (using a hidden forum)
* For extension activities, for example ‘brain teasers’ for students to ponder and suggest solutions to
* A social space for off-topic discussions';
$string['modulename_link'] = 'mod/forum/view';
$string['modulenameplural'] = 'Forums';
$string['more'] = 'more';
$string['movedmarker'] = '(Moved)';
Expand Down
17 changes: 16 additions & 1 deletion mod/glossary/lang/en/glossary.php
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,22 @@
$string['mainglossary'] = 'Main glossary';
$string['maxtimehaspassed'] = 'Sorry, but the maximum time for editing this comment ({$a}) has passed!';
$string['modulename'] = 'Glossary';
$string['modulename_help'] = 'The glossary module enables participants to create and maintain a list of definitions, like a dictionary. Glossary entries may be automatically linked wherever the concept words and phrases appear throughout the course.';
$string['modulename_help'] = 'The glossary activity module enables participants to create and maintain a list of definitions, like a dictionary.
A teacher can allow files to be attached to glossary entries. Attached images are displayed in the entry. Entries can be searched or browsed alphabetically or by category, date or author. Entries can be approved by default or require approving by a teacher before they are viewable by everyone.
If the glossary auto-linking filter is enabled, entries will be automatically linked to where the concept words and/or phrases appear within the course.
A teacher can allow comments on entries. Entries can also be rated by teachers or students (peer evaluation). Ratings are aggregated to form a final grade which is recorded in the gradebook.
Glossaries have many uses, such as
* A collaborative bank of key terms
* A ‘getting to know you’ space where new students add their name and personal details
* A ‘handy tips’ resource of best practice in a practical subject
* A sharing area of useful videos, images or sound files
* A revision resource of facts to remember';
$string['modulename_link'] = 'mod/glosssary/view';
$string['modulenameplural'] = 'Glossaries';
$string['newentries'] = 'New glossary entries';
$string['newglossary'] = 'New glossary';
Expand Down
7 changes: 6 additions & 1 deletion mod/imscp/lang/en/imscp.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,12 @@
$string['imscp:addinstance'] = 'Add a new IMS content package';
$string['imscp:view'] = 'View IMS content';
$string['modulename'] = 'IMS content package';
$string['modulename_help'] = 'An IMS content package allows for packages created according to the IMS Content Packaging specification to be displayed in the course.';
$string['modulename_help'] = 'An IMS content package is a collection of files which are packaged according to an agreed standard so they can be reused in different systems. The IMS content package module enables such content packages to be uploaded as a zip file and added to a course as a resource.
Content is usually displayed over several pages, with navigation between the pages. There are various options for displaying content in a pop-up window, with a navigation menu or buttons etc.
An IMS content package may be used for presenting multimedia content and animations.';
$string['modulename_link'] = 'mod/imscp/view';
$string['modulenameplural'] = 'IMS content packages';
$string['navigation'] = 'Navigation';
$string['page-mod-imscp-x'] = 'Any IMS content package module page';
Expand Down
9 changes: 8 additions & 1 deletion mod/label/lang/en/label.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,14 @@
$string['label:addinstance'] = 'Add a new label';
$string['labeltext'] = 'Label text';
$string['modulename'] = 'Label';
$string['modulename_help'] = 'A label enables text and images to be inserted among the activity links on the course page.';
$string['modulename_help'] = 'The label module enables text and multimedia to be inserted into the course page in between links to other resources and activities. Labels are very versatile and can help to improve the appearance of a course if used thoughtfully.
Labels may be used
* To split up a long list of activities with a subheading or an image
* To display an embedded sound file or video directly on the course page
* To add a short description to a course section';
$string['modulename_link'] = 'mod/label/link';
$string['modulenameplural'] = 'Labels';
$string['pluginadministration'] = 'Label administration';
$string['pluginname'] = 'Label';
14 changes: 13 additions & 1 deletion mod/lesson/lang/en/lesson.php
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,19 @@
$string['modattempts_help'] = 'If enabled, students can navigate through the lesson again from the start.';
$string['modattemptsnoteacher'] = 'Student review only works for students.';
$string['modulename'] = 'Lesson';
$string['modulename_help'] = 'The lesson module enables the teacher to create an adaptive learning experience consisting of a series of pages containing questions.';
$string['modulename_help'] = 'The lesson activity module enables a teacher to deliver content in an interesting and flexible way.
A lesson consists of a number of pages. Each page normally ends with a question and a number of possible answers. Question types include multiple choice, matching and short answer. Depending on the student\'s choice of answer they either progress to the next page or are taken back to a previous page.
A lesson may be graded if desired, with the grade recorded in the gradebook.
Lessons may be used
* For self-directed learning of a new topic
* For role-play simulations / decision-making exercises
* As a means of catering for different learning styles, for example students can opt for a video page, or a podcast page or a page of text according to their preference
* For differentiated revision guides, with different sets of revision questions depending upon answers given to initial questions';
$string['modulename_link'] = 'mod/lesson/view';
$string['modulenameplural'] = 'Lessons';
$string['move'] = 'Move page';
$string['movedpage'] = 'Moved page';
Expand Down
24 changes: 10 additions & 14 deletions mod/lti/lang/en/lti.php
Original file line number Diff line number Diff line change
Expand Up @@ -256,20 +256,16 @@
$string['missingparameterserror'] = 'The page is misconfigured: "{$a}"';
$string['module_class_type'] = 'Moodle module type';
$string['modulename'] = 'External Tool';
$string['modulename_help'] = 'External tools allow Moodle users to interact with learning resources and activities on other web sites. For instance, an
external tool could provide access to a new activity type or learning materials from a publisher.
To setup an external tool instance a tool provider which supports LTI (Learning Tools Interoperability) is required.
If you find a tool provider which supports LTI, they should be able to provide instructions on how to configure the
external tool instance. Additionally, tool types configured by a site administrator will also be available for use.
External tools differ from URL resources in a few ways:
* **Context aware** - External tools have access to information about the user who launched the tool, such as
insitution, course, name, and other information.
* **Deep integration** - External tools support reading, updating, and deleting grades associated with the activity instance. More integration points
are planned for future releases.
* **Security** - External tool configurations create a trust relationship between Moodle and the tool provider, allowing secure communication
between them.';
$string['modulename_help'] = 'The external tool activity module enables students to interact with learning resources and activities on other web sites. For example, an external tool could provide access to a new activity type or learning materials from a publisher.
To create an external tool activity, a tool provider which supports LTI (Learning Tools Interoperability) is required. A teacher can create an external tool activity or make use of a tool configured by the site administrator.
External tool activities differ from URL resources in a few ways:
* External tools are context aware i.e. they have access to information about the user who launched the tool, such as institution, course and name
* External tools support reading, updating, and deleting grades associated with the activity instance
* External tool configurations create a trust relationship between your site and the tool provider, allowing secure communication between them';
$string['modulename_link'] = 'mod/lti/view';
$string['modulenameplural'] = 'basicltis';
$string['modulenamepluralformatted'] = 'LTI Instances';
$string['never'] = 'Never';
Expand Down
10 changes: 9 additions & 1 deletion mod/page/lang/en/page.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,15 @@
$string['legacyfilesactive'] = 'Active';
$string['legacyfilesdone'] = 'Finished';
$string['modulename'] = 'Page';
$string['modulename_help'] = 'A page enables a web page to be displayed and edited within the course.';
$string['modulename_help'] = 'The page module enables a teacher to create a web page resource using the text editor. A page can display text, images, sound, video, web links and embedded code, such as Google maps.
Advantages of using the page module rather than the file module include the resource being more accessible (for example to users of mobile devices) and easier to update.
A page may be used
* To present the terms and conditions of a course or the course syllabus
* To embed several videos or sound files together with some explanatory text';
$string['modulename_link'] = 'mod/page/view';
$string['modulenameplural'] = 'Pages';
$string['neverseen'] = 'Never seen';
$string['optionsheader'] = 'Options';
Expand Down
Loading

0 comments on commit 2e6b68f

Please sign in to comment.