lang/en_utf8/help/filters.html

   1 <h1>Filters Administration</h1>
   2
   3 <p>The Filters administration page allows you to specify which filters are
   4    applied to displayed text and in what order. It also provides access to
   5    the settings page provided by some filters. Filters are applied to most
   6    user-text in moodle just before it is displayed. They permit 'last minute'
   7    modification of the text.</p>
   8
   9 <p>Filters are a 'pluggable' resource. More may be available from the
  10    <a href="http://moodle.org/mod/data/view.php?id=6009">Modules and plugins database</a>.</p>
  11
  12 <p>Select the filters you wish to use by 'unhiding' them, with the eye icon.
  13    If you have more that one unhidden you can change the order in which they
  14    are applied with the up and down arrows.</p>
  15
  16 <h2>TeX notation</h2>
  17
  18 <div class="indent">
  19   <p>TeX notation is primarily used to generate inline mathematical formulae
  20   within Moodle resources. For example $$ sqrt(a+b) $$ (the $$ is the 'tag'
  21   for the start and end of this format).</p>
  22   <p>Moodle uses external binaries to render the images which may need setting
  23   up for your system. The filter will first check for a LaTeX renderer (Ghostscript
  24   is also required for this method) and failing that will use the simpler <i>mimetex</i>
  25   binary included in the Moodle distribution. LaTex permits the whole range
  26   of syntax, whereas mimetex only supports a mathematical subset.</p>
  27   <p>Ghostscript is available for Windows and there is a LaTeX implementation
  28   called MikTeX available also.</p>
  29   <p>The settings page allows the LaTeX and Ghostscript binary paths to be
  30   configured, along with the LaTeX preamble.</p>
  31   <h3>More info</h3>
  32   <p><a href="http://www.miktex.org/">MiKTeX</a><br />
  33      <a href="http://www.forkosh.com/mimetex.html">MimeTeX</a><br />
  34      <a href="http://www.latex-project.org/">LaTeX</a><br />
  35      <a href="http://www.ghostscript.com/">ghostscript</a></p>
  36 </div>
  37
  38 <h2>Word Censorship</h2>
  39
  40 <div class="indent">
  41   <p>Word Censorship scans text for 'bad words' from a list and obscures them with a black box. You need to enter a list of bad words in the word censorship settings.</p>
  42 </div>
  43
  44 <h2>Resource Names Auto-Linking</h2>
  45
  46 <div class="indent">
  47   <p>Resource Name Auto-linking scans text for resource titles that
  48   exist in the same course. Where found they will be highlighted and a link
  49   created. Note that to use this effectively you should use descriptive titles. For
  50   example a title of 'Introduction' is poor because <b>any</b> use of the word
  51   'Introduction' in the text will be linked regardless of what it refers to.</p>
  52 </div>
  53
  54 <h2>Activity Names Auto-Linking</h2>
  55
  56 <div class="indent">
  57   <p>Activity Name Auto-linking scans text for activity titles that
  58   exist in the same course. Where found they will be highlighted and a link
  59   created. Note that to use this effectively you should use descriptive titles. For
  60   example a title of 'Quiz' is poor because <b>any</b> use of the word
  61   'Quiz' in the text will be linked regardless of what it refers to.</p>
  62 </div>
  63
  64 <h2>Glossary Auto-Linking</h2>
  65
  66 <div class="indent">
  67   <p>This filter scans the text for keywords used in any glossary in the course. Note,
  68   however, that each glossary entry must have linking enabled. Where found they
  69   will be highlighted and a link created.
  70   </p>
  71 </div>
  72
  73 <h2>Email Protection</h2>
  74
  75 <div class="indent">
  76   <p>The Email Protection filter scans the text for any email addresses. Where found
  77   they are 'obfusticated' to help prevent automatic email collection systems from
  78   harvesting emails. This can reduce the risk of spam if parts of your Moodle site
  79   are open.</p>
  80 </div>
  81
  82 <h2>Tidy</h2>
  83
  84 <div class="indent">
  85   <p>Tidy scans text for HTML constructs. Where found it applies rules that attempt
  86   to make the HTML valid. Note that the tidy functionality must be built in to your
  87   PHP installation for this to work.</p>
  88 </div>
  89
  90 <h2>Multi-Language Content</h2>
  91
  92 <div class="indent">
  93   <p>This filter enables resources to be created in multiple languages. The resource
  94   language will then change when the user changes their selected Moodle language. To
  95   use this feature first create your contents in multiple languages (in the same
  96   resource). Then enclose each language block in the following tags:</p>
  97   <pre>      &lt;span lang="XX" class="multilang"&gt;your_content_here&lt;/span&gt;</pre>
  98   <p>You can still use the old (deprecated) span tags instead, for example:</p>
  99   <pre>      &lt;lang lang="XX" &gt;your_content_here&lt;/lang&gt;</pre>
 100  </div>