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

Filters: Difference between revisions

From MoodleDocs
(→‎Standard filters: Database auto-linking note moved to Database auto-linking filter)
 
(17 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Improve}}
{{Managing content}}
{{Filters}}
Filters can be used to add links, insert multimedia players, convert Mathematical expressions or emoticons into images and more.


 
A filter may be enabled at the site level and then removed as needed at the course or activity level. Thus a teacher can disable glossary auto-linking in a quiz for example.
Filters can transform simple text into different often more complex forms.  The potential for a filter is set at the site level and then it can be applied or removed as needed in site on a context level. HTML hyperlinking, or a text link that automatically calls up a sound player are examples of text filters.
 
There are many applications for filters. You could turn on the LaTeX filter just for courses in the Maths and Physics categories so users could create math formula notations with text based short cuts. Here the LaTeX filter would need to be enabled for the site and you would need permission in the context of those course categories to edit the filter settings.  A teacher could turn off glossary linking in a course exam, or in the entire course.
 
Filters are one of the general categories that can be selected for a course backup or as part of the course import process.
 
 
==Managing filters at site level==
 
[[Image:Manage filters 2.png|thumb|Manage filters]]
#In the settings block access ''Site administration > Plugins > Filters > Manage filters''
#Select 'On', 'Off but available' or 'Disabled' as required for each filter
#Use the up/down arrow icons to arrange the filters in the order in which they should be applied
 
Certain filters have additional settings, which can be accessed via the links in the settings column.
 
==Managing filters at course or activity level==
[[Image:Filter settings in forum.png|thumb|Filter settings in a forum]]
#In the settings block access ''Course administration > Filters'' or ''Activity administration > Filters''
#Set each filter on or off as required
#Click the 'Save changes' button


==Standard filters==
==Standard filters==


*Activity Names Auto-linking - This scans text for activity titles that exist in the same course and creates a link.
Filters in Moodle include:
*[[Algebra filter|Algebra]] - This filter will convert algebra code into GIF images. It requires the [[TeX notation filter|TeX filter]] to be installed. Note also that your system must also include the following Perl module: HTML::Entities.pm
*Database auto-linking - As the name suggests, this filter enables automatic linking of [[Database module]] entries.
*Email Protection - This filter scans the text for any email addresses. Where found they are changed (obfuscated) to reduce the chance of being added to a spammers list.
*Glossary auto-linking - As the name suggests, this filter enables automatic linking of [[Glossary module]] entries. In addition to this filter, individual glossary entries should have the "This entry should be automatically linked" box checked.
*[[Multi language content]] - This filter enables resources to be created in multiple languages. It looks for <span lang="xx" class="multilang">...</span> tags which indicate that a text contains multiple languages. Then it selects and outputs the best language for the current user. The language of the resource will change when the user changes their selected Moodle language.
*[[Multimedia plugins]]
*Resource Names Auto-linking - The titles of [[Resources]] can automatically become hyperlinks that take you to the relevant resource within the same course.
*[[TeX notation filter|TeX notation]]
*HTML tidy - This filter checks whether HTML code is XHTML compliant, tidying where necessary. To make this filter work you need to have PHP compiled with the libtidy option; see http://www.php.net/tidy. The Using Moodle discussion [http://moodle.org/mod/forum/discuss.php?d=28418 Tidy Filter for Moodle 1.5] contains more details.
*Wiki Page Auto-linking - As the name suggests, this filter enables automatic linking between wiki pages, based on the name of the page.  It does not, however, change the behavior of linking of pages by using CamelCase or [square brackets].
*[[Word censorship]] - This filter "blacks out" words found on a list.
*[[Display emoticons as images]] - This filter converts emoticons, for example :-) into smilie images.
*Convert URLs into links - This filter converts URLs in selected formats, such as Moodle auto-format, to click-able links.


==Filters and the File Resource==
*[[Activity names auto-linking filter|Activity names auto-linking]] - This scans text for activity titles that exist in the same course and creates a link
There is a setting for filters in Site administration ► Plugins ► Activity modules ► File
*[[Algebra filter|Algebra notation]] - This filter will convert algebra code into GIF images
*[[Convert URLs into links filter|Convert URLs into links]] - This filter converts URLs in selected formats, such as Moodle auto-format, to click-able links
*[[Database auto-linking filter|Database auto-linking]] - As the name suggests, this filter enables automatic linking of [[Database module]] entries
*[[Display emoticons as images filter|Display emoticons as images]] - This converts emoticon (smiley) characters into images
*[[Email protection filter|Email protection]] - This obfuscates email address links to make them more difficult for spammers to harvest
*[[Glossary auto-linking filter|Glossary auto-linking]] - This scans text for glossary entries that exist in the same course and creates a link
*[[MathJax filter|MathJax]] - For adding mathematical equations and expressions using an equation editor (new in 2.7 onwards)
*[[Multimedia plugins filter|Multimedia plugins]] - This finds a link in text that points to a multimedia resource and replaces the link with an appropriate multimedia player code which can play the resource
*[[Multi-language content filter|Multi-language content]] - This filter enables resources to be created in multiple languages
*[[TeX notation filter|TeX notation]] For displaying mathematics using images (new features in 2.8).
*[[Word censorship]] - This filter "blacks out" words found on a list


This setting applies to content in HTML pages.
==Contributed filters==


[[File:Use_filters_on_File_content.png]]
Filters have also been made by developers in the community. Some docs online for these include:
*[[FontAwesome_filter|FontAwesome]] - This scans text for icons that can be embedded using the FontAwesome icon set.
*[[IPA_filter|IPA]] - Renders simple X-SAMPA markup in the International Phonetic Alphabet
*[[PoodLL_filter|PoodLL]] - is the core PoodLL plugin for Moodle. It contains all the recorders, widgets and the code that makes it possible to use them around Moodle. It is a required component for all the other PoodLL plugins.


==See also==
==See also==


*[[Common filter settings]]
*[[Managing filters]]
*[[Filter settings|Common filter settings]] for the site
*[[Filters FAQ]]
*[[Filters FAQ]]
*[[Filters used on the Moodle.org forums]]
 
[[Category:Filter]]
[[Category:Mathematics]]


[[fr:Filtres 2.0]]
[[fr:Filtres 2.0]]
[[de:Filter]]
[[es:Filtros]]

Latest revision as of 03:35, 9 November 2014

Filters can be used to add links, insert multimedia players, convert Mathematical expressions or emoticons into images and more.

A filter may be enabled at the site level and then removed as needed at the course or activity level. Thus a teacher can disable glossary auto-linking in a quiz for example.

Standard filters

Filters in Moodle include:

  • Activity names auto-linking - This scans text for activity titles that exist in the same course and creates a link
  • Algebra notation - This filter will convert algebra code into GIF images
  • Convert URLs into links - This filter converts URLs in selected formats, such as Moodle auto-format, to click-able links
  • Database auto-linking - As the name suggests, this filter enables automatic linking of Database module entries
  • Display emoticons as images - This converts emoticon (smiley) characters into images
  • Email protection - This obfuscates email address links to make them more difficult for spammers to harvest
  • Glossary auto-linking - This scans text for glossary entries that exist in the same course and creates a link
  • MathJax - For adding mathematical equations and expressions using an equation editor (new in 2.7 onwards)
  • Multimedia plugins - This finds a link in text that points to a multimedia resource and replaces the link with an appropriate multimedia player code which can play the resource
  • Multi-language content - This filter enables resources to be created in multiple languages
  • TeX notation For displaying mathematics using images (new features in 2.8).
  • Word censorship - This filter "blacks out" words found on a list

Contributed filters

Filters have also been made by developers in the community. Some docs online for these include:

  • FontAwesome - This scans text for icons that can be embedded using the FontAwesome icon set.
  • IPA - Renders simple X-SAMPA markup in the International Phonetic Alphabet
  • PoodLL - is the core PoodLL plugin for Moodle. It contains all the recorders, widgets and the code that makes it possible to use them around Moodle. It is a required component for all the other PoodLL plugins.

See also