Help:Contents
From Jtvcommunity
This page will give you some basic formatting help for the MediaWiki platform that we use here for the Justin.tv Community Wiki
Contents |
Text formatting markup
| Description | You type | You get |
|---|---|---|
| character 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 four or more headings will automatically create a table of contents. Use of a level 1 heading is highly discouraged as it appears with the same formatting and size as the page title, which can be confusing. |
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. |
|
| Numbered list |
# one # two<br />spanning several lines<br />without breaking the numbering # three ## three point one ## three point two |
|
| Definition list |
;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 adoption may be controversial from the viewpoint of accessibility. |
|
| 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 |
|
| 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 |
Links
Internal Linking
To add an internal link, enclose the name of the page you want to link to in double square brackets. When you save the page, you'll see the new link pointing to your page. If the page exists already it is displayed in blue, if it does not, in red. Selflinks to the current page are not transformed in URLs but displayed in bold.
The first letter of the target page is automatically capitalized, unless otherwise set by the admins, and spaces are represented as underscores (typing an underscore in the link will have a similar effect as typing a space, but is not recommended, since the underscore will also be shown in the text).
| Description | You type | You get |
|---|---|---|
| Internal link | [[Main Page]] | Main Page |
| Piped link | [[Main Page|different text]] | different text |
| Redirect | #REDIRECT [[Main Page]] See also Help:Redirects | → Main Page |
External Links
| Description | You type | You get |
|---|---|---|
| External link | http://mediawiki.org | http://mediawiki.org |
| External link with different label | [http://mediawiki.org MediaWiki] | MediaWiki |
| External link numbered | [http://mediawiki.org] | [1] |
| External link icons | [http://en.wikipedia.org/wiki/.avi video] [http://en.wikipedia.org/wiki/.wav sound] [http://en.wikipedia.org/wiki/.pdf document] External link icons may differ depending on the file type of the target. | |
| External link to the same host | [http://{{SERVERNAME}}/pagename]
| [2] |
| External link to other host passing the pagename | [http://google.com/search?q={{PAGENAMEE}}]
| [3] |
| Mailto link | [mailto:info@example.org email me] | email me |
| Mailto named with subject line and body | [mailto:info@example.org?Subject=URL%20Encoded%20Subject&body=Body%20Text info] | info |
How to avoid auto-links
By default, when you write a URL as is, it will be transformed to an external link.
To avoid that effect, put the URL between <nowiki> tags as in:
<nowiki>http://mediawiki.org</nowiki>
Image Formatting Markup
Syntax
The full syntax for displaying an image is:
[[Image:{filename}|{options}]]
Where options can be zero or more of the following, separated by pipes:
border,frame,thumb, orframeless: Controls how the image is formattedleft,right,center,none: Controls the alignment of the image within a textbaseline,sub,super,top,text-top,middle,bottom,text-bottom: Controls the vertical alignment of the image within a text{width}px: Resizes the image to the given width in pixels{width}x{height}px: Resizes the image to fit within the given width and height in pixels; it is possible to specify only the height by writingx{height}px- Note that the image will always retain its aspect ratio.
link={destination}: Allows to link to an arbitrary title, URL or just nowherelink=: Will display an image without link, e.g.[[File:Name.jpg|link=]].- Note that
linkcannot be used in conjunction withthumborframe.
alt={alternative text}: For changing the alternative text (alt="") of an image- Special cases:
-
page=1: Displays the specified page when showing a djvu file
-
The options can be given in any order. If the given options conflict each other, the latter is applied, except for the format options, where the options take the priority in the order of frame, thumb, and frameless and/or border. If a given option does not match any of the other possibilities, it is assumed to be the caption text. Caption text can contain wiki links or other formatting.
For more information and examples check the MediaWiki help page on Images
Wiki table markup summary
{|
| table start |
|+ | table caption, optional; only between table start and first table row |
|- | table row, optional on first row -- wiki engine assumes the first row |
! | table header cell, optional. Consecutive table header cells may be added on same line separated by double marks (!!) or start on new lines, each with its own single mark (!).
|
| | table data cell, required! Consecutive table data cells may be added on same line separated by double marks (||) or start on new lines, each with its own single mark (|).
|
|} | table end |
- The above marks must start on a new line except the double
||and!!for optionally adding consecutive cells to a line. However, blank spaces at the beginning of a line are ignored. - XHTML attributes. Each mark, except table end, optionally accepts one or more XHTML attributes. Attributes must be on the same line as the mark. Separate attributes from each other with a single space.
- Cells and caption (
|or||,!or!!, and|+) hold content. So separate any attributes from content with a single pipe (|). Cell content may follow on same line or on following lines. - Table and row marks (
{|and|-) do not directly hold content. Do not add pipe (|) after their optional attributes. If you erroneously add a pipe after attributes for the table mark or row mark the parser will delete it and your final attribute if it was touching the erroneous pipe!
- Cells and caption (
- Content may (a) follow its cell mark on the same line after any optional XHTML attributes or (b) on lines below the cell mark. Content that uses wiki markup that itself needs to start on a new line, such as lists, headings, or nested tables, must be on its own new line.
Basics
The following table lacks borders and good spacing but shows the simplest wiki markup table structure.
| You type | You get | ||||||
|---|---|---|---|---|---|---|---|
{|
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream
|}
|
|
The cells in the same row can be listed on one line separated by ||.
Extra spaces within cells in the wiki markup, as in the wiki markup below, do not affect the actual table rendering.
| You type | You get | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
{|
| Orange || Apple || more
|-
| Bread || Pie || more
|-
| Butter || Ice cream || and more
|}
|
|
Table headers
Table headers can be created by using "!" instead of "|". Headers usually show up bold and centered by default.
| You type | You get | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{|
! Item
! Amount
! Cost
|-
|Orange
|10
|7.00
|-
|Bread
|4
|3.00
|-
|Butter
|1
|5.00
|-
!Total
|
|15.00
|}
|
|
Caption
A table caption can be added to the top of any table as follows.
| You type | You get | ||||||
|---|---|---|---|---|---|---|---|
{|
|+Food complements
|-
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream
|}
|
|
XHTML attributes
You can add XHTML attributes to tables. For the authoriative source on these, see the W3C's HTML 4.01 Specification page on tables.
Attributes on tables
Placing attributes after the table start tag ({|) applies attributes to the entire table.
| You type | You get | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
{| border="1"
|Orange
|Apple
|12,333.00
|-
|Bread
|Pie
|500.00
|-
|Butter
|Ice cream
|1.00
|}
|
|
Attributes on cells
You can put attributes on individual cells. For example, numbers may look better aligned right.
| You type | You get | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
{| border="1"
|Orange
|Apple
|align="right" | 12,333.00
|-
|Bread
|Pie
|align="right" | 500.00
|-
|Butter
|Ice cream
|align="right" | 1.00
|}
|
|
You can also use cell attributes when you are listing multiple cells on a single line. Note that the cells are separated by ||, and within each cell the attribute(s) and value are separated by |.
| You type | You get | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
{| border="1"
| Orange || Apple || align="right" | 12,333.00
|-
| Bread || Pie || align="right" | 500.00
|-
| Butter || Ice cream || align="right" | 1.00
|}
|
|
Attributes on rows
You can put attributes on individual rows, too.
| You type | You get | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
{| border="1"
|Orange
|Apple
|align="right"|12,333.00
|-
|Bread
|Pie
|align="right"|500.00
|- style="font-style:italic; color:green;"
|Butter
|Ice cream
|align="right"|1.00
|}
|
|
With HTML attributes and CSS styles
CSS style attributes can be added with or without other HTML attributes.
| You type | You get | ||||||
|---|---|---|---|---|---|---|---|
{| style="color:green; background-color:#ffffcc;" cellpadding="20" cellspacing="0" border="1"
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream
|}
|
|
Attributes can be added to the caption and headers as follows.
| You type | You get | ||||||
|---|---|---|---|---|---|---|---|
{| border="1" cellpadding="20" cellspacing="0"
|+ align="bottom" style="color:#e76700;" |''Food complements''
|-
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream
|}
|
|
Caveat
Negative numbers
If you start a cell on a new line with a negative number with a minus sign (or a parameter that evaluates to a negative number), your table can get broken, because the characters |- will be parsed as the wiki markup for table row, not table cell. To avoid this, insert a space before the value (| -6) or use in-line cell markup (|| -6).
