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

Filters: Difference between revisions

From MoodleDocs
(updated video)
 
(123 intermediate revisions by 32 users not shown)
Line 1: Line 1:
'''Filters''' allow for the for the automatic transformation of entered text into different, often more complex forms. For example the titles of [[Resources]] can automatically become hyperlinks that take you to the relevant resource, URLs pointing to [[mp3]] files can become [[Flash]] controls embedded in the webpage that let you pause and rewind the audio. The possibilities are endless and there are a number of standard filters included with Moodle and many more specialized filters contributed by the community.
{{Managing content}}
Filters can be used to add links, insert multimedia players, convert Mathematical expressions or emoticons into images and more.


==Filters administration screen==
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.
{{Moodle 1.6}}
Cache Controls


* Text cache lifetime
{{MediaPlayer | url =https://youtu.be/8UgjhEVWX8o | desc = Overview of course filters}}
* Filter uploaded files
* Filter match once per page
* Filter match once per text
* Filter all strings


==Algebra==
==Standard filters==


This filter will convert algebra code into GIF images. It requires the tex filter to be installed ([[#TeX notation|see below]]).
Filters in Moodle include:


==Glossary auto-linking==
*[[Activity names auto-linking filter|Activity names auto-linking]] - Scans course text for activity titles that exist in the same course and creates a link to them
*[[Algebra filter|Algebra notation]] - Convert algebra code into images
*[[Convert URLs into links filter|Convert URLs into links and images]] - Converts URLs in selected formats, such as Moodle auto-format, to click-able links
*[[Database auto-linking filter|Database auto-linking]] - Enables automatic linking of [[Database module|course Database activity]] entries
*[[Display emoticons as images filter|Display emoticons as images]] - Converts textual emoticon (smiley) characters into images
*[[Email protection filter|Email protection]] - Obfuscates email address links to make them more difficult for spammers to harvest
*[[Glossary auto-linking filter|Glossary auto-linking]] - Scans text for glossary entries that exist in the same course and creates a link
*[[HTML tidy filter|HTML tidy]] - Checks any added HTML code that it is XHMTL compliant
*[[MathJax filter|MathJax]] - For adding mathematical equations and expressions using an equation editor
*[[Multimedia plugins filter|Multimedia plugins]] - Converts HTML links in text that points to a multimedia resource and replaces the link with an appropriate multimedia players
*[[Multi-language content filter|Multi-Language content]] - Enables resources to be created in multiple languages
*[[TeX notation filter|TeX notation]] Displaying math formulae in TeX notation using images
*[[Word censorship]] - This filter "blacks out" words found on a list you can manage


As the name suggests, this filter enables automatic linking of [[mod/glossary/index|glossary]] entries. In addition to this filter, individual glossary entries should have the "This entry should be automatically linked" box checked.
==Contributed filters==


It's possible to fine-tune text filtering by adding the following lines from ''config-dist.php'' to ''config.php'' and removing the //.
Filters have also been [https://moodle.org/plugins/browse.php?list=category&id=7 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.
*[[filter generico]] - gives you considerable ability to customize your Moodle site without having to resort to multiple plugins, or custom PHP coding
*[[filter multiembed]] - Facilitates embedding of third-party content from a growing list of service providers (e.g. Prezi, Haiku Deck, etc.)


// Enabling this will make most text-based filters only match the first time
==See also==
// a phrase occurs in a given text.  Otherwise all are matched.
//      $CFG->filtermatchonepertext = true;
 
==Multimedia plugins==
 
The [[Multimedia plugins]] filter looks for links to various media and replaces them with a proper plugin.
 
==Multi-language content==
 
This filter enables resources to be created in multiple languages. It looks for <lang> 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.
 
To use this feature first create your contents in multiple languages (in the same resource). Then enclose each language block in the following tags:
 
      <lang lang="XX">your_content_here</lang>
      <lang lang="YY">your_content_in_other_language_here</lang>
 
==TeX notation==
 
The [[TeX Filter]] filter converts TeX code into GIF images. It requires a binary program called [[MimeTeX]] - versions for Linux (glib2.3), Windows and Mac OS X are included.
 
==Tidy==
 
The tidy filter checks whether HTML code is XHTML compliant, tidying where necessary. To make this filter work you need to have PHP compiled. The discussion [http://moodle.org/mod/forum/discuss.php?d=28418 Tidy Filter for Moodle 1.5] contains more details.
 
==Word censorship==
{{Moodle 1.6}}
* [[Word censorship|Word censorship in 1.6]]
 
To enable word censorship in 1.5,
{{Moodle 1.5}}
* Activate the word censorship filter
* Edit ''config.php'' in in the root folder
* Under <code>// 7. OTHER MISCELLANEOUS SETTINGS</code> add the line
$CFG->textfilter1 = 'filter/censor/filter.php';
* Edit ''lang/xx/censor.php'', adding any words you wish to ban
* Type some bad words in the HTML editor, as a test. After saving your post, all bad words will be blacked out.
 
==Non-standard filters==
 
* [[Jmol filter|Jmol]] - for interactive 3D viewing of molecular structures
* [[Code Syntax Highlighting]] - for more readable excerpts of programming languages including [[PHP]], [[HTML]], [[CSS]], and XML amongst many others


==See also==
*[[Managing filters]]
*[[Filter settings|Common filter settings]] for the site
*[[Filters FAQ]]


*[http://download.moodle.org/modules/filters.php Moodle Download: Filters]
[[Category:Filter]]
*[http://moodle.org/mod/forum/discuss.php?d=37119 Multimedia plugin vs object embed] forum discussion
[[Category:Mathematics]]
*[http://moodle.org/mod/forum/discuss.php?d=29588 Size of embedded Flash] forum discussion


[[Category:Administrator|Admin/filter]]
[[fr:Réglages communs aux filtres]]
[[Category:Filter|Admin/filter]]
[[de:Filter]]
[[es:Filtros]]

Latest revision as of 12:12, 16 July 2019

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.

Overview of course filters

Standard filters

Filters in Moodle include:

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.
  • filter generico - gives you considerable ability to customize your Moodle site without having to resort to multiple plugins, or custom PHP coding
  • filter multiembed - Facilitates embedding of third-party content from a growing list of service providers (e.g. Prezi, Haiku Deck, etc.)

See also