Difference between revisions of "Basic wiki syntax"
(Created page with "You can format your text by using wiki markup. This consists of normal characters like asterisks, single quotes or equal signs which have a special function in the wiki, somet...") |
Jason Fields (talk | contribs) |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | You can format your text by using wiki markup. This consists of normal characters like asterisks, single quotes or equal signs 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 pairs of single quotes like <code><nowiki>''this''</nowiki></code>. | + | You can format your text by using wiki markup. This consists of normal characters like asterisks, single quotes or equal signs 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 pairs of single quotes like <code> |
+ | <nowiki>''this''</nowiki> </code>. | ||
== Text formatting markup == | == Text formatting markup == | ||
Line 42: | Line 43: | ||
</pre> | </pre> | ||
| | | | ||
− | <nowiki>no ''markup''</nowiki> | + | |
+ | |||
+ | <nowiki>no ''markup''</nowiki> | ||
|- | |- | ||
| Escape wiki markup once | | Escape wiki markup once | ||
Line 53: | Line 56: | ||
! colspan="3" style="background:#ABE" | section formatting – ''only at the beginning of the line'' | ! colspan="3" style="background:#ABE" | section formatting – ''only at the beginning of the line'' | ||
|- | |- | ||
− | | Headings of different levels | + | | Headings of different levels |
| <pre> | | <pre> | ||
Line 208: | Line 211: | ||
#: this looks like a continuation | #: this looks like a continuation | ||
#: and is often used | #: and is often used | ||
− | #: instead<br />of <nowiki><br /></nowiki> | + | #: instead<br />of |
+ | <nowiki><br /></nowiki> | ||
# five | # five | ||
## five sub 1 | ## five sub 1 | ||
Line 216: | Line 220: | ||
| Preformatted text | | Preformatted text | ||
| <pre> | | <pre> | ||
− | + | Start each line with a space. | |
− | + | Text is '''preformatted''' and | |
− | + | ''markups'' '''''can''''' be done. | |
</pre> | </pre> | ||
---- | ---- | ||
{{note|This way of preformatting only applies to section formatting. Character formatting markups are still effective.}} | {{note|This way of preformatting only applies to section formatting. Character formatting markups are still effective.}} | ||
| | | | ||
− | + | Start each line with a space. | |
− | + | Text is '''preformatted''' and | |
− | + | ''markups'' '''''can''''' be done. | |
|- | |- | ||
| Preformatted text blocks | | Preformatted text blocks | ||
− | | <pre> <nowiki><nowiki>Start with a space in the first column, | + | | <pre> |
− | (before the <nowiki>). | + | <nowiki></nowiki> |
+ | <nowiki>Start with a space in the first column, | ||
+ | (before the </nowiki> | ||
+ | <nowiki>). | ||
Then your block format will be | Then your block format will be | ||
Line 242: | Line 249: | ||
print True | print True | ||
else: | else: | ||
− | print False</nowiki> | + | print False</nowiki> |
− | + | <nowiki>Start with a space in the first column, | |
− | + | (before the </nowiki> | |
− | + | <nowiki>). | |
− | (before the <nowiki>). | ||
Then your block format will be | Then your block format will be | ||
Line 259: | Line 265: | ||
print True | print True | ||
else: | else: | ||
− | print False</nowiki> | + | print False</nowiki> |
|} | |} | ||
Line 268: | Line 274: | ||
== HTML tags == | == HTML tags == | ||
− | Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code><code></code>, <code><div></code>, <code><nowiki><span></nowiki></code> and <code><nowiki><font></nowiki></code>. These apply anywhere you insert them. | + | Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code><code></code>, <code><div></code>, <code> |
+ | <nowiki><span></nowiki> </code> and <code> | ||
+ | <nowiki><font></nowiki> </code>. These apply anywhere you insert them. | ||
{| class="wikitable" | {| class="wikitable" | ||
Line 353: | Line 361: | ||
</pre> | </pre> | ||
---- | ---- | ||
− | {{note|For marking up of preformatted text, check the "Preformatted text" entry at the bottom of the previous table.}} | + | {{note|For marking up of preformatted text, check the "Preformatted text" entry at the bottom of the previous table.}} |
| | | | ||
<pre> Text is '''preformatted''' and | <pre> Text is '''preformatted''' and | ||
Line 377: | Line 385: | ||
| '''Customized''' preformatted text with text wrap according to screen width | | '''Customized''' preformatted text with text wrap according to screen width | ||
| <pre> | | <pre> | ||
− | <pre style="white-space: pre-wrap; | + | <pre style="white-space: pre-wrap; |
white-space: -moz-pre-wrap; | white-space: -moz-pre-wrap; | ||
white-space: -pre-wrap; | white-space: -pre-wrap; | ||
− | white-space: -o-pre-wrap; | + | white-space: -o-pre-wrap; |
word-wrap: break-word"> | word-wrap: break-word"> | ||
This longer sentence is used to demonstrate text wrapping. This additional sentence is for those with >1920-pixel wide monitors. | This longer sentence is used to demonstrate text wrapping. This additional sentence is for those with >1920-pixel wide monitors. | ||
Line 386: | Line 394: | ||
</pre> | </pre> | ||
| | | | ||
− | <pre style="white-space: pre-wrap; | + | <pre style="white-space: pre-wrap; |
white-space: -moz-pre-wrap; | white-space: -moz-pre-wrap; | ||
white-space: -pre-wrap; | white-space: -pre-wrap; | ||
Line 407: | Line 415: | ||
== Inserting symbols == | == Inserting symbols == | ||
− | Symbols and other special characters not available on your keyboard can be inserted through a special sequence of characters. Those sequences are called HTML entities. For example, the following sequence (entity) '''&rarr;''' when inserted will be shown as <ins>right arrow</ins> HTML symbol → and '''&mdash;''' when inserted will be shown as an <ins>em dash</ins> HTML symbol — | + | Symbols and other special characters not available on your keyboard can be inserted through a special sequence of characters. Those sequences are called HTML entities. For example, the following sequence (entity) '''&rarr;''' when inserted will be shown as <ins>right arrow</ins> HTML symbol → and '''&mdash;''' when inserted will be shown as an <ins>em dash</ins> HTML symbol — |
---- | ---- | ||
− | {{note|Hover any character to find out the symbol that produces it. Some symbols not available in the current font will appear as empty squares.}} | + | {{note|Hover any character to find out the symbol that produces it. Some symbols not available in the current font will appear as empty squares.}} |
{| class="wikitable" align=center width=100% | {| class="wikitable" align=center width=100% | ||
Line 714: | Line 722: | ||
=== Nowiki for HTML === | === Nowiki for HTML === | ||
<<nowiki />nowiki /> can prohibit (HTML) tags: | <<nowiki />nowiki /> can prohibit (HTML) tags: | ||
− | *<nowiki><<</nowiki>nowiki />pre> → <<nowiki/>pre> | + | * |
+ | <nowiki><<</nowiki> nowiki />pre> → <<nowiki/>pre> | ||
But ''not'' & symbol escapes: | But ''not'' & symbol escapes: | ||
*&<<nowiki />nowiki />amp; → & | *&<<nowiki />nowiki />amp; → & | ||
− | [[Category: | + | == Other formatting == |
− | [[Category: | + | |
− | [[Category: | + | Beyond the text formatting markup shown above, here are some other formatting references: |
+ | |||
+ | * [http://www.mediawiki.org/wiki/Help:Links Links] | ||
+ | * [http://www.mediawiki.org/wiki/Help:Images Images] | ||
+ | * [http://meta.wikimedia.org/wiki/Help:List Lists] | ||
+ | * [http://www.mediawiki.org/wiki/Help:Tables Tables] | ||
+ | |||
+ | You can find more references at [[Help:Contents]]. | ||
+ | |||
+ | [[Category:Help|Formatting]] | ||
+ | [[Category:Wiki syntax]] | ||
+ | [[Category:Editing]] | ||
+ | [[Category:Formatting]] |
Latest revision as of 06:18, 29 January 2013
You can format your text by using wiki markup. This consists of normal characters like asterisks, single quotes or equal signs 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 pairs of single quotes like
''this''
.
Contents
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 |
Strike text | <strike> strike text </strike> |
|
Escape wiki markup | <nowiki>no ''markup''</nowiki> |
|
Escape wiki markup once | [[API]]<nowiki/>extension |
APIextension |
section formatting – only at the beginning of the line | ||
Headings of different levels | == Level 2 == === Level 3 === ==== Level 4 ==== ===== Level 5 ===== ====== Level 6 ====== |
Level 2Level 3Level 4Level 5Level 6 |
Horizontal rule | Text above ---- Text below |
Text above Text below |
Bullet list |
* Start each line * with an [[Wikipedia:asterisk|asterisk]] (*). ** More asterisks gives deeper *** and deeper levels. * Line breaks<br />don't break levels. *** But jumping levels creates empty space. Any other start ends the list. |
Any other start ends the list. |
Numbered list |
# Start each line # with a [[Wikipedia:Number_sign|number sign]] (#). ## More number signs gives deeper ### and deeper ### levels. # Line breaks<br />don't break levels. ### But jumping levels creates empty space. # Blank lines # end the list and start another. Any other start also ends the list. |
Any other start also ends the list. |
Definition list | ;item 1 : definition 1 ;item 2 : definition 2-1 : definition 2-2 |
|
Indent text | : 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 looks like a continuation #: and is often used #: instead<br />of <nowiki><br /></nowiki> # five ## five sub 1 ### five sub 1 sub 1 ## five sub 2 |
<br />
|
Preformatted text | Start each line with a space. Text is '''preformatted''' and ''markups'' '''''can''''' be done. |
Start each line with a space. Text is preformatted and markups can be done. |
Preformatted text blocks | Start with a space in the first column, (before the ). Then your block format will be maintained. This is good for copying in code blocks: def function(): """documentation string""" if True: print True else: print False Start with a space in the first column, (before the ). Then your block format will be maintained. This is good for copying in code blocks: def function(): """documentation string""" if True: print True else: print False |} == Paragraphs == MediaWiki ignores single line breaks. To start a new paragraph, leave an empty line. You can force a line break within a paragraph with the HTML tag <code><br /></code>. == HTML tags == Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code><code></code>, <code><div></code>, <code> <span> </code> and <code> <font> </code>. These apply anywhere you insert them. {| class="wikitable" ! Description ! width=40% | You type ! width=40% | You get |- | Inserted<br />(Displays as underline in most browsers.) | <pre> <ins>Inserted</ins> or <u>Underline</u> |
Inserted or Underline |
Deleted (Displays as strikethrough in most browsers.) |
<s>Struck out</s> or <del>Deleted</del> |
or
|
Fixed width text | <code>Source code</code> or <tt>Fixed width text</tt> |
or Fixed width text |
Blockquotes | text above text above <blockquote>blockquote</blockquote> text below text below |
text above text above
text below text below |
Comment | <!-- This is a comment --> Comments are only visible in the edit window. |
Comments are only visible in the edit window. |
Completely preformatted text | <pre> Text is '''preformatted''' and ''markups'' '''''cannot''''' be done</pre> |
Text is '''preformatted''' and ''markups'' '''''cannot''''' be done |
Customized preformatted text | <pre style="color:red"> Text is '''preformatted''' with a style and ''markups'' '''''cannot''''' be done </pre> |
Text is '''preformatted''' with a style and ''markups'' '''''cannot''''' be done |
Customized preformatted text with text wrap according to screen width | <pre style="white-space: pre-wrap; white-space: -moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: break-word"> This longer sentence is used to demonstrate text wrapping. This additional sentence is for those with >1920-pixel wide monitors. </pre> |
This longer sentence is used to demonstrate text wrapping. This additional sentence is for those with >1920-pixel wide monitors. |
Preformatted text with text wrap according to screen width | <code> This longer sentence is used to demonstrate text wrapping. This additional sentence is for those with >1920-pixel wide monitors. </code> |
|
Inserting symbols
Symbols and other special characters not available on your keyboard can be inserted through a special sequence of characters. Those sequences are called HTML entities. For example, the following sequence (entity) → when inserted will be shown as right arrow HTML symbol → and — when inserted will be shown as an em dash HTML symbol —
HTML symbol entities | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Á | á | Â | â | ´ | Æ | æ | À | à | ℵ | Α | α | & | ∧ | ∠ | Å | å | ≈ | Ã | ã | Ä | ä | „ | Β | β | ¦ | • | ∩ | Ç | ç | ¸ | ¢ |
Χ | χ | ˆ | ♣ | ≅ | © | ↵ | ∪ | ¤ | † | ‡ | ↓ | ⇓ | ° | Δ | δ | ♦ | ÷ | É | é | Ê | ê | È | è | ∅ | Ε | ε | ≡ | Η | η | ||
Ð | ð | Ë | ë | € | ∃ | ƒ | ∀ | ½ | ¼ | ¾ | ⁄ | Γ | γ | ≥ | > | ↔ | ⇔ | ♥ | … | Í | í | Î | î | ¡ | Ì | ì | ℑ | ∞ | ∫ | Ι | ι |
¿ | ∈ | Ï | ï | Κ | κ | Λ | λ | 〈 | « | ← | ⇐ | ⌈ | “ | ≤ | ⌊ | ∗ | ◊ | | ‹ | ‘ | < | ¯ | — | µ | · | − | Μ | μ | ∇ | – | |
≠ | ∋ | ¬ | ∉ | ⊄ | Ñ | ñ | Ν | ν | Ó | ó | Ô | ô | Œ | œ | Ò | ò | ‾ | Ω | ω | Ο | ο | ⊕ | ∨ | ª | º | Ø | ø | Õ | õ | ⊗ | Ö |
ö | ¶ | ∂ | ‰ | ⊥ | Φ | φ | Π | π | ϖ | ± | £ | ′ | ″ | ∏ | ∝ | Ψ | ψ | " | √ | 〉 | » | → | ⇒ | ⌉ | ” | ℜ | ® | ⌋ | Ρ | ρ | |
› | ’ | ‚ | Š | š | ⋅ | § | | Σ | σ | ς | ∼ | ♠ | ⊂ | ⊆ | ∑ | ⊃ | ¹ | ² | ³ | ⊇ | ß | Τ | τ | ∴ | Θ | θ | ϑ | Þ | þ | ˜ | |
× | ™ | Ú | ú | ↑ | ⇑ | Û | û | Ù | ù | ¨ | ϒ | Υ | υ | Ü | ü | ℘ | Ξ | ξ | Ý | ý | ¥ | ÿ | Ÿ | Ζ | ζ | | |
Description | You type | You get |
---|---|---|
Copyright symbol | © |
|
Greek delta letter symbol | δ |
|
Euro currency symbol | € |
|
See the list of all HTML entities on the Wikipedia article List of HTML entities. Additionally, MediaWiki supports two non-standard entity reference sequences: &רלמ;
and &رلم;
which are both considered equivalent to ‏
which is a right-to-left mark. (Used when combining right to left languages with left to right languages in the same page.)
HTML tags and symbol entities displayed themselves (with and without interpreting them)
- &euro; → €
- <span style="color: red; text-decoration: line-through;">Typo to be corrected</span> → Typo to be corrected
- <span style="color: red; text-decoration: line-through;">Typo to be corrected</span> → <span style="color: red; text-decoration: line-through;">Typo to be corrected</span>
Nowiki for HTML
<nowiki /> can prohibit (HTML) tags:
<< nowiki />pre> → <pre> But not & symbol escapes:
- &<nowiki />amp; → &
Other formatting
Beyond the text formatting markup shown above, here are some other formatting references:
You can find more references at Help:Contents.