Filters: Difference between revisions

Latest revision as of 13:11, 27 January 2011

Note: This page describes filters in Moodle prior to Moodle 2.0. For documentation on filters in Moodle 2.0 see Filters 2.0.

Location: Administration > Modules (Plug-ins, in Moodle 2.0) > Manage filters

Filters allow 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 web page 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 available from the Moodle.org Modules and plugins database.

Enabling filters

Filters administration in Moodle 1.8

To enable a filter:

Access Administration > Modules (Plug-ins, in 2.0) > Filters.
On the filters administration page, click the eye icon opposite the filter you want to enable, so that it changes to an open eye.
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.

Common settings

Common filter settings can be found in Administration > Appearance > Filter settings.

Text cache lifetime

Text filters can take a lot of processor power to analyze. If you have a large number of courses, the filters may slow your system. The text cache lifetime determines how often the filters run. If you set them to run too frequently, your system may slow down. If you set them to run too infrequently, analyzing new content will take too long and users will notice. You should experiment to find the correct amount of time for your server.

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.

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

If checked, headings and titles can be displayed in different languages using the multi-language filter.

Standard filters

Filters included in the standard download are:

Activity Names Auto-linking - This scans text for activity titles that exist in the same course and creates a link.
Algebra - This filter will convert algebra code into GIF images. It requires the 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.

Note: If entries are required before viewing, the database auto-linking filter should be disabled. This is because the database auto-linking filter can't determine whether a user has submitted the required number of 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. However, as this filter is switched off by default, the site administrator may wish to enable this filter before importing user's email addresses.
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. Please note: going to the past, the multilang filter supported the <lang> tag. Then, officially, we changed it to the standard HTML <span> tag and the <lang> solution is now deprecated.
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
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 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.

Non-standard filters

