Help:Formatting

From FamilySearch Wiki

(Difference between revisions)
m (1 revision: missing MediaWiki PD help)
Line 1: Line 1:
{{PD Help Page}}
+
{{PD Help Page}}  
You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks 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 single quotes like <code><nowiki>''this''</nowiki></code>.
+
<br>{{Contributor Help badge}}<br><br><br>
  
== Text formatting markup ==
 
  
{| class="wikitable"
+
You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks 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 single quotes like <code><nowiki>''this''</nowiki></code>.
! Description !! You type !! You get
+
 
 +
== Text formatting markup  ==
 +
 
 +
{| class="wikitable FCK__ShowTableBorders"
 +
|-
 +
! Description  
 +
! You type  
 +
! You get
 
|-
 
|-
! colspan="3" style="background:#ABE" | character (inline) formatting – ''applies anywhere''
+
! style="background: #abe" colspan="3" | character (inline) formatting – ''applies anywhere''
 
|-
 
|-
|Italic text
+
| Italic text  
| <code><nowiki>''italic''</nowiki></code>
+
| <code><nowiki>''italic''</nowiki></code>  
|''italic''
+
| ''italic''
 
|-
 
|-
| Bold text
+
| Bold text  
| <code><nowiki>'''bold'''</nowiki></code>
+
| <code><nowiki>'''bold'''</nowiki></code>  
|'''bold'''
+
| '''bold'''
 
|-
 
|-
| Bold and italic
+
| Bold and italic  
| <code><nowiki>'''''bold & italic'''''</nowiki></code>
+
| <code><nowiki>'''''bold & italic'''''</nowiki></code>  
|'''''bold & italic'''''
+
| '''''bold &amp; italic'''''
 
|-
 
|-
|Escape wiki markup
+
| Escape wiki markup  
| <code><nowiki><nowiki>no ''markup''&lt;/nowiki></nowiki></code>
+
| <code><nowiki><nowiki>no ''markup''</nowiki></nowiki></code>  
|<nowiki>no ''markup''</nowiki>
+
| <nowiki>no ''markup''</nowiki>
 
|-
 
|-
! colspan="3" style="background:#ABE" | section formatting – ''only at the beginning of the line''
+
! style="background: #abe" colspan="3" | section formatting – ''only at the beginning of the line''
 
|-
 
|-
|Headings of different levels  
+
| Headings of different levels  
 
| <pre>=level 1=
 
| <pre>=level 1=
 
==level 2==
 
==level 2==
Line 34: Line 40:
 
=====level 5=====
 
=====level 5=====
 
======level 6======</pre>
 
======level 6======</pre>
An article with 4 or more headings automatically creates a [[wikipedia:Wikipedia:Section#Table of contents (TOC)|table of contents]].
+
An article with 4 or more headings automatically creates a [[wikipedia:Wikipedia:Section|table of contents]].
  
|<!-- hack to prevent TOC viewing for h1 - h6 elements: their style is hardcopied here -->
+
| <!-- hack to prevent TOC viewing for h1 - h6 elements: their style is hardcopied here --><div style="border-bottom: #aaa 1px solid; padding-bottom: 0.17em; margin: 0px; font-size: 188%; padding-top: 0.5em">Level 1</div><div style="border-bottom: #aaa 1px solid; padding-bottom: 0.17em; margin: 0px; font-size: 150%; padding-top: 0.5em">Level 2</div><div style="font-size: 132%; font-weight: bold">Level 3</div><!--
<div style="font-size: 188%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa">Level 1</div>
+
-->'''Level 4'''<!--
<div style="font-size: 150%; margin: 0; padding-top: .5em; padding-bottom: .17em; border-bottom: 1px solid #aaa">Level 2</div>
+
<div style="font-size: 132%; font-weight: bold">Level 3</div><!--
+
--><b>Level 4</b><!--
+
 
--><div style="font-size: 86%; font-weight: bold">Level 5</div><!--
 
--><div style="font-size: 86%; font-weight: bold">Level 5</div><!--
--><b style="font-size: 80%">Level 6</b>
+
-->'''Level 6'''
 
|-
 
|-
|Horizontal rule
+
| Horizontal rule  
| <code>----</code>
+
| <code>----</code>  
|
+
|  
 
----
 
----
 +
 
|-
 
|-
|Bullet list
+
| Bullet list  
|
+
| <pre>* one
<pre>
+
* one
+
 
* two
 
* two
 
* three
 
* three
Line 59: Line 61:
 
</pre>
 
</pre>
 
Inserting a blank line will end the first list and start another.
 
Inserting a blank line will end the first list and start another.
|
+
 
* one
+
|  
* two
+
*one  
* three
+
*two  
** three point one
+
*three  
** three point two
+
**three point one  
 +
**three point two
 +
 
 
|-
 
|-
|Numbered list
+
| Numbered list  
|
+
| <pre># one
<pre>
+
# two&lt;br /&gt;spanning more lines&lt;br /&gt;doesn't break numbering
# one
+
# two<br />spanning more lines<br />doesn't break numbering
+
 
# three
 
# three
 
## three point one
 
## three point one
 
## three point two
 
## three point two
 
</pre>
 
</pre>
|
+
|  
# one
+
#one  
# two<br />spanning more lines<br />doesn't break numbering
+
#two<br>spanning more lines<br>doesn't break numbering  
# three
+
#three  
## three point one
+
##three point one  
## three point two
+
##three point two
 +
 
 
|-
 
|-
|Definition list
+
| Definition list  
|<pre>
+
| <pre>;item 1
;item 1
+
 
: definition 1
 
: definition 1
 
;item 2
 
;item 2
Line 90: Line 92:
 
: definition 2-2
 
: definition 2-2
 
</pre>
 
</pre>
|
+
|  
;item 1
+
;item 1  
: definition 1
+
:definition 1  
;item 2
+
;item 2  
: definition 2-1
+
:definition 2-1  
: definition 2-2
+
:definition 2-2
 +
 
 
|-
 
|-
| Adopting definition list to indent text
+
| Adopting definition list to indent text  
|
+
| <pre>: Single indent
<pre>: Single indent
+
 
:: Double indent
 
:: Double indent
 
::::: Multiple indent</pre>
 
::::: Multiple indent</pre>
 
This workaround may be controversial from the viewpoint of accessibility.
 
This workaround may be controversial from the viewpoint of accessibility.
|
+
 
: Single indent
+
|  
:: Double indent
+
:Single indent  
::::: Multiple indent
+
::Double indent  
 +
:::::Multiple indent
 +
 
 
|-
 
|-
| Mixture of different types of list
+
| Mixture of different types of list  
|
+
| <pre># one
<pre>
+
# one
+
 
# two
 
# two
 
#* two point one
 
#* two point one
Line 121: Line 123:
 
#: four def one
 
#: four def one
 
#: this rather looks like the continuation of # four
 
#: this rather looks like the continuation of # four
#: and thus often used instead of <br />
+
#: and thus often used instead of &lt;br /&gt;
 
# five
 
# five
 
## five sub 1
 
## five sub 1
Line 136: Line 138:
 
</pre>
 
</pre>
 
The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also be controversial.
 
The usage of <code>#:</code> and <code>*:</code> for breaking a line within an item may also be controversial.
|
+
 
# one
+
|  
# two
+
#one  
#* two point one
+
#two  
#* two point two
+
#*two point one  
# three
+
#*two point two
#; three item one
+
#three  
#: three def one
+
#;three item one  
# four
+
#:three def one
#: four def one
+
#four  
#: this rather looks like the continuation of <code># four</code>
+
#:four def one  
#: often used instead of <code>&lt;br /></code>
+
#:this rather looks like the continuation of <code># four</code>  
# five
+
#:often used instead of <code>&lt;br /&gt;</code>
## five sub 1
+
#five  
### five sub 1 sub 1
+
##five sub 1  
## five sub 2
+
###five sub 1 sub 1
;item 1
+
##five sub 2
:* definition 1-1
+
 
:* definition 1-2
+
;item 1  
:
+
;*definition 1-1  
;item 2
+
;*definition 1-2
:# definition 2-1
+
:;item 2  
:# definition 2-2
+
;#definition 2-1  
 +
;#definition 2-2
 +
 
 
|-
 
|-
|-
+
| Preformatted text  
|Preformatted text
+
| <pre> preformatted text is done with
|
+
<pre>
+
preformatted text is done with
+
 
  a '''space''' at the  
 
  a '''space''' at the  
 
  ''beginning'' of the line
 
  ''beginning'' of the line
 
</pre>
 
</pre>
 
This way of preformatting only applies to section formatting, and character formatting markups are still effective.
 
This way of preformatting only applies to section formatting, and character formatting markups are still effective.
|
+
 
 +
|  
 
  preformatted text is done with
 
  preformatted text is done with
 
  a '''space''' at the  
 
  a '''space''' at the  
''beginning'' of the line
+
''beginning'' of the line
 +
 
 
|}
 
|}
  
== Paragraphs ==
+
== 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 tags <code>&lt;br /></code>.
+
  
== HTML ==
+
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 tags <code>&lt;br /&gt;</code>.  
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code>&lt;code></code>, <code>&lt;div></code>, <code><nowiki><span></nowiki></code> and <code><nowiki><font></nowiki></code>. These apply anywhere you insert them.
+
  
{| class="wikitable"
+
== HTML  ==
!Description
+
 
!You type
+
Some [[wikipedia:HTML|HTML]] tags are allowed in MediaWiki, for example <code>&lt;code&gt;</code>, <code>&lt;div&gt;</code>, <code><nowiki><span></nowiki></code> and <code><nowiki><font></nowiki></code>. These apply anywhere you insert them.
!You get
+
 
 +
{| class="wikitable FCK__ShowTableBorders"
 +
|-
 +
! Description  
 +
! You type  
 +
! You get
 
|-
 
|-
| Strikethrough
+
| Strikethrough  
| <code>&lt;del>Strikethrough&lt;/del></code> or <code>&lt;s>Strikethrough&lt;/s></code>
+
| <code>&lt;del&gt;Strikethrough&lt;/del&gt;</code> or <code>&lt;s&gt;Strikethrough&lt;/s&gt;</code>  
|<del>Strikethrough</del>
+
| <del>Strikethrough</del>
|- style="white-space:nowrap"
+
|- style="white-space: nowrap"
|Fixed width text
+
| Fixed width text  
| <code>&lt;tt>Fixed width text&lt;/tt></code> or <code>&lt;code>source code&lt;/code></code>
+
| <code>&lt;tt&gt;Fixed width text&lt;/tt&gt;</code> or <code>&lt;code&gt;source code&lt;/code&gt;</code>  
 
| <tt>Fixed width text</tt> or <code>source code</code>
 
| <tt>Fixed width text</tt> or <code>source code</code>
 
|-
 
|-
|Blockquotes
+
| Blockquotes  
 
| <code>
 
| <code>
text text text text text text text text text text text text
+
text text text text text text text text text text text text text text text text text text text text text text text text &lt;blockquote&gt; quote quote quote quote quote quote &lt;/blockquote&gt; text text text text text text text text text text text text
text text text text text text text text text text text text
+
&lt;blockquotequote quote quote quote quote quote &lt;/blockquote>
+
text text text text text text text text text text text text
+
 
</code>
 
</code>
| text text text text text text text text text text text text text text text text text text text text text text text text <blockquote> quote quote quote quote quote quote </blockquote> text text text text text text text text text text text text
+
| text text text text text text text text text text text text text text text text text text text text text text text text <blockquote>quote quote quote quote quote quote </blockquote>text text text text text text text text text text text text
 
|-
 
|-
|Comment
+
| Comment  
| <code>&lt;!-- This is a comment --></code>
+
| <code>&lt;!-- This is a comment --&gt;</code>  
 
Text can only be viewed in the edit window.
 
Text can only be viewed in the edit window.
|
+
 
<!-- This is a real invisible comment -->
+
| <!-- This is a real invisible comment -->
 
|-
 
|-
|Completely preformatted text
+
| Completely preformatted text  
|
+
|  
 
<code><nowiki><pre>this way, all markups are '''ignored'''</pre></nowiki></code>
 
<code><nowiki><pre>this way, all markups are '''ignored'''</pre></nowiki></code>
|
+
 
<pre> this way, all markups are '''ignored'''.</pre>
+
| <pre> this way, all markups are '''ignored'''.</pre>
 
|-
 
|-
|'''Customized''' preformatted text
+
| '''Customized''' preformatted text  
|
+
|  
 
<code><nowiki><pre style="CSS text">this way, all markups are '''ignored''' and formatted with a CSS text</pre></nowiki></code>
 
<code><nowiki><pre style="CSS text">this way, all markups are '''ignored''' and formatted with a CSS text</pre></nowiki></code>
|
+
 
<pre style="white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word;overflow:auto;">
+
| <pre style="word-wrap: break-word; overflow: auto"> this way for instance, all '''ignored''' markups take into account the navigator size, by automatically adding some carriage returns dynamically to it.</pre>
this way for instance, all '''ignored''' markups take into account the navigator size, by automatically adding some carriage returns dynamically to it.</pre>
+
 
|}
 
|}
  
{{Admin tip|tip=If you trust your users you can allow full HTML by setting <code>{{mediawiki|Manual:$wgRawHtml|$wgRawHtml}} = true;</code> in {{mediawiki|Manual:LocalSettings.php|LocalSettings.php}}.}}
+
{{Admin tip|tip=If you trust your users you can allow full HTML by setting <code>{{mediawiki|Manual:$wgRawHtml|$wgRawHtml}} = true;</code> in {{mediawiki|Manual:LocalSettings.php|LocalSettings.php}}.}}  
 +
 
 +
== Other formatting  ==
  
== Other formatting ==
+
Beyond the text formatting markup shown above, here are some other formatting references:  
Beyond the text formatting markup shown above, here are some other formatting references:
+
  
*[[Help:Links|Links]]
+
*[[Help:Links|Links]]  
* [[Help:Images|Images]]
+
*[[Help:Images|Images]]  
* [[Help:Tables|Tables]]
+
*[[Help:Tables|Tables]]
  
{{Languages}}
+
{{Languages}}  
  
[[Category:Help|Formatting]]
+
[[Category:Help]]

Revision as of 09:12, 20 April 2011

PD Important note: This page started out as a copy of one of the Public Domain Help Pages, which can be freely copied into fresh wiki installations and/or distributed with MediaWiki software; see mw:Help:Contents for an overview of all pages. See Project:PD help/Copying for instructions. PD

Help-content.png Questions?
Visit the Wiki Contributor Help Forum to receive help with contributing to the Wiki.





You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks 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 single quotes like ''this''.

Contents

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
Escape wiki markup <nowiki>no ''markup''</nowiki> no ''markup''
section formatting – only at the beginning of the line
Headings of different levels
=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======

An article with 4 or more headings automatically creates a table of contents.

Level 1
Level 2
Level 3
Level 4
Level 5
Level 6
Horizontal rule ----
Bullet list
* one
* two
* three
** three point one
** three point two

Inserting a blank line will end the first list and start another.

  • one
  • two
  • three
    • three point one
    • three point two
Numbered list
# one
# two<br />spanning more lines<br />doesn't break numbering
# three
## three point one
## three point two
  1. one
  2. two
    spanning more lines
    doesn't break numbering
  3. three
    1. three point one
    2. three point two
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
Adopting definition list to indent text
: Single indent
:: Double indent
::::: Multiple indent

This workaround may be controversial from the viewpoint of 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 rather looks like the continuation of # four
#: and thus often used instead of <br />
# five
## five sub 1
### five sub 1 sub 1
## five sub 2

;item 1
:* definition 1-1
:* definition 1-2
:
;item 2
:# definition 2-1
:# definition 2-2

The usage of #: and *: for breaking a line within an item may also be controversial.

  1. one
  2. two
    • two point one
    • two point two
  3. three
    three item one
    three def one
  4. four
    four def one
    this rather looks like the continuation of # four
    often used instead of <br />
  5. five
    1. five sub 1
      1. five sub 1 sub 1
    2. five sub 2
item 1
  • definition 1-1
  • definition 1-2
item 2
  1. definition 2-1
  2. definition 2-2
Preformatted text
 preformatted text is done with
 a '''space''' at the 
 ''beginning'' of the line

This way of preformatting only applies to section formatting, and character formatting markups are still effective.

preformatted text is done with
a space at the 

beginning of the line

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 tags <br />.

HTML

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

Description You type You get
Strikethrough <del>Strikethrough</del> or <s>Strikethrough</s> Strikethrough
Fixed width text <tt>Fixed width text</tt> or <code>source code</code> Fixed width text or source code
Blockquotes

text text text text text text text text text text text text text text text text text text text text text text text text <blockquote> quote quote quote quote quote quote </blockquote> text text text text text text text text text text text text

text text text text text text text text text text text text text text text text text text text text text text text text
quote quote quote quote quote quote
text text text text text text text text text text text text
Comment <!-- This is a comment -->

Text can only be viewed in the edit window.

Completely preformatted text

<pre>this way, all markups are '''ignored'''</pre>

 this way, all markups are '''ignored'''.
Customized preformatted text

<pre style="CSS text">this way, all markups are '''ignored''' and formatted with a CSS text</pre>

 this way for instance, all '''ignored''' markups take into account the navigator size, by automatically adding some carriage returns dynamically to it.
Tools.png Tip for wiki admins: If you trust your users you can allow full HTML by setting $wgRawHtml = true; in LocalSettings.php.

Other formatting

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

Template:Languages