Note: You are currently viewing documentation for Moodle 2.2. Up-to-date documentation for the latest stable version is available here: Formatting text.

Formatting text: Difference between revisions

From MoodleDocs
No edit summary
 
(22 intermediate revisions by 6 users not shown)
Line 1: Line 1:
When writing text in Moodle there are several formats you can choose to produce your text, depending on your expertise and the type of browser you are using.
{{Editing text}}
When writing text in Moodle there are several formats you can choose to produce your text.


Usually you can just leave this setting to the default value and things should work as you expect.
==Formatting text options==


By default, the [[Text editor]] is available for all text areas in Moodle and the format is automatically set to HTML format.


==Moodle auto-format==
However, if the setting 'When editing text' in ''Settings > My profile settings > Edit profile'' is set to 'Use standard web forms', then various format options are available in a dropdown menu below the text area.
 
[[File:Format dropdown.png]]
 
==HTML format==
 
When writing HTML in Moodle, you are free to use almost any HTML tags you like to produce the effect you want.
 
Note that scripting (eg Javascript or VB Script) is not allowed, and will be removed automatically.
 
Your code will normally be printed on the page within a table cell, so:
 
* There is no need to use any <HEAD> or <BODY> tags
* Be careful about unmatched </TABLE> tags that may mess up the display.


This format is best for when you are using normal web forms for entry (instead of the Richtext HTML editor). Just type text normally, as if you were sending an email.
Anything starting with www. or http:// will automatically be turned into a clickable link, for example [http://www.moodle.org www.moodle.org] (assuming the [[Convert URLs into links filter]] is enabled by an administrator).


When you save your text, Moodle will do a number of things to automatically format your text for you.  
This format assumes the text is pure HTML. If you are using the text editor to edit text then this is the default format - all the commands in the toolbar are producing HTML for you.


For example, URLs such as http://yahoo.com or even www.yahoo.com will be turned into links. Your line breaks will be retained, and blank lines will start new paragraphs.
Even if you are not using the text editor, you can use HTML code in your text and it should come out exactly as you intended.


Smiley characters such as :-) will automatically become their graphical equivalents.
==Moodle auto-format==


You can even embed HTML code if you want to and it will be retained.
This format is best for when you are using normal web forms for entry (instead of using the text editor). Just type text normally, as if you were sending an email.


More info about Moodle auto-formatting: http://moodle.org/help.php?file=text.html
When you save your text, Moodle will do a number of things to automatically format your text for you.  


==HTML format==
As for HTML format, websites will automatically be turned into a clickable link (assuming the [[Convert URLs into links filter]] is enabled by an administrator).


This format assumes the text is pure HTML. If you are using the HTML editor to edit text then this is the default format - all the commands in the toolbar are producing HTML for you.
Smiley characters such as :-) will automatically become their graphical equivalents (assuming the [[Display emoticons as images filter]] is enabled by an administrator).


Even if you are not using the Richtext HTML editor, you can use HTML code in your text and it should come out exactly as you intended.
[[Image:Smilies.png]]


Unlike the Moodle auto-format, no automatic formatting is performed.
Your line breaks will be retained, and blank lines will start new paragraphs.


More info about HTML in Moodle: http://moodle.org/help.php?file=html.html
You can even embed HTML code if you want to and it will be retained.


More info about the Richtext HTML editor: http://moodle.org/help.php?file=richtext.html
[[Image:Html tags.png]]


==Plain text format==
==Plain text format==
Line 36: Line 51:
It still translates spaces and new lines, but otherwise your text isn't touched.
It still translates spaces and new lines, but otherwise your text isn't touched.


==Markdown text format==


==Markdown text format==
[[Markdown]] format tries to make it easy as possible to type well-formatted XHTML pages using nothing but text written more or less like you would write an email.


Markdown format tries to make it easy as possible to type well-formatted XHTML pages using nothing but text written more or less like you would write an email.
It's very good for writing clean text pages with some headings and some lists but without many links or images. It is an excellent choice when accessibility of the generated page is important.


It's very good for writing clean text pages with some headings and some lists but without many links or images.
An unordered list may be created with asterisks (*).


