From CE Club

Wiki Markup Help

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

Text Formatting Markup

=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======

* one
* two
* three
** three point one
** three point two

# one
# two<br />spanning more lines<br />doesn't break numbering
# three
## three point one
## three point two

;item 1
: definition 1
;item 2
: definition 2-1
: definition 2-2

: Single indent
:: Double indent
::::: Multiple indent

# 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

 preformatted text is done with
 a '''space''' at the 
 ''beginning'' of the line

preformatted text is done with
a space at the 
beginning of the line

Paragraphs

MediaWiki ignores normal 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.

 this way, all markups are '''ignored'''

Template:Admin tip

Link Formatting

There are four sorts of links in MediaWiki:

1. internal links to other pages in the wiki
2. external links to other websites
3. interwiki links to other websites registered to the wiki in advance
4. Interlanguage links to other websites registered as other language versions of the wiki

Internal links

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. (If you really want to link to the current page, use an anchor (see below), or [[#top|current page]] which always links to the top.)

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

[[Main Page]]

[[Main Page|different text]]

#REDIRECT [[Main Page]]

[[#See also]]

[[Help:Images#See also]]

[[{{TALKPAGENAME}}|Discussion]]

[[/example]]

[[:Category:Help]]

[[media:example.jpg]]

[[media:example.pdf]]

External links

http://mediawiki.org

[http://mediawiki.org MediaWiki]

[http://mediawiki.org]

[http://en.wikipedia.org/wiki/.avi video]
[http://en.wikipedia.org/wiki/.wav sound]
[http://en.wikipedia.org/wiki/.pdf document]

[http://{{SERVERNAME}}/pagename]

[http://google.com/search?q={{PAGENAMEE}}]

[mailto:info@example.org email me]

[mailto:info@example.org?Subject=URL%20Encoded%20Subject&body=Body%20Text info]

Template:Admin tip Template:Admin tip

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>

Interwiki links

Interwiki links are links with the internal link markup to a website registered in advance. For example, you can link to the Sunflower article on http://en.wikipedia.org by typing [[wikipedia:Sunflower]], which will result in a link wikipedia:Sunflower. This is because http://en.wikipedia.org/wiki/ is registered to your wiki by default with the prefix of wikipedia. This link may not work properly, if the admin of your wiki has changed the setting.

Similar to internal page links, you can create piped links, with alternate link label, e.g. [[wikipedia:Sunflower|big yellow flower]].

Basically this is an abbreviation for longer URLs. A very similar link could be created as a normal external link by typing [http://en.wikipedia.org/wiki/Sunflower Sunflower], but interwiki links allow you to type out an easy and compact link, almost as if you are linking to a page on your own wiki.

Template:Admin tip

Interlanguage links

If your wiki has other language versions, you may find “interlanguage links” in the sidebar, just below toolbox in the box named “in other languages.”

Interlanguage links behave similar to interwiki links, except that they are listed in the sidebar. To create an interlanguage link from a page, just type [[language prefix:pagename]] wherever you like in the page; the language prefix is the prefix specified at your wiki for the other language version (typically the ISO language code).

If you want to make the interlanguage link to appear in the content of the page, you can add a colon before the language prefix, e. g. [[:en:Sunflower]].

Image Formatting

This page explains the image syntax when editing the wiki. You or another user must usually upload an image before you can use it on a page.

Syntax

The full syntax for displaying an image is:

 [[File:{file_name}|{options}]]

Where options can be zero or more of the following, separated by pipes:

• border, frame, thumb, or frameless: Controls how the image is formatted
• left, right, center, none: Controls the alignment of the image within a text
• baseline, 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 writing x{height}px
  • Note that the image will always retain its aspect ratio.
• link={destination}: Allows to link to an arbitrary title, URL or just nowhere (1.14+)
  • link= : Will display an image without link, e.g. [[File:Name.jpg|20px|link=Help:Images]] → File:Name.jpg.
  • Note that link cannot be used in conjunction with thumb as thumb is always meant to link to the larger version of the image. In addition, link cannot be used with frame.
• alt={alternative text}: For changing the alternative text (alt="") of an image (1.14+)
• 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.

Format

The following table shows the effect of all available formats.

When the height of an image in thumbnail is bigger than its width and you find it too outstanding, you may try the option upright, which will try to adjust its size to more desirable size.

Note that by writing thumb={filename}, you can use a different image for the thumbnail.

Alignment

Note that when using frame or thumb, the default alignment will be right.

Vertical alignment

text text [[File:Example.jpg|20px]]
text text [[File:Example.jpg|20px|baseline]]
text text [[File:Example.jpg|20px|sub]]
text text [[File:Example.jpg|20px|super]]
text text [[File:Example.jpg|20px|text-top]]
text text [[File:Example.jpg|20px|middle]]
text text [[File:Example.jpg|20px|bottom]]
text text [[File:Example.jpg|20px|text-bottom]]

results in (the text is underlined to show the result more clearly)

text text File:Example.jpg text text File:Example.jpg text text File:Example.jpg text text File:Example.jpg text text File:Example.jpg text text File:Example.jpg text text File:Example.jpg text text File:Example.jpg

Size and Frame

Among different formats, the effect of the size parameter may be different, as shown below.

• When the format is not specified, or only bordered, the size can be both reduced and enlarged.
• An image with frame always ignores the size specification.
• The size of an image with thumb and frameless can be reduced, but can not be enlarged beyond the original size of the image.

For how it appears when its size is not specified, see Format section above.

Stopping text flow

On occasion it is desirable to stop text from flowing around an image. Depending on the web browser's screen resolution and such, text flow on the right side of an image may cause a section header (for instance, == My Header ==) to appear to the right of the image, instead of below it, as a user may expect. The text flow can be stopped by placing <br style="clear: both" /> before the text that should start after the image. See Template:- for additional explanation.

Gallery of images

It's easy to make a gallery of thumbnails only, not other images, with the <gallery> tag. The syntax is:

<gallery>
File:Image Name.ext|caption
File:Image Name.ext|caption
{...}
</gallery>

Note that the image code is not enclosed in brackets when enclosed in gallery tags.

Captions are optional, and may contain wiki links or other formatting.

for example:

<gallery>
File:Example.jpg|Item 1
File:Example.jpg|a link to [[Help:Contents]]
File:Example.jpg
File:Example.jpg
File:Example.jpg| ''italic caption''
File:Example.jpg|on page "{{PAGENAME}}"
</gallery>

is formatted as:

Parameters

The gallery tag itself takes several additional parameters:

<gallery {parameters}>
{images}
</gallery>

• caption={caption}: sets a caption on the gallery.
• widths={width}px: sets the widths of the images.
• heights={heights}px: sets the (max) heights of the images.
• perrow={integer}: sets the number of images per row.

Links

Link to description page

If you put a colon (:) before File:, the image will not be embedded and the link will lead to the description page of the file.

[[:File:Example.jpg]]
[[:File:Example.jpg|Sunflowers]]

results in

File:Example.jpg Sunflowers

Link directly to file

You can use the pseudo-namespace “Media” to link directly to a file, bypassing the description page.

[[Media:Example.jpg]]
[[Media:Example.jpg|Sunflowers]]

results in

Media:Example.jpg Sunflowers

You can also use: 

[[Special:FilePath/Example.jpg]]

which can be used to link to a potential file, even if it doesn't exist. You can also use:

{{FILEPATH:Example.jpg}}

which generates an external URL to the file inline:

Requisites

Before using images in your page, the system administrator of your wiki must have Template:Mediawiki and a user has to upload the file. System administrators may also set the wiki to accept files from Template:Mediawiki, such as the Wikimedia Commons.

Files at other websites

You can link to an external file available online using the same syntax used for linking to an external web page.

[http://url.for/some/image.png]

Or with different text:

[http://url.for/some/image.png link text here]

If it is enabled on your wiki (see Template:Mediawiki), you can also embed external images. To do that, simply insert the image's url:

http://url.for/some/image.png

Tables

Tables may be authored in wiki pages using either XHTML table elements directly, or using wikicode formatting to define the table. XHTML table elements and their use are well described on various web pages and will not be discussed here. The benefit of wikicode is that the table is constructed of character symbols which tend to make it easier to perceive the table structure in the article editing view compared to XHTML table elements.

As a general rule, it is best to avoid using a table unless you need one. Table markup often complicates page editing.

Wiki table markup summary

{|

|+

|-

! 

|

|}

• 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!
• 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.
• Escaping to insert a pipe (|) character into a table use the <nowiki> markup

Basics

The following table lacks borders and good spacing but shows the simplest wiki markup table structure.

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

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

{|
! 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.

{|
|+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.

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

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

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

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

HTML colspan and rowspan

You can use HTML colspan and rowspan attributes on cells for advanced layout.

{| border="1"
!colspan="6"|Shopping List
|-
|rowspan="2"|Bread & Butter
|Pie
|Buns
|Danish
|colspan="2"|Croissant
|-
|Cheese
|colspan="2"|Ice cream
|Butter
|Yoghurt
|}

With HTML attributes and CSS styles

CSS style attributes can be added with or without other HTML attributes.

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

{| border="1" cellpadding="20" cellspacing="0"
|+ align="bottom" style="color:#e76700;" |''Food complements''
|-
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream 
|}

Caveats

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

CSS vs Attributes

Table borders specified through CSS rather than the border attribute will render incorrectly in a small subset of text browsers.