Help:Formatting - Revision history

Fabartus: /* Linking basics */ add

2013-07-07T14:18:25Z

Linking basics: add

← Older revision		Revision as of 14:18, 7 July 2013
Line 33:		Line 33:

	== Linking basics==		== Linking basics==
	The true strength of a wiki and indeed the internet is the ability to form hyperlinks to other pages within a web site or external to the web site. Wiki markup provides internal links made up using the square brackets on your keyboard. Putting <code><nowiki>[[around this phrase]]</nowiki></code> will form a link to a page of that name, with a url local on this wiki. So <code><nowiki>[["Trainz-bulid tag]]</nowiki></code> will make the link: '''[["Trainz-bulid tag]]''' (bold added).		The true strength of a wiki and indeed the internet is the ability to form hyperlinks to other pages within a web site or external to the web site. Wiki markup provides internal links made up using the square brackets on your keyboard. Putting <code><nowiki>[[around this phrase]]</nowiki></code> will form a link to a page of that name, with a url local on this wiki. So <code><nowiki>[["Trainz-bulid tag]]</nowiki></code> will make the link: '''[["Trainz-bulid tag]]''' (bold added). Of course, if you misspell the page, or it doesn't exist yet, you get that redlink page highlighting instead of a good link like: <code>'''[["Trainz-build" tag]]'''</code> (bold added).

			Now you are about ready to begin editing pages, I can see you are anxious to do so, but how do you make a pretty ''External Link'' to say TrainzProRoutes or JointedRail or HP-Trainz, or Wikipedia so you don't have to explain everything yourself? Not so ready yet are you!? A simple external link also uses square braces, but only one at each end.

	== Text formatting markup ==		== Text formatting markup ==

Fabartus: /* unordered lists and indenting */ tweak

2013-07-07T14:00:24Z

unordered lists and indenting: tweak

← Older revision		Revision as of 14:00, 7 July 2013
Line 13:		Line 13:
	Each of those sub-tiles will be a bit smaller (up to a limit) and also show up in the Table of Contents, each subsection indented further under the parent section above.		Each of those sub-tiles will be a bit smaller (up to a limit) and also show up in the Table of Contents, each subsection indented further under the parent section above.

	===~~unordered~~ lists and indenting===		===Unordered lists and indenting===
	By now some of you are wondering how the preceding was enumerated, well the answer is using the '#' character in the left column just like this example uses the {{wp\|asterisk}} (<big><tt>'''*'''</tt></big>) character to make an indented bulleted list:		By now some of you are wondering how the preceding was enumerated, well the answer is using the '#' character in the left column just like this example uses the {{wp\|asterisk}} (<big><tt>'''*'''</tt></big>) character to make an indented bulleted list:
	* This sentence has a leading bullet.		* This sentence has a leading bullet.
Line 28:		Line 28:
	## two "**' symbols cause a similar bulleted nested sub-para		## two "**' symbols cause a similar bulleted nested sub-para
	## one ':' or more cause plain indenting		## one ':' or more cause plain indenting
	# whereas one pair of '=' signs in the left margin, ''as 'all of these' '''''must start''''' in the ''left margin'' or they just show up as characters at the beginning of a line.		# whereas one pair of '=' signs in the left margin, ''as 'all of these' '''''must start''''' in the ''left margin'' or they just show up as characters at the beginning of a line.
			That's an important point. If there is whitespace (spaces or tabs) in the first line column postition
			you get this effect, which has been used in the reference pages of the TrainzOnline wiki extensively to set off config.txt {{wp\|INI file}} codes.

	== Linking basics==		== Linking basics==

Fabartus: /* Ordered lists */ tweak

2013-07-07T13:56:35Z

Ordered lists: tweak

← Older revision		Revision as of 13:56, 7 July 2013
Line 8:		Line 8:
	===Ordered lists===		===Ordered lists===
	#<tt><code><nowiki> = title large =</nowiki> </code></tt>		#<tt><code><nowiki> = title large =</nowiki> </code></tt>
	# <nowiki> == Major Section title ==</nowiki>		# <tt><code><nowiki> == Major Section title ==</nowiki> </code></tt> — by convention, most sections on a page are of the double-equals ('==') variety, mostly because single equals form a really big title—which of course sometimes have a place.
	# <nowiki> === Sub-section title ===</nowiki>		# <tt><code><nowiki> === Sub-section title ===</nowiki></code></tt>
	# <nowiki> ==== Sub-subsection title ====</nowiki> and so on. Each of those will show up in the Table of Contents, each subsection indented further under the parent section above.		# <tt><code><nowiki> ==== Sub-subsection title ====</nowiki></code></tt> and so on.
			Each of those sub-tiles will be a bit smaller (up to a limit) and also show up in the Table of Contents, each subsection indented further under the parent section above.

	===unordered lists and indenting===		===unordered lists and indenting===
	By now some of you are wondering how the preceding was enumerated, well the answer is using the '#' character in the left column just like this example uses the {{wp\|asterisk}} (<big><tt>'''*'''</tt></big>) character to make an indented bulleted list:		By now some of you are wondering how the preceding was enumerated, well the answer is using the '#' character in the left column just like this example uses the {{wp\|asterisk}} (<big><tt>'''*'''</tt></big>) character to make an indented bulleted list:

Fabartus: Begin fixing up

2013-07-07T13:48:02Z

Begin fixing up

@@ Line 1: / Line 1: @@
 {{PD Help Page}}
-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>.
+<big>What you expect me to tell you? This is, as they say, an 'opportunity' ''to show something 'else'.''</big> Whether you guessed or don't know, you should see a little ''blue 'edit' tag'' just to the right near'' <code>'this' '''sections title''' line''</code>. Click on that if you aren't sure of how it is done. Now forming a title is bit easier, you use the same paired '{{wp|operator (computing)|operator) principle like HTML uses tags delimited by <code>&lt; and &gt; operators</code>, but wiki-markup uses <code>'='</code> characters ({{wp|equals sign}}s) to set off titles:
 == Text formatting markup ==
@@ Line 740: / Line 768: @@
 {{mediawiki}}
 [[Category:Help|Formatting]]

Fabartus: genesis, port unchanged from WikiMedia+cat w/{{Mediawiki} -- needs ParserFunctions to turn on

2013-07-02T11:59:28Z

genesis, port unchanged from WikiMedia+cat w/{{Mediawiki} -- needs ParserFunctions to turn on

New page

{{PD Help Page}}

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'''''
|-
| Strike text
| <pre>
<strike> strike text </strike>
</pre>
|<strike> strike text </strike>
|-
| Escape wiki markup
| <pre>
<nowiki>no ''markup''</nowiki>
</pre>
|
<nowiki>no ''markup''</nowiki>
|-
| Escape wiki markup once
| <pre>
[[API]]<nowiki/>extension
</pre>
|
[[API]]<nowiki/>extension
|-
! colspan="3" style="background: #ABE" | Section formatting – ''only at the beginning of the line''
|-
| Headings of different levels
| <pre>

== Level 2 ==

=== Level 3 ===

==== Level 4 ====

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

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

</pre>
----
{{note|
* [[Help_talk:Formatting#Level_1|Skip Level 1]], it is page name level.
* An article with 4 or more headings automatically creates a [[wikipedia:Wikipedia:Section#Table of contents (TOC)|table of contents]].
}}
|


<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 don't break levels.
*** But jumping levels creates empty space.
Any other start ends the list.
</pre>
|
* Start each line
* with an [[Wikipedia:asterisk|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.
|-
| Numbered list
|
<pre>
# Start each line
# with a [[Wikipedia:Number_sign|number sign]] (#).
## More number signs give deeper
### and deeper
### levels.
# Line breaks 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 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|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 of <nowiki> </nowiki>
# five
## five sub 1
### five sub 1 sub 1
## five sub 2
</pre>
----
{{note|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 of <nowiki> </nowiki>
# five
## five sub 1
### five sub 1 sub 1
## five sub 2{{anchor|pre}}
|-
| Preformatted text
| <pre>
Start each line with a space.
Text is '''preformatted''' and
''markups'' '''''can''''' be done.
</pre>
----
{{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
| <pre> <nowiki><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</nowiki></nowiki>
</pre>
|
<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</nowiki>
|}

== 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> </code>.

== HTML tags ==

Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code><code></code>, <code><div></code>, <code><nowiki></nowiki></code> and <code><nowiki></nowiki></code>. These apply anywhere you insert them.

{| class="wikitable"
! Description
! width=40% | You type
! width=40% | You get
|-
| Inserted (Displays as underline in most browsers)
| <pre>
<ins>Inserted</ins>

or

Underline
</pre>
|
<ins>Inserted</ins>

or

Underline
|-
| Deleted (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

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

or

<tt>Fixed width text</tt>
|-
| Blockquotes
| <pre>
Text before
<blockquote>Blockquote</blockquote>
Text after
</pre>
|
Text before
<blockquote>Blockquote</blockquote>
Text after
|-
| Comment
| <pre>

Comments are only visible
in the edit zone.
</pre>
|

Comments are only visible
in the edit zone.
|-
| Completely preformatted text
| <pre>
<pre> Text is '''preformatted''' and
''markups'' '''''cannot''''' be done</pre>
</pre>
----
{{note|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
</pre>
</pre>
----
{{note|A CSS style can be named within the <code>style</code> property.}}
|
<pre style="color: red">
Text is '''preformatted'''
with a style and
''markups'' '''''cannot''''' be done
</pre>
|}

continued:
{| class="wikitable"
! Description
! width=40% | You type
! width=40% | You get
|-
| '''Customized''' preformatted text with text wrap according to available width
| <pre>
<pre style="white-space: pre-wrap;
white-space: -moz-pre-wrap;
white-space: -pre-wrap;
white-space: -o-pre-wrap;
word-wrap: break-word;">
This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer.
</pre>
</pre>
|
<pre style="white-space: pre-wrap;
white-space: -moz-pre-wrap;
white-space: -pre-wrap;
white-space: -o-pre-wrap;
word-wrap: break-word;">
This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer.
</pre>
|-
| Preformatted text with text wrap according to available width
| <pre>
<code>
This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer.
</code>
</pre>
| <code>
This long sentence is used to demonstrate text wrapping. This additional sentence makes the text even longer.
</code>
|}

== Inserting symbols ==

Symbols and other special characters not available on your keyboard can be inserted through a special sequence of characters. Those sequences are called HTML entities. For example, the following sequence (entity) '''&rarr;''' when inserted will be shown as <ins>right arrow</ins> HTML symbol → and '''&mdash;''' when inserted will be shown as an <ins>em dash</ins> HTML symbol —.
----
{{note|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" align=center width=100%
! colspan=32 | HTML symbol entities
|- align=center
| '''Á
| '''á
| '''Â
| '''â
| '''´
| '''Æ
| '''æ
| '''À
| '''à
| '''&alefsym;
| '''Α
| '''α
| '''&
| '''&and;
| '''&ang;
| '''Å
| '''å
| '''≈
| '''Ã
| '''ã
| '''Ä
| '''ä
| '''&bdquo;
| '''Β
| '''β
| '''¦
| '''•
| '''∩
| '''Ç
| '''ç
| '''¸
| '''¢
|- align=center
| '''Χ
| '''χ
| '''&circ;
| '''&clubs;
| '''&cong;
| '''©
| '''&crarr;
| '''∪
| '''¤
| '''&dagger;
| '''&Dagger;
| '''↓
| '''&dArr;
| '''°
| '''Δ
| '''δ
| '''&diams;
| '''÷
| '''É
| '''é
| '''Ê
| '''ê
| '''È
| '''è
| '''∅
| '''&emsp;
| '''&ensp;
| '''Ε
| '''ε
| '''&equiv;
| '''Η
| '''η
|- align=center
| '''Ð
| '''ð
| '''Ë
| '''ë
| '''€
| '''∃
| '''&fnof;
| '''∀
| '''½
| '''¼
| '''¾
| '''&frasl;
| '''Γ
| '''γ
| '''≥
| '''>
| '''↔
| '''⇔
| '''&hearts;
| '''…
| '''Í
| '''í
| '''Î
| '''î
| '''¡
| '''Ì
| '''ì
| '''&image;
| '''∞
| '''∫
| '''Ι
| '''ι
|- align=center
| '''¿
| '''∈
| '''Ï
| '''ï
| '''Κ
| '''κ
| '''Λ
| '''λ
| '''&lang;
| '''«
| '''←
| '''⇐
| '''&lceil;
| '''“
| '''≤
| '''&lfloor;
| '''&lowast;
| '''&loz;
| '''&lrm;
| '''&lsaquo;
| '''‘
| '''<
| '''¯
| '''—
| '''µ
| '''·
| '''−
| '''Μ
| '''μ
| '''∇
| ''' 
| '''–
|- align=center
| '''≠
| '''&ni;
| '''¬
| '''∉
| '''&nsub;
| '''Ñ
| '''ñ
| '''Ν
| '''ν
| '''Ó
| '''ó
| '''Ô
| '''ô
| '''&OElig;
| '''&oelig;
| '''Ò
| '''ò
| '''&oline;
| '''Ω
| '''ω
| '''Ο
| '''ο
| '''&oplus;
| '''&or;
| '''ª
| '''º
| '''Ø
| '''ø
| '''Õ
| '''õ
| '''&otimes;
| '''Ö
|- align=center
| '''ö
| '''¶
| '''∂
| '''&permil;
| '''&perp;
| '''Φ
| '''φ
| '''Π
| '''π
| '''ϖ
| '''±
| '''£
| '''′
| '''″
| '''∏
| '''&prop;
| '''Ψ
| '''ψ
| '''"
| '''√
| '''&rang;
| '''»
| '''→
| '''⇒
| '''&rceil;
| '''”
| '''&real;
| '''®
| '''&rfloor;
| '''Ρ
| '''ρ
| '''&rlm;
|- align=center
| '''&rsaquo;
| '''’
| '''&sbquo;
| '''&Scaron;
| '''&scaron;
| '''⋅
| '''§
| '''
| '''Σ
| '''σ
| '''&sigmaf;
| '''&sim;
| '''&spades;
| '''⊂
| '''&sube;
| '''∑
| '''⊃
| '''¹
| '''²
| '''³
| '''&supe;
| '''ß
| '''Τ
| '''τ
| '''&there4;
| '''Θ
| '''θ
| '''&thetasym;
| ''' 
| '''Þ
| '''þ
| '''&tilde;
|- align=center
| '''×
| '''™
| '''Ú
| '''ú
| '''↑
| '''&uArr;
| '''Û
| '''û
| '''Ù
| '''ù
| '''¨
| '''&upsih;
| '''Υ
| '''υ
| '''Ü
| '''ü
| '''&weierp;
| '''Ξ
| '''ξ
| '''Ý
| '''ý
| '''¥
| '''ÿ
| '''&Yuml;
| '''Ζ
| '''ζ
| '''&zwj;
| '''&zwnj;'''
|}

{| class="wikitable"
! Description
! width=40% | You type
! width=40% | You get
|-
| Copyright symbol
| <tt><pre>
&copy;
</pre></tt>
|
:::'''©'''
|-
| Greek delta letter symbol
| <tt><pre>
&delta;
</pre></tt>
|
:::'''δ'''
|-
| Euro currency symbol
| <tt><pre>
&euro;
</pre></tt>
|
:::'''€'''
|}

See the list of all HTML entities on the Wikipedia article [[w:List of HTML entities|List of HTML entities]]. Additionally, MediaWiki supports two non-standard entity reference sequences: <code>&רלמ;</code> and <code>&رلم;</code> which are both considered equivalent to <code>&rlm;</code> which is a [[w:Right-to-left mark|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) ==

:<tt>&amp;euro;</tt>  → '''&euro;'''

:<tt>Typo to be corrected</tt>  → '''Typo to be corrected'''

:<tt>&lt;span style="color: red; text-decoration: line-through;">Typo to be corrected&lt;/span></tt>  → '''Typo to be corrected'''

=== Nowiki for HTML ===

<<nowiki />nowiki /> can prohibit (HTML) tags:
* <nowiki><<</nowiki>nowiki />pre>  → <<nowiki/>pre>
But ''not'' & symbol escapes:
* &<<nowiki />nowiki />amp;  → &

== Other formatting ==

Beyond the text formatting markup shown hereinbefore, here are some other formatting references:

* [[Help:Links|Links]]
* [[Help:List|Lists]]
* [[Help:Images|Images]]
* References - see [[Extension:Cite/Cite.php]]
* [[Help:Tables|Tables]]

You can find more references at [[Help:Contents]].

{{Languages}}
{{mediawiki}}
[[Category:Help|Formatting]]