More info about the Markdown format: http://moodle.org/help.php?file=markdown.html
For complete syntax description, see: http://daringfireball.net/projects/markdown/syntax Moodle 1.6 has extended features called Markdown Extra: for ''additional'' features see http://www.michelf.com/projects/php-markdown/extra/


==Tips and Tricks==
==Tips and Tricks==
* ''Wrong Characters Showing'' - If some users do not see the same characters or figures, have them check their browser settings for their character settings.  At Moodle.org, the recommended default character decoding set is UTF-8.  On a Firefox browser, this can be found in Tools>Options>Fonts & colors>advanced>default character decoding pull down menu.
* ''Wrong Characters Showing'' - If some users do not see the same characters or figures, have them check their browser settings for their character settings.  At Moodle.org, the recommended default character decoding set is UTF-8.  On a Firefox browser, this can be found in Tools>Options>Fonts & colors>advanced>default character decoding pull down menu.
If that doesn't work you can try installing a UTF-8 Unicode font from: http://titus.fkidg1.uni-frankfurt.de/unicode/tituut.asp. (This has at least helped XP users that weren't seeing stars in the ratings.)
[[de:Text formatieren]]

Latest revision as of 19:48, 27 January 2012

When writing text in Moodle there are several formats you can choose to produce your text.

Formatting text options

By default, the Text editor is available for all text areas in Moodle and the format is automatically set to HTML format.

However, if the setting 'When editing text' in Settings > My profile settings > Edit profile is set to 'Use standard web forms', then various format options are available in a dropdown menu below the text area.

Format dropdown.png

HTML format

When writing HTML in Moodle, you are free to use almost any HTML tags you like to produce the effect you want.

Note that scripting (eg Javascript or VB Script) is not allowed, and will be removed automatically.

Your code will normally be printed on the page within a table cell, so:

  • There is no need to use any <HEAD> or <BODY> tags
  • Be careful about unmatched tags that may mess up the display.

Anything starting with www. or http:// will automatically be turned into a clickable link, for example www.moodle.org (assuming the Convert URLs into links filter is enabled by an administrator).

This format assumes the text is pure HTML. If you are using the text editor to edit text then this is the default format - all the commands in the toolbar are producing HTML for you.

Even if you are not using the text editor, you can use HTML code in your text and it should come out exactly as you intended.

Moodle auto-format

This format is best for when you are using normal web forms for entry (instead of using the text editor). Just type text normally, as if you were sending an email.

When you save your text, Moodle will do a number of things to automatically format your text for you.

As for HTML format, websites will automatically be turned into a clickable link (assuming the Convert URLs into links filter is enabled by an administrator).

Smiley characters such as :-) will automatically become their graphical equivalents (assuming the Display emoticons as images filter is enabled by an administrator).

Smilies.png

Your line breaks will be retained, and blank lines will start new paragraphs.

You can even embed HTML code if you want to and it will be retained.

Html tags.png

Plain text format

This format is useful when you need to include lots of code or HTML that you want to be displayed exactly as you wrote it.

It still translates spaces and new lines, but otherwise your text isn't touched.

Markdown text format

Markdown format tries to make it easy as possible to type well-formatted XHTML pages using nothing but text written more or less like you would write an email.

It's very good for writing clean text pages with some headings and some lists but without many links or images. It is an excellent choice when accessibility of the generated page is important.

An unordered list may be created with asterisks (*).

For complete syntax description, see: http://daringfireball.net/projects/markdown/syntax Moodle 1.6 has extended features called Markdown Extra: for additional features see http://www.michelf.com/projects/php-markdown/extra/

Tips and Tricks

  • Wrong Characters Showing - If some users do not see the same characters or figures, have them check their browser settings for their character settings. At Moodle.org, the recommended default character decoding set is UTF-8. On a Firefox browser, this can be found in Tools>Options>Fonts & colors>advanced>default character decoding pull down menu.

If that doesn't work you can try installing a UTF-8 Unicode font from: http://titus.fkidg1.uni-frankfurt.de/unicode/tituut.asp. (This has at least helped XP users that weren't seeing stars in the ratings.)