Note: You are currently viewing documentation for Moodle 4.0. Up-to-date documentation for the latest stable version of Moodle may be available here: Glossary settings.

Glossary settings: Difference between revisions

From MoodleDocs
mNo edit summary
 
(34 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{Glossary}}
{{Glossary}}
==Adding a glossary==
This page explores in more detail the settings for the [[Glossary activity]] once you have added it to your course and also covers the Site administration settings.
To add a glossary:
 
#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 expanded by clicking the "Expand all" link top right.
==General==
==General==
 
Give the glossary a name and description if required, checking the box to display the description on the course page.
{|
;Is this glossary global?
|[[File:glossarygeneral25.png|thumb|General settings expanded by default]]
:Only administrators see this. 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
===Name===
:Here you can decide whether the glossary will be main or secondary. This feature enables you to choose particular entries from any number of secondary glossaries in the course and add them to the main glossary. You can only have one main glossary per course.
Give your new glossary a descriptive name.
:After creating a main glossary, if you then go to a secondary glossary, you'll notice next to each entry there is an 'Export to main glossary' icon (arrow with line under it).
===Description===
Describe the purpose of the glossary and provide instructions or background information, links etc. Click "Show editing tools" to display the rich text editor, 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==
==Entries==
(These settings are collapsed by default)
;Approved by default
{|
:If set to "yes" then new entries appear automatically. If not, then the teacher must approve each one first.
|[[File:glossaryentries25.png|thumb|Entries settings expanded]]
;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
===Approved by default===
:This allows the entry of more than one definition for a given word.
If set to "yes" then new entries appear automatically. If not, then the teacher must approve each one first.
;Allow comments on entries
===Always allow editing===
:Students and teachers can leave comments on glossary definitions. The comments are available through a link at the bottom of the definition. Note that Comments must be enabled sitewide for this feature.
If set to "yes", students can edit their entries at any time. If not, then they can only edit for a certain period (defined in [[Site Policies]])
;Automatically link glossary entries
===Duplicate entries allowed===
: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.
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 [[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|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.
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==
==Appearance==
(These settings are collapsed by default)
;Display format
{|
:This specifies the way that each entry will be shown within the glossary. The default formats are:
|[[File:glossaryappearance25.png|thumb|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.  
* 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 64: Line 35:
* 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.


See [[Glossary FAQ]] for more information on the code for the different display formats.


===Approval display format===
<table style="text-align: center;" border="1" cellpadding="2" cellspacing="0">
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.
  <tr>
===Entries shown per page===
    <th style="text-align: left; width: 15em;">Format</th>
Decid here how many entries to show per page.
    <th style="width: 4em;">Entry</th>
===Show alphabet links===
    <th style="width: 4em;">Author</th>
If set to "yes", users can browse the glossary by letters of the alphabet.
    <th style="width: 4em;">Date</th>
===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.)


==RSS==
    <th style="width: 4em;">Definition</th>
(These settings are collapsed by default and only visible if RSS has been enabled on the site and for the glossary.)
    <th style="width: 4em;">Images</th>
{|
    <th style="width: 4em;">Attachments</th>
|[[File:glossaryrss25.png|thumb|RSS settings expanded]]
  </tr>
|}
  <tr>
    <td style="text-align: left;">Entry list</td>
    <td>x</td>
 
    <td>- </td>
    <td>-</td>
    <td>x</td>
    <td>x</td>
    <td>link</td>
  </tr>
 
  <tr>
    <td style="text-align: left;">Simple Dictionary</td>
    <td>x</td>
    <td>-</td>
    <td>-</td>
    <td>x</td>
 
    <td>x</td>
    <td>link</td>
  </tr>
  <tr>
    <td style="text-align: left;">Continuous</td>
    <td>x</td>
    <td>-</td>
 
    <td>-</td>
    <td>x</td>
    <td>x</td>
    <td>link</td>
  </tr>
  <tr>
    <td style="text-align: left;">FAQ</td>


===RSS feed for this activity===
    <td>x</td>
    <td>-</td>
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>link</td>


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.
  </tr>
  <tr>
    <td style="text-align: left;">Full without Author</td>
    <td>x</td>
    <td>-</td>
    <td>x</td>
    <td>x</td>


===Number of RSS recent articles===
    <td>x</td>
    <td>link</td>
  </tr>
  <tr>
    <td style="text-align: left;">Full with Author</td>
    <td>x</td>
    <td>x</td>


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.
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>link</td>
  </tr>
  <tr>
    <td style="text-align: left;">Encyclopedia</td>


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.
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>x*</td>


==Grade==
  </tr>
(This setting is collapsed by default)
</table>
Choose the category in which this glossary will appear if ratings are enabled.
<p>* Attached images are shown inline.</p>


;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.):
==Ratings==
==Ratings==
(This setting is collapsed by default)
;Roles with permission 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]].
;Grade to pass
:If ratings are enabled you can set a passing grade for the glossary. This may be connected with [[Activity completion]] and [[Restrict access]] 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==
|[[File:ratings25.png|thumb|Ratings settings expanded]]
This setting is only visible if RSS has been enabled on the site and for the glossary.
|}
;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.


===Roles with permissions to rate===
When RSS is enabled for your glossary, a "RSS feed for this glossary" entry appears in the action menu. When a user chooses that entry, 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.
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]].
==Common module settings==
(These settings are collapsed by default.)


See [[Common module settings]]
==Grade==
==Restrict access/Activity completion==
(This setting is collapsed by default)
(These settings are collapsed by default)
Choose the category in which this glossary will appear if ratings are enabled.
 
The Restrict access and Activity completion settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.


==Adding a new glossary entry==
==Other settings==
See [[Using Glossary]]
Depending on what is enabled for your site and course, you may also need to explore [[Common  module settings]], [[Restrict access| Restrict access]],  [[Activity completion]], [[Tags]] and [[Competencies]]


==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.
 
Clicking the configure icon for a particular format displays a new page with options for that particular format:


=== Glossary level default settings ===
[[File:displayformatsetup.png|center]]


* glossary_entbypage - Number of Glossary entries shown per page. Default is set to 10.
Display formats may be edited to specify various defaults, such as the sort order.
* 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===
Visible tabs for each display format can be specified, so that display formats without author do not have a 'Browse by author' tab.


* glossary_linkentries - Whether or not glossary entries should be automatically linked. Default is set to "No".
[[File:visible tabs setting.png]]
* 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 ===


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.


[[Category:Site administration]]
[[Category:Site administration]]
Line 150: Line 182:
[[de:Glossar konfigurieren]]
[[de:Glossar konfigurieren]]
[[ja:用語集エントリを追加/編集する]]
[[ja:用語集エントリを追加/編集する]]
[[es:Configuraciones del glosario]]

Latest revision as of 10:09, 5 April 2021

This page explores in more detail the settings for the Glossary activity once you have added it to your course and also covers the Site administration settings.

General

Give the glossary a name and description if required, checking the box to display the description on the course page.

Is this glossary global?
Only administrators see this. 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. This feature enables you to choose particular entries from any number of secondary glossaries in the course and add them to the main glossary. You can only have one main glossary per course.
After creating a main glossary, if you then go to a secondary glossary, you'll notice next to each entry there is an 'Export to main glossary' icon (arrow with line under it).

Entries

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. Note that Comments must be enabled sitewide for this feature.
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.

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

Display format
This 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.):

Ratings

Roles with permission 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.
Grade to pass
If ratings are enabled you can set a passing grade for the glossary. This may be connected with Activity completion and Restrict access 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

This setting is only visible if RSS has been enabled on the site and for the glossary.

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, a "RSS feed for this glossary" entry appears in the action menu. When a user chooses that entry, 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.

Other settings

Depending on what is enabled for your site and course, you may also need to explore Common module settings, Restrict access, Activity completion, Tags and Competencies

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