Help:Formatting

From 2009.igem.org

(Difference between revisions)
(Copied from the MediaWiki Help:Formatting page)
(That should do it!)
 
Line 1: Line 1:
-
{{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>
-
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 &lt;code&gt;&lt;nowiki&gt;''this''&lt;/nowiki&gt;&lt;/code&gt;
+
== Text formatting markup ==
== Text formatting markup ==
-
{| class=&quot;wikitable&quot;
+
{| class="wikitable"
-
! style=&quot;width:15%&quot; |Description
+
! style="width:15%" |Description
-
! style=&quot;width:45%&quot; |You type
+
! style="width:45%" |You type
-
! style=&quot;width:40%&quot; |You get
+
! style="width:40%" |You get
|-
|-
-
! colspan=&quot;3&quot; align=&quot;center&quot; style=&quot;background:#A7C1F2&quot; | character formatting - ''applies anywhere''
+
! colspan="3" align="center" style="background:#A7C1F2" | character formatting - ''applies anywhere''
|-
|-
|Italic text
|Italic text
-
|&lt;pre&gt;''italic''&lt;/pre&gt;
+
|<pre>''italic''</pre>
|''italic''
|''italic''
|-
|-
| Bold text
| Bold text
-
|&lt;pre&gt;'''bold'''&lt;/pre&gt;
+
|<pre>'''bold'''</pre>
|'''bold'''
|'''bold'''
|-
|-
| Bold and italic
| Bold and italic
-
|&lt;pre&gt;'''''bold &amp; italic'''''&lt;/pre&gt;
+
|<pre>'''''bold & italic'''''</pre>
-
|'''''bold &amp; italic'''''
+
|'''''bold & italic'''''
|-
|-
|Escape wiki markup
|Escape wiki markup
|
|
-
&lt;pre&gt;&amp;lt;nowiki&gt;no ''markup''&lt;/nowiki&gt;&lt;/pre&gt;
+
<pre>&lt;nowiki>no ''markup''</nowiki></pre>
-
|&lt;nowiki&gt;no ''markup''&lt;/nowiki&gt;
+
|<nowiki>no ''markup''</nowiki>
|-
|-
-
! colspan=&quot;3&quot; align=&quot;center&quot; style=&quot;background:#A7C1F2&quot;| section formatting - ''only at the beginning of the line''
+
! colspan="3" align="center" style="background:#A7C1F2"| section formatting - ''only at the beginning of the line''
|-
|-
|Headings of different levels  
|Headings of different levels  
|
|
-
&lt;pre&gt;=level 1=
+
<pre>=level 1=
==level 2==
==level 2==
===level 3===
===level 3===
====level 4====
====level 4====
=====level 5=====
=====level 5=====
-
======level 6======&lt;/pre&gt;
+
======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].
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.
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.
|
|
-
&lt;!-- little hack to prevent TOC viewing --&gt;
+
<!-- little hack to prevent TOC viewing -->
-
&lt;div style=&quot;font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;&quot;&gt;Level 1&lt;/div&gt;
+
<div style="font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 1</div>
-
&lt;div style=&quot;font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;&quot;&gt;Level 2&lt;/div&gt;
+
<div style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa;">Level 2</div>
-
&lt;div style=&quot;font-size: 132%; border-bottom: none; font-weight: bold;&quot;&gt;Level 3&lt;/div&gt;
+
<div style="font-size: 132%; border-bottom: none; font-weight: bold;">Level 3</div>
-
&lt;div style=&quot;font-size: 100%; border-bottom: none; font-weight: bold;&quot;&gt;Level 4&lt;/div&gt;
+
<div style="font-size: 100%; border-bottom: none; font-weight: bold;">Level 4</div>
-
&lt;div style=&quot;font-size: 86%; border-bottom: none; font-weight: bold;&quot;&gt;Level 5&lt;/div&gt;
+
<div style="font-size: 86%; border-bottom: none; font-weight: bold;">Level 5</div>
-
&lt;div style=&quot;font-size: 80%; border-bottom: none; font-weight: bold;&quot;&gt;Level 6&lt;/div&gt;
+
<div style="font-size: 80%; border-bottom: none; font-weight: bold;">Level 6</div>
|-
|-
|Horizontal rule
|Horizontal rule
|
|
-
&lt;pre&gt;----&lt;/pre&gt;
+
<pre>----</pre>
|
|
----
----
Line 57: Line 56:
|Bullet list
|Bullet list
|
|
-
&lt;pre&gt;
+
<pre>
* one
* one
* two
* two
Line 63: Line 62:
** three point one
** three point one
** three point two
** three point two
-
&lt;/pre&gt;
+
</pre>
Inserting a blank line will end the first list and start another.
Inserting a blank line will end the first list and start another.
|
|
Line 74: Line 73:
|Numbered list
|Numbered list
|
|
-
&lt;pre&gt;
+
<pre>
# one
# one
-
# two&lt;br /&gt;spanning several lines&lt;br /&gt;without breaking the numbering
+
# two<br />spanning several lines<br />without breaking the numbering
# three
# three
## three point one
## three point one
## three point two
## three point two
-
&lt;/pre&gt;
+
</pre>
|
|
# one
# one
-
# two&lt;br /&gt;spanning several lines&lt;br /&gt;without breaking the numbering
+
# two<br />spanning several lines<br />without breaking the numbering
# three
# three
## three point one
## three point one
Line 90: Line 89:
|Definition list
|Definition list
|
|
-
&lt;pre&gt;
+
<pre>
;item 1
;item 1
:definition 1
:definition 1
Line 96: Line 95:
:definition 2-1
:definition 2-1
:definition 2-2
:definition 2-2
-
&lt;/pre&gt;
+
</pre>
|
|
;item 1
;item 1
Line 106: Line 105:
| Adopting definition list to indent text
| Adopting definition list to indent text
|
|
-
&lt;pre&gt;:Single indent
+
<pre>:Single indent
::Double indent
::Double indent
-
:::::Multiple indent&lt;/pre&gt;
+
:::::Multiple indent</pre>
This adoption may be controversial from the viewpoint of accessibility.
This adoption may be controversial from the viewpoint of accessibility.
|
|
Line 117: Line 116:
| Mixture of different types of list
| Mixture of different types of list
|
|
-
&lt;pre&gt;
+
<pre>
# one
# one
# two
# two
Line 128: Line 127:
#: four def one
#: four def one
#: this rather looks like the continuation of # four
#: this rather looks like the continuation of # four
-
#: and thus often used instead of &lt;br /&gt;
+
#: and thus often used instead of <br />
# five
# five
## five sub 1
## five sub 1
Line 140: Line 139:
:# definition 2-1
:# definition 2-1
:# definition 2-2
:# definition 2-2
-
&lt;/pre&gt;
+
</pre>
-
The usage of &lt;code&gt;#:&lt;/code&gt; and  &lt;code&gt;*:&lt;/code&gt; for breaking a line within an item may also be controversial.
+
The usage of <code>#:</code> and  <code>*:</code> for breaking a line within an item may also be controversial.
|
|
# one
# one
Line 152: Line 151:
# four
# four
#: four def one
#: four def one
-
#: this rather looks like the continuation of &lt;code&gt;# four&lt;/code&gt;
+
#: this rather looks like the continuation of <code># four</code>
-
#: and thus often used instead of &lt;code&gt;&lt;nowiki&gt;&lt;br /&gt;&lt;/nowiki&gt;&lt;/code&gt;
+
#: and thus often used instead of <code><nowiki><br /></nowiki></code>
# five
# five
## five sub 1
## five sub 1
Line 169: Line 168:
|Preformatted text
|Preformatted text
|
|
-
&lt;pre&gt;
+
<pre>
  preformatted text is done with
  preformatted text is done with
  a '''space''' at the  
  a '''space''' at the  
  ''beginning'' of the line
  ''beginning'' of the line
-
&lt;/pre&gt;
+
</pre>
This way of preformatting only applies to section formatting, and character formatting markups are still effective.
This way of preformatting only applies to section formatting, and character formatting markups are still effective.
|
|
Line 182: Line 181:
== Paragraphs ==
== 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 &lt;code&gt;&lt;nowiki&gt;&lt;br /&gt;&lt;/nowiki&gt;&lt;/code&gt;.
+
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 ==
== HTML ==
-
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example &lt;code&gt;&lt;nowiki&gt;&lt;code&gt;&lt;/nowiki&gt;&lt;/code&gt;, &lt;code&gt;&lt;nowiki&gt;&lt;div&gt;&lt;/nowiki&gt;&lt;/code&gt;, &lt;code&gt;&lt;nowiki&gt;&lt;span&gt;&lt;/nowiki&gt;&lt;/code&gt; and &lt;code&gt;&lt;nowiki&gt;&lt;font&gt;&lt;/nowiki&gt;&lt;/code&gt;. These apply anywhere you insert them.
+
Some [[wikipedia:HTML|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.
-
{| class=&quot;wikitable&quot;
+
{| class="wikitable"
!Description
!Description
!You type
!You type
Line 194: Line 193:
|Fixed width text
|Fixed width text
|
|
-
&lt;pre&gt;&lt;tt&gt;Fixed width text&lt;/tt&gt;&lt;/pre&gt;
+
<pre><tt>Fixed width text</tt></pre>
|
|
-
&lt;tt&gt;Fixed width text&lt;/tt&gt;
+
<tt>Fixed width text</tt>
|-
|-
|Blockquotes
|Blockquotes
|
|
-
&lt;pre&gt;
+
<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
text text text text text text text text text text text text
text text text text text text text text text text text text
-
&lt;blockquote&gt; quote quote quote quote quote quote &lt;/blockquote&gt;
+
<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
-
&lt;/pre&gt;
+
</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
text text text text text text text text text text text text
text text text text text text text text text text text text
-
&lt;blockquote&gt; quote quote quote quote quote quote &lt;/blockquote&gt;
+
<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
|-
|-
|Comment
|Comment
|
|
-
&lt;pre&gt;&lt;!--This is comment--&gt;&lt;/pre&gt;
+
<pre><!--This is comment--></pre>
|
|
-
&lt;!--This is comment--&gt;
+
<!--This is comment-->
|-
|-
|Completely preformatted text
|Completely preformatted text
|
|
-
&lt;pre&gt;&lt;pre&gt;this way, all markups are '''ignored'''&amp;lt;/pre&gt;&lt;/pre&gt;
+
<pre>&lt;pre>this way, all markups are '''ignored'''&lt;/pre></pre>
|
|
-
&lt;pre&gt;
+
<pre>
-
this way, all markups are '''ignored'''&lt;/pre&gt;
+
this way, all markups are '''ignored'''</pre>
|}
|}
-
{{Admin tip|tip=If you trust your users you can allow full HTML by setting &lt;code&gt;{{mediawiki|Manual:$wgRawHtml|$wgRawHtml}} = true;&lt;/code&gt; in {{mediawiki|Manual:LocalSettings.php|LocalSettings.php}}.}}
 
== Other formatting ==
== Other formatting ==
Line 233: Line 231:
*[[Help:Tables|Tables]]
*[[Help:Tables|Tables]]
-
{{Languages}}
 
[[Category:Help|Formatting]]
[[Category:Help|Formatting]]

Latest revision as of 10:21, 10 April 2009

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''

Contents

Text formatting markup

Description You type You get
character 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 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.

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 several lines<br />without breaking the numbering
# three
## three point one
## three point two
  1. one
  2. two
    spanning several lines
    without breaking the 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 adoption 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
    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
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
Fixed width text
<tt>Fixed width text</tt>

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 comment-->
Completely preformatted text
<pre>this way, all markups are '''ignored'''</pre>
this way, all markups are '''ignored'''

Other formatting

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