Difference between revisions of "Bohemia Interactive Community:Formatting"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m
Line 96: Line 96:
 
<!--T:46-->
 
<!--T:46-->
 
* Start each line
 
* Start each line
* with an [[Wikipedia:asterisk|asterisk]] (*).
+
* with an asterisk (*).
 
** More asterisks give deeper
 
** More asterisks give deeper
 
*** and deeper levels.
 
*** and deeper levels.
Line 126: Line 126:
 
<!--T:47-->
 
<!--T:47-->
 
* Start each line
 
* Start each line
* with an [[Wikipedia:asterisk|asterisk]] (*).
+
* with an asterisk (*).
 
** More asterisks give deeper
 
** More asterisks give deeper
 
*** and deeper levels.
 
*** and deeper levels.
Line 158: Line 158:
 
<!--T:49-->
 
<!--T:49-->
 
# Start each line
 
# Start each line
# with a [[Wikipedia:Number_sign|number sign]] (#).
+
# with a number sign (#).
 
## More number signs give deeper
 
## More number signs give deeper
 
### and deeper
 
### and deeper
Line 176: Line 176:
 
<!--T:51-->
 
<!--T:51-->
 
# Start each line
 
# Start each line
# with a [[Wikipedia:Number_sign|number sign]] (#).
+
# with a number sign (#).
 
## More number signs give deeper
 
## More number signs give deeper
 
### and deeper
 
### and deeper

Revision as of 23:45, 5 January 2019

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
''<!--T:8--> italic''

italic

Bold text
'''<!--T:11--> bold'''

bold

Bold and italic
'''''<!--T:14--> bold & italic'''''

bold & italic

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

== Level 2 == <!--T:26-->

=== Level 3 === <!--T:27-->

==== Level 4 ==== <!--T:28-->

===== Level 5 ===== <!--T:29-->

====== Level 6 ====== <!--T:30-->


Template:note

Level 2

Level 3

Level 4

Level 5
Level 6
Horizontal rule
<!--T:41--> Text before
----
<!--T:42--> Text after
Text before

Text after
Bullet list

<!--T:46-->
* Start each line
* with an 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.

<!--T:160-->
* combine bullet list
** with definition 
::- definition
** creates empty space

<!--T:161-->
* combine bullet list
** with definition 
*:- definition
** without empty spaces

<!--T:162-->
*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

<!--T:49-->
# Start each line
# with a 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

<!--T:50-->
# 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

<!--T:54-->
;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

<!--T:57-->
: Single indent
:: Double indent
::::: Multiple indent


Template:Note

Single indent
Double indent
Multiple indent
Mixture of different types of list

<!--T:61-->
# 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


Template:note

  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

 <!--T:65-->
Start each line with a space.
 Text is '''preformatted''' and
 ''markups'' '''''can''''' be done.


Template:note

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></>).

<!--T:70-->
Then your block format will be
    maintained.

<!--T:170-->
This is good for copying in code blocks:


def function():
    """<!--T:171--> 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>, and <span>. These apply anywhere you insert them.

Description You type You get
Inserted
(Displays as underline in most browsers)
<ins><!--T:86--> Inserted</ins>

<!--T:87--> or

<u><!--T:88--> Underline</u>

Inserted

or

Underline

Deleted
(Displays as strikethrough in most browsers)
<s><!--T:93--> Struck out</s>

<!--T:94--> or

<del><!--T:95--> Deleted</del>

Struck out

or

Deleted

Fixed width text
<code><!--T:100--> Source code</code>

<!--T:101--> or

<code><!--T:157--> Fixed width text</code>

Source code

or

Fixed width text

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

Blockquote

Text after
Quotes
<q><!--T:168--> This is a quotation</q>

Template:Note

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

Comments are visible only in the edit zone.

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

Template:note

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

Template:note

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

continued:

Description You type You get
Default preformatted text has a CSS attribute (white-space: pre-wrap;) to wrap the text according to available width
<pre>
<!--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.
</pre>
<!--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.
Customized preformatted text with disabled text wrapping
<pre style="white-space: pre;">
<!--T:130--> 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.
</pre>
<!--T:131--> 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.

Inserting symbols

Symbols and other special characters not available on your keyboard can be inserted in a multitude of ways. Many Operating Systems and browsers allow you to insert special characters through a menu option or Operating System panel.

As a last resort, you can use 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 —.


Template:note

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

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)

&amp;euro;  → &euro;
<span style="color: red; text-decoration: line-through;"> Typo to be corrected</span>  → Typo to be corrected
&lt;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;  → &

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