Difference between revisions of "Help:Editing"

Jump to: navigation, search

Note: You are currently viewing documentation for Moodle 2.7. Up-to-date documentation for the latest stable version of Moodle may be available here: Editing.

(editing basics, wikitext markup)
 
(formatting, links)
Line 1: Line 1:
== Editing Basics ==
+
== Editing ==
  
;Start editing
+
Every wiki page has an "edit" tab at the top plus edit links at the side. These links lets you do exactly what they say i.e. edit the page you're looking at. Please try it in the [[sandbox]]!
:To start editing a page, click on the "'''Edit this page'''" (or just "'''edit'''") link at one of its edges. This will bring you to the '''edit page''': a page with a text box containing the ''wikitext'': the editable source code from which the server produces the webpage.
 
  
;Summarize your changes
+
=== Show preview ===
:You should write a short edit summary in the small field below the edit-box.
+
This 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!
  
;Preview before saving
+
=== Edit summary ===
:When you have finished, press preview to see how your changes will look - '''before''' you make them permanent.  Repeat the edit/preview process until you are satisfied, then click "Save" and your changes will be immediately applied to the article.
+
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.
  
== Wikitext markup ==
+
== Formatting ==
{| border="1" cellpadding="2" cellspacing="0"
 
|-
 
!What it looks like
 
!What you type
 
|-
 
|
 
Start sections with header lines
 
  
Note: Single equal signs give the highest level heading, like the page title; usually projects have the convention not to use them.
+
Most '''formatting''' is usually done with Wiki markup - you don't have to learn HTML!
  
<!-- This is the original
+
=== Bold and italics ===
= DO NOT USE THIS =
+
'''Bolding''' and ''italicizing'' is done by surrounding a word or phrase with multiple apostrophes (<tt>'</tt>):
== New section ==
 
=== Subsection ===
 
==== Sub-subsection ====
 
-->
 
  
<!-- next set
+
:<code><nowiki>''italics''</nowiki></code> appears as ''italics''. (2 apostrophes on both sides)
<h1> DO NOT USE THIS </h1>
+
:<code><nowiki>'''bold'''</nowiki></code> appears as '''bold'''. (3 apostrophes on both sides)
<h2> New section </h2>
+
:<code><nowiki>'''''bolded italics'''''</nowiki></code> appears as '''''bolded italics'''''. (5 apostrophes on both sides)
<h3> Subsection </h3>
 
<h4> Sub-subsection </h4>
 
  -->
 
  
<!-- This code prevents confusion in the section editing feature-->
+
=== Headings and subheadings ===
<b><font style="font-size:120%"> New section </font></b>
+
Headings and subheadings are an easy way to improve the organization of an article.
  
<b><font style="font-size:110%"> Subsection</font></b>
+
Headings can be created like this:
 +
:<code><nowiki>==Top level heading==</nowiki></code> (2 equals signs)
 +
:<code><nowiki>===Subheading===</nowiki></code> (3 equals signs)
 +
:<code><nowiki>====Another level down====</nowiki></code> (4 equals signs)
  
<b><font style="font-size:100%"> Sub-subsection</font></b>
+
If an article has at least four headings, a table of contents will automatically be generated.
 
 
*Start with a second-level heading (<tt><nowiki>==</nowiki></tt>); don't use first-level headings (=).
 
*Don't skip levels (for example, second-level followed by fourth-level).
 
*A [[#Table of contents|table of contents]] will automatically be added to an article that has four or more sections.
 
*If you want to keep headings out of the TOC you have to use HTML heading tags and close them without using a slash e.g. <nowiki><h4>heading too low level to be in the toc of large page<h4></nowiki>.
 
|<pre><nowiki>
 
 
 
== New section ==
 
 
 
=== Subsection ===
 
 
 
==== Sub-subsection ====
 
</nowiki></pre>
 
  
 +
=== Indentations ===
 +
The simplest way of indenting is to place a colon (<code>:</code>) 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.
 +
:<code>This is aligned all the way to the left.</code>
 +
:<code><nowiki>:</nowiki>This is indented slightly.</code>
 +
:<code><nowiki>::</nowiki>This is indented more.</code>
 +
is shown as
 +
:This is aligned all the way to the left.
 +
::This is indented slightly.
 +
:::This is indented more.
  
 +
=== Lists ===
 +
{| border="1" cellpadding="2" cellspacing="0"
 
|-
 
|-
|
+
!What it looks like
;Newline:
+
!What you type
 
 
A single
 
newline
 
has no
 
effect on the
 
layout.
 
 
 
But an empty line
 
starts a new paragraph,
 
or ends a list or indented part.
 
(<nowiki><p></nowiki> disables this paragraphing until <nowiki></p></nowiki> or the end  of the section)
 
 
 
You can make the wikitext more readable by putting in newlines.
 
 
 
|<pre><nowiki>
 
 
 
A single
 
newline
 
has no
 
effect on the
 
layout.
 
 
 
But an empty line
 
starts a new paragraph.</nowiki></pre>
 
 
 
 
|-
 
|-
 
|
 
|
Line 92: Line 53:
 
*in a list   
 
*in a list   
 
marks the end of the list.
 
marks the end of the list.
*Of course
 
*you can
 
*start again.
 
  
 
|<pre><nowiki>* Unordered Lists are easy to do:
 
|<pre><nowiki>* Unordered Lists are easy to do:
Line 102: Line 60:
 
*in a list   
 
*in a list   
 
marks the end of the list.
 
marks the end of the list.
*Of course
 
*you can
 
*start again.
 
 
 
</nowiki></pre>
 
</nowiki></pre>
 
|-
 
|-
Line 115: Line 69:
 
#in a list   
 
#in a list   
 
marks the end of the list.
 
marks the end of the list.
#New numbering starts
 
#with 1.
 
 
 
|<pre><nowiki># Numbered lists are also good
 
|<pre><nowiki># Numbered lists are also good
 
## very organized
 
## very organized
Line 124: Line 75:
 
#in a list   
 
#in a list   
 
marks the end of the list.
 
marks the end of the list.
#New numbering starts
 
#with 1.
 
</nowiki></pre>
 
|-
 
|
 
* You can even do mixed lists
 
*# and nest them
 
*#* or break lines<br>in lists
 
|<pre><nowiki>* You can even do mixed lists
 
*# and nest them
 
*#* or break lines<br>in lists</nowiki></pre>
 
|-
 
|'''Definition list'''
 
; word : definition of the word
 
; longer phrase
 
: phrase defined
 
|<pre><nowiki>; word : definition of the word
 
; longer phrase
 
: phrase defined</nowiki></pre>
 
 
* One item per line; a newline can appear before the colon, but using a space before the colon improves parsing.
 
|-
 
|
 
;indenting
 
:A colon indents a line or paragraph.
 
A manual newline starts a new paragraph.
 
* This is often used for discussion on [[Help:Talk page|Talk page]]s.
 
|<pre><nowiki>: A colon indents a line or paragraph.
 
A manual newline starts a new paragraph.
 
</nowiki></pre>
 
|-
 
|
 
When there is a need for separating a block of text
 
<blockquote>
 
the '''blockquote''' command will indent both margins when needed instead of the left margin only as the colon does. 
 
</blockquote>
 
This is useful for (as the name says) inserting blocks of quoted (and cited) text. 
 
|
 
<pre><nowiki>
 
<blockquote>
 
The '''blockquote''' command will indent
 
both margins when needed instead of the
 
left margin only as the colon does. 
 
</blockquote>
 
</nowiki></pre>
 
|-
 
|<center>Centered text.</center>
 
* Please note the US-English spelling of "center".
 
|<pre><nowiki><center>Centered text.</center></nowiki></pre>
 
|-
 
|A horizontal dividing line:
 
this is above it...
 
----
 
...and this is below it.
 
 
If you don't use a section header, you don't get a TOC entry.
 
|<pre><nowiki>A horizontal dividing line:
 
this is above it...
 
----
 
...and this is below it.
 
 
</nowiki></pre>
 
</nowiki></pre>
 
|}
 
|}
  
=== Links, URLs ===
+
== Links ==
==== Internal links ====
 
*Enclose the '''target name''' in double square brackets -- <nowiki>"[[" and "]]"</nowiki>
 
*First letter of target name is automatically capitalized
 
*Spaces are represented as underscores (but don't do underscores yourself)
 
*[[the weather in London|Links to nonexistent pages]] are shown in red -- [[Help:Starting a new page]] tells about creating the page.
 
*When the mouse cursor "hovers" over the link, you see a "hover box" containing...
 
{| border="1" cellpadding="2" cellspacing="0"
 
|-
 
!What it looks like
 
!What you type
 
|-
 
|
 
;Basic
 
Sue is reading the [[official position]]
 
(or [[Official position]]s).
 
|<pre><nowiki>Sue is reading the
 
[[official position]]
 
(or [[Official position]]s).</nowiki></pre>
 
|-
 
|
 
;Interwiki linking
 
A link to the page on another wiki (e.g. the same subject in another language)
 
*For more info see [[m:Help:Interwiki linking]].
 
*[[:fr:Wikipédia:Aide]].
 
|<pre><nowiki>
 
*For more info see [[m:Help:Interwiki linking]].
 
*[[:fr:Wikipédia:Aide]].
 
</nowiki></pre>
 
|-
 
|
 
;Section of page
 
*[[List of cities by country#Morocco]].
 
*[[List of cities by country#Sealand]].
 
If the section doesn't exist, the link goes to the top of the page.
 
If there are multiple sections by the same name, link to specific ones by adding how many times that header has alreay appeared (e.g. if there are 3 sections entitled "Example header," and you wish to link to the third one, then use <nowiki>[[#Example section 3]]</nowiki>. For more info, see [[Help:Editing FAQ#Q: Can I link to a specific section header if there are multiple section headers of the same name? If so, how?|Help:Editing FAQ]].
 
|
 
<pre><nowiki>*[[List of cities by country#Morocco]].
 
*[[List of cities by country#Sealand]].</nowiki></pre>
 
<pre><nowiki></nowiki></pre>
 
|-
 
|
 
;[[Help:Piped link|Piped link]]
 
Use a pipe "'''|'''" to create a '''link label''':
 
*[[Help:Link|About Links]]
 
*[[List of cities by country#Morocco|
 
Cities in Morocco]]
 
|<pre><nowiki>*[[Help:Link|About Links]]
 
*[[List of cities by country#Morocco|
 
Cities in Morocco]]
 
</nowiki></pre>
 
|-
 
|'''"blank" pipes''' hide:
 
*Words in parentheses: [[kingdom (biology)|kingdom]].
 
*Namespace: [[Meta:Requests for adminship|Requests for adminship]].
 
After you save, the server automatically fills in the link label.
 
|<pre><nowiki>*In parentheses: [[kingdom (biology)|]].
 
*Namespace: [[Meta:Requests for adminship|]].</nowiki></pre>
 
|-
 
|
 
;Links to nonexistent pages
 
[[The weather in London]] is a page that doesn't exist yet.
 
*You can create it by clicking on the link.
 
*Have a look at [[Help:Starting a new page|how to start a page]] guide and the naming conventions page for your project.
 
|<pre><nowiki>[[The weather in London]] is a page
 
that doesn't exist yet.</nowiki></pre>
 
|-
 
|
 
;Link to yourself
 
You should "sign" your comments on talk pages:
 
: Your user name: [[User:Karl Wick|Karl Wick]]
 
: Or your user name plus date/time: [[User:Karl Wick|Karl Wick]] 08:10 Oct 5, 2002 (UTC)
 
The server will fill in the link after you save.
 
|<pre><nowiki>You should "sign" your comments on talk pages:
 
: Your user name: ~~~
 
: Or your user name plus date/time: ~~~~
 
</nowiki></pre>
 
|-
 
|
 
;[[Help:Redirect|Redirect]]s
 
one article title to another with this special link.
 
|<pre><nowiki>#REDIRECT [[United States]]</nowiki></pre>
 
|-
 
|
 
;"Magic" links
 
* [[w:ISBN|ISBN]] links to books: ISBN 0123456789X (See [[Help:ISBN links]]
 
* [[w:Request for Comments|RFC]] links to Requests for Comments: RFC 123 (See [[mediawiki:Rfcurl]])
 
|<pre><nowiki>
 
ISBN 0123456789X
 
RFC 123</nowiki></pre>
 
|-
 
|
 
;Media links
 
To include links to non-image uploads such as sounds, use a "media" link.
 
<br/>[[media:Sg_mrob.ogg|Sound]]
 
|<pre>
 
<nowiki>
 
[[media:Sg_mrob.ogg|Sound]]
 
</nowiki></pre>
 
|-
 
|
 
;Links to Categories
 
To include links to a Category page.
 
<br/>[[:Category:English documentation]]
 
|<pre>
 
<nowiki>
 
[[:Category:English documentation]]
 
</nowiki></pre>
 
|-
 
|
 
;Dates:
 
Use links for dates, so everyone can set their own display order. Use [[Special:Preferences]] to change your own date display setting.
 
|<pre><nowiki>[[July 20]], [[1969]] , [[20 July]] [[1969]]
 
and [[1969]]-[[07-20]]
 
</nowiki></pre>will all appear as [[20 July]]-[[1969]] if you set your date display preference to 1 January 2001.
 
|-
 
|
 
;Special pages
 
"What links here" and "Recent changes" can be linked as:<br/>
 
[[Special:Whatlinkshere/{{NAMESPACE}}:{{PAGENAME}}]] and
 
[[Special:Recentchangeslinked/{{NAMESPACE}}:{{PAGENAME}}]]
 
|<pre><nowiki>
 
[[Special:Whatlinkshere/
 
Help:Editing]] and
 
[[Special:Recentchangeslinked/
 
Help:Editing]]</nowiki></pre>
 
|}
 
 
 
====External links====
 
{| border="1" cellpadding="2" cellspacing="0"
 
|-
 
|[http://www.nupedia.com Nupedia], [http://www.nupedia.com]
 
|<pre><nowiki>
 
[http://www.nupedia.com Nupedia],
 
[http://www.nupedia.com]</nowiki></pre>
 
|-
 
|Or just give the URL: http://www.nupedia.com.
 
*In the [[Help:URL|URL]] all symbols must be among: A-Z a-z 0-9 ._\/~%- &amp;#?!=()@ \x80-\xFF. If a URL contains a different character it should be converted; for example, ^ has to be written ^ (to be looked up in [[w:ASCII|ASCII]]). A blank space can also be converted into an underscore.
 
|<pre><nowiki>Or just give the URL:
 
http://www.nupedia.com.</nowiki></pre>
 
|}
 
 
 
=== Images, video, and sounds ===
 
See also: [[Help:Images and other uploaded files]]
 
 
 
{| border="1" cellpadding="2" cellspacing="0"
 
|-
 
!What it looks like
 
!What you type
 
|-
 
|
 
;In-line picture: [[Image:Wiki.png|Wikipedia - The Free Encyclopedia]]
 
* For many projects, only images that have been uploaded to the same project or [[commons:|the Commons]] can be used. To upload images, use the [[Special:Upload|upload page]]. You can find the uploaded image on the [[Special:Imagelist|image list]]
 
|<pre><nowiki>
 
A picture: [[Image:Wiki.png]]</nowiki></pre>
 
or, with alternative text (''strongly'' encouraged) <!-- actually required in HTML4 -->    vbgf
 
<pre><nowiki>[[Image:Wiki.png|
 
Wikipedia - The Free Encyclopedia]] </nowiki>
 
</pre>
 
[[w:Web browser|Web browser]]s render alternative text when not displaying an image -- for example, when the image isn't loaded, or in a text-only browser, or when spoken aloud. See [[w:Wikipedia:Alternative text for images|Alternative text for images]] for help on choosing alternative text.  See [[Help:Extended image syntax|Extended image syntax]] for more options.
 
There is  [[Help:Images and other uploaded files#More_details_and_examples_on_embedding_internal_images__into_articles|more information]] on resizing and other formatting tricks.
 
|-
 
|
 
;Other ways of linking to pictures
 
*The [[Help:Image page|Image page]]: [[:Image:Wiki.png]]
 
*A link to just the picture: [[media:Wiki.png|Wikipedia]]
 
* Clicking on an image displayed on a page (such as any of the ones above) also leads to the description page
 
* To include links to images shown as links instead of drawn on the page, use a "media" link.
 
|<pre><nowiki>[[:Image:Wiki.png]]
 
[[media:Wiki.png|Wikipedia]]
 
</nowiki></pre>
 
|-
 
|'''Other Media Links -- Video and Sounds'''
 
Use a "media" link: [[media:Sg_mrob.ogg|Sound]]
 
<br>There is
 
[[Help:Images and other uploaded files#Supported_file_types.3B_miscellaneous|More information on other media types]].
 
|<pre><nowiki>[[media:Sg_mrob.ogg|Sound]]</nowiki></pre>
 
|}
 
 
 
=== Text formatting -- controlling how it looks ===
 
 
 
<table border="1" cellpadding="2" cellspacing="0">
 
<tr>
 
<th>What it looks like</th>
 
<th>What you type</th>
 
</tr>
 
<tr valign="top"><td>
 
''Emphasize'' (italics), '''strongly''' (bold), '''''very strongly''''' (bold italics).
 
(These are double and triple apostrophes, not double quotes.)
 
</td>
 
<td valign="bottom">
 
<pre><nowiki>''Emphasize'', '''strongly''',
 
'''''very strongly'''''.</nowiki></pre>
 
</td>
 
</tr>
 
<tr valign="top"><td>
 
You can also write <i>italic</i> and <b>bold</b>.
 
This is useful in mathematical formulas where you need specific font styles rather than emphasis.
 
:<b>F</b> = <i>m</i><b>a</b>
 
(The difference between these two methods is not very important for graphical browsers, so most people ignore it). But it may make a big difference for the visually impaired ;-)
 
</td>
 
<td>
 
<pre><nowiki>You can also write <i>italic</i> and <b>bold</b>.
 
This is useful in mathematical formulas where you
 
need specific font styles rather than emphasis.
 
:<b>F</b> = <i>m</i><b>a</b></nowiki></pre><!-- that's not a mathematical formula, though -- sure it is, just because it's being applied to physics doesn't make it stop being mathematics -->
 
</td>
 
</tr>
 
<tr valign="top"><td>
 
You can also write
 
<span style="font-variant:small-caps">
 
in small caps</span>.
 
If the wiki has the templates, this can
 
{{bsm}}be much simpler to write{{esm}}.
 
</td>
 
<td>
 
<pre><nowiki>You can also write
 
<span style="font-variant:small-caps">
 
in small caps</span>.
 
If the wiki has the templates, this can
 
{{bsm}}be much simpler to write{{esm}}.</nowiki></pre>
 
</td>
 
</tr>
 
<tr valign=top>
 
<td>A typewriter font, sometimes used for
 
<tt>technical terms</tt> and <code>computer code</code>.
 
</td>
 
<td><pre><nowiki>A typewriter font, sometimes used for
 
<tt>technical terms</tt> and <code>computer code</code>.</nowiki></pre>
 
* For semantic reasons, using <code>&lt;code&gt;</code> where applicable is preferable to using <code>&lt;tt&gt;</code>.
 
</td><!-- tt is really 'teletype', not 'technical term' -->
 
</tr>
 
<tr valign=top>
 
<td>You can use <small>small text</small> for captions.
 
</td>
 
<td><pre><nowiki>You can use <small>small text</small>
 
for captions.</nowiki></pre>
 
</td>
 
</tr>
 
<tr valign="top"><td>You can <strike>strike out deleted material</strike>
 
and <u>underline new material</u>.
 
 
 
You can also mark <del>deleted material</del> and
 
<ins>inserted material</ins> using logical markup
 
rather than visual markup.
 
* When editing regular articles, just make your changes and do not mark them up in any special way.
 
* When editing your own previous remarks in talk pages, it is sometimes appropriate to mark up deleted or inserted material.
 
</td>
 
<td><pre><nowiki>You can <strike>strike out deleted material</strike>
 
and <u>underline new material</u>.
 
 
 
You can also mark <del>deleted material</del> and
 
<ins>inserted material</ins> using logical markup
 
rather than visual markup.
 
</nowiki></pre>
 
</td>
 
</tr>
 
 
 
<tr valign="bottom" id="subscript"><td>Subscript: x<sub>2</sub><br/>
 
Superscript: x<sup>2</sup> or x&sup2;
 
 
 
Most browsers have an easier time formatting lines with &amp;sup2; than with &lt;sup>2&lt;/sup>
 
 
 
&epsilon;<sub>0</sub> =
 
8.85 &times; 10<sup>&minus;12</sup>
 
C&sup2; / J m.
 
<br/>
 
<br/>
 
1 [[hectare]] = [[1 E4 m²]]
 
</td>
 
 
 
<td valign="bottom"><pre><nowiki>Subscript: x<sub>2</sub>
 
Superscript: x<sup>2</sup> or x&amp;sup2;
 
</nowiki></pre>
 
<pre><nowiki>
 
&amp;epsilon;<sub>0</sub> =
 
8.85 &amp;times; 10<sup>&amp;minus;12</sup>
 
C&amp;sup2; / J m.
 
 
 
1 [[hectare]] = [[1 E4 m&amp;sup2]]
 
</nowiki></pre></td>
 
</tr>
 
</table>
 
 
 
===Spacing things out -- spaces and tables ===
 
<table border="1" cellpadding="2" cellspacing="0">
 
<tr valign="top"><td>
 
;Using non-breaking spaces
 
<i>x</i><sup>2</sup>&nbsp;&nbsp;
 
&nbsp;&ge;
 
&nbsp;&nbsp;&nbsp;0 true.
 
</td>
 
<td><pre><nowiki>
 
<i>x</i><sup>2</sup>&amp;nbsp;
 
&amp;nbsp;&amp;ge;
 
&amp;nbsp;&amp;nbsp;0 true.
 
</nowiki></pre></td>
 
</tr>
 
 
 
<tr>
 
<td>
 
;Using [[Help:Table#Simple_example|Wikitext piped tables]]
 
{||-
 
|<i>x</i><sup>2</sup>
 
| width=20px | || width=20px | &ge;0 || true.
 
|-
 
| a || || b
 
|}
 
See templates [[Template:hs1]], [[Template:hs]], and [[Template:vs]] for more examples
 
</td>
 
<td>
 
<pre><nowiki>
 
{||-
 
|<i>x</i><sup>2</sup>
 
| width=20px | || width=20px | &ge;0 || true.
 
|-
 
| a || || b
 
|}
 
</nowiki></pre>
 
See [[Help:Table]] for more information
 
</td>
 
</tr>
 
 
 
</table>
 
 
 
===Just show what I typed===
 
&lt;nowiki&gt; and &lt;pre&gt; tags can tell the server and the browser to display things as you typed them.
 
<table border="1" cellpadding="2" cellspacing="0">
 
<tr>
 
<td>
 
;Example:
 
 
 
arrow      &rarr;
 
 
 
''italics''
 
[[link]]
 
</td>
 
<td valign="bottom">
 
<pre><nowiki>arrow      &amp;rarr;
 
 
 
''italics''
 
[[link]]</nowiki></pre>
 
</td>
 
</tr>
 
<tr>
 
<td valign="bottom">
 
;&lt;nowiki>
 
* interpret special characters
 
* don't interpret special wiki markup
 
* reformat text (removing newlines and multiple spaces)
 
<nowiki>
 
arrow      &rarr;
 
 
 
''italics''
 
[[link]]
 
</nowiki>
 
</td>
 
<td valign="bottom">
 
<pre><nowiki><nowiki>
 
arrow      &amp;rarr;
 
 
 
''italics''
 
[[link]]
 
</nowiki></nowiki></pre>
 
 
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
;<nowiki><pre></nowiki>
 
* interpret special characters
 
* don't interpret special wiki markup
 
* don't reformat text
 
 
 
<pre>arrow      &rarr;
 
 
 
''italics''
 
[[link]]
 
</pre>
 
</td>
 
<td valign="bottom">
 
<pre><nowiki><pre>arrow      &amp;rarr;
 
 
 
''italics''
 
[[link]]</pre></nowiki></pre>
 
</td>
 
</tr>
 
 
 
<tr>
 
<td>
 
; leading space
 
* interpret special characters
 
* interpret special wiki markup
 
* don't reformat text
 
arrow      &rarr;
 
 
''italics''
 
[[link]]
 
</pre>
 
</td>
 
<td valign="bottom">
 
<pre> <nowiki>arrow      &amp;rarr;
 
 
 
''italics''
 
[[link]]</nowiki></pre>
 
</td>
 
</tr>
 
 
 
<tr valign=top>
 
<td>
 
;preformatted text
 
IF a line of plain text starts with a space
 
  it will be formatted exactly
 
    as typed
 
  in a fixed-width font
 
  lines won't wrap
 
ENDIF
 
this is useful for:
 
  * pasting preformatted text;
 
  * algorithm descriptions;
 
  * program source code
 
  * ASCII art;
 
  * chemical structures;
 
 
 
For larger preformatted text passages you can use the <nowiki><pre>a lot of text</pre></nowiki> tag.
 
 
 
WARNING If you make it wide,
 
you [[w:page widening|force the whole page to be wide]] and
 
hence less readable. Never start ordinary lines with spaces.<br>
 
<center>(see also below)</center>
 
</td>
 
<td><pre><nowiki> IF a line of plain text starts with a space
 
  it will be formatted exactly
 
    as typed
 
  in a fixed-width font
 
  lines won't wrap
 
ENDIF
 
this is useful for:
 
  * pasting preformatted text;
 
  * algorithm descriptions;
 
  * program source code
 
  * ASCII art;
 
  * chemical structures;
 
</nowiki></pre>
 
</td>
 
</tr>
 
 
 
  
<tr>
+
=== Wiki links ===
<td>
+
To make a wiki link, simply put the word in double square brackets, like this: <code><nowiki>[[Sandbox]]</nowiki></code>
;typewriter font:
 
  
<tt>arrow      &rarr;</tt>
+
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 (SHIFT + BACKSLASH on English-layout and other keyboards) followed by the alternative name.
  
<tt>''italics''</tt>
+
For example, if you wanted to make a link to the [[sandbox]], but wanted it to say "my text" you would write it as: <tt><nowiki>[[sandbox|my text]]</nowiki>...</tt> It would appear as: [[sandbox|my text]]... but would link to the sandbox.
<tt>[[link]]</tt>
 
  
</td>
+
To put a page in a category, just type <code><nowiki>[[Category:]]</nowiki></code>, and put the name of the category between the colon and the brackets.
<td valign="bottom">
 
<pre><nowiki><tt>arrow      &amp;rarr;</tt>
 
  
<tt>''italics''</tt>
+
=== External links ===
<tt>[[link]]</nowiki></tt></pre>
 
</td>
 
</tr>
 
  
<tr>
+
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://www.google.com.
<td>
 
;Show special character codes:
 
  
&amp;rarr;
+
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 Google, type <code><nowiki>[http://www.google.com/]</nowiki></code>
</td>
+
This will display the link as a number in brackets, like this: [http://www.google.com/].
<td valign="bottom">
 
<pre>&amp;amp;rarr;</pre>
 
</td>
 
</tr>
 
  
<tr>
+
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 [http://www.google.com Google search engine], just type <code><nowiki>[http://www.google.com Google search engine]</nowiki></code>.
<td>
 
;Comments
 
The text between '''here'''
 
<!-- comment here -->
 
'''and here''' won't be displayed
 
</td>
 
<td>
 
<pre><nowiki>The text between '''here'''
 
<!-- comment here -->
 
'''and here''' won't be displayed</nowiki></pre>
 
</td>
 
</tr>
 
</table>
 
  
 
[[Category:MoodleDocs]]
 
[[Category:MoodleDocs]]

Revision as of 12:22, 25 November 2005

Editing

Every wiki page has an "edit" tab at the top plus edit links at the side. These links lets you do exactly what they say i.e. edit the page you're looking at. Please try it in the sandbox!

Show preview

This 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 is usually done with Wiki 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.
  1. Numbered lists are also good
    1. very organized
    2. easy to follow
  2. A newline
  3. 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.

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 (SHIFT + BACKSLASH on English-layout and other keyboards) 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.

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

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://www.google.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 Google, type
[http://www.google.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 Google search engine, just type
[http://www.google.com Google search engine]
.