lang/en_utf8/help/textformat.html

   1 <h1>Formatting text</h1>
   2
   3 <p>When writing text in Moodle there are several formats you can choose
   4    to produce your text, depending on your expertise and the type of browser
   5    you are using.</p>
   6
   7 <p><b>Usually you can just leave this setting to the default value and things
   8       should work as you expect</b>.</p>
   9
  10 <h2>1. Moodle auto-format</h2>
  11
  12 <ul>
  13 <p>This format is best for when you are using normal web forms for entry
  14    (instead of the Richtext HTML editor).  Just type text normally, as if you
  15    were sending an email.</p>
  16
  17 <p>When you save your text, Moodle will do a number of things to automatically
  18    format your text for you. </p>
  19 <p>For example, URLs such as </p>
  20    <a href="http://yahoo.com/">http://yahoo.com</a> or even
  21    <a href="http://www.yahoo.com/">www.yahoo.com</a> will be turned into links.
  22 <p>Your line breaks will be retained, and blank lines will start new paragraphs.</p>
  23 <p>Smiley characters such as :-) will automatically become their graphical equivalents.</p>
  24 <p>You can even embed HTML code if you want to and it will be retained.</p>
  25 <p align="right"><a href="help.php?file=text.html">More info about Moodle auto-formatting</a></p>
  26 </ul>
  27
  28
  29 <h2>2. HTML format</h2>
  30
  31 <ul>
  32 <p>This format assumes the text is pure HTML.  If you are using the
  33    HTML editor to edit text then this is the default format - all
  34    the commands in the toolbar are producing HTML for you.</p>
  35
  36 <p>Even if you are not using the Richtext HTML editor, you can use HTML code
  37    in your text and it should come out exactly as you intended.</p>
  38
  39 <p>Unlike the Moodle auto-format, no automatic formatting is performed.</p>
  40 <p align="right"><a href="help.php?file=html.html">More info about HTML in Moodle</a></p>
  41 <p align="right"><a href="help.php?file=richtext.html">More info about the Richtext HTML editor</a></p>
  42 </ul>
  43
  44
  45 <h2>3. Plain text format</h2>
  46
  47 <ul>
  48 <p>This format is useful when you need to include lots of code
  49    or HTML that you want to be displayed exactly as you wrote it.</p>
  50
  51 <p>It still translates spaces and new lines, but otherwise your
  52    text isn't touched.</p>
  53 </ul>
  54
  55
  56 <h2>4. Markdown text format</h2>
  57
  58 <ul>
  59 <p>Markdown format tries to make it easy as possible to type
  60    well-formatted XHTML pages using nothing but text written
  61    more or less like you would write an email.</p>
  62
  63 <p>It's very good for writing clean text pages with some headings
  64    and some lists but without many links or images.</p>
  65
  66 <p align="right"><a href="help.php?file=markdown.html">More info about the Markdown format</a></p>
  67 </ul>