Editing KSI Wiki:Editors Manual/formatting

__NOTOC__

= General Formatting =

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 <code><nowiki>''this''</nowiki></code>.

== Text formatting markup ==

{| class="wikitable"
! Description
! width=40% | You type
! width=40% | You get
|-
! colspan="3" style="background: #ABE" | Character (inline) 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&gt; no ''markup''&lt;/nowiki&gt;
</pre>
|
 <nowiki>no ''markup''</nowiki>
|-
! colspan="3" style="background: #ABE" | Section formatting – ''only at the beginning of the line''
|-
| Section Headings of different levels 
| <pre>

== Level 2 ==

=== Level 3 ===

==== Level 4 ====

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

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

</pre>
----
{{note|1=<nowiki/>
*  '''Skip Level 1''', it is page name level.
* Do not put any text on the same line after the ending equal signs.
* An article with 4 or more headings automatically creates a [[wikipedia:Help:Section#Table of contents (TOC)|table of contents]] (unless setting the magic word<nowiki>__NOTOC__</nowiki>).
}}
|
<!-- using HTML markup to avoid creating new sections -->

<h2>Level 2</h2>

<h3>Level 3</h3>

<h4>Level 4</h4>

<h5>Level 5</h5>

<h6>Level 6</h6>

|-
| Horizontal rule
| <pre>
 Text before
----
 Text after
</pre>
|
 Text before
----
 Text after
|-
| Bullet list
|
<pre>


* 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.


* combine bullet list
** with definition 
::- definition
** creates empty space


* combine bullet list
** with definition 
*:- definition
** without empty spaces


*bullet list
:- definition
:* sublist that doesn't create empty
:* spaces after definition

</pre>
|


* 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.


* combine bullet list
** with definition 
::- definition
** creates empty space


* combine bullet list
** with definition 
*:- definition
** without empty spaces


*bullet list
:- definition
:* sublist that doesn't create empty
:* spaces after definition

|-
| Numbered list
|
<pre>


# 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.

</pre>
|


# 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.

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

|-
| Indent text
| <pre>


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

</pre>
----
{{Note|1=This workaround may harm accessibility.}}
|


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

|-
| Mixture of different types of list
|
<pre>


# 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 &lt;nowiki><br />&lt;/nowiki>
# five
## five sub 1
### five sub 1 sub 1
## five sub 2

</pre>
----
{{note|1=The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also harm accessibility.}}
|


# 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

|-
| Preformatted text
| <pre>


Start each line with a space.
 Text is '''preformatted''' and
 ''markups'' '''''can''''' be done.

</pre>
----
{{note|1=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
| <pre> &lt;nowiki&gt;<!--T:69-->
Start with a space in the first column,
(before the <tvar|1>&lt;nowiki&gt;</>).


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&lt;/nowiki&gt;
</pre>
|
 {{#tag:nowiki|
Start with a space in the first column,
(before the &lt;nowiki&gt;).


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>&lt;br /></code>.

== HTML tags == 

Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code>&lt;code></code>, <code>&lt;div></code>, and <code><nowiki><span></nowiki></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>
</pre>
|
<ins>Inserted</ins>

or

<u>Underline</u>
|-
| Deleted <br />(Displays as strikethrough in most browsers)
| <pre>
<s>Struck out</s>

or

<del>Deleted</del>

</pre>
|
<s>Struck out</s>

or

<del>Deleted</del>
|-
| Fixed width text
| <pre>
<code>Source code</code>

or

<code>Fixed width text</code>
</pre>
|
<code>Source code</code>

or

<code>Fixed width text</code>
|-
| Blockquotes
| <pre>
Text before
<blockquote>Blockquote</blockquote>
Text after
</pre>
|
Text before
<blockquote>Blockquote</blockquote>
Text after
|-
| Quotes
| <pre>&lt;q&gt;This is a quotation&lt;&#47;q&gt;</pre>
{{Note|1=The q element '''must not''' be used in place of quotation marks that do not represent quotes; for example, it is inappropriate to use the q element for marking up sarcastic statements.}}
| <q>This is a quotation</q>
|-
| Comment
| <pre>

<!-- This is a comment -->
Comments are visible only 
in the edit zone.
</pre>
|


<!-- This is a comment -->
Comments are visible only 
in the edit zone.

|-
| Completely preformatted text
| <pre>
<pre>

Text is '''preformatted''' and 
''markups'' '''''cannot''''' be done&lt;/pre>
</pre>
----
{{note|1=For marking up of preformatted text, check the "Preformatted text" entry at the end of the previous table.}} 
|
<pre>

Text is '''preformatted''' and 
''markups'' '''''cannot''''' be done
</pre>
|-
| '''Customized''' preformatted text
| <pre>
<pre style="color: red">

Text is '''preformatted''' 
with a style and 
''markups'' '''''cannot''''' be done
&lt;/pre>
</pre>
----
{{note|1=A CSS style can be named within the <code>style</code> attribute.}}
|
<pre style="color: red">

Text is '''preformatted''' 
with a style and 
''markups'' '''''cannot''''' be done
</pre>
|}