Difference between revisions of "Glossary settings"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 3.3. Up-to-date documentation for the latest stable version of Moodle is probably available here: Glossary settings.

(MDL-31647 - entrylist behaviour has been altered)
(clarifying display formats set up (thanks to Jon Bolton))
 
(45 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
{{Glossary}}
 
{{Glossary}}
 
==Adding a glossary==
 
==Adding a glossary==
[[Image:Glossarysettings.png|thumb|Adding a glossary]]
 
 
To add a glossary:
 
To add a glossary:
#Click the "Turn editing on" button.
+
#With the editing turned on, in the section you wish to add your glossary, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose ''Glossary''. All settings may be expanded by clicking the "Expand all" link in the top right of the page.
#Select Glossary from the "Add an activity" dropdown menu.
 
#On the Adding a new glossary page give your new glossary a descriptive name.
 
#Describe the purpose of the glossary, provide instructions or background information, links etc. in the Description area.
 
#Select the general and grade options and the common module settings (see below).
 
#Click the "Save changes" button at the bottom of the page.
 
  
==Glossary administration settings==
+
==General==
  
===Entries shown per page===
+
{|
 
+
|[[File:glossarydescription.png|thumb|477px|General settings expanded by default]]
This sets the number of words and definitions that students will see when they view the glossary list. If you have a large number of automatically-linked entries you should set this number lower to prevent long loading times.
+
|}
 +
===Name===
 +
Give your new glossary a descriptive name.
 +
===Description===
 +
Describe the purpose of the glossary and provide instructions or background information, links etc. Click the icon to the top left of the editor to expand the toolbars, and drag the bottom right of the text box out to expand it.
  
 +
===Display description on course page===
 +
If this box is ticked, the description will appear on the course page just below the name of the glossary.
 
===Is this glossary global?===
 
===Is this glossary global?===
  
Line 24: Line 24:
 
Here you can decide whether the glossary will be main or secondary. The glossary system allows you to export entries from any secondary glossary to the main one of the course. In order to do this, you should specify which glossary is the main one. You can only have one main glossary per course.
 
Here you can decide whether the glossary will be main or secondary. The glossary system allows you to export entries from any secondary glossary to the main one of the course. In order to do this, you should specify which glossary is the main one. You can only have one main glossary per course.
  
===Duplicated entries allowed===
+
==Entries==
 +
(These settings are collapsed by default)
 +
{|
 +
|[[File:glossaryentries.png|thumb|300px|Entries settings expanded]]
 +
|}
 +
 
 +
===Approved by default===
 +
If set to "yes" then new entries appear automatically. If not, then the teacher must approve each one first.
 +
===Always allow editing===
 +
If set to "yes", students can edit their entries at any time. If not, then they can only edit for a certain period (as defined in [[Site policies]]).
  
 +
===Duplicate entries allowed===
 
This allows the entry of more than one definition for a given word.
 
This allows the entry of more than one definition for a given word.
 
 
===Allow comments on entries===
 
===Allow comments on entries===
 
 
Students and teachers can leave comments on glossary definitions. The comments are available through a link at the bottom of the definition.
 
Students and teachers can leave comments on glossary definitions. The comments are available through a link at the bottom of the definition.
 
===Allow print view===
 
 
This provides a printer-friendly version link for students. (Teachers are always provided with a printer-friendly version link.)
 
  
 
===Automatically link glossary entries===
 
===Automatically link glossary entries===
 +
If the [[Glossary auto-linking filter]] is enabled by an administrator (see [[Managing filters]] for further details), then turning this on allows individual entries in this glossary to be automatically linked whenever the concept words and phrases appear throughout the rest of the same course. This includes forum postings, internal resources, week summaries and so on.
 +
{|
 +
|[[Image:Glossaryautolink.png|thumb|400px|An auto-linked word in a forum]]
 +
|}
  
If the [[Glossary auto-linking filter]] is enabled by an administrator (see [[Filters]] for further details), then turning this on allows individual entries in this glossary to be automatically linked whenever the concept words and phrases appear throughout the rest of the same course. This includes forum postings, internal resources, week summaries and so on.
+
Note: Enabling linking for the glossary does not automatically turn on linking for each entry - linking needs to be set for each entry individually. If you do not want particular text to be linked (in a forum posting, say) then you should add <nolink> and </nolink> tags around the text. Note that category names are also linked.
  
[[Image:Glossaryautolink.png|thumb|An auto-linked word in a forum]]Note: Enabling linking for the glossary does not automatically turn on linking for each entry - linking needs to be set for each entry individually. If you do not want particular text to be linked (in a forum posting, say) then you should add <nolink> and </nolink> tags around the text. Note that category names are also linked.
+
==Appearance==
 
+
(These settings are collapsed by default)
===This entry is case sensitive===
+
{|
 
+
|[[File:glosssaryappearance.png|thumb|430px|Appearance settings expanded]]
This setting specifies whether matching exact upper and lower case is necessary when performing automatic linking to these entries. For example, if this is turned on, then a word like "html" in a forum posting will NOT be linked to a glossary entry called "HTML".
+
|}
 
 
===Match whole words only===
 
 
 
If automatic linking is enabled, then turning this setting on will force only whole words to be linked. For example, a glossary entry named "construct" will not create a link inside the word "constructivism".
 
 
 
===Approved by default===
 
 
 
That allows the teacher to define what happens to new entries added by students. They can be automatically made available to everyone, otherwise the teacher will have to approve each one.
 
  
 
===Display format===
 
===Display format===
Line 59: Line 59:
  
 
* Simple, dictionary style - This looks like a conventional dictionary with separate entries. No authors are displayed and attachments are shown as links.  
 
* Simple, dictionary style - This looks like a conventional dictionary with separate entries. No authors are displayed and attachments are shown as links.  
* Continuous without author - That shows the entries one after other without any kind of separation but the editing icons.  
+
* Continuous without author - Like the simple style. Shows the entries one after other without any kind of separation but the editing icons, but only if your theme supports it, you usually have to modify the theme if you want an alternative appearance to the simple setting.
 
* Full with author - A forum-like display format showing author's data. Attachments are shown as links.  
 
* Full with author - A forum-like display format showing author's data. Attachments are shown as links.  
 
* Full without author - A forum-like display format that does not show author's data. Attachments are shown as links.  
 
* Full without author - A forum-like display format that does not show author's data. Attachments are shown as links.  
Line 66: Line 66:
 
* FAQ  - Useful for displaying lists of frequently asked questions. It automatically appends the words QUESTION and ANSWER in the concept and definition respectively.
 
* FAQ  - Useful for displaying lists of frequently asked questions. It automatically appends the words QUESTION and ANSWER in the concept and definition respectively.
  
The table below summarises the different display formats.
+
 
 
<table style="text-align: center;" border="1" cellpadding="2" cellspacing="0">
 
<table style="text-align: center;" border="1" cellpadding="2" cellspacing="0">
 
   <tr>
 
   <tr>
Line 148: Line 148:
 
     <td>x</td>
 
     <td>x</td>
 
     <td>x</td>
 
     <td>x</td>
     <td>x**</td>
+
     <td>x*</td>
  
 
   </tr>
 
   </tr>
 
</table>
 
</table>
<p>* Will be shown in a pop-up window.</p>
+
<p>* Attached images are shown inline.</p>
<p>* * Attached images are shown inline.</p>
 
  
==RSS in Glossaries==
+
===Approval display format===
 +
It is possible to set an alternative display format for when entries are approved that can differ from the display format on the course page. This could be useful for instance if a tutor wants to see who made a particular glossary entry before approving it but doesn't want the students' name to be displayed for others on the course page.
 +
===Entries shown per page===
 +
Enter the number of entries to show to the user looking at the glossary activity. For example, the teacher may want to display one definition at a time to a student. The default is 10 entries.
  
If [[RSS feeds]] are enabled, you will see two additional fields under the glossary setup page:  
+
===Show alphabet links===
 +
If set to "yes", users can browse the glossary by letters of the alphabet.
 +
===Show 'ALL' link===
 +
If set to "yes", users can browse all the entries at once
 +
===Show 'Special' link===
 +
If set to "yes", users can can browse the glossary by special characters, such as @ and #.
 +
===Allow print view===
 +
This provides a printer-friendly version link for students. (Teachers are always provided with a printer-friendly version link.)
 +
===Grade to pass===
 +
Here you can set a passing grade for the glossary. This may be connected with [[Activity completion]] and [[Conditional activities]] such that a student will not be able to access a follow up activity until they have obtained the required rating in this glossary.
 +
 
 +
==RSS==
 +
(These settings are collapsed by default and only visible if RSS has been enabled on the site and for the glossary.)
 +
{|
 +
|[[File:glossaryrss.png|thumb|450px|RSS settings expanded]]
 +
|}
  
 
===RSS feed for this activity===
 
===RSS feed for this activity===
Line 167: Line 184:
 
This number sets the number of entries that go out via RSS. If this number is set to 5, then the 5 most recent articles will be sent to subscribers. As new entries get added, the oldest entry gets replaced on the RSS feed. If your glossary gets a lot of posts every day, you will want to set this number high.  
 
This number sets the number of entries that go out via RSS. If this number is set to 5, then the 5 most recent articles will be sent to subscribers. As new entries get added, the oldest entry gets replaced on the RSS feed. If your glossary gets a lot of posts every day, you will want to set this number high.  
  
When RSS is enabled for your glossary, an orange RSS button appears on the main page (in the upper right-hand side). When a user clicks on the RSS button, they see the [[XML]] code displayed, needed by the news-reader. Once a user has the RSS news-feed link, adding it to a reader is simple and will then display Forum and Glossary aggregated information, along with other information they subscribe to.
+
When RSS is enabled for your glossary, an orange RSS button appears on the main page (in the upper right-hand side). When a user clicks on the RSS button, they see the [[XML]] code displayed, needed by the news-reader. Once a user has the RSS news-feed link, adding it to a reader is simple and will then display Glossary aggregated information, along with other information they subscribe to.
 +
 
 +
==Grade==
 +
(This setting is collapsed by default)
 +
Choose the category in which this glossary will appear if ratings are enabled.
 +
 
 +
==Ratings==
 +
(This setting is collapsed by default)
 +
 
 +
{|
 +
|[[File:glossaryratings.png|thumb|466px|Ratings settings expanded]]
 +
|}
 +
 
 +
===Roles with permissions to rate===
 +
Glossary entries can be rated using a [[Scales|scale]]. By default, only teachers can rate glossary entries, though students can be given permission to do so if desired from ''Administration>Glossary administration''. This is a useful tool for giving students participation grades. Any ratings given are recorded in the [[Gradebook|gradebook]].
  
 
==Glossary permissions==
 
==Glossary permissions==
Role permissions for the activity can be changed in ''Settings > Glossary administration > Permissions.''  
+
Role permissions for the activity can be changed in ''Course administration > Glossary administration > Permissions.''  
  
 
==Site administration settings==
 
==Site administration settings==
  
The glossary module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > Glossary''.
+
Default settings for a glossary activity and for adding a new entry can be set by an administrator in ''Site administration > Plugins > Activity modules > Glossary''.
 +
 
 +
If desired, the number of possible display formats may be reduced by clicking on the eye next to the format to disable it.  
  
=== Glossary level default settings ===
+
Clicking the configure icon for a particular format displays a new page with options for that particular format:
  
* glossary_entbypage - Number of Glossary entries shown per page. Default is set to 10.
+
[[File:displayformatsetup.png|center]]
* glossary_dupentries - Whether or not the Glossary will allow duplicate entries. Default is set to "No".
 
* glossary_allowcomments - Whether or not the Glossary will accept user comments on its entries. Default is set to "No".
 
* glossary_linkbydefault - Whether or not a glossary should be automatically linked. Default is set to "Yes".
 
* glossary_defaultapproval - Whether or not the Glossary will define the approval status of an entry posted by a student. Default is set to "Yes".
 
* glossary_enablerssfeeds - Enabling of RSS feeds for all glossaries. Default is set to "No". Note: feeds will still need to be turned on manually in the settings for each glossary.
 
  
=== Entry level default settings===
+
Display formats may be edited to specify various defaults, such as the sort order.
  
* glossary_linkentries - Whether or not glossary entries should be automatically linked. Default is set to "No".
+
Visible tabs for each display format can be specified, so that display formats without author do not have a 'Browse by author' tab.
* glossary_casesensitive - Whether or not an entry is case sensitive when linked. Default is set to "No".
 
* glossary_fullmatch - Whether or not an entry should match the case in the target text by default when linked. Default is set to "No".  
 
  
=== Display Formats Setup ===
+
[[File:visible tabs setting.png]]
  
To hide or show any of these entries, simply click on the "eye" icon next to the entry. Clicking on the "writing hand" icon will take you to the settings page for that entry.
+
==See also==
 +
*[http://youtu.be/y82WI5DJzkE Moodle 2 Glossary]  MoodleBites video on YouTube
  
 
[[Category:Site administration]]
 
[[Category:Site administration]]
Line 199: Line 226:
 
[[de:Glossar konfigurieren]]
 
[[de:Glossar konfigurieren]]
 
[[ja:用語集エントリを追加/編集する]]
 
[[ja:用語集エントリを追加/編集する]]
 +
[[es:Configuraciones del glosario]]

Latest revision as of 17:31, 6 August 2016

Adding a glossary

To add a glossary:

  1. With the editing turned on, in the section you wish to add your glossary, click the "Add an activity or resource" link (or, if not present, the "Add an activity" drop down menu) and choose Glossary. All settings may be expanded by clicking the "Expand all" link in the top right of the page.

General

General settings expanded by default

Name

Give your new glossary a descriptive name.

Description

Describe the purpose of the glossary and provide instructions or background information, links etc. Click the icon to the top left of the editor to expand the toolbars, and drag the bottom right of the text box out to expand it.

Display description on course page

If this box is ticked, the description will appear on the course page just below the name of the glossary.

Is this glossary global?

Administrators can make a global glossary, with entries linking throughout the whole Moodle site. Any course may contain a global glossary, though the best practice is to place a global glossary on the site front page.

Glossary type

Here you can decide whether the glossary will be main or secondary. The glossary system allows you to export entries from any secondary glossary to the main one of the course. In order to do this, you should specify which glossary is the main one. You can only have one main glossary per course.

Entries

(These settings are collapsed by default)

Entries settings expanded

Approved by default

If set to "yes" then new entries appear automatically. If not, then the teacher must approve each one first.

Always allow editing

If set to "yes", students can edit their entries at any time. If not, then they can only edit for a certain period (as defined in Site policies).

Duplicate entries allowed

This allows the entry of more than one definition for a given word.

Allow comments on entries

Students and teachers can leave comments on glossary definitions. The comments are available through a link at the bottom of the definition.

Automatically link glossary entries

If the Glossary auto-linking filter is enabled by an administrator (see Managing filters for further details), then turning this on allows individual entries in this glossary to be automatically linked whenever the concept words and phrases appear throughout the rest of the same course. This includes forum postings, internal resources, week summaries and so on.

An auto-linked word in a forum

Note: Enabling linking for the glossary does not automatically turn on linking for each entry - linking needs to be set for each entry individually. If you do not want particular text to be linked (in a forum posting, say) then you should add <nolink> and </nolink> tags around the text. Note that category names are also linked.

Appearance

(These settings are collapsed by default)

Appearance settings expanded

Display format

That specifies the way that each entry will be shown within the glossary. The default formats are:

  • Simple, dictionary style - This looks like a conventional dictionary with separate entries. No authors are displayed and attachments are shown as links.
  • Continuous without author - Like the simple style. Shows the entries one after other without any kind of separation but the editing icons, but only if your theme supports it, you usually have to modify the theme if you want an alternative appearance to the simple setting.
  • Full with author - A forum-like display format showing author's data. Attachments are shown as links.
  • Full without author - A forum-like display format that does not show author's data. Attachments are shown as links.
  • Encyclopedia - Like 'Full with author' but attached images are shown inline.
  • Entry list - This lists the concepts as links.
  • FAQ - Useful for displaying lists of frequently asked questions. It automatically appends the words QUESTION and ANSWER in the concept and definition respectively.


Format Entry Author Date Definition Images Attachments
Entry list x - - x x link
Simple Dictionary x - - x x link
Continuous x - - x x link
FAQ x - x x x link
Full without Author x - x x x link
Full with Author x x x x x link
Encyclopedia x x x x x x*

* Attached images are shown inline.

Approval display format

It is possible to set an alternative display format for when entries are approved that can differ from the display format on the course page. This could be useful for instance if a tutor wants to see who made a particular glossary entry before approving it but doesn't want the students' name to be displayed for others on the course page.

Entries shown per page

Enter the number of entries to show to the user looking at the glossary activity. For example, the teacher may want to display one definition at a time to a student. The default is 10 entries.

Show alphabet links

If set to "yes", users can browse the glossary by letters of the alphabet.

Show 'ALL' link

If set to "yes", users can browse all the entries at once

Show 'Special' link

If set to "yes", users can can browse the glossary by special characters, such as @ and #.

Allow print view

This provides a printer-friendly version link for students. (Teachers are always provided with a printer-friendly version link.)

Grade to pass

Here you can set a passing grade for the glossary. This may be connected with Activity completion and Conditional activities such that a student will not be able to access a follow up activity until they have obtained the required rating in this glossary.

RSS

(These settings are collapsed by default and only visible if RSS has been enabled on the site and for the glossary.)

RSS settings expanded

RSS feed for this activity

This turns RSS on or off. When set to “None,” the RSS feed is disabled. When set to “Concepts with authors,” the RSS feed will send out the glossary entries with the name of the author. When set to “Concepts without authors,” the RSS feed sends out glossary entries without the name of the author.

Number of RSS recent articles

This number sets the number of entries that go out via RSS. If this number is set to 5, then the 5 most recent articles will be sent to subscribers. As new entries get added, the oldest entry gets replaced on the RSS feed. If your glossary gets a lot of posts every day, you will want to set this number high.

When RSS is enabled for your glossary, an orange RSS button appears on the main page (in the upper right-hand side). When a user clicks on the RSS button, they see the XML code displayed, needed by the news-reader. Once a user has the RSS news-feed link, adding it to a reader is simple and will then display Glossary aggregated information, along with other information they subscribe to.

Grade

(This setting is collapsed by default) Choose the category in which this glossary will appear if ratings are enabled.

Ratings

(This setting is collapsed by default)

Ratings settings expanded

Roles with permissions to rate

Glossary entries can be rated using a scale. By default, only teachers can rate glossary entries, though students can be given permission to do so if desired from Administration>Glossary administration. This is a useful tool for giving students participation grades. Any ratings given are recorded in the gradebook.

Glossary permissions

Role permissions for the activity can be changed in Course administration > Glossary administration > Permissions.

Site administration settings

Default settings for a glossary activity and for adding a new entry can be set by an administrator in Site administration > Plugins > Activity modules > Glossary.

If desired, the number of possible display formats may be reduced by clicking on the eye next to the format to disable it.

Clicking the configure icon for a particular format displays a new page with options for that particular format:

displayformatsetup.png

Display formats may be edited to specify various defaults, such as the sort order.

Visible tabs for each display format can be specified, so that display formats without author do not have a 'Browse by author' tab.

visible tabs setting.png

See also