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