Filters are one of Moodle's pluggable resources and may be added or removed simply by using a file manager to add or remove them from the /filters directory. Moodle detects those that are present and makes them available to use.

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
HiddenText - for teachers who want to provide "hints" to students where the information is initially hidden but can easily be revealed by student in any time when he need.
DocView - preview office documents (stored inside course's file repository) using one of the online document editing services (google docs, zoho, writely...). linked documents are opened inside a frame on the resource's page.

@@ 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.
+<p class="note">'''Note:''' This page describes filters in Moodle prior to Moodle 2.0. For documentation on filters in Moodle 2.0 see [[Filters 2.0]].</p>
-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.
-=Filters administration screen=
+Location: ''Administration > Modules (Plug-ins, in Moodle 2.0) > Manage filters''
-The filters manager is in the administration block, in the configuration section.
-In pre 1.6 version of Moodle, 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.
-Underneath the filter selection area, there are fields which control the cache.
+Filters allow for the automatic transformation of entered text into different, often more complex forms. For example the titles of [[Resources|resources]] can automatically become hyperlinks that take you to the relevant resource, URLs pointing to [[mp3]] files can become [[Flash]] controls embedded in the web page 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 available from the Moodle.org [http://moodle.org/mod/data/view.php?id=6009 Modules and plugins database].
-{{Moodle 1.6}}
-Version 1.6 has a good help menu in filter administration.  While it looks different it has the same functions of turning on and ordering the filters.  Some of the filters have additional setting adjustments which can be changed in this area.
-=Filters=
-==Algebra==
+==Enabling filters==
+[[Image:filters admin.png|thumb|Filters administration in Moodle 1.8]]
+To enable a filter:
+#Access ''Administration > Modules (Plug-ins, in 2.0) > Filters''.
+#On the filters administration page, click the eye icon opposite the filter you want to enable, so that it changes to an open eye.
+#Use the up/down arrow icons to arrange the filters in the order in which they should be applied.
-This filter will convert algebra code into GIF images. It requires the tex filter to be installed ([[#TeX notation|see below]]). Note also that your system must also include the following Perl module: HTML::Entities.pm
+Certain filters have additional settings, which can be accessed via the links in the settings column.
-==Glossary auto-linking==
+==Common settings==
-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.
+Common filter settings can be found in ''Administration > Appearance > Filter settings''.
-==Multimedia plugins==
+===Text cache lifetime===
-See [[Multimedia plugins]]
+Text filters can take a lot of processor power to analyze. If you have a large number of courses, the filters may slow your system. The text cache lifetime determines how often the filters run. If you set them to run too frequently, your system may
+slow down. If you set them to run too infrequently, analyzing new content will take too long and users will notice. You should experiment to find the correct amount of time for your server.
-==Multi-language content==
+===Filter uploaded files===
-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.  More information about using this feature can be found in the MoodleDoc page [[Multi_language_content]].
+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.
-==TeX notation==
+===Filter match once per page===
-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==
-This filter "blacks out" words found on a list.  See [[Word censorship]].
-==Email Protection==
-The Email Protection filter scans the text for any email addresses. Where found they are changed to reduce the chance of being added to a spammers list.
-Email address written in the course presentations (which are open) seem to be hidden entirely (both for logged in Admin and uninvited guests.) In course contents the email seems to be shown even for "guests". Hmm..
-==Resource Names Auto-linking==
-The titles of [[Resources]] can automatically become hyperlinks that take you to the relevant resource within the same course.
-==Activity Names Auto-linking==
-Scans text for activity titles that exist in the same course and creates a link.
-==Wiki Page Auto-linking==
-=Cache Controls=
-==Text cache lifetime==
-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.
-==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==
+===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==
+===Filter all strings===
-When set to yes, all Moodle text will be filtered. This is probably only necessary when using the multi-language filter.
+If checked, headings and titles can be displayed in different languages using the [[Multi language content|multi-language filter]].
-Doesn't seem to include Course titles. (1.6)
+==Standard filters==
-=Config.php settings=
+Filters included in the standard download are:
-For Moodle 1.6 see the Cache Settings above. For earlier versions of Moodle, the filter\config.php file will need to be changed for the visual effects below.  The following two settings affect the glossary, activity and resource linking filters:
+*Activity Names Auto-linking - This scans text for activity titles that exist in the same course and creates a link.
+*[[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.
+:''Note'': If entries are required before viewing, the database auto-linking filter should be disabled. This is because the database auto-linking filter can't determine whether a user has submitted the required number of 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. However, as this filter is switched off by default, the site administrator may wish to enable this filter before importing user's email addresses.
+*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 &lt;span&nbsp;lang="xx" class="multilang"&gt;...&lt;/span&gt; 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. Please note: going to the past, the multilang filter supported the &lt;lang&gt; tag. Then, officially, we changed it to the standard HTML &lt;span&gt; tag and the &lt;lang&gt; solution is now deprecated.
+*[[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]]
+*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.
-To convert only the first matching title on a page, insert or uncomment the  following line in config.php
+==Non-standard filters==
-    $CFG->filtermatchoneperpage = true;
+Filters are one of Moodle's pluggable resources and may be added or removed simply by using a file manager to add or remove them from the ''/filters'' directory.  Moodle detects those that are present and makes them available to use.
-To convert only the first matching title in a discrete block of text, insert or uncomment the following line in config.php
+* [[Jmol filter|Jmol]] - for interactive 3D viewing of molecular structures
+* [[Code Syntax Highlighting]] - for more readable excerpts of programming languages including [[PHP]], [[HTML in Moodle|HTML]], [[CSS]], and XML amongst many others
-    $CFG->filtermatchonepertext = true;
+* [[HiddenText filter|HiddenText]] - for teachers who want to provide "hints" to students where the information is initially hidden but can easily be revealed by student in any time when he need.
+* [[DocView filter|DocView]] - preview office documents (stored inside course's file repository) using one of the online document editing services (google docs, zoho, writely...). linked documents are opened inside a frame on the resource's page.
-=See also=
+==See also==
-Non-standard filters
-* [[Jmol filter|Jmol]] - for interactive 3D viewing of molecular structures
+*[[Filters FAQ]]
-* [[Code Syntax Highlighting]] - for more readable excerpts of programming languages including [[PHP]], [[HTML]], [[CSS]], and XML amongst many others
+*[[Filters used on the Moodle.org forums]]
+*[[Development:Filters]]
+*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=76206 Filter Demo's now online] forum discussion
-[[Category:Administrator]]
 [[Category:Filter]]
 [[es:Filtros (Administrador)]]
 [[fr:Filtres (administrateur)]]
+[[ja:フィルタ]]

Documentation