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

Filters: Difference between revisions

From MoodleDocs
(see also links removed as they are included in Multimedia plugins)
m (category)
 
(82 intermediate revisions by 20 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 may be added or removed simply by using a file manager to add or remove them to the /filters directory. Moodle detects those that are present and makes them available to use.
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 administration screen==
==Standard filters==


The filters administration screen enables individual filters to be shown (enabled) or hidden (disabled). Only enabled filters will be applied to displayed text. The order in which filters are applied to displayed text can be significant - you can change the order in which enabled filters are applied using the up and down buttons. The enabled filters are applied from the top of the list down. Some filters have their own settings screen, see the documentation for the individual filter for information.
Filters in Moodle include:


===Cache Controls===
*[[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
*[[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]]
*[[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]]
*[[Word censorship]] - This filter "blacks out" words found on a list


====Text cache lifetime====
==See also==


To reduce load on the server and to speed display of pages, Moodle can store previously processed pages (that have not changed) for a period of time. This setting controls the time for which processed pages are stored. A longer setting may improve performance but has the effect that changes to pages may not become visible for a time. You can switch caching off completely here.
*[[Managing filters]]
*[[Filter settings|Common filter settings]] for the site
*[[Filters FAQ]]


====Filter uploaded files====
This setting enables uploaded files (HTML and text only) to be processed by the filters system. You can choose to have none, only HTML or all files filtered.
{{Moodle 1.6}}
====Filter match once per page====
This setting effects the glossary, activity and resource linking filters. If set to yes, only the first match on the complete page will be converted to a link. All others will be ignored.
====Filter match once per text====
This setting effects the glossary, activity and resource linking filters. If set to yes, only the first match in a discrete block of text will be converted to a link. All others in that text block will be ignored.
====Filter all strings====
When set to yes, all Moodle text will be filtered. This is probably only necessary when using the multi-language filter.
=== Config.php settings ===
For Moodle 1.6 see the Cache Settings above. The following two settings affect the glossary, activity and resource linking filters:
To convert only the first matching title on a page, insert or uncomment the  following line in config.php
    $CFG->filtermatchoneperpage = true;
To convert only the first matching title in a discrete block of text, insert or uncomment the following line in config.php
    $CFG->filtermatchonepertext = true;
==Algebra==
This filter will convert algebra code into GIF images. It requires the tex filter to be installed ([[#TeX notation|see below]]).
==Glossary auto-linking==
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.
==Multimedia plugins==
See [[Multimedia plugins]]
==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==
See [[TeX filter]]
==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==
See [[Word censorship]]
==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
[[Category:Administrator]]
[[Category:Filter]]
[[Category:Filter]]


[[es:Filtros (Administrador)]]
[[fr:Filtres 2.0]]

Latest revision as of 10:58, 14 October 2011

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:

See also