Help:Formatting

From 2009.igem.org

(Difference between revisions)
Chowes (Talk | contribs)
(Copied from the MediaWiki Help:Formatting page)
Newer edit →

Revision as of 10:07, 10 April 2009

Template:PD Help Page 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 <code><nowiki>this</nowiki></code>

Contents

Text formatting markup

Description You type You get
character formatting - applies anywhere
Italic text <pre>italic</pre> italic
Bold text <pre>bold</pre> bold
Bold and italic <pre>bold & italic</pre> bold & italic
Escape wiki markup

<pre>&lt;nowiki>no markup</nowiki></pre>

<nowiki>no markup</nowiki>
section formatting - only at the beginning of the line
Headings of different levels

<pre>=level 1=

level 2

level 3

level 4

level 5

======level 6======</pre> An article with four or more headings will automatically create a [http://en.wikipedia.org/wiki/Wikipedia:Section#Table_of_contents_.28TOC.29 table of contents].

Use of a level 1 heading is highly discouraged as it appears with the same formatting and size as the page title, which can be confusing.

<!-- little hack to prevent TOC viewing --> <div style="font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 1</div> <div style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 2</div> <div style="font-size: 132%; border-bottom: none; font-weight: bold;">Level 3</div> <div style="font-size: 100%; border-bottom: none; font-weight: bold;">Level 4</div> <div style="font-size: 86%; border-bottom: none; font-weight: bold;">Level 5</div> <div style="font-size: 80%; border-bottom: none; font-weight: bold;">Level 6</div>

Horizontal rule

<pre>----</pre>

Bullet list

<pre>

  • one
  • two
  • three
    • three point one
    • three point two

</pre> Inserting a blank line will end the first list and start another.

  • one
  • two
  • three
    • three point one
    • three point two
Numbered list

<pre>

  1. one
  2. two<br />spanning several lines<br />without breaking the numbering
  3. three
    1. three point one
    2. three point two

</pre>

  1. one
  2. two<br />spanning several lines<br />without breaking the numbering
  3. three
    1. three point one
    2. three point two
Definition list

<pre>

item 1
definition 1
item 2
definition 2-1
definition 2-2

</pre>

item 1
definition 1
item 2
definition 2-1
definition 2-2
Adopting definition list to indent text

<pre>:Single indent

Double indent
Multiple indent</pre>

This adoption may be controversial from the viewpoint of accessibility.

Single indent
Double indent
Multiple indent
Mixture of different types of list

<pre>

  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
    and thus 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

</pre> The usage of <code>#:</code> and <code>*:</code> 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 <code># four</code>
    and thus often used instead of <code><nowiki><br /></nowiki></code>
  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

<pre> 

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

</pre> 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 <code><nowiki><br /></nowiki></code>.

HTML

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

Description You type You get
Fixed width text

<pre><tt>Fixed width text</tt></pre>

<tt>Fixed width text</tt>

Blockquotes

<pre> 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 </pre>

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

Comment

<pre><!--This is comment--></pre>

<!--This is comment-->

Completely preformatted text

<pre><pre>this way, all markups are ignored&lt;/pre></pre>

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

Template:Admin tip

Other formatting

Beyond the text formatting markup shown above, here are some other formatting references:

Template:Languages

Retrieved from "http://2009.igem.org/Help:Formatting"