Help:Formatting

From IoTWiki
Revision as of 16:31, 16 June 2017 by Brett Wuth (talk)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

<languages /> Template:TNT <translate> 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

</translate>

<translate> Description</translate> <translate> You type</translate> <translate> You get</translate>
<translate> Character (inline) formatting – applies anywhere</translate>
<translate> Italic text</translate>
''<translate><!--T:8--> italic</translate>''

<translate> italic</translate>

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

<translate> bold</translate>

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

<translate> bold & italic</translate>

<translate> Escape wiki markup</translate>
<nowiki><translate><!--T:20--> no ''markup''</translate></nowiki>

<translate> no ''markup''</translate>

<translate> Section formatting – only at the beginning of the line</translate>
<translate> Section Headings of different levels</translate>
<translate>
== Level 2 == <!--T:26-->

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

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

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

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

Template:Note

<translate>

Level 2

Level 3

Level 4

Level 5
Level 6

</translate>

<translate> Horizontal rule</translate>
<translate><!--T:41--> Text before</translate>
----
<translate><!--T:42--> Text after</translate>

<translate> Text before</translate>


<translate> Text after</translate>

<translate> Bullet list</translate>
<translate>
<!--T:46-->
* 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.

<!--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
</translate>

<translate>

  • 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

</translate>

<translate> Numbered list</translate>
<translate>
<!--T:49-->
# 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

<!--T:50-->
# end the list and start another.
Any other start also
ends the list.
</translate>

<translate>

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

<translate> Definition list</translate>
<translate>
<!--T:54-->
;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2
</translate>

<translate>

item 1
definition 1
item 2
definition 2-1
definition 2-2

</translate>

<translate> Indent text</translate>
<translate>
<!--T:57-->
: Single indent
:: Double indent
::::: Multiple indent
</translate>

Template:Note

<translate>

Single indent
Double indent
Multiple indent

</translate>

<translate> Mixture of different types of list</translate>
<translate>
<!--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
</translate>

Template:Note

<translate>

  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{{safesubst:#invoke:anchor|main}}

</translate>

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

Template:Note

<translate> Start each line with a space.

Text is preformatted and
markups can be done.

</translate>

<translate> Preformatted text blocks</translate>
 <translate><!--T:69-->
<nowiki>Start with a space in the first column,
(before the <nowiki>).

<!--T:70-->
Then your block format will be
    maintained.
 
This is good for copying in code blocks:

<!--T:71-->
def function():
    """documentation string"""

    <!--T:72-->
if True:
        print True
    else:
        print False</nowiki></translate>
<translate>

Start with a space in the first column, (before the <nowiki>). <!--T:74--> Then your block format will be maintained. <!--T:75--> This is good for copying in code blocks: <!--T:76--> def function(): """documentation string""" <!--T:77--> if True: print True else: print False</translate>

<translate>

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

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

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

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

<translate> Inserted</translate>

<translate> or</translate>

<translate> Underline</translate>

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

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

<del><translate><!--T:95--> Deleted</translate></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>

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

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

Template:Note

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

Template:Note

<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;">
<translate><!--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.</translate>
</pre>
<translate><!--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.</translate>

<translate>

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. Additionally, you can use the WikiEditor or VisualEditor to insert them into the edit screen.

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 —. </translate>


Template:Note

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