MDL-21695 adding help strings
authorHelen Foster <helen@moodle.org>
Wed, 21 Apr 2010 18:12:44 +0000 (18:12 +0000)
committerHelen Foster <helen@moodle.org>
Wed, 21 Apr 2010 18:12:44 +0000 (18:12 +0000)
mod/data/lang/en/data.php

index f5937c2..bddd24c 100755 (executable)
@@ -44,6 +44,11 @@ $string['autogenallforms'] = 'Generate all default templates';
 $string['autolinkurl'] = 'Autolink the URL';
 $string['availablefromdate'] = 'Available from';
 $string['availabletags'] = 'Available tags';
+$string['availabletags_help'] = 'Tags are placeholders in the template, which will be replaced by data or other items, such as an edit icon, when entries are edited or viewed.
+
+Fields have the format [[fieldname]]. All other tags have the format ##sometag##.
+
+Only the tags that are in the "Available tags" list may be used for the current template.';
 $string['availabletodate'] = 'Available to';
 $string['blank'] = 'Blank';
 $string['buttons'] = 'Actions';
@@ -68,6 +73,7 @@ $string['csstemplate'] = 'CSS template';
 $string['csvfailed'] = 'Unable to read the raw data from the CSV file';
 $string['csvfile'] = 'CSV file';
 $string['csvimport'] = 'CSV file import';
+$string['csvimport_help'] = 'Entries may be imported via a plain text file with a list of field names as the first line, then the data, with one record per line.';
 $string['csvwithselecteddelimiter'] = '<acronym title="Comma Separated Values">CSV</acronym> text with selected delimiter:';
 $string['dataadministration'] = 'Database activity administration';
 $string['data:approve'] = 'Approve unapproved entries';
@@ -117,6 +123,7 @@ $string['example'] = 'Database module example';
 $string['excel'] = 'Excel';
 $string['export'] = 'Export';
 $string['exportaszip'] = 'Export as zip';
+$string['exportaszip_help'] = 'The export as zip feature allows you to save the templates and fields as a preset zip for download. The zip may then be imported to another course.';
 $string['exportdatabaserecords'] = 'Export Database records';
 $string['exportedtozip'] = 'Exported to temporary zip...';
 $string['failedpresetdelete'] = 'Error deleting a preset!';
@@ -147,6 +154,7 @@ $string['forcelinkname'] = 'Forced name for the link';
 $string['foundnorecords'] = 'No records found (<a href="{$a->reseturl}">Reset filters</a>)';
 $string['foundrecords'] = 'Found records: {$a->num}/{$a->max} (<a href="{$a->reseturl}">Reset filters</a>)';
 $string['fromfile'] = 'Import from zip file';
+$string['fromfile_help'] = 'The import from zip file feature allows you to browse for and upload a preset zip of templates and fields.';
 $string['generateerror'] = 'Not all files generated!';
 $string['guestrate'] = 'Guests are not allowed to rate entries.';
 $string['header'] = 'Header';
@@ -186,12 +194,14 @@ $string['listtemplate'] = 'List template';
 $string['longitude'] = 'Longitude';
 $string['mappingwarning'] = 'All old fields not mapped to a new field will be lost and all data in that field will be removed.';
 $string['maxentries'] = 'Maximum entries';
+$string['maxentries_help'] = 'The maximum number of entries a student is allowed to submit for this activity.';
 $string['maxsize'] = 'Maximum size';
 $string['menu'] = 'Menu';
 $string['menuchoose'] = 'Choose...';
 $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['modulenameplural'] = 'Databases';
 $string['more'] = 'More';
 $string['moreurl'] = 'More URL';
@@ -213,6 +223,9 @@ $string['nametextarea'] = 'Textarea field';
 $string['nameurl'] = 'URL field';
 $string['newentry'] = 'New entry';
 $string['newfield'] = 'Create a new field';
+$string['newfield_help'] = 'A field allows the input of data. Each entry in a database activity can have multiple fields of multiple types such as a date field, which allows participants to select a day, month and year from a dropdown list, a picture field, which allows participants to upload an image file, or a checkbox field, which allows participants to select one or more options.
+
+Each field must have a unique field name. The field description is optional.';
 $string['noaccess'] = 'You do not have access to this page';
 $string['nodefinedfields'] = 'New preset has no defined fields!';
 $string['nofieldcontent'] = 'Field content not found';
@@ -258,8 +271,13 @@ $string['recorddeleted'] = 'Entry deleted';
 $string['recordsnotsaved'] = 'No entry was saved. Please check the format of the uploaded file.';
 $string['recordssaved'] = 'entries saved';
 $string['requireapproval'] = 'Require approval?';
+$string['requireapproval_help'] = 'If enabled, entries require approving by a teacher before they are viewable by everyone.';
 $string['requiredentries'] = 'Required entries';
+$string['requiredentries_help'] = 'The number of entries a student is required to submit before the activity can be considered complete.';
 $string['requiredentriestoview'] = 'Entries required before viewing';
+$string['requiredentriestoview_help'] = 'The number of entries a student is required to submit before they can view entries from other students.
+
+Note: If entries are required before viewing, the database auto-linking filter should be disabled. This is because the database auto-linking filter can\'t determine whether a user has submitted the required number of entries.';
 $string['resetsettings'] = 'Reset filters';
 $string['resettemplate'] = 'Reset template';
 $string['resizingimages'] = 'Resizing image thumbnails...';
@@ -272,6 +290,7 @@ $string['save'] = 'Save';
 $string['saveandadd'] = 'Save and add another';
 $string['saveandview'] = 'Save and view';
 $string['saveaspreset'] = 'Save as preset';
+$string['saveaspreset_help'] = 'The save as preset feature publishes the templates and fields as a preset which others on the site can then use. (You may delete it from the list of presets at any time.)';
 $string['savesettings'] = 'Save settings';
 $string['savesuccess'] = 'Saved successfully. Your preset will now be available across the site.';
 $string['savetemplate'] = 'Save template';
@@ -297,6 +316,7 @@ $string['uploadfile'] = 'Upload file';
 $string['uploadrecords'] = 'Upload entries from a file';
 $string['url'] = 'Url';
 $string['usestandard'] = 'Use a preset';
+$string['usestandard_help'] = 'To use a preset available to the whole site, select it from the list. (If you have added a preset to the list using the save as preset feature then you have the option of deleting it.)';
 $string['viewfromdate'] = 'Viewable from';
 $string['viewtodate'] = 'Viewable to';
 $string['wrongdataid'] = 'Wrong data id provided';