Help:Formatting

From NPrize
Revision as of 16:23, 4 January 2010 by Vincent (Sọ̀rọ̀ | contribs) (links)
Jump to navigationJump to search

You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in italic, you include it in two single quotes like ''this''.

Text formatting markup

Description You type You get
character (inline) formatting – applies anywhere
Italic text ''italic'' italic
Bold text '''bold''' bold
Bold and italic '''''bold & italic''''' bold & italic
Escape wiki markup <nowiki>no ''markup''</nowiki> no ''markup''
section formatting – only at the beginning of the line
Headings of different levels
=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======

An article with 4 or more headings automatically creates a table of contents.

Level 1
Level 2
Level 3
Level 4
Level 5
Level 6
Horizontal rule ----
Bullet list
* one
* two
* three
** three point one
** three point two

Inserting a blank line will end the first list and start another.

  • one
  • two
  • three
    • three point one
    • three point two
Numbered list
# one
# two<br />spanning more lines<br />doesn't break numbering
# three
## three point one
## three point two
  1. one
  2. two
    spanning more lines
    doesn't break numbering
  3. three
    1. three point one
    2. three point two
Definition list
;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2
item 1
definition 1
item 2
definition 2-1
definition 2-2
Adopting definition list to indent text
: Single indent
:: Double indent
::::: Multiple indent

This workaround may be controversial from the viewpoint of accessibility.

Single indent
Double indent
Multiple indent
Mixture of different types of list
# one
# two
#* two point one
#* two point two
# three
#; three item one
#: three def one
# four
#: four def one
#: this rather looks like the continuation of # four
#: and thus often used instead of <br />
# five
## five sub 1
### five sub 1 sub 1
## five sub 2

;item 1
:* definition 1-1
:* definition 1-2
:
;item 2
:# definition 2-1
:# definition 2-2

The usage of #: and *: for breaking a line within an item may also be controversial.

  1. one
  2. two
    • two point one
    • two point two
  3. three
    three item one
    three def one
  4. four
    four def one
    this rather looks like the continuation of # four
    often used instead of <br />
  5. five
    1. five sub 1
      1. five sub 1 sub 1
    2. five sub 2
item 1
  • definition 1-1
  • definition 1-2
item 2
  1. definition 2-1
  2. definition 2-2
Preformatted text
 preformatted text is done with
 a '''space''' at the 
 ''beginning'' of the line

This way of preformatting only applies to section formatting, and character formatting markups are still effective.

preformatted text is done with
a space at the 
beginning of the line

Paragraphs

MediaWiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tags <br />.

HTML

Some HTML tags are allowed in MediaWiki, for example <code>, <div>, <span> and <font>. These apply anywhere you insert them.

Description You type You get
Strikethrough <del>Strikethrough</del> or <s>Strikethrough</s> Strikethrough
Fixed width text <tt>Fixed width text</tt> or <code>source code</code> Fixed width text
Blockquotes

text text text text text text text text text text text text text text text text text text text text text text text text <blockquote> quote quote quote quote quote quote </blockquote> text text text text text text text text text text text text

text text text text text text text text text text text text text text text text text text text text text text text text

quote quote quote quote quote quote

text text text text text text text text text text text text
Comment <!-- This is a comment -->

Text can only be viewed in the edit window.

Completely preformatted text

<pre>this way, all markups are '''ignored'''</pre>

 this way, all markups are '''ignored'''.
Customised preformatted text

<pre style="CSS text">this way, all markups are '''ignored''' and formatted with a CSS text</pre>

 this way for instance, all '''ignored''' markups take into account the navigator size, by automatically adding some carriage returns dynamically to it.

Internal links

To add an internal link, enclose the name of the page you want to link to in double square brackets. When you save the page, you'll see the new link pointing to your page. If the page exists already it is displayed in blue, if it does not, in red. Selflinks to the current page are not transformed in URLs but displayed in bold. (If you really want to link to the current page, use an anchor (see below), or [[#top|current page]] which always links to the top.)

The first letter of the target page is automatically capitalized, unless otherwise set by the admins, and spaces are represented as underscores (typing an underscore in the link will have a similar effect as typing a space, but is not recommended, since the underscore will also be shown in the text).

Description You type You get
Internal link
[[Main Page]]
Main Page
Piped link
[[Main Page|different text]]
different text
Shortened sort-of-piped link
[[Internationalisation]]s
Internationalisations
Redirect
#REDIRECT [[Main Page]]

See also Help:Redirects

Main Page
Internal link to an anchor
[[#See also]]

Section headings and the top of the page are automatically anchored.

#See also
Internal link to an anchor at another page
[[Help:Images#See also]]
Help:Images#See also
Internal link to the current page's talk page
[[{{TALKPAGENAME}}|Discussion]]

See also Help:Magic_words#Page_names

Discussion
Internal link to a subpage
[[/example]]

Shortcut for [[Help:Links/example]]. See also Help:Subpages.

/example
Internal link to a category page
[[:Category:Help]]

See also Help:Categories

Category:Help
Internal link to an image or a file of other types
[[media:example.jpg]]

[[media:example.pdf]]

See also Help:Images

media:example.jpg

media:example.pdf

External links

Description You type You get
External link
http://mediawiki.org
http://mediawiki.org
External link with different label
[http://mediawiki.org MediaWiki]
MediaWiki
External link numbered
[http://mediawiki.org]
[1]
External link icons
[http://en.wikipedia.org/wiki/.avi video]
[http://en.wikipedia.org/wiki/.wav sound]
[http://en.wikipedia.org/wiki/.pdf document]

External link icons may differ depending on the file type of the target.

video sound document

External link to the same host
[http://{{SERVERNAME}}/pagename]
[2]
External link to other host passing the pagename
[http://google.com/search?q={{PAGENAMEE}}]
[3]
Mailto link
[mailto:info@example.org email me]
email me
Mailto named with subject line and body
[mailto:info@example.org?Subject=URL%20Encoded%20Subject&body=Body%20Text info]
info

Template:Admin tip Template:Admin tip

How to avoid auto-links

By default, when you write a URL as is, it will be transformed to an external link.

To avoid that effect, put the URL between <nowiki> tags as in:

<nowiki>http://mediawiki.org</nowiki>