Difference between revisions of "Help:Formatting"

From Founders District
Jump to: navigation, search
(Created page with "You can format your text by using wiki markup. This consists of normal characters like asterisks, apostrophes or equal signs which have a special function in the wiki, someti...")
 
Line 58: Line 58:
 
</pre>
 
</pre>
 
|
 
|
[[Special:MyLanguage/API:Main page|API]]<nowiki/>&nbsp;
+
[[Special:MyLanguage/API:Main page|API]]<nowiki/>&nbsp;extension
extension
+
 
|-
 
|-
! colspan="3" style="background: #ABE" | <translate><!--T:24-->
+
! colspan="3" style="background: #ABE" |  
Section formatting – ''only at the beginning of the line''</translate>
+
Section formatting – ''only at the beginning of the line''
 
|-
 
|-
| <translate><!--T:25-->
+
|  
Headings of different levels</translate>
+
Headings of different levels
 
| <pre>
 
| <pre>
<translate>
 
== Level 2 == <!--T:26-->
 
  
=== Level 3 === <!--T:27-->
+
== Level 2 ==  
  
==== Level 4 ==== <!--T:28-->
+
=== Level 3 ===  
  
===== Level 5 ===== <!--T:29-->
+
==== Level 4 ====  
  
====== Level 6 ====== <!--T:30-->
+
===== Level 5 =====
</translate>
+
 
 +
====== Level 6 ======  
 
</pre>
 
</pre>
 
----
 
----
 
{{note|
 
{{note|
* <translate><!--T:31-->
+
* [[Special:MyLanguage/Help_talk:Formatting#Level_1|Skip Level 1]], it is page name level.
[[<tvar|lv1>Special:MyLanguage/Help_talk:Formatting#Level_1</>|Skip Level 1]], it is page name level.</translate>
+
* An article with 4 or more headings automatically creates a [[wikipedia:Wikipedia:Section#Table of contents (TOC)|table of contents]].
* <translate><!--T:33-->
+
An article with 4 or more headings automatically creates a [[wikipedia:Wikipedia:Section#Table of contents (TOC)|table of contents]].</translate>
+
 
}}
 
}}
 
|
 
|
 
<!-- using HTML markup to avoid creating new sections -->
 
<!-- using HTML markup to avoid creating new sections -->
<translate>
 
<!--T:35-->
 
 
<h2>Level 2</h2>
 
<h2>Level 2</h2>
  
<!--T:36-->
 
 
<h3>Level 3</h3>
 
<h3>Level 3</h3>
  
<!--T:37-->
 
 
<h4>Level 4</h4>
 
<h4>Level 4</h4>
  
<!--T:38-->
 
 
<h5>Level 5</h5>
 
<h5>Level 5</h5>
  
<!--T:39-->
 
 
<h6>Level 6</h6>
 
<h6>Level 6</h6>
</translate>
 
 
|-
 
|-
| <translate><!--T:40-->
+
|  
Horizontal rule</translate>
+
Horizontal rule
 
| <pre>
 
| <pre>
<translate><!--T:41-->
+
Text before
Text before</translate>
+
 
----
 
----
<translate><!--T:42-->
+
Text after
Text after</translate>
+
 
</pre>
 
</pre>
 
|
 
|
<translate><!--T:43-->
+
Text before
Text before</translate>
+
 
----
 
----
<translate><!--T:44-->
+
Text after
Text after</translate>
+
 
|-
 
|-
| <translate><!--T:45-->
+
|  
Bullet list</translate>
+
Bullet list
 
|
 
|
 
<pre>
 
<pre>
<translate>
 
<!--T:46-->
 
 
* Start each line
 
* Start each line
 
* with an [[Wikipedia:asterisk|asterisk]] (*).
 
* with an [[Wikipedia:asterisk|asterisk]] (*).
Line 134: Line 117:
 
*** But jumping levels creates empty space.
 
*** But jumping levels creates empty space.
 
Any other start ends the list.
 
Any other start ends the list.
</translate>
 
 
</pre>
 
</pre>
 
|
 
|
<translate>
 
<!--T:47-->
 
 
* Start each line
 
* Start each line
 
* with an [[Wikipedia:asterisk|asterisk]] (*).
 
* with an [[Wikipedia:asterisk|asterisk]] (*).
Line 146: Line 126:
 
*** But jumping levels creates empty space.
 
*** But jumping levels creates empty space.
 
Any other start ends the list.
 
Any other start ends the list.
</translate>
 
 
|-
 
|-
| <translate><!--T:48-->
+
|  
Numbered list</translate>
+
Numbered list
 
|
 
|
 
<pre>
 
<pre>
<translate>
 
<!--T:49-->
 
 
# Start each line
 
# Start each line
 
# with a [[Wikipedia:Number_sign|number sign]] (#).
 
# with a [[Wikipedia:Number_sign|number sign]] (#).
Line 163: Line 140:
 
# Blank lines
 
# Blank lines
  
<!--T:50-->
 
 
# end the list and start another.
 
# end the list and start another.
 
Any other start also
 
Any other start also
 
ends the list.
 
ends the list.
</translate>
 
 
</pre>
 
</pre>
 
|
 
|
<translate>
 
<!--T:51-->
 
 
# Start each line
 
# Start each line
 
# with a [[Wikipedia:Number_sign|number sign]] (#).
 
# with a [[Wikipedia:Number_sign|number sign]] (#).
Line 181: Line 154:
 
# Blank lines
 
# Blank lines
  
<!--T:52-->
 
 
# end the list and start another.
 
# end the list and start another.
 
Any other start also
 
Any other start also
 
ends the list.
 
ends the list.
</translate>
 
 
|-
 
|-
| <translate><!--T:53-->
+
|  
Definition list</translate>
+
Definition list
 
| <pre>
 
| <pre>
<translate>
 
<!--T:54-->
 
 
;item 1
 
;item 1
 
: definition 1
 
: definition 1
Line 197: Line 166:
 
: definition 2-1
 
: definition 2-1
 
: definition 2-2
 
: definition 2-2
</translate>
 
 
</pre>
 
</pre>
 
|
 
|
<translate>
 
<!--T:55-->
 
 
;item 1
 
;item 1
 
: definition 1
 
: definition 1
Line 207: Line 173:
 
: definition 2-1
 
: definition 2-1
 
: definition 2-2
 
: definition 2-2
</translate>
 
 
|-
 
|-
| <translate><!--T:56-->
+
|  
Indent text</translate>
+
Indent text
 
| <pre>
 
| <pre>
<translate>
 
<!--T:57-->
 
 
: Single indent
 
: Single indent
 
:: Double indent
 
:: Double indent
 
::::: Multiple indent
 
::::: Multiple indent
</translate>
 
 
</pre>
 
</pre>
 
----
 
----
{{Note|<translate><!--T:58-->
+
{{Note|This workaround may harm accessibility.}}
This workaround may harm accessibility.</translate>}}
+
 
|
 
|
<translate>
 
<!--T:59-->
 
 
: Single indent
 
: Single indent
 
:: Double indent
 
:: Double indent
 
::::: Multiple indent
 
::::: Multiple indent
</translate>
 
 
|-
 
|-
| <translate><!--T:60-->
+
|  
Mixture of different types of list</translate>
+
Mixture of different types of list
 
|
 
|
 
<pre>
 
<pre>
<translate>
 
<!--T:61-->
 
 
# one
 
# one
 
# two
 
# two
Line 252: Line 208:
 
### five sub 1 sub 1
 
### five sub 1 sub 1
 
## five sub 2
 
## five sub 2
</translate>
 
 
</pre>
 
</pre>
 
----
 
----
{{note|<translate><!--T:62-->
+
{{note|The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also harm accessibility.}}
The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also harm accessibility.</translate>}}
+
 
|
 
|
<translate>
 
<!--T:63-->
 
 
# one
 
# one
 
# two
 
# two
Line 275: Line 227:
 
## five sub 1
 
## five sub 1
 
### five sub 1 sub 1
 
### five sub 1 sub 1
## five sub 2{{anchor|pre}}
+
## five sub 2
</translate>
+
 
|-
 
|-
| <translate><!--T:64-->
+
|  
Preformatted text</translate>
+
Preformatted text
 
| <pre>
 
| <pre>
<translate>
 
<!--T:65-->
 
 
Start each line with a space.
 
Start each line with a space.
 
  Text is '''preformatted''' and
 
  Text is '''preformatted''' and
 
  ''markups'' '''''can''''' be done.
 
  ''markups'' '''''can''''' be done.
</translate>
 
 
</pre>
 
</pre>
 
----
 
----
{{note|<translate><!--T:66-->
+
{{note|This way of preformatting only applies to section formatting. Character formatting markups are still effective.}}
This way of preformatting only applies to section formatting. Character formatting markups are still effective.</translate>}}
+
 
|
 
|
<translate>
 
<!--T:67-->
 
 
Start each line with a space.
 
Start each line with a space.
 
  Text is '''preformatted''' and
 
  Text is '''preformatted''' and
 
  ''markups'' '''''can''''' be done.
 
  ''markups'' '''''can''''' be done.
</translate>
 
 
|-
 
|-
| <translate><!--T:68-->
+
|  
Preformatted text blocks</translate>
+
Preformatted text blocks
| <pre> <translate><!--T:69-->
+
| <pre>
 
<nowiki><nowiki>Start with a space in the first column,
 
<nowiki><nowiki>Start with a space in the first column,
 
(before the <nowiki>).
 
(before the <nowiki>).
  
<!--T:70-->
 
 
Then your block format will be
 
Then your block format will be
 
     maintained.
 
     maintained.
Line 311: Line 254:
 
This is good for copying in code blocks:
 
This is good for copying in code blocks:
  
<!--T:71-->
 
 
def function():
 
def function():
 
     """documentation string"""
 
     """documentation string"""
  
    <!--T:72-->
 
 
if True:
 
if True:
 
         print True
 
         print True
 
     else:
 
     else:
         print False</nowiki></nowiki></translate>
+
         print False</nowiki></nowiki>
 
</pre>
 
</pre>
 
|
 
|
<translate><!--T:73-->
 
 
<nowiki>Start with a space in the first column,
 
<nowiki>Start with a space in the first column,
 
(before the <nowiki>).
 
(before the <nowiki>).
  
<!--T:74-->
 
 
Then your block format will be
 
Then your block format will be
 
     maintained.
 
     maintained.
Line 332: Line 271:
 
This is good for copying in code blocks:
 
This is good for copying in code blocks:
  
<!--T:76-->
 
 
def function():
 
def function():
 
     """documentation string"""
 
     """documentation string"""
  
    <!--T:77-->
 
 
if True:
 
if True:
 
         print True
 
         print True
 
     else:
 
     else:
         print False</nowiki></translate>
+
         print False</nowiki>
 
|}
 
|}
  

Revision as of 17:30, 13 June 2016

You can format your text by using wiki markup. This consists of normal characters like asterisks, apostrophes 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 apostrophes 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

Strike text

<strike>strike text</strike>
strike text

Escape wiki markup

<nowiki>no ''markup''</nowiki>

no ''markup''

Escape wiki markup once

[[Special:MyLanguage/API:Main page|API]]<nowiki/> extension

API extension

Section formatting – only at the beginning of the line

Headings of different levels


== Level 2 == 

=== Level 3 === 

==== Level 4 ==== 

===== Level 5 ===== 

====== Level 6 ====== 

Level 2

Level 3

Level 4

Level 5
Level 6

Horizontal rule

Text before
----
Text after

Text before


Text after

Bullet list

* Start each line
* with an [[Wikipedia:asterisk|asterisk]] (*).
** More asterisks give deeper
*** and deeper levels.
* Line breaks <br />don't break levels.
*** But jumping levels creates empty space.
Any other start ends the list.
  • Start each line
  • with an asterisk (*).
    • More asterisks give deeper
      • and deeper levels.
  • Line breaks
    don't break levels.
      • But jumping levels creates empty space.

Any other start ends the list.

Numbered list

# Start each line
# with a [[Wikipedia:Number_sign|number sign]] (#).
## More number signs give 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.
  1. Start each line
  2. with a number sign (#).
    1. More number signs give deeper
      1. and deeper
      2. levels.
  3. Line breaks
    don't break levels.
      1. But jumping levels creates empty space.
  4. Blank lines
  1. end the list and start another.

Any other start also ends the list.

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

Indent text

: Single indent
:: Double indent
::::: Multiple indent

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

  1. one
  2. two
    • two point one
    • two point two
  3. three
    three item one
    three def one
  4. four
    four def one
    this looks like a continuation
    and is often used
    instead
    of <br />
  5. five
    1. five sub 1
      1. five sub 1 sub 1
    2. five sub 2

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

<nowiki>Start with a space in the first column,
(before the <nowiki>).

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

Start with a space in the first column, (before the <nowiki>). 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 <br />.

HTML tags

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

Description</translate>

You type\

You get

Inserted
(Displays as underline in most browsers)

Inserted

or

<u>
Underline</translate></u>

Inserted

or

Underline</translate>

Deleted
(Displays as strikethrough in most browsers)

<s>
Struck out</translate></s>

or

<del>
Deleted</del>

<translate> Struck out</translate>

<translate> or</translate>

<translate> Deleted</translate>

<translate>

Fixed width text</translate>

<code><translate><!--T:100-->
Source code</translate></code>

<translate><!--T:101-->
or</translate>

<tt><translate><!--T:157-->
Fixed width text</translate></tt>

<translate> Source code</translate>

<translate> or</translate>

<translate> Fixed width text</translate>

<translate>

Blockquotes</translate>

<translate><!--T:105-->
Text before</translate>
<blockquote><translate><!--T:106-->
Blockquote</translate></blockquote>
<translate><!--T:107-->
Text after</translate>

<translate> Text before</translate>

<translate> Blockquote</translate>

<translate> Text after</translate>

<translate>

Comment</translate>

<translate>
<!--T:112-->
<!-- This is a comment -->
Comments are visible only 
in the edit zone.
</translate>

<translate> Comments are visible only in the edit zone. </translate>

<translate>

Completely preformatted text</translate>

<pre><translate>
<!--T:115-->
Text is '''preformatted''' and 
''markups'' '''''cannot''''' be done</pre>
</translate>

<translate>
<!--T:117-->
Text is '''preformatted''' and 
''markups'' '''''cannot''''' be done
</translate>
<translate>

Customized preformatted text</translate>

<pre style="color: red"><translate>
<!--T:119-->
Text is '''preformatted''' 
with a style and 
''markups'' '''''cannot''''' be done
</pre>
</translate>

<translate>
<!--T:121-->
Text is '''preformatted''' 
with a style and 
''markups'' '''''cannot''''' be done
</translate>

<translate> continued:</translate>

<translate>

Description</translate>

<translate>

You type</translate>

<translate>

You get</translate>

<translate>

Default preformatted text has a CSS attribute (white-space: pre-wrap;) to wrap the text according to available width</translate>

<pre>
<translate><!--T:127-->
This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer. This additional sentence makes the text even longer.</translate>
</pre>
<translate><!--T:128-->
This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer. This additional sentence makes the text even longer.</translate>
<translate>

Customized preformatted text with disabled text wrapping</translate>

<pre style="white-space: pre; 
white-space: -moz-pre; 
white-space: -pre; 
white-space: -o-pre;">
<translate><!--T:130-->
This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer.</translate>
</pre>
<translate><!--T:131-->
This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer.</translate>

<translate>

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 right arrow HTML symbol → and &mdash; when inserted will be shown as an em dash HTML symbol —. </translate>



HTML symbol entities
Á á Â â ´ Æ æ À à Α α & Å å Ã ã Ä ä Β β ¦ Ç ç ¸ ¢
Χ χ ˆ © ¤ ° Δ δ ÷ É é Ê ê È è Ε ε Η η
Ð ð Ë ë ƒ ½ ¼ ¾ Γ γ > Í í Î î ¡ Ì ì Ι ι
¿ Ï ï Κ κ Λ λ « < ¯ µ · Μ μ  
¬ Ñ ñ Ν ν Ó ó Ô ô Œ œ Ò ò Ω ω Ο ο ª º Ø ø Õ õ Ö
ö Φ φ Π π ϖ ± £ Ψ ψ " » ® Ρ ρ
Š š § ­ Σ σ ς ¹ ² ³ ß Τ τ Θ θ ϑ Þ þ ˜
× Ú ú Û û Ù ù ¨ ϒ Υ υ Ü ü Ξ ξ Ý ý ¥ ÿ Ÿ Ζ ζ
<translate>

Description</translate>

<translate>

You type</translate>

<translate>

You get</translate>

<translate>

Copyright symbol</translate>

&copy;
©
<translate>

Greek delta letter symbol</translate>

&delta;
δ
<translate>

Euro currency symbol</translate>

&euro;

<translate> 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 &rlm; 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)

</translate>

&amp;euro;  → &euro;
<span style="color: red; text-decoration: line-through;"><translate>

Typo to be corrected</translate></span>  → <translate> Typo to be corrected</translate>

<translate>

&lt;span style="color: red; text-decoration: line-through;">Typo to be corrected</span></translate>  → <span style="color: red; text-decoration: line-through;"><translate> Typo to be corrected</translate></span> <translate>

Nowiki for HTML

</translate> <nowiki /> <translate> can prohibit (HTML) tags:</translate>

  • <<nowiki />pre>  → <pre>

<translate> But not & symbol escapes:</translate>

  • &<nowiki />amp;  → &

<translate> To print & symbol escapes as text, use "&amp;" to replace the "&" character (eg. type "&amp;nbsp;", which results in "&nbsp;").

Other formatting

Beyond the text formatting markup shown hereinbefore, here are some other formatting references: </translate>

<translate>

  • [[<tvar|lists>Special:MyLanguage/Help:Lists</>|Lists]]

</translate>

<translate>

  • References - see [[<tvar|citephp>Special:MyLanguage/Extension:Cite/Cite.php</>|Extension:Cite/Cite.php]]
  • [[<tvar|tables>Special:MyLanguage/Help:Tables</>|Tables]]

You can find more references at [[<tvar|help-contents>Special:MyLanguage/Help:Contents</>|Help:Contents]]. </translate> [[Category:HelpTemplate:Langcat|Formatting]]