Formatting – Bohemia Interactive Community

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{ServerExec}}" to "{{Icon|serverExec|32}}")
m (Some wiki formatting)
(30 intermediate revisions by 3 users not shown)
Line 4: Line 4:
== Text formatting markup ==
== Text formatting markup ==


{| class="wikitable"
{| class="wikitable" width = "100%"
! Description
! Description
! width="40%" | You type
! width="40%" | You type
Line 72: Line 72:
|Text can be made <big>bigger like this</big>
|Text can be made <big>bigger like this</big>
|-
|-
|Teletype
|Teletype (using {{Template|hl}})
|<pre>
|<pre>
Highlight <tt>TAG_someVariable</tt> in a text
Highlight {{hl|TAG_someVariable}} in a text
</pre>
</pre>
|Highlight <tt>TAG_someVariable</tt> in a text
|Highlight {{hl|TAG_someVariable}} in a text
|-
|-
! 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''
Line 93: Line 93:
</pre>
</pre>
----
----
{{Important|
{{Feature|important|
* Do not put any text on the same line after the ending equal signs.
* Do not put any text on the same line after the ending equal signs.
* An article with 4 or more headings automatically creates a '''T'''able '''o'''f '''C'''ontents (ToC) - unless setting the magic word <tt><nowiki>__NOTOC__</nowiki></tt>.
* An article with 4 or more headings automatically creates a '''T'''able '''o'''f '''C'''ontents (ToC) - unless setting the magic word {{hl|<nowiki>__NOTOC__</nowiki>}}.
* You can use a right-side ToC with the [[Template:TOC|{{<nowiki/>TOC|side}} template]].
* You can use a right-side ToC with the [[Template:TOC|{{<nowiki/>TOC|side}} template]].
* Recommended spacing:
* Recommended spacing:
Line 155: Line 155:
</pre>
</pre>
----
----
{{Informative|This workaround may harm accessibility.}}
{{Feature|Informative|This workaround may harm accessibility.}}
|
|


Line 184: Line 184:
</pre>
</pre>
----
----
{{Informative|The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also harm accessibility.}}
{{Feature|Informative|The usage of <code>#:</code> and <code>*:</code> to break a line within an item may also harm accessibility.}}
|
|


Line 212: Line 212:
</pre>
</pre>
----
----
{{Informative|This way of preformatting only applies to section formatting. Character formatting markups are still effective.}}
{{Feature|Informative|This way of preformatting only applies to section formatting. Character formatting markups are still effective.}}
|
|
Start each line with a space.
Start each line with a space.
Line 262: Line 262:
       }}
       }}
|}
|}


== HTML tags ==
== HTML tags ==
{| class="wikitable"
 
{| class="wikitable" width = "100%"
! Description
! Description
! width="40%" | You type
! width="40%" | You type
Line 270: Line 272:
|-
|-
| Inserted <br />(Displays as underline in most browsers)
| Inserted <br />(Displays as underline in most browsers)
| <pre>
| <syntaxhighlight lang="html"><ins> Inserted</ins></syntaxhighlight>
<ins> Inserted</ins>


or
or


<u> Underline</u>
<syntaxhighlight lang="html"><u>Underline</u></syntaxhighlight>
</pre>
</pre>
|
|
<ins> Inserted</ins>
<ins>Inserted</ins>


or
or


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


  or
  or


<del> Deleted</del>
<syntaxhighlight lang="html"><del>Deleted</del></syntaxhighlight>
 
</pre>
|
|
<s> Struck out</s>
<s>Struck out</s>


  or
  or


<del> Deleted</del>
<del>Deleted</del>
|-
|-
| Blockquotes
| Blockquotes
| <pre>
| <syntaxhighlight lang="html">
  Text before
  Text before
<blockquote> Blockquote</blockquote>
<blockquote> Blockquote</blockquote>
  Text after
  Text after
</pre>
</syntaxhighlight>
|
|
Text before
Text before
<blockquote> Blockquote</blockquote>
<blockquote> Blockquote</blockquote>
Text after
Text after
|-
|-
| Quotes
| Quotes
| <pre>&lt;q&gt; This is a quotation&lt;&#47;q&gt;</pre>
| <syntaxhighlight lang="html"><q>This is a quotation</q></syntaxhighlight>
{{Important|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.<ref>[https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-q-element HTML Living Standard—The &lt;'''q'''&gt; element]</ref>}}
{{Feature|important|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.<ref>[https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-q-element HTML Living Standard—The &lt;'''q'''&gt; element]</ref>}}
| <q> This is a quotation</q>
| <q>This is a quotation</q>
|-
|-
| Comment
| Comment
| <pre>
| <syntaxhighlight lang="html">
 
<!-- This is a comment -->
<!-- This is a comment -->
Comments are visible only
Comments are visible only
in the edit zone.
in the edit zone.
</pre>
</syntaxhighlight>
|
|
<!-- This is a comment -->Comments are visible only
<!-- This is a comment -->
Comments are visible only
in the edit zone.
in the edit zone.


|-
|-
| Completely preformatted text
| Completely preformatted text
| <pre>
| <syntaxhighlight lang="html">
<pre>
<pre>


Text is '''preformatted''' and
Text is '''preformatted''' and
''markups'' '''''cannot''''' be done&lt;/pre>
''markups'' '''''cannot''''' be done</pre>
</pre>
</syntaxhighlight>
----
----
{{Informative|For marking up of preformatted text, check the "Preformatted text" entry at the end of the previous table.}}
{{Feature|Informative|For marking up of preformatted text, check the "Preformatted text" entry at the end of the previous table.}}
|
|
<pre>
<pre>
Line 345: Line 343:
|-
|-
| '''Customized''' preformatted text
| '''Customized''' preformatted text
| <pre>
| <syntaxhighlight lang="html">
<pre style="color: red">
<pre style="color: red">


Line 351: Line 349:
with a style and
with a style and
''markups'' '''''cannot''''' be done
''markups'' '''''cannot''''' be done
&lt;/pre>
</pre>
</pre>
</syntaxhighlight>
----
----
{{Informative|A CSS style can be defined within the <code>style</code> attribute.}}
{{Feature|Informative|A CSS style can be defined within the <code>style</code> attribute.}}
|
|
<pre style="color: red">
<pre style="color: red">
Line 370: Line 368:
! width="40%" | You get
! width="40%" | You get
|-
|-
| '''Default''' preformatted text has a CSS attribute (<code>white-space: pre-wrap;</code>) to wrap the text according to available width
| '''Default''' preformatted text has a CSS attribute (<syntaxhighlight lang="css" inline>white-space: pre-wrap;</syntaxhighlight>) to wrap the text according to available width
| <pre>
| <pre>
<pre>
<pre>
Line 401: Line 399:
As a last resort, you can use a special sequence of characters. Those sequences are called HTML entities. For example, the following sequence (entity) '''&amp;rarr;''' when inserted will be shown as <ins>right arrow</ins> HTML symbol &rarr; and '''&amp;mdash;''' when inserted will be shown as an <ins>em dash</ins> HTML symbol &mdash;.
As a last resort, you can use a special sequence of characters. Those sequences are called HTML entities. For example, the following sequence (entity) '''&amp;rarr;''' when inserted will be shown as <ins>right arrow</ins> HTML symbol &rarr; and '''&amp;mdash;''' when inserted will be shown as an <ins>em dash</ins> HTML symbol &mdash;.
----
----
{{Informative|Hover over any character to find out the symbol that it produces. Some symbols not available in the current font will appear as empty squares.}}
{{Feature|Informative|Hover over any character to find out the symbol that it produces. Some symbols not available in the current font will appear as empty squares.}}


{| class="wikitable" width="100%" align="center"
{| class="wikitable" width="100%" align="center"
Line 692: Line 690:
:<code>&amp;amp;euro;</code> &nbsp;&rarr; '''&amp;euro;'''
:<code>&amp;amp;euro;</code> &nbsp;&rarr; '''&amp;euro;'''


:<code>&lt;span style="color: red; text-decoration: line-through;"> Typo to be corrected&lt;/span></code> &nbsp;&rarr; '''<span style="color: red; text-decoration: line-through;"> Typo to be corrected</span>'''
:<code style="display: block">&lt;span style="color: red; text-decoration: line-through;"> Typo to be corrected&lt;/span></code> &nbsp;&rarr; '''<span style="color: red; text-decoration: line-through;"> Typo to be corrected</span>'''


:<code> <nowiki>&amp;lt;span style="color: red; text-decoration: line-through;">Typo to be corrected</span></nowiki></code> &nbsp;&rarr; '''&lt;span style="color: red; text-decoration: line-through;"> Typo to be corrected&lt;/span>'''
:<code style="display: block"> <nowiki>&amp;lt;span style="color: red; text-decoration: line-through;">Typo to be corrected</span></nowiki></code> &nbsp;&rarr; '''&lt;span style="color: red; text-decoration: line-through;"> Typo to be corrected&lt;/span>'''


=== Nowiki for HTML ===
=== Nowiki for HTML ===
Line 703: Line 701:
* &<<nowiki/>nowiki />amp; &nbsp;&rarr; &amp;
* &<<nowiki/>nowiki />amp; &nbsp;&rarr; &amp;


To print &amp; symbol escapes as text, use "<code>&amp;amp;</code>" to replace the "&" character (eg. type "<code>&amp;amp;nbsp;</code>", which results in "<code>&amp;nbsp;</code>")
To print &amp; symbol escapes as text, use "<code style="display: block">&amp;amp;</code>" to replace the "&" character (eg. type "<code style="display: block">&amp;amp;nbsp;</code>", which results in "<code style="display: block">&amp;nbsp;</code>")


== Code Formatting ==
== Code Formatting ==
* Use <tt>syntaxhighlight</tt> with option "cpp" to highlight Config (see example below)
* Use '''tab alignment''' in Config - '''not''' spaces
* Keep some space in Config, e.g: <syntaxhighlight lang="cpp">
class exampleClass
{
stringValue="value"; // bad
stringValue = "value"; // good
arrayValue = {0,0.5,0,1}; // bad
arrayValue = { 0, 0.5, 0, 1 }; // good
};
</syntaxhighlight>
** Before and after <tt>=</tt>
** In Array definitions
** Try to align a batch of comments together ('''with tabs''')
{{Informative | If you have to put an equal sign (<tt>{{=}}</tt>) inside a template (<tt>{{ }}</tt>), use the [[Template:=|equal template]]: <tt><nowiki>{{=}}</nowiki></tt>.}}


{| class="wikitable" width = "100%"
{| class="wikitable" width = "100%"
Line 729: Line 709:
! Description !! You type !! You get
! Description !! You type !! You get
|-
|-
| Inline Code || <pre>{{Inline code|Inline code}}</pre> || {{Inline code|Inline code}}
| Code block (no highlighting)
| <pre>Lorem ipsum ...
<code style="display: block">player setPosASL [0, 0, 0];
player setDamage 0;</code>
... dolor sit amet.</pre>
| <div>Lorem ipsum ...<code style="display: block">player setPosASL [0, 0, 0];
player setDamage 0;</code>... dolor sit amet.</div>
 
|-
|-
| Code || <pre><code>Code</code></pre> || <code>Code</code>
| Code inline-block (no highlighting)
| <pre>Lorem ipsum ... <code style="display: inline-block">player setPosASL [0, 0, 0];
player setDamage 0;</code> ... dolor sit amet.</pre>
| <div>Lorem ipsum ... <code style="display: inline-block">player setPosASL [0, 0, 0];
player setDamage 0;</code> ... dolor sit amet.</div>
 
 
|-
|-
| One-line Code Comment || <pre>{{cc|Code comment}}</pre> || {{cc|Code comment}}
| [[Template:cc|Single-line code comment]] (should only be used inside <code>&lt;code&gt;</code> tags where the usage of <code>&lt;sqf&gt; tags is not possible)
| <pre><code style="display: block">[[player]] setPos{{Color|red|ASL}} [0, 0, 0]; {{cc|teleports the player}}</code></pre>
| <code style="display: block">[[player]] setPos{{Color|red|ASL}} [0, 0, 0]; {{cc|teleports the player}}</code>
|-
|-
| Code Comment || <pre>{{codecomment|Code comment}}</pre> || {{codecomment|Code comment}}
<!-- The template {{codecomment}} adds no real value.
| [[Template:codecomment|Code comment]] || <pre>{{codecomment|// Code comment}}</pre> || {{codecomment|// Code comment}}
|-
|-
| Syntaxhighlight<br>"cpp" = C++ highlight || <pre><syntaxhighlight lang="cpp">
-->
class exampleClass
| Config code block (uses C++ highlighting)
| <pre><syntaxhighlight lang="cpp">
class ExampleClass
{
{
value1 = 1;
value1 = 1; // Lorem ipsum dolor sit amet.
value2 = "value2";
value2 = "value2";
};
};
</syntaxhighlight></pre>
</syntaxhighlight></pre>
| <syntaxhighlight lang="cpp">
| <syntaxhighlight lang="cpp">
class exampleClass
class ExampleClass
{
{
value1 = 1;
value1 = 1; // Lorem ipsum dolor sit amet.
value2 = "value2";
value2 = "value2";
};
};
</syntaxhighlight>
</syntaxhighlight>
|-
| [[SQS Syntax|SQS]] code block
| <pre><sqs>
#Label1
hint "repeating"
goto "Label1"
</sqs></pre>
| <sqs>
#Label1
hint "repeating"
goto "Label1"
</sqs>
|-
| Inline SQS code || <pre>Lorem ipsum <sqs inline>[player, _jeep] exec "getin.sqs"</sqs> dolor sit amet.</pre> || Lorem ipsum <sqs inline>[player, _jeep] exec "getin.sqs"</sqs> dolor sit amet.
|-
| [[SQF Syntax|SQF]] code block
| <pre><sqf>
private _pos = [0, 0, 0];
player setPosASL _pos;
player setDamage 0; // Heals the player
</sqf></pre>
| <sqf>
private _pos = [0, 0, 0];
player setPosASL _pos;
player setDamage 0; // Heals the player
</sqf>
|-
| Inline SQF code || <pre>Lorem ipsum <sqf inline>player setPosASL [0, 0, 0]</sqf> dolor sit amet.</pre> || Lorem ipsum <sqf inline>player setPosASL [0, 0, 0]</sqf> dolor sit amet.
|-
| Enforce Script code block
| <pre>
<enforce>
string text = "Hello World!";
Print(text); // Prints "Hello World!".
</enforce>
</pre>
| <enforce>
string text = "Hello World!";
Print(text); // Prints "Hello World!".
</enforce>
|-
| Inline Enforce Script code (uses C# highlighting) || <pre>Lorem ipsum <enforce inline>string text = "Hello World!"</enforce> dolor sit amet.</pre> || Lorem ipsum <enforce inline>string text = "Hello World!"</enforce> dolor sit amet.
|}
|}
'''Notes:'''
* To render an equals sign ({{hl|{{=}}}}) or a pipe ({{hl|{{!}}}}) within a template without breaking the page, use the [[Template:=|equals template]] ({{hl|<nowiki>{{=}}</nowiki>}}) and the [[Template:!|pipe template]] ({{hl|<nowiki>{{!}}</nowiki>}}) or wrap the symbols with {{hl|<<nowiki/>nowiki>}} tags. Example:
** {{hl|<nowiki>{{hl|_myNumber = 5;}}</nowiki>}} - This will not render properly.
** {{hl|<nowiki>{{hl|_myNumber {{=}} 5;}}</nowiki>}} - This renders properly.
* Use the [[Template:hl|highlight template]] ({{hl|<nowiki>{{hl}}</nowiki>}}) or {{hl|<nowiki><var></nowiki>}} tags for inline variables (e.g. "The variable <var>_myNumber</var> has the value 5").
* Use tabs for indentation, not spaces (tick the box ''Allow tabulations usage'' in the Editing Area if necessary).
* Maintain spacing between symbols and items, for example: <syntaxhighlight lang="cpp">
class ExampleClass
{
stringValue="value"; // bad (no space around the equals sign)
stringValue = "value"; // good
arrayValue = {0,0.5,0,1}; // bad (no space between the numbers)
arrayValue = { 0, 0.5, 0, 1 }; // good
};
</syntaxhighlight>
{{Feature|Informative|At the root level of the page (i.e. not within templates and tables), text indented by one space renders the same way as text wrapped in {{hl|<nowiki><code style="display: block"></nowiki>}} tags.}}


== Lists ==
== Lists ==
Line 860: Line 919:
To list terms and definitions, start a new line with a semicolon (;) followed by the term. Then, type a colon (:) followed by a definition. The format can also be used for other purposes, such as make and models of vehicles, etc.
To list terms and definitions, start a new line with a semicolon (;) followed by the term. Then, type a colon (:) followed by a definition. The format can also be used for other purposes, such as make and models of vehicles, etc.


''Description lists''<!--HTML5 name--> (formerly ''definition lists''<!--HTML4 name-->, and a.k.a. ''association lists''<!--draft HTML5 name-->) consist of group names corresponding to values. Group names (terms) are in bold. Values (definitions) are indented. Each group <em>must</em> include one or more definitions. For a single or first value, the <code>:</code> can be placed on the same line after <code>;</code> – but subsequent values must be placed on separate lines.
''Description lists''<!--HTML5 name--> (formerly ''definition lists''<!--HTML4 name-->, and a.k.a. ''association lists''<!--draft HTML5 name-->) consist of group names corresponding to values. Group names (terms) are in bold. Values (definitions) are indented. Each group <em>must</em> include one or more definitions. For a single or first value, the <code style="display: block">:</code> can be placed on the same line after <code style="display: block">;</code> – but subsequent values must be placed on separate lines.


'''Do not use a semicolon (;) simply to bold a line without defining a value using a colon (:). This usage renders invalid HTML5 and creates issues with screen readers.'''
'''Do not use a semicolon (;) simply to bold a line without defining a value using a colon (:). This usage renders invalid HTML5 and creates issues with screen readers.'''
Line 922: Line 981:
|-
|-
| Auto renamed link (pipe trick)
| Auto renamed link (pipe trick)
| <pre>[[createTrigger (VBS1)|]]</pre>
| <pre>[[:Category:Scripting Commands|]]</pre>
| [[createTrigger (VBS1)|createTrigger]]
| [[:Category:Scripting Commands|Scripting Commands]]
|-
|-
| Automatically hide stuff in parentheses
| Automatically hide stuff in parentheses
| <pre>[[createTrigger (VBS1)|]]</pre>
| <pre>[[raP (ArmA)|]]</pre>
| [[createTrigger (VBS1)|createTrigger]]
| [[raP (ArmA)|raP]]
|-
|-
| Automatically hide the comma and following text
| Automatically hide the comma and following text
Line 943: Line 1,002:
| Does not work for section links
| Does not work for section links
| <pre>[[Wikipedia:Manual of Style#Links|]]</pre>
| <pre>[[Wikipedia:Manual of Style#Links|]]</pre>
|<nowiki> [[Wikipedia:Manual of Style#Links|]]</nowiki>
| <nowiki>[[Wikipedia:Manual of Style#Links|]]</nowiki>
|-
|-
|}
|}
Line 950: Line 1,009:
You can add the specific section you want to link by adding the seciton title to the link after a # (hash).
You can add the specific section you want to link by adding the seciton title to the link after a # (hash).
{| class="wikitable" width = "100%"
{| class="wikitable" width = "100%"
!Description !! You type !! You get
!Description
! width="40%" | You type
! width="40%" | You get
|-
|-
| Link to a section within another page
| Link to a section within another page
Line 964: Line 1,025:
==== Blended links ====
==== Blended links ====
{| class="wikitable" width = "100%"
{| class="wikitable" width = "100%"
! Desctiption !! You type !! You get
! Description
! width="40%" | You type
! width="40%" | You get
|-
|-
| Blending active
| Blending active
Line 980: Line 1,043:
Redirects are used to redirect specific pages to another page.
Redirects are used to redirect specific pages to another page.
{| class="wikitable" width = "100%"  
{| class="wikitable" width = "100%"  
! Description !! You type
! width="20%" |  Description
! width="80%" |  You type
|-
|-
|Redirect to an article
| Redirect to an article
|<code><nowiki>#REDIRECT [[United States]] </nowiki></code>
| <code style="display: block"><nowiki>#REDIRECT [[United States]] </nowiki></code>
|-
|-
|Redirect to a section
| Redirect to a section
|<code><nowiki>#REDIRECT [[United States#History]]</nowiki></code>
| <code style="display: block"><nowiki>#REDIRECT [[United States#History]]</nowiki></code>
|}
 
=== Link to another namespace ===
 
{| class="wikitable" width = "100%"
!What you type
!What it looks like
|-
|-
|
| Link to another namespace
<code><nowiki>See the [[Wikipedia:Manual of Style]].</nowiki></code>
| <code style="display: block"><nowiki>See the [[Wikipedia:Manual of Style]].</nowiki></code>
|
| See the [[Wikipedia:Manual of Style]].
See the [[Wikipedia:Manual of Style]].
|}
|}


Line 1,005: Line 1,061:
{| class="wikitable" width = "100%"
{| class="wikitable" width = "100%"
!Description
!Description
!You type
! width="40%" | You type
!You get
! width="40%" | You get
|-
|-
| Add article to category
| Add article to category
| <code><nowiki>[[Category:Character sets]]</nowiki></code>
| <code style="display: block"><nowiki>[[Category:Character sets]]</nowiki></code>
|
|
|-
|-
| Link to a category
| Link to a category
| <code><nowiki>[[:Category:Character sets]]</nowiki></code>
| <code style="display: block"><nowiki>[[:Category:Character sets]]</nowiki></code>
| [[:Category:Character sets]]
| [[:Category:Character sets]]
|-
|-
| Without prefix.
| Without prefix.
| <code><nowiki>[[:Category:Character sets|]]</nowiki></code>
| <code style="display: block"><nowiki>[[:Category:Character sets|]]</nowiki></code>
| [[:Category:Character sets|Character sets]]
| [[:Category:Character sets|Character sets]]
|}
|}
Line 1,027: Line 1,083:
{| class="wikitable" width = "100%"
{| class="wikitable" width = "100%"
!Description
!Description
!You type
! width="40%" | You type
!You get
! width="40%" | You get
|-
|-
| Named link with an external link icon
| Named link with an external link icon
Line 1,048: Line 1,104:
use <nowiki>&lt;nowiki&gt;</nowiki>&lt;/nowiki&gt; to keep this bad style from showing
use <nowiki>&lt;nowiki&gt;</nowiki>&lt;/nowiki&gt; to keep this bad style from showing
|
|
<code><nowiki>http://www.wikipedia.org</nowiki></code>
<code style="display: block"><nowiki>http://www.wikipedia.org</nowiki></code>
|
|
http://www.wikipedia.org
http://www.wikipedia.org
Line 1,057: Line 1,113:
(Not often used)
(Not often used)
|
|
<code><nowiki><span class="plainlinks">[http://www.wikipedia.org Wikipedia]</span></nowiki></code>
<code style="display: block"><nowiki><span class="plainlinks">[http://www.wikipedia.org Wikipedia]</span></nowiki></code>
|
|
<span class="plainlinks"> [http://www.wikipedia.org Wikipedia]</span>
<span class="plainlinks"> [http://www.wikipedia.org Wikipedia]</span>
Line 1,066: Line 1,122:
{| class="wikitable" width = "100%"
{| class="wikitable" width = "100%"
!Description
!Description
!You type
! width="40%" | You type
!You get
! width="40%" | You get
|-
|-
| Simple image without description
| Simple image without description
| <code><nowiki>[[Image:Logo_A3_black.png]] or [File:Logo_A3_black.png]]</nowiki> </code>
| <pre>[[File:Logo_A3_black.png]]</pre> or <pre>[[Image:Logo_A3_black.png]]</pre>
| [[Image:Logo_A3_black.png]]
{{Feature|important|<code>File:</code> is to be preferred.}}
| [[File:Logo_A3_black.png]]
|-
|-
| Thumb image with description, defined size and aligned right. Size can by any number. Alignment can be (left, right and center)
| Thumb image with description, defined size and aligned right. Size can by any number. Alignment can be (left, right and center)
| <code><nowiki>[[Image:Logo_A3_black.png|thumb|right|100px|Some description]]</nowiki></code>
| <pre>[[File:Logo_A3_black.png|thumb|right|100px|Some description]]</pre>
| [[Image:Logo_A3_black.png|thumb|right|100px|Some description]]
| [[File:Logo_A3_black.png|thumb|right|100px|Some description]]
|}
|}


Line 1,084: Line 1,141:
* [https://www.tablesgenerator.com/mediawiki_tables Table Generator]
* [https://www.tablesgenerator.com/mediawiki_tables Table Generator]


{{Informative|Make sure the raw text is well formatted so it is easier to edit later.}}
{{Feature|Informative|Make sure the raw text is well formatted so it is easier to edit later.}}


== Useful templates ==
== Useful templates ==


{{Informative|Visit [[:Category:Templates]], to see a complete list of available templates.}}
{{Feature|Informative|Visit [[:Category:Templates]], to see a complete list of available templates.}}


{| class="wikitable"  width = "100%"
{| class="wikitable"  width = "100%"
! Template || Code || Result
! Template
! width="40%" | You type
! width="40%" | You get
|-
|-
| [[Template:Delete]]
| rowspan="4" | [[Template:Wiki]]
| <pre>{{Delete|reason}}</pre>
| <pre>{{Wiki|delete|reason}}</pre>
|
| {{Messagebox|'''This article has been submitted for''' <big>deletion</big>'''.''' '''The reason given was:''' reason'''.'''|🗙|#F00}}
{{Messagebox|'''This article has been submitted for''' <big>deletion</big>'''.''' '''The reason given was:''' reason'''.'''|🗙|#F00}}
|-
|-
| [[Template:Feature]]
| <pre>{{Wiki|merge}}</pre>
| <pre>{{Feature|arma3|text}}</pre>
| {{Messagebox|This article has been proposed to merge with [[Main Page]].|<div style{{=}}"font-size: .75em; line-height: .6em">↘<br>↗</div><!--↣-->|blueviolet}}
| {{Feature|arma3|text}}
|-
|-
| [[Template:GVI]]
| <pre>{{Wiki|stub}}</pre>
| <pre>{{GVI|arma3|version}}</pre>
| <div class="notice metadata" id="stub">''This article is a [[:Category:Stubs|Stub]]. You can help BI Community Wiki by <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit}} expanding it]</span>.''</div>
| {{GVI|arma3|dev}}
|-
|-
| [[Template:Informative]]
| <pre>{{Wiki|WIP}}</pre>
| <pre>{{Informative|text}}</pre>
| {{Messagebox|This article is a '''work in progress'''!|🏗|dodgerblue}}
| {{Informative|text}}
|-
|-
| [[Template:Important]]
| rowspan="6" | [[Template:Feature]]<br>See {{Template|Feature}} for all the available types.
| <pre>{{Important|important text!}}</pre>
| <pre>{{Feature|arma3|text}}</pre>
| {{Important|important text!}}
| {{Feature|arma3|text}}
|-
|-
| [[Template:Warning]]
| <pre>{{Feature|informative|text}}</pre>
| <pre>{{Warning|text}}</pre>
| {{Feature|Informative|text}}
| {{Warning|text}}
|-
|-
| [[Template:cn]]
| <pre>{{Feature|important|important text}}</pre>
| <pre>{{cn}}</pre>
| {{Feature|important|text}}
| <sup><nowiki>[</nowiki>''[[Template:cn|citation needed]]''<nowiki>]</nowiki></sup>
|-
|-
| [[Template:Merge]]
| <pre>{{Feature|warning|text}}</pre>
| <pre>{{Merge|article}}</pre>
| {{Feature|warning|text}}
| {{Messagebox|This article has been proposed to merge with [[article]].||blueviolet}}
|-
|-
| [[Template:WIP]]
| <pre>{{Feature|obsolete}}</pre>
| <pre>{{WIP}}</pre>
| {{Feature|obsolete}}
| {{Messagebox|This article is a '''work in progress'''!|🏗|dodgerblue}}
|-
|-
| [[Template:Stub]]
| <pre>{{Feature|quote|Gastovski, out!|James Gastovski
| <pre>{{Stub}}</pre>
|https://www.youtube.com/watch?v{{=}}TGKFY1QiIGA}}</pre>
| <div class="notice metadata" id="stub">''This article is a [[:Category:Stubs|Stub]]. You can help BI Community Wiki by <span class="plainlinks">[{{fullurl:{{FULLPAGENAME}}|action=edit}} expanding it]</span>.''</div>
| {{Feature|quote|Gastovski, out!|James Gastovski|https://www.youtube.com/watch?v{{=}}TGKFY1QiIGA}}
|-
|-
| [[Template:Quote]]
| [[Template:GVI]]
| <pre>{{Quote|Gastovski, out!|James Gastovski
| <pre>{{GVI|arma3|version}}</pre>
|https://www.youtube.com/watch?v{{=}}TGKFY1QiIGA}}</pre>
| {{GVI|arma3|1.96}}
| {{Quote|Gastovski, out!|James Gastovski|https://www.youtube.com/watch?v{{=}}TGKFY1QiIGA}}
|-
|-
| [[Template:ServerExec]]
| [[Template:cn]]
| <pre>{{Icon|serverExec|32}}</pre>
| <pre>{{cn}}</pre>
| {{Icon|serverExec|32}}
<pre>{{cn|Miller is a nice guy}}</pre>
| {{cn}}<br>
{{cn|Miller is a nice guy}}
|-
|-
| [[Template:Outdated]]
| [[Template:Icon]]
| <pre>{{Outdated}}</pre>
| <pre>{{Icon|serverExec|32}}
| {{Outdated}}
{{Icon|globalArgument|32}}
{{Icon|localArgument|32}}
{{Icon|globalEffect|32}}
{{Icon|localEffect|32}}</pre>
|
{{Icon|serverExec|32}}
{{Icon|globalArgument|32}}
{{Icon|localArgument|32}}
{{Icon|globalEffect|32}}
{{Icon|localEffect|32}}
|}
|}




[[Category:Community Wiki]]
[[Category:Community Wiki]]

Revision as of 15:22, 18 January 2023


The text editor comes with some basic text formatting tips

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

Colored text
<span style="color: red;">Colour</span>

Colour

Spoiler
<spoiler text="Click me!">spoiler</spoiler>

spoiler

Escape wiki markup
<nowiki> no ''markup''</nowiki>
no ''markup''
Small chunks of source code within a line of normal text.

Code is displayed in a monospace font.

function <code>int m2()</code> is nice.
function int m2() is nice.
Small text
Text can be made <small>smaller like this</small>
Text can be made smaller like this
Big text
Text can be made <big>bigger like this</big>
Text can be made bigger like this
Teletype (using {{hl}})
Highlight {{hl|TAG_someVariable}} in a text
Highlight TAG_someVariable in a text
Section formatting – only at the beginning of the line
Section Headings of different levels
== Level 2 ==

=== Level 3 ===

==== Level 4 ====

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

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

  • 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 (ToC) - unless setting the magic word __NOTOC__.
  • You can use a right-side ToC with the {{TOC|side}} template.
  • Recommended spacing:
    • Add spaces between the title itself and the equal signs
    • Two empty lines before a Level 2 title, one after
    • One empty line before a Level 3 title, one after
    • One empty line before a Level 4..6 title, none after.

Level 2



Level 3


Level 4


Level 5


Level 6


Horizontal rule
 Text before
----
 Text after
Text before

Text after
Line Breaks
A single newline here has no effect on the layout.

But an empty line starts a new paragraph, or ends a list or an indented part.
Lines can be forced to break <br> like this.
A single newline here has no effect on the layout.

But an empty line starts a new paragraph,

or ends a list or an indented part.

Lines can be forced to break

like this.

Indent text
: Single indent
:: Double indent
::::: Multiple indent

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

The usage of #: and *: to break 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.

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


HTML tags

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

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

Text before

Blockquote

Text after

Quotes
<q>This is a quotation</q>
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.[1]
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>

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>

A CSS style can be defined within the style attribute.

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>
 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>
 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;">
 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>
 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 —.


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

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;")

Code Formatting

Description You type You get
Code block (no highlighting)
Lorem ipsum ...
<code style="display: block">player setPosASL [0, 0, 0];
player setDamage 0;</code>
... dolor sit amet.
Lorem ipsum ...player setPosASL [0, 0, 0]; player setDamage 0;... dolor sit amet.
Code inline-block (no highlighting)
Lorem ipsum ... <code style="display: inline-block">player setPosASL [0, 0, 0];
player setDamage 0;</code> ... dolor sit amet.
Lorem ipsum ... player setPosASL [0, 0, 0]; player setDamage 0; ... dolor sit amet.


Single-line code comment (should only be used inside <code> tags where the usage of <sqf> tags is not possible)
<code style="display: block">[[player]] setPos{{Color|red|ASL}} [0, 0, 0]; {{cc|teleports the player}}</code>
player setPosASL [0, 0, 0]; // teleports the player
Config code block (uses C++ highlighting)
<syntaxhighlight lang="cpp">
class ExampleClass
{
	value1 = 1; // Lorem ipsum dolor sit amet.
	value2 = "value2";
};
</syntaxhighlight>
class ExampleClass
{
	value1 = 1; // Lorem ipsum dolor sit amet.
	value2 = "value2";
};
SQS code block
<sqs>
#Label1
hint "repeating"
goto "Label1"
</sqs>
#Label1 hint "repeating" goto "Label1"
Inline SQS code
Lorem ipsum <sqs inline>[player, _jeep] exec "getin.sqs"</sqs> dolor sit amet.
Lorem ipsum [player, _jeep] exec "getin.sqs" dolor sit amet.
SQF code block
<sqf>
private _pos = [0, 0, 0];
player setPosASL _pos;
player setDamage 0; // Heals the player
</sqf>
private _pos = [0, 0, 0]; player setPosASL _pos; player setDamage 0; // Heals the player
Inline SQF code
Lorem ipsum <sqf inline>player setPosASL [0, 0, 0]</sqf> dolor sit amet.
Lorem ipsum player setPosASL [0, 0, 0] dolor sit amet.
Enforce Script code block
<enforce>
string text = "Hello World!";
Print(text); // Prints "Hello World!".
</enforce>
string text = "Hello World!"; Print(text); // Prints "Hello World!".
Inline Enforce Script code (uses C# highlighting)
Lorem ipsum <enforce inline>string text = "Hello World!"</enforce> dolor sit amet.
Lorem ipsum string text = "Hello World!" dolor sit amet.

Notes:

  • To render an equals sign (=) or a pipe (|) within a template without breaking the page, use the equals template ({{=}}) and the pipe template ({{!}}) or wrap the symbols with <nowiki> tags. Example:
    • {{hl|_myNumber = 5;}} - This will not render properly.
    • {{hl|_myNumber {{=}} 5;}} - This renders properly.
  • Use the highlight template ({{hl}}) or <var> tags for inline variables (e.g. "The variable _myNumber has the value 5").
  • Use tabs for indentation, not spaces (tick the box Allow tabulations usage in the Editing Area if necessary).
  • Maintain spacing between symbols and items, for example:
    class ExampleClass
    {
    	stringValue="value";			// bad (no space around the equals sign)
    	stringValue = "value";			// good
    
    	arrayValue = {0,0.5,0,1};		// bad (no space between the numbers)
    	arrayValue = { 0, 0.5, 0, 1 };	// good
    };
    
At the root level of the page (i.e. not within templates and tables), text indented by one space renders the same way as text wrapped in <code style="display: block"> tags.

Lists

Do not leave blank lines between items in a list unless there is a reason to do so, since this causes the MediaWiki software to interpret each item as beginning a new list.

Unordered lists

Markup Renders as
* Item1
* Item2
* Item3
* Item4
** Sub-item 4 a)
*** Sub-item 4 a) 1.
**** Sub-item 4 a) 1. i)
**** Sub-item 4 a) 1. ii)
** Sub-item 4 b)
* Item5

  • Item1
  • Item2
  • Item3
  • Item4
    • Sub-item 4 a)
      • Sub-item 4 a) 1.
        • Sub-item 4 a) 1. i)
        • Sub-item 4 a) 1. ii)
    • Sub-item 4 b)
  • Item5

Unordered, multi column, list

Markup Renders as
<div style="columns: 3">
* {{arma3}}
* {{arma2}}
* {{arma1}}
* {{ofp}}
</div>

  • Arma 3
  • Arma 2
  • Armed Assault
  • Operation Flashpoint

Ordered lists

Markup Renders as
# Item1
# Item2
# Item3
# Item4
## Sub-item 1
### Sub-sub-item
#### Sub-sub-sub-item
## Sub-item 2
# Item5

  1. Item1
  2. Item2
  3. Item3
  4. Item4
    1. Sub-item 1
      1. Sub-sub-item
        1. Sub-sub-sub-item
    2. Sub-item 2
  5. Item5

Description lists

To list terms and definitions, start a new line with a semicolon (;) followed by the term. Then, type a colon (:) followed by a definition. The format can also be used for other purposes, such as make and models of vehicles, etc.

Description lists (formerly definition lists, and a.k.a. association lists) consist of group names corresponding to values. Group names (terms) are in bold. Values (definitions) are indented. Each group must include one or more definitions. For a single or first value, the : can be placed on the same line after ; – but subsequent values must be placed on separate lines.

Do not use a semicolon (;) simply to bold a line without defining a value using a colon (:). This usage renders invalid HTML5 and creates issues with screen readers.

Markup Renders as
; Term : Definition1

Term 
Definition1
; Term
: Definition1
: Definition2
: Definition3
: Definition4

Term
Definition1
Definition2
Definition3
Definition4

HTML equivalent: <dl>, <dt> <dd>, <dl>


Links

Internal Links

In most wikis, internal links are used in wikitext markup instead of regular urls to simplify linking and reading

Description You type You get
Internal link
Arma is made by [[Bohemia Interactive]].
Arma is made by Bohemia Interactive.
Renamed link
Ylands is also made by [[Bohemia Interactive|BI]].
Ylands is also made by BI.
Auto renamed links (pipe trick)
Auto renamed link (pipe trick)
[[:Category:Scripting Commands|]]
Scripting Commands
Automatically hide stuff in parentheses
[[raP (ArmA)|]]
raP
Automatically hide the comma and following text
[[Seattle, Washington|]]
Seattle
Automatically hide namespace
[[Wikipedia:Village pump|]]
Village pump
Or both
[[Wikipedia:Manual of Style (headings)|]]
Manual of Style
Does not work for section links
[[Wikipedia:Manual of Style#Links|]]
[[Wikipedia:Manual of Style#Links|]]

Link to a section of a page

You can add the specific section you want to link by adding the seciton title to the link after a # (hash).

Description You type You get
Link to a section within another page
[[Wikipedia:Manual of Style#Italics]]
Wikipedia:Manual of Style#Italics
Piped link to a section within another page.
[[Wikipedia:Manual of Style#Italics|Italics]]
Italics.

Blended links

Description You type You get
Blending active
San Francisco also has [[public transport]]ation. Examples include [[bus]]es, [[taxicab]]s, and [[tram]]s.
San Francisco also has public transportation. Examples include buses, taxicabs, and trams.
Blending supressed
A [[micro-]]<nowiki />second.
A micro-second.

Redirects

Redirects are used to redirect specific pages to another page.

Description You type
Redirect to an article #REDIRECT [[United States]]
Redirect to a section #REDIRECT [[United States#History]]
Link to another namespace See the [[Wikipedia:Manual of Style]]. See the Wikipedia:Manual of Style.

Categories

Description You type You get
Add article to category [[Category:Character sets]]
Link to a category [[:Category:Character sets]] Category:Character sets
Without prefix. [[:Category:Character sets|]] Character sets

External links

External links link to external websites other than the Biki. These links are in url format.

Description You type You get
Named link with an external link icon [http://www.wikipedia.org Wikipedia] Wikipedia
Unnamed link

(Used only within article body for footnotes)

[http://www.wikipedia.org]

[1]

Bare URL

(Bad style)

use <nowiki></nowiki> to keep this bad style from showing

http://www.wikipedia.org

http://www.wikipedia.org

Link without arrow

(Not often used)

<span class="plainlinks">[http://www.wikipedia.org Wikipedia]</span>

Wikipedia

Images

Description You type You get
Simple image without description
[[File:Logo_A3_black.png]]
or
[[Image:Logo_A3_black.png]]
File: is to be preferred.
Logo A3 black.png
Thumb image with description, defined size and aligned right. Size can by any number. Alignment can be (left, right and center)
[[File:Logo_A3_black.png|thumb|right|100px|Some description]]
Some description

Tables

There are multiple ways to make tables in wikitext. Recommended are:

Make sure the raw text is well formatted so it is easier to edit later.

Useful templates

Visit Category:Templates, to see a complete list of available templates.
Template You type You get
Template:Wiki
{{Wiki|delete|reason}}
🗙
This article has been submitted for deletion. The reason given was: reason.
{{Wiki|merge}}

This article has been proposed to merge with Main Page.
{{Wiki|stub}}
{{Wiki|WIP}}
🏗
This article is a work in progress!
Template:Feature
See {{Feature}} for all the available types.
{{Feature|arma3|text}}
Arma 3
text
{{Feature|informative|text}}
text
{{Feature|important|important text}}
text
{{Feature|warning|text}}
text
{{Feature|obsolete}}
🕖
The following information is obsolete.
{{Feature|quote|Gastovski, out!|James Gastovski
|https://www.youtube.com/watch?v{{=}}TGKFY1QiIGA}}
«
« Gastovski, out! » – James Gastovski (source)
Template:GVI
{{GVI|arma3|version}}
Arma 3 logo black.png1.96
Template:cn
{{cn}}
{{cn|Miller is a nice guy}}
[citation needed]

Miller is a nice guy [citation needed]

Template:Icon
{{Icon|serverExec|32}}
{{Icon|globalArgument|32}}
{{Icon|localArgument|32}}
{{Icon|globalEffect|32}}
{{Icon|localEffect|32}}

SEServer GAGlobal LALocal GEGlobal LELocal