Help:Editing

This page is for editing Moodle Documentation (MoodleDocs). This is a similar but much more robust type of program than the standard Moodle wiki.

Every ModdleDoc page has an "edit" tab at the top . This link will let you edit the page you are viewing. Please try editing a page by using this sandbox link.

Show preview

In edit mode, the show preview button at the bottom of the page lets you see what the page will look like after your edit, before you actually save. We all make mistakes; this feature lets you catch them immediately. Using Show preview before saving also lets you try format changes and other edits without cluttering up the page history, and has a number of other advantages. Don't forget to save your edits after previewing, though!

Edit summary

Before saving the page, it's considered good practice to enter a very brief summary of your changes in the summary box below the edit-box.

Formatting

Most formatting in MoodleDocs is usually done with MediaWiki markup - you don't have to learn HTML!

Bold and italics

Bolding and italicizing is done by surrounding a word or phrase with multiple apostrophes ('):

''italics'' appears as italics. (2 apostrophes on both sides)

'''bold''' appears as bold. (3 apostrophes on both sides)

'''''bolded italics''''' appears as bolded italics. (5 apostrophes on both sides)

Headings and subheadings

Headings and subheadings are an easy way to improve the organization of an article.

Headings can be created like this:

==Top level heading== (2 equals signs)

===Subheading=== (3 equals signs)

====Another level down==== (4 equals signs)

If an article has at least four headings, a table of contents will automatically be generated.

Indentations

The simplest way of indenting is to place a colon (:) at the beginning of a line. The more colons you put, the further indented the text will be. A newline marks the end of the indented paragraph e.g.

This is aligned all the way to the left.

:This is indented slightly.

::This is indented more.

is shown as

This is aligned all the way to the left.

This is indented slightly.

This is indented more.

Lists

What it looks like	What you type
Unordered lists are easy to do: start every line with a star more stars means deeper levels A newline in a list marks the end of the list.	* Unordered Lists are easy to do: ** start every line with a star *** more stars means deeper levels *A newline *in a list marks the end of the list.
Numbered lists are also good very organized easy to follow A newline in a list marks the end of the list.	# Numbered lists are also good ## very organized ## easy to follow #A newline #in a list marks the end of the list.

Preserving formatting

What it looks like	What you type
Leading spaces are another way to preserve formatting. Putting a space at the beginning of each line stops the text from being reformatted.	Leading spaces are another way to preserve formatting. Putting a space at the beginning of each line stops the text from being reformatted.

You can also use

<pre>

tags around code and other preformatted text.

 or use block the text and use the nowiki tool

Links

Wiki links

To make a wiki link, simply put the word in double square brackets, like this: [[Sandbox]]

If you want to use words other than the article title as the text of the link, you can do so by adding the pipe "|" divider followed by the alternative name.

For example, if you wanted to make a link to the Sandbox, but wanted it to say "my text" you would write it as: [[Sandbox|my text]]... It would appear as: my text... but would link to the sandbox.

External links

The easiest way to make an external link is to simply type in the full URL for the page you want to link to e.g. http://moodle.com.

To make the link display something other than the URL, use one square bracket at each end. If you want to make a link to moodle.com, type [http://moodle.com/] This will display the link as a number in brackets, like this: [1].

If you want the link to appear with text that you specify, add an alternative title after the address separated by a space (not a pipe). So if you want the link to appear as Moodle, just type [http://moodle.com Moodle] .

Categories

To put a page in a category, just type [[Category:]], and put the name of the category between the colon and the brackets.

To link directly to a category use [[:Category:Teacher | teacher]], this will show as teacher, note the preceding ":", which is different to [[Category:Teacher | teacher]]. The second will put the current page in the teacher category as mentioned above.

Inter-language links

Simply type [[es:Corresponding page title in Spanish]] in the English Moodle Docs, or [[en:Corresponding page title in English]] in the Spanish Moodle Docs, at the bottom of the page, below the category link. Inter-language links will appear automatically in the "In other languages" block.

User-page links

Talk page contributions may be signed and dated by typing four tildes ~~~~. This will appear as Helen Foster 06:35, 19 February 2006 (WST), for example.

Page comments

The page comment tab is used for discussion about the page. Sometimes before making an edit on the page for the first time, it is a good idea to check the page comments. It can be formatted the same as a main page, thus can be used to show a draft of a proposed change.

External links

• MediaWiki Help:Editing
• Help:HTML in wikitext
• HTML to MediaWiki converter
• Firefox Wikipedia extension - The Wikipedia extension makes editing of wiki pages easier by adding a new toolbar to your browser and by providing new menu items in the context menu (right mouse key).