KSI Wiki:Editors Manual/formatting

From KSI Wiki
Jump to: navigation, search


General Formatting[edit source]

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[edit source]

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

Escape wiki markup
<nowiki> no ''markup''</nowiki>
no ''markup''
Section formatting – only at the beginning of the line
Section Headings of different levels

== Level 2 ==

=== Level 3 ===

==== Level 4 ====

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

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


Note:
  • 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 table of contents (unless setting the magic word__NOTOC__).

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.


* 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


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


  • 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


# 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


Note: This workaround may harm 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 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


Note: The usage of #: and *: for breaking a line within an item may also harm accessibility.


  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.


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
 <nowiki><!--T:69-->
Start with a space in the first column,
(before the <tvar|1><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[edit source]

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[edit source]

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

Description You type You get
Inserted
(Displays as underline in most browsers)
<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>

Struck out

or

Deleted

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

or

<code>Fixed width text</code>

Source code

or

Fixed width text

Blockquotes
Text before
<blockquote>Blockquote</blockquote>
Text after

Text before

Blockquote

Text after

Quotes
<q>This is a quotation</q>
Note: 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.
This is a quotation
Comment

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


Comments are visible only in the edit zone.

Completely preformatted text
<pre>

Text is '''preformatted''' and 
''markups'' '''''cannot''''' be done</pre>

Note: For marking up of preformatted text, check the "Preformatted text" entry at the end of the previous table.

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>

Note: A CSS style can be named within the style attribute.

Text is '''preformatted''' 
with a style and 
''markups'' '''''cannot''''' be done