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

Glossary settings: Difference between revisions

From MoodleDocs
 
(27 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Glossaries}}
{{Glossary}}
==Adding a glossary==
[[Image:Glossarysettings.png|thumb|Adding a glossary]]
To add a glossary:
#Click the "Turn editing on" button.
#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.


Adding a new entry, you have to fill in two fields. Others are obligatory.
==Glossary administration settings==
==Concept (mandatory) ==


Here you should insert the word/concept, the definition of which you wish to create.
===Entries shown per page===


==Definition (mandatory) ==
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.


As its name suggests, this field should contain the definition of the word/concept.
===Is this glossary global?===


==Keywords==
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.


Each entry in the glossary can have an associated list of keywords (or aliases). Enter each alias on a new line (not separated by commas). The aliased words and phrases can be used as alternative ways to refer to the entry. For example, if you are using the glossary auto-linking filter then the aliases will be used (as well as the main name of the entry) when deciding what words to link to this entry.
===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.


[[Image:Glossary_5.png|frame|left|just fill in the form to create the new glossary entry]]
===Duplicated entries allowed===
<br style="clear:both;">


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


The default setting is 'Not categorised'. However, if you do add new categories, they will display here giving the possibility of choice.
===Allow comments on entries===


==Enabling automatic linking in a entry==
Students and teachers can leave comments on glossary definitions. The comments are available through a link at the bottom of the definition.


Turning this feature on will allow the entry 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.
===Allow print view===


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.
This provides a printer-friendly version link for students. (Teachers are always provided with a printer-friendly version link.)


To be able to turn on this feature, auto linking must be enabled at glossary level.
===Automatically link glossary entries===


==Case sensitive matching==
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.


This setting specifies whether matching exact upper and lower case is necessary when performing automatic linking to these entries.
[[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.


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".
===This entry is case sensitive===


==Whole words matching==
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".


If automatic linking is enabled, then turning this setting on will force only whole words to be linked.
===Match whole words only===


For example, a glossary entry named "construct" will not create a link inside the word "constructivism".
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".


==Attachment: (optional)==
===Approved by default===
You can choose to add an attachment file to the entry. This is useful if you are creating a photo gallery.


To delete the attachment you need to go to the [[Files | files]] option of the administration block and look in the directory called moddata and the sub-directory called glossary. The file for each entry will be stored in each individual sub-directory.
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.
 
[[Category:Teacher]]
===Display format===
[[Category:Glossary]]
 
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 if your theme supports it.
* 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.
 
The table below summarises the different display formats.
<table style="text-align: center;" border="1" cellpadding="2" cellspacing="0">
  <tr>
    <th style="text-align: left; width: 15em;">Format</th>
    <th style="width: 4em;">Entry</th>
    <th style="width: 4em;">Author</th>
    <th style="width: 4em;">Date</th>
 
    <th style="width: 4em;">Definition</th>
    <th style="width: 4em;">Images</th>
    <th style="width: 4em;">Attachments</th>
  </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>
 
    <td>x</td>
    <td>-</td>
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>link</td>
 
  </tr>
  <tr>
    <td style="text-align: left;">Full without Author</td>
    <td>x</td>
    <td>-</td>
    <td>x</td>
    <td>x</td>
 
    <td>x</td>
    <td>link</td>
  </tr>
  <tr>
    <td style="text-align: left;">Full with Author</td>
    <td>x</td>
    <td>x</td>
 
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>link</td>
  </tr>
  <tr>
    <td style="text-align: left;">Encyclopedia</td>
 
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>x</td>
    <td>x*</td>
 
  </tr>
</table>
<p>* Attached images are shown inline.</p>
 
==RSS in Glossaries==
 
If [[RSS feeds]] are enabled, you will see two additional fields under the glossary setup page:
 
===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 Forum and Glossary aggregated information, along with other information they subscribe to.
 
==Glossary permissions==
Role permissions for the activity can be changed in ''Settings > Glossary administration > Permissions.''
 
==Site administration settings==
 
The glossary module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > Glossary''.
 
=== Glossary level default settings ===
 
* glossary_entbypage - Number of Glossary entries shown per page. Default is set to 10.
* 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===
 
* glossary_linkentries - Whether or not glossary entries should be automatically linked. Default is set to "No".
* 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]]
 
[[de:Glossar konfigurieren]]
[[fr:Paramètres du glossaire]]
[[ja:用語集エントリを追加/編集する]]

Latest revision as of 12:58, 10 May 2013

Adding a glossary

Adding a glossary

To add a glossary:

  1. Click the "Turn editing on" button.
  2. Select Glossary from the "Add an activity" dropdown menu.
  3. On the Adding a new glossary page give your new glossary a descriptive name.
  4. Describe the purpose of the glossary, provide instructions or background information, links etc. in the Description area.
  5. Select the general and grade options and the common module settings (see below).
  6. Click the "Save changes" button at the bottom of the page.

Glossary administration settings

Entries shown per page

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.

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.

Duplicated 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.

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

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.

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.

This entry is case sensitive

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

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 if your theme supports it.
  • 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.

The table below summarises the different display formats.

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.

RSS in Glossaries

If RSS feeds are enabled, you will see two additional fields under the glossary setup page:

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 Forum and Glossary aggregated information, along with other information they subscribe to.

Glossary permissions

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

Site administration settings

The glossary module has additional settings which may be changed by an administrator in Settings > Site administration > Plugins > Activity modules > Glossary.

Glossary level default settings

  • glossary_entbypage - Number of Glossary entries shown per page. Default is set to 10.
  • 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

  • glossary_linkentries - Whether or not glossary entries should be automatically linked. Default is set to "No".
  • 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.