MoodleDocs - User contributions [en]

Development:Navigation 2.0

2009-04-01T06:21:58Z

Jwc: /* Other */

{{Moodle 2.0}}

__TOC__

<div style="background:#FFFFAA;border:1px solid #FFFF00;color:#444444;padding:0.5em 1em;">
===State of play end March 2009===

A consensus seems to be emerging. Martin will be summarasing what we thing that is, and Tim will be working out a plan for implementing it all. Until we have a clearer summary, I am leaving the following reading list:
* Start by reading this page. It is Martin's summary of what we are hoping to achieve.
Then we get to the various forum threads and proposals:
* [[Development:Navigation/Pagelib/Blocks_2.0_design|This proposal]] is Tim's first attempt to work out how to achieve some of the goals outlined on this page.
* There is a [http://moodle.org/mod/forum/discuss.php?d=95882 thread about blocks] in the general developer forum. Related to that is Tim's [[Development:Very_flexible_block_system_proposal|proposal about how blocks might work in future]].
* The other hot topic is templates, and whether they are the right way for Moodle to output HTML. There is [http://moodle.org/mod/forum/discuss.php?d=108993 one thread in the General Developer Forum] and another in the [http://moodle.org/mod/forum/discuss.php?d=116398 Themes forum]. There might now be an answer to this: [[Development:Theme engines for Moodle?]]
* Probably the least clear aspect at the moment is Navigation. This [http://moodle.org/mod/forum/discuss.php?d=115620 GDF thread is the place to discuss navigation].
I hope I have not forgotten anything. Naturally, once our plans are clearer, they need to be reduced to a single, comprehensible proposal.
</div>

==Goals==

Improving navigation in a complex web application like Moodle touches on a lot of areas, but in particular we must aim to hit these goals:

===Clarity===

It should be clearer what settings affect only yourself, and what settings affect what others see.

It should be clear what is global navigation (whole site), and what is local navigation (within a course or module).

===Consistency===

All parts of the interface should be consistent. We need to have a set of guidelines and core frameworks to better restrict what developers are allowed to do, while also reworking the core code to implement things like blocks and tabs in consistent ways.

===Usability===

Users should be able to easily learn what is there for them.

Users should be able to move around "their world" within Moodle with a minimum of effort.

===Performance===

Processing blocks and building up a page with navigation must be very efficient.

===Backward compatibility===

If possible, plugins should not have to change.

Users should also not find the new interface too different (just better!)

==Scope==

What parts of Moodle might be affected by this work?

===Navigation bar===

Since Moodle 1.9, we construct the navigation bar from an array using the build_navigation function. However, that converts all the data to a string, which is then passed to the theme. Instead, we should keep the information about the navigation bar links as structured data, and let the theme choose how to render it.

===Local navigation===

In different places we have the global administration tree, the Course admin block, the Jump to menu, tabs like in the user profile, various activities, in the roles UI, and the 'Update this forum' button. These are all ways of getting around nearby, related pages. It would be good to make these concepts more consistent. (There is also $homelink in the footer. Currently the HTML for this is generated in print_header.)

'''This is an area we need to think about a lot more'''
:Please discuss here: http://moodle.org/mod/forum/discuss.php?d=115620

===Blocks/pagelib===

Blocks themselves should not change. What is currently inconsistent is how blocks get associated with particular pages. At the moment this is done through the (pageid, pagetype) columns of block_instance, and the pagetype column of block_pinned. Does it work if we change this to (contextid, pagetype)?

The other thought is, can we make sticky blocks more flexible? What if we let them be configured in any context, not just globally? This would let people do things like add a block to every course in a particular category.

Perhaps let themes control where on the page blocks can appear.

'''Some more thought required here'''.
:Please discuss here: http://moodle.org/mod/forum/discuss.php?d=95882

===Course view===

What do we need on top of the existing course formats?

===Themability===

Give themers as much flexibility as possible, without having to do major changes throughout Moodle.

Let them change the HTML output by the print_XXX functions in weblib.php.

Should we allow themes to have their own lang files and settings.php page in the admin tree?

[[Development:Theme engines for Moodle?]]

==Solution 1==

This section is intended to be a short summary of a possible solution for Moodle 2.0. It's heavily based on Tim Hunt's ideas and discussions I've had with him, but I wanted to paraphrase it to help me think about it. [[User:Martin Dougiamas|Martin Dougiamas]] 06:52, 13 March 2009 (UTC)

The one-line summary is: make blocks more consistent and themes more powerful, and then let people build their "perfect" interfaces from those.

A key point to all this is backward compatibility. All of this will only affect pages that are coded for it. Older code will work as before, using deprecated functions.

===1. Improve HTML generation===

Our aim is to give interface designers ultimate control over the presentation of Moodle.

Key points:
* refactor all weblib-type functions into a class of renderers
* implement similar renderers for all modules
* allow any current theme to subclass and override these renderers
* allow themes to define named regions on the page where blocks will go (eg left, right, top, bottom, center)

This gives us great flexibility within a common and easy to understand framework. For example, it allows templates, but doesn't depend on them.

See Tim's [[Development:Theme_engines_for_Moodle%3F|explanation of theme engines]] for a lot more details.

===2. Improve Blocks and Pages===

Our aim is to make blocks work everywhere with a lot of control where they go.

Key points:
* change the implementation of "pages" to be based on contexts
* develop the idea of sticky blocks to support inheritance in the tree of contexts (eg sticky block at course level would appear in all subcontexts unless they chose to "override" this block).
* add more controls to blocks to hide/show them in certain types of pages
* use the theme regions when placing blocks

See Tim's [[Development:Very_flexible_block_system_proposal|very flexible block system proposal]] for details.

===3. Use blocks for most navigation===

Even though we plan the default configuration to provide the best navigation we can, by having most navigation in blocks we give admins and teachers the most flexibility to customise their navigation.

Key points:
*'''Navigation block''': with a hierarchical tree that adapts to show "things around you" within Moodle. eg at site level it could show courses, at course level it could show the same thing as well as activities within the current course. Such a block would normally be made sticky so that it appears in the same place on all pages. Depending on the theme it could be a block on the side or a drop-down menu in the header!
*'''Settings block''': would contain all the settings for the current thing you are looking at. Forum settings in the forum, Course settings in the course.
*'''CMS block''': would allow the custom definition of top-level pages and links to other systems (eg like the menus on moodle.org).

==Implementation plan==

Please see [[Development:Navigation 2.0 implementation plan]].

==Relevant tracker issues==

===Tracking bugs===

* MDL-12212 META: Complete review and rewrite of Pagelib (and blocks)

===Theme related===

These come from a review of all the [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10088&sorter/field=issuekey&sorter/order=ASC&sorter/field=priority&sorter/order=DESC 'Theme' tracker issues].

* MDL-3625 $menu in header does too many things
* MDL-3626 header.html and footer.html $variable inconsistency
* MDL-8369 Folder-like presentation of the courses at the main page
* MDL-9306 Main course formats need to have tables removed but keep AJAX working - ''there seem to be some regressions from this work ;-)''
** MDL-12164 Hiding Course Topics and Switching Roles creates Problem in other Topics
** MDL-13410 Course view misaligned
** MDL-17450 Display of blocks and topic section not correct in 2.0
* MDL-10522 Hard-coded used for spacing.
** MDL-14058 Code includes tags in many places, which breaks theming, or makes it more difficult
* MDL-10681 Popup windows need uniform body class
* MDL-12093 It is not possible to change the page layout in popup windows
* MDL-12183 Improve block HTML structure
* MDL-12191 Let themes know whether this page has blocks.
* MDL-14061 Add category short names, and an option for categories in the navigation bar.
* MDL-14305 Class on body to identify the page as Moodle, and a specific site. (Enables sharing of stylesheets, but with a few specific customisations.)
* MDL-14306 The course category hierarchy should be reflected in CSS classes on the body tag (actually, contextids would let this be done more efficiently).
* MDL-14539 Replace table layout with div - ''parhaps a duplicate of MDL-9306.''
* MDL-14632 Increase use of tabs on all mod activities.
* MDL-14901 Themes can no longer control the separater used in the nav bar.
* MDL-15400 Sideblocks on "My Moodle" page not conforming to global width
* MDL-15817 Part course them and part site theme is used when displayng Outline and Complete reports
* MDL-15959 patch any theme to have a personal visual style (CSS file) for each course - ''not sure this is a good solution, but it is an interesting requirement.''
* MDL-16244 Support for a drop-down menu bar - ''Like on moodle.org now''.

===Block related===

And the following are the relevant [http://tracker.moodle.org/secure/IssueNavigator.jspa?reset=true&pid=10011&resolution=-1&component=10076&sorter/field=summary&sorter/order=ASC&sorter/field=resolution&sorter/order=ASC&sorter/field=status&sorter/order=ASC&sorter/field=priority&sorter/order=DESC 'Blocks' issues].

* MDL-12240 Add the $CFG->defaultblocks functions to adminmenu
* MDL-15946 Add ability to add blocks to Category page
* MDL-11960 Cannot configure rss block on tag page
* MDL-11131 Moving blocks causes some blocks to disappear (pinned blocks trouble)
* MDL-14542 Modification to improve javascript and css header insertion for blocks, modules and filters
* MDL-5320 Under some circumstances some block_instances aren't deleted...
* MDL-6692 blocks on forum pages
* MDL-13582 "Course Sticky Blocks" don't get displayed when the "Show the course blocks" option is chosen when using "Add a resource" > "Compose a web page"
* MDL-13606 Sticky blocks on tag pages
* MDL-13627 Blocks - Default Closed View
* MDL-13708 The instances column, in the blocks management screen, links only to courses, but counts everything
* MDL-13888 Allow RSS block on MyMoodle pages only for users who can configure it
* MDL-13891 admin tree block disply in myMoodle controlled by capabilities
* MDL-15379 No way to exclude core blocks from specific modules if Blocks in Modules is enabled without changing core block code
* MDL-17447 LOCAL: stickyblocks targets
* MDL-6024 make hidden blocks visible to teacher
* MDL-6748 Patch to allow a center position for Moodle blocks
* MDL-5898 customizable blogs blocks

===Other===

* MDL-17730 More flexibility when creating skip links.
* MDL-7336 Allow filters to be enabled/disabled per course or activity
* MDL-6981 Allow text filters to add stuff to page footer
* MDL-18765 Maximum and minimum block widths are currently hard-coded in some view pages

==See also==

* [[Roadmap]]
* [[Development:Navigation/Pagelib/Blocks 2.0 design|a possible (partial) design from Tim]]
* [[Development:Filter enable/disable by context]]

Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=115620 What is the structure of a Moodle site?]
* [http://moodle.org/mod/forum/discuss.php?d=108993 The Future of Moodle Templates?]
* [http://moodle.org/mod/forum/discuss.php?d=95882 Proposed format plugin changes] (about blocks/pagelib)
* [http://moodle.org/mod/forum/discuss.php?d=115389 Can create but not see a block on the Course categories page]
* [http://moodle.org/mod/forum/discuss.php?d=116398 How hard is it to theme for Moodle?]

[[Category:Developer]]

Development:Developer documentation

2009-03-23T15:30:47Z

Jwc:

Developers write code for Moodle. 
So, if you are a new [[Administrator documentation|site administrator (go here)]]. 
If you are a new [[Teacher documentation|teacher (go here)]]. 
However, everyone is welcome to examine and contribute to the "Development" section of the Moodle documentation.

'''Note:''' New developer documentation pages should be added to the ''Development namespace'' by typing <code>Development:</code> before the new page name i.e. <code><nowiki>[[Development:New page name]]</nowiki></code>. If you are a developer, you probably want to change your [[Special:Preferences|preferences]] to include the Development namespace in searches. 

A page may be added to the Developer category by adding the template <code><nowiki>{{CategoryDeveloper}}</nowiki></code> to the bottom of the page. (If required, you can use <code><nowiki>[[Category:Developer|Sort key]]</nowiki></code> to provide a sort key other than the default page name.)

==How Moodle development works==

The [[Development:Overview|overview of the Moodle development process]] explains how Moodle development occurs and how people become Moodle developers. Current plans are listed on the [[Roadmap]].

You can also enrol in one of the [http://dev.moodle.org Moodle Developer Courses].

==Guidelines==

The following guidelines are crucial reading for anyone wanting to contribute to the Moodle code base:
*[[Development:Coding|Coding guidelines]] have to be followed by all Moodle developers
*[[Moodle design goals]] spells out the basic design goals behind Moodle
*[[Interface guidelines]] aim to provide a common feel to the Moodle user interface
*[[CVS (developer)|Moodle CVS for developers]] explains how to work with the Moodle code in CVS
*[[Tracker]] explains the Moodle Tracker for keeping track of bugs, issues, feature requests etc
*[[Development:Working with the Community|Working with the Community]] explains how to engage with the dev community and discuss changes
*[[Development:Unit tests|Unit tests]] explains how to run the unit tests, and how to write new test cases.
*[[Development:Fast portable SQL]] shows SQL techniques that are fast, efficient, and known to work on all supported DBs.

==Documentation for core components==

This section is for documentation of specific components of the existing core Moodle code. Discussion of components that are under discussion or in development can be found in the [[Development:Developer notes|developer notes]] or on the [[Roadmap|roadmap]].

The documents below give a general overview. For detailed function-by-function documentation, see the [http://phpdocs.moodle.org/ phpDocumentor] documentation that is automatically generated from the comments in the code.

And don't forget that the most up-to-date and detailed description of how the code works is the code itself, and you can [http://xref.moodle.org/nav.html?index.html browse the code online using PHPXref]. Moodle code should be easy to read and understand. See [[Development:PHPXref]] for more information on '''PHPXref'''.

===Core components that affect everything===

*[[Development:Database schema introduction|The database schema]]
*lib/moodlelib.php
*[[Development:lib/weblib.php|lib/weblib.php]] for outputting stuff
*[[Development:JavaScript_functions|JavaScript function available on the client side]]
*[[Development:XMLDB_Documentation|Database abstraction layer]] @ v[[1.7]]
*[[Development:Roles|Roles and Capabilities system]] @ v[[1.7]] for controlling who can do what
*[[Development:lib/formslib.php|Forms library]] @ v[[1.8]] for creating accessible and secure HTML forms that let users edit things
*[[Development:Using_the_file_API|File API]] @ v[[2.0]] for managing files stored by Moodle

===Core libraries with a more specific uses===

*[[Authentication API]]
*[[Cookieless Sessions]]
*[[Email processing]]
*[[Development:Environment checking|Environment checking]] before install, check the user's server to ensure Moodle will work there.
*[[Development:Groups|Groups system]]
*[[Development:Grades|Gradebook]]
*[[Development:Moodle Network|Moodle Network]]
*[[Question engine]]
*[[Stats package]]
*[[UTF-8 migration|Migration to UTF-8]] @ v[[:Category:Moodle 1.6|1.6]]
*[http://developer.yahoo.com/yui YUI JavaScript library] - YUI was selected as the official AJAX library for Moodle.
*[[Development:lib/graphlib|lib/graphlib]]
*[[Development:Admin settings|Admin settings]]

===Modules included in the standard distribution===

*[[Development:Lesson Specification|Lesson Specification]]
*[[Quiz developer docs|Quiz module]]
*[[SCORM schema|SCORM module 1.5 schema]]

==How you can contribute==

===Make a new plugin===

The M in Moodle stands for modular, and the easiest, most maintainable way to add new functionality to Moodle is by using one of the many plugin APIs. There are many types of plugin you can write:
*[[Development:Modules|Activity modules]], see also [[Development:NEWMODULE Documentation]] (work in progress)
*[[Development:Admin reports|Admin reports]]
*[[Development:Assignment types|Assignment types]]
*[[Development:Authentication plugins|Authentication plugins]]
*[[Development:Blocks|Blocks]]
*[[Course formats]]
*[[Development:Course Report Plugins|Course reports]]
*[[Development:Database fields|Database fields]]
*[[Development:Database presets|Database presets]]
*[[Development:Enrolment plugins|Enrolment plugins]]
*[[Development:Filters|Filters]]
*[[Development:Gradebook plugins|Gradebook plugins]]
**[[Development:Gradebook_Report_Tutorial|Gradebook report]]
**[[Development:Gradebook export|Gradebook export]]
**[[Development:Gradebook import|Gradebook import]]
*[[Development:Writing_a_Portfolio_Plugin|Portfolio Plugins]]
*[[Development:Question_type_plugin_how_to|Question types]]
*[[Development:Question import/export formats|Question import/export formats]]
*[[Development:How to write a quiz report plugin|Quiz reports]]
*[[Development:Repository plugins|Repository plugins]]
*[[Development:Resource types|Resource types]]
*[[Development:Search engine adapters|Search engine adapters]]

General information that applies to all types of plugins
*[[Development:Places to search for lang strings|Where to put language strings for your plugin]]
*[[Development:Installing and upgrading plugin database tables|Defining the database tables for your plugin]]

Please see the [[Development:Guidelines for contributed code|Guidelines for contributed code]] for an overview of how to contribute to the Moodle code.

Sometimes it is not possible to write a proper plugin for what you want to do, in which case you may have to resort to using the [[Development:Local_customisation|local customisations]] hook.

===Change core code===

Some types of change can only be made by editing the core Moodle code. Such changes are much harder to maintain than plugins. If you want your core change to be considered for inclusion in the official Moodle release, you need to create an issue in the [[Tracker|tracker]], and attach your change as a [[Development:How_to_create_a_patch|patch]]. It is also a good idea to discuss your ideas in the forums first. See [[Development:Overview#Major_Development]] for more details.

===Ways to contribute that do not involve PHP programming===

*[[Themes|Create Moodle themes]]
*[[Translation|Translate Moodle into other languages]]
*[[MoodleDocs:Guidelines for contributors|Help document Moodle]]
*[[Development:Tests|Join the testing effort]], which involves [[Tracker|participating in the bug tracker]]

==Plans for the future==

Ideas for and details of planned future features of Moodle are initially discussed on the forums in the [http://moodle.org/course/view.php?id=5 Using Moodle] course at moodle.org. That developer discussions are intermixed with user discussions in the same forums may seem strange at first but is one of the reasons for the success of Moodle. It is important that both end-users and developers discuss the future features together.

Once ideas begin to crystallize on the forums they can be summarized in this wiki, either as part of the [[Roadmap|roadmap]] or in the form of [[Development:Developer notes|developer notes]]. These pages then form the basis for further discussion in the forums.

*[[Roadmap]]
*[[Development:Developer notes|Developer notes]]
*[[Student projects]]
*[[Developer meetings]]

== Resources ==

*[[Developer FAQ]] - frequently asked questions, especially useful for newcomers to Moodle
*[[Development:Finding_your_way_into_the_Moodle_code|Finding your way into the Moodle code]] - also aimed at newcomers
*[http://tracker.moodle.org/ Moodle tracker] - bug reports, feature requests and other tracked issues
**[[Firefox tracker search]] - How to setup a firefox quicksearch to easily navigate to moodle bugs
**[[Firefox tracker search#Firefox Search Plugins|Firefox Search Plugins]] - Find tracked issues even more easily
*[[Unmerged files]] - changes on the stable branch in CVS that have not been merged to HEAD
*Browse the code online:
**[http://cvs.moodle.org/moodle/ the code with a complete change history from CVS]
**[http://xref.moodle.org/index.html the code, with links generated by PHPXref]
*[http://phpdocs.moodle.org/ Moodle PHP doc reference] - compiled from the comment attached to each class and function in the code
*[[Development:Database Schema|Database Schema]] - for recent releases
*[http://moodle.org/course/view.php?id=5#4 Development news and discussion] section of Using Moodle course
**especially the [http://moodle.org/mod/forum/view.php?id=55 General developer forum]
**[[Filters used on the Moodle.org forums|cool tricks you can use in the moodle.org forums]]

== Tools ==
Some tools people use when working on Moodle code:
*[[Development:Setting_up_Eclipse|Setting up Eclipse for Moodle development]] - Eclipse is a great editor to use for php development, if you can work out how to set it up.
*[[Development:vim|Setting up Vim for Moodle development]]
*[[Development:Setting_up_Netbeans|Setting up NetBeans for Moodle development]] - NetBeans for PHP is a great out-of-the-box editor.
*[[Development:ctags|Ctags]] - Using a tags file to navigate code
*[[W3C_validation|W3C HTML validator]] - Moodle has built in support to make using it easier.
*[http://getfirebug.com Firebug] add-on for Firefox.
** Some enhancements to make Firebug even more powerful: [http://www.drweb.de/magazin/mehr-power-fur-firebug/ Mehr Power für Firebug] (list of 10 enhancements, in German, but you can follow the links)
** Firebug now got it's own page: [[Development:Firebug]]
*[[Development:Windows Installer|Windows Installer]] - Windows Installer documentation for developer.

* See also: [http://dev.moodle.org/mod/forum/view.php?id=18 Useful Development Tools forum]in the [http://dev.moodle.org/course/view.php?id=2 Introduction to Moodle Programming course]

==See also==

*[http://security.moodle.org/ Moodle Security Centre]
*[http://moodle.com/partners/ Moodle Partners] - providers of custom Moodle development services

[[Category:Developer]]
[[Category:Developer tools]]

[[es:Documentación para Desarrolladores]]
[[fr:Documentation développeur]]
[[pt:Desenvolvimento:Documentação para programadores]]
[[zh:开发者文档]]
[[ja:開発者ドキュメント]]
[[fi:Ohjelmoijan opas]]

Filters

2008-05-23T17:32:24Z

Jwc: /* Standard filters */

Location: ''Administration > Modules > Manage filters''

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

==Enabling filters==
[[Image:filters admin.png|thumb|Filters administration in Moodle 1.8]]
To enable a filter:
#Access Administration > Modules > 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==

Note: Prior to Moodle 1.9, 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 content|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 filter|Algebra]] - 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
*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. However, as this filter may be 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">... 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 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 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
*[[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 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
* [[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.

==See also==

*[[Filters used on the Moodle.org forums]]
*[[Development:Filters]]
*[http://youtube.com/watch?v=rL1FVNewG7I Video demonstrating the set-up and use of filters in Moodle]
*Using Moodle [http://moodle.org/mod/forum/discuss.php?d=76206 Filter Demo's now online] forum discussion

[[Category:Filter]]

[[es:Filtros (Administrador)]]
[[fr:Filtres (administrateur)]]
[[ja:フィルタ (管理者)]]