Difference between revisions of "Help:Contents"

Jump to: navigation, search

Difference between revisions of "Help:Contents"

Line 631: Line 631:
 
If no caption text is supplied, a caption is automatically created showing the file name.  To completely remove the caption, set it to <code><nowiki><span title=""></span></nowiki></code>. For example, <code><nowiki>[[File:Example.jpg|20px|<span title=""></span>]]</nowiki></code> renders as [[File:Example.jpg|20px|<span title=""></span>]].
 
If no caption text is supplied, a caption is automatically created showing the file name.  To completely remove the caption, set it to <code><nowiki><span title=""></span></nowiki></code>. For example, <code><nowiki>[[File:Example.jpg|20px|<span title=""></span>]]</nowiki></code> renders as [[File:Example.jpg|20px|<span title=""></span>]].
  
=== Format ===
+
For more help on images see [[http://www.mediawiki.org/wiki/Help:Images here]].
The following table shows the effect of all available formats.
 
 
 
{|class="wikitable plainlinks"
 
|-
 
!Description
 
!You type
 
!You get
 
{{Help:Images/frame|frame=|ex=no format specified|float=no|inline=yes}}
 
{{Help:Images/frame|frame=border|ex='''border''' results in a very small gray border|float=no|inline=yes}}
 
{{Help:Images/frame|frame=frameless|ex='''frameless''', like thumbnail, respect user preferences for image width, but without border and no right float|float=no|inline=yes}}
 
{{Help:Images/frame|frame=frameless|2=border|ex='''frameless''' and '''border'''|float=no|inline=yes}}
 
{{Help:Images/frame|frame=frame|ex='''frame'''|float=yes|inline=no}}
 
{{Help:Images/frame|frame=thumb|ex='''thumb''' or '''thumbnail'''|float=yes|inline=no}}
 
|}
 
 
 
When the height of an image in thumbnail is bigger than its width (i.e. in portrait orientation rather than landscape) and you find it too large, you may try the option <code>upright</code>, which will try to adjust its size to a more desirable size by reducing the height instead of the width. The alternative is to specify the desired maximum height (in pixels) explicitly.
 
 
 
Note that by writing <code>thumb={filename}</code>, you can use a different image for the thumbnail.
 
 
 
=== Size and frame ===
 
Among different formats, the effect of the size parameter may be different, as shown below.
 
* For how it appears when its size is not specified, see [[#Format|Format]] section above.
 
* When the format is not specified, or only <code>border</code>ed, the size can be both reduced and enlarged to any specified size.
 
* In the examples below, the original size of the image is 400 × 267 pixels.
 
* An image with <code>frame</code> always ignores the size specification, the original image will be reduced if it exceeds the maximum size defined in user preferences.
 
* The size of an image with <code>thumb</code> can be reduced, but can not be enlarged beyond the original size of the image.
 
 
 
{|class="wikitable"
 
|-
 
! Format !! Reduced !! Enlarged
 
{{Help:Images/size|frame=}}
 
{{Help:Images/size|frame=border}}
 
{{Help:Images/size|frame=frame}}
 
{{Help:Images/size|frame=thumb}}
 
{{Help:Images/size|frame=frameless}}
 
|}
 
 
 
=== Horizontal alignment ===
 
Note that when using the <code>frame</code> or <code>thumb[nail]</code> formats, the default horizontal alignment will be <code>right</code>.
 
 
 
{|class="wikitable"
 
|-
 
!Description
 
!You type
 
!You get
 
{{Help:Images/frame|2=100px|frame=|ex='''no horizontal alignment specified''', or default alignment|inline=yes|float=no}}
 
{{Help:Images/frame|2=100px|frame=none|ex=specify horizontal alignment as: '''none'''|inline=no|float=no}}
 
{{Help:Images/frame|2=100px|frame=center|ex=specify horizontal alignment as: '''center'''|inline=no|float=no}}
 
{{Help:Images/frame|2=100px|frame=left|ex=specify horizontal alignment as: '''left'''|inline=no|float=yes}}
 
{{Help:Images/frame|2=100px|frame=right|ex=specify horizontal alignment as: '''right'''|inline=no|float=yes}}
 
|}
 
 
 
=== Vertical alignment ===
 
The vertical alignment options take effect only if the image '''is''' rendered as an inline element and '''is not''' floating. They alter the way the inlined image will be vertically aligned with the text present in the same block before and/or after this image on the same rendered row.
 
 
 
Note that the rendered line of text where inline images are inserted (and the lines of text rendered after the current one) may be moved down (this will increase the line-height conditionally by additional line spacing, just as it may occur with spans of text with variable font sizes, or with superscripts and subscripts) to allow the image height to be fully displayed with this alignment constraint.
 
<div class="mw-collapsible mw-collapsed"><div class="mw-collapsible-toggle toccolours" style="float:none;text-align:center">'''{{Blue|Toggle source code view}}'''</div>
 
<div class="mw-collapsible-content">
 
<source lang="html4strict" enclose="div">
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''top:''' [[File:Example.jpg|20px|top]] [[File:Example.jpg|40px|top]] [[File:Example.jpg|40px|border|top]]
 
<del>text</del></u></span></p>
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''text-top:''' [[File:Example.jpg|20px|text-top]] [[File:Example.jpg|40px|text-top]] [[File:Example.jpg|40px|border|text-top]]
 
<del>text</del></u></span></p>
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
<sup>super:</sup> [[File:Example.jpg|20px|super]] [[File:Example.jpg|40px|super]] [[File:Example.jpg|40px|border|super]]
 
<del>text</del></u></span></p>
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''baseline:''' [[File:Example.jpg|20px|baseline]] [[File:Example.jpg|40px|baseline]] [[File:Example.jpg|40px|border|baseline]]
 
<del>text</del></u></span></p>
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
<sub>'''sub:'''</sub> [[File:Example.jpg|20px|sub]] [[File:Example.jpg|40px|sub]] [[File:Example.jpg|40px|border|sub]]
 
<del>text</del></u></span></p>
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''default:''' [[File:Example.jpg|20px]][[File:Example.jpg|40px]] [[File:Example.jpg|40px|border]]
 
<del>text</del></u></span></p>
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''middle:''' [[File:Example.jpg|20px|middle]] [[File:Example.jpg|40px|middle]] [[File:Example.jpg|40px|border|middle]]
 
<del>text</del></u></span></p>
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''text-bottom:''' [[File:Example.jpg|20px|text-bottom]] [[File:Example.jpg|40px|text-bottom]] [[File:Example.jpg|40px|border|text-bottom]]
 
<del>text</del></u></span></p>
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''bottom:'' [[File:Example.jpg|20px|bottom]] [[File:Example.jpg|40px|bottom]] [[File:Example.jpg|40px|border|bottom]]
 
<del>text</del></u></span></p>
 
</source></div></div>
 
 
 
To show the alignment result more clearly, the text spans are overlined and underlined, the line-height is increased to 200% of the font-height, the font-height is emphasized with a yellow background covering the line margins, and the full line-height is shown with a dark gray border; additionally images of different sizes are aligned, including one with an additional border that adds some pixels to its specified dimensions and slightly changes its vertical alignment:
 
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''top:''' [[File:Example.jpg|20px|top]] [[File:Example.jpg|40px|top]] [[File:Example.jpg|40px|border|top]]
 
<del>text</del></u></span></p>
 
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''text-top:''' [[File:Example.jpg|20px|text-top]] [[File:Example.jpg|40px|text-top]] [[File:Example.jpg|40px|border|text-top]]
 
<del>text</del></u></span></p>
 
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
<sup>'''super:'''</sup> [[File:Example.jpg|20px|super]] [[File:Example.jpg|40px|super]] [[File:Example.jpg|40px|border|super]]
 
<del>text</del></u></span></p>
 
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''baseline:''' [[File:Example.jpg|20px|baseline]] [[File:Example.jpg|40px|baseline]] [[File:Example.jpg|40px|border|baseline]]
 
<del>text</del></u></span></p>
 
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
<sub>'''sub:'''</sub> [[File:Example.jpg|20px|sub]] [[File:Example.jpg|40px|sub]] [[File:Example.jpg|40px|border|sub]]
 
<del>text</del></u></span></p>
 
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''default:''' [[File:Example.jpg|20px]] [[File:Example.jpg|40px]] [[File:Example.jpg|40px|border]]
 
<del>text</del></u></span></p>
 
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''middle:''' [[File:Example.jpg|20px|middle]] [[File:Example.jpg|40px|middle]] [[File:Example.jpg|40px|border|middle]]
 
<del>text</del></u></span></p>
 
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''text-bottom:''' [[File:Example.jpg|20px|text-bottom]] [[File:Example.jpg|40px|text-bottom]] [[File:Example.jpg|40px|border|text-bottom]]
 
<del>text</del></u></span></p>
 
 
 
<p style="border:1px solid #AAA;background:#FF0;padding:0;font-size:150%;line-height:2">
 
<span style="background:#FFF;color:#000;text-decoration:overline"><u><del>text</del>
 
'''bottom:''' [[File:Example.jpg|20px|bottom]] [[File:Example.jpg|40px|bottom]] [[File:Example.jpg|40px|border|bottom]]
 
<del>text</del></u></span></p>
 
 
 
Notes:
 
# The "middle" vertical alignment position of the image (which is also the default) usually refers to the middle between the x-height and the baseline of the text (on which the vertical middle of the image will be aligned, and on which usually the text may be overstroke), but not to the middle of the line-height of the font-height that refers to the space between the "text-top" and "text-bottom" positions ; the font-height excludes:
 
#* the additional line separation spacing normally divided equally into two line-margins (here 0.5em, according to line-height set to 200%) above and below the font-height).
 
#* the additional line spacing which may be added by superscripts and subscripts.
 
# However, if the image height causes its top or bottom position to go above or below the normal full line-height of text, the middle position will be adjusted after the increasing the top and/or bottom line-margins so that the image can fit and align properly, and all images (including those with smaller heights) will be vertically centered on the adjusted middle position (for computing the effective line-height, the text of each rendered row with the larger font-height will be considered).
 
# The "text-top" and "text-bottom" alignment positions also excludes the extra line spacing added by superscripts and subscripts, but not the additional line-spacing defined by the line-height.
 
# The "top" and "bottom" alignment positions take into account all these extra line spacings (including superscripts and subscripts, if they are present in a rendered line span). When the image alignment constrains the image to grow above or below the normal line-spacing, and the image is not absolutely positioned, the image will cause the "top" and "bottom" positions to be adjusted (just like superscripts and subscripts), so the effective line-height between rendered lines of text will be higher.
 
# The "underline", "overline" and "overstrike" text-decoration positions should be somewhere within these two limits and ''may'' depend on the type and height of fonts used (the superscript and subscript styles may be taken into account in some browsers, but usually these styles are ignored and the position of these decorations may not be adjusted); so these decorations normally don't affect the vertical position of images, relatively to the text.
 
 
 
=== Stopping the text flow ===
 
On occasion it is desirable to stop text (or other inline non-floating images) from flowing around a floating 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, <nowiki>== My Header ==</nowiki>) 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 '''<nowiki><br style="clear: both" /></nowiki>''' before the text that should start below the floating image.
 
 
 
All images rendered as blocks (including non-floating '''center'''ed images, '''left'''- or '''right'''-floating images, as well as '''framed''' or '''thumbnail'''ed floating images) are implicitly breaking the surrounding lines of text (terminating the current block of text before the image, and creating a new paragraph for the text after them). They will then stack vertically along their left or right alignment margin (or along the center line between these margins for '''center'''ed images).
 
 
 
=== Altering the default link target ===
 
The following table shows how to alter the link target (whose default is the image description page) or how to remove it. Changing the link does not alter the format described in the previous sections.
 
 
 
{|class="wikitable plainlinks"
 
|-
 
!Description
 
!You type
 
!You get
 
{{Help:Images/frame|2=link=Main Page|ex=internal link}}
 
{{Help:Images/frame|2=link=http://wikipedia.org/wiki/Test|ex=external link}}
 
{{Help:Images/frame|2=link=|ex=no link (external or file page)}}
 
|}
 
 
 
'''Warning :'''
 
: The licencing requirements on your wiki may not allow you to remove all links to the description page that displays the required authors attributions, the copyrights statements, the applicable licencing terms, or a more complete description of the rendered image (including its history of modifications).
 
: If you change or remove the target link of an image, you will then have to provide somewhere else on your page an explicit link to this description page, or to display the copyright and author statement and a link to the applicable licence, if they are different from the elements applicable to the embedding page itself.
 
: Your wiki policy may restrict the use of the alternate link parameter, or may even enforce a prohibition of alternate link parameters for embedded media files (in which case, the link parameter will be ignored), or may only accept them after validation by authorized users or administrators.
 
 
 
== Rendering a gallery of images ==
 
 
 
=== Gallery syntax ===
 
It's easy to make a gallery of thumbnails with the <code><nowiki><gallery></nowiki></code> tag. The syntax is:
 
<nowiki><gallery></nowiki>
 
Image:file_name.ext|caption
 
Image:file_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:
 
<nowiki><gallery></nowiki>
 
File:Example.jpg|Item 1
 
File:Example.jpg|a link to <nowiki>[[Help:Contents]]</nowiki>
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg| <nowiki>''italic caption''</nowiki>
 
File:Example.jpg|on page "<nowiki>{{PAGENAME}}</nowiki>"
 
</gallery>
 
is formatted as:
 
<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>
 
 
 
=== Optional gallery attributes ===
 
The gallery tag itself takes several additional parameters, specified as attribute name-value pairs:
 
 
 
<pre><gallery {parameters}>
 
{images}
 
</gallery></pre>
 
 
 
* <code>caption={caption}</code>: sets a caption on the gallery.
 
* <code>widths={width}px</code>: sets the widths of the images, default 120px. ''Note the plural, width'''s'''''
 
* <code>heights={heights}px</code>: sets the (max) heights of the images.
 
* <code>perrow={integer}</code>: sets the number of images per row.
 
* <code>showfilename={anything}</code>: Show the filenames of the images in the individual captions for each image (1.17+)
 
 
 
Example:
 
 
 
Coding:
 
<pre>
 
<gallery widths=60px heights=60px perrow=7 caption="sunflowers are groovy">
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
</gallery>
 
</pre>
 
 
 
Result:
 
<gallery widths=60px heights=60px perrow=7 caption="sunflowers are groovy">
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
File:Example.jpg
 
</gallery>
 
 
 
== Linking to an image without displaying it ==
 
=== Link to description page ===
 
If you put a colon (<code>:</code>) before <code>{{ns:image}}:</code>, the image will not be embedded and the link will lead to the description page of the file.
 
 
 
<nowiki>[[</nowiki>:{{ns:image}}:{{mediawiki:image_sample}}]]
 
<nowiki>[[</nowiki>:{{ns:image}}:{{mediawiki:image_sample}}|Sunflowers]]
 
 
 
results in
 
 
 
[[:{{ns:image}}:{{mediawiki:image_sample}}]]
 
[[:{{ns:image}}:{{mediawiki:image_sample}}|Sunflowers]]
 
 
 
=== Link to another page ===
 
{{note|link '''does not work with''' thumb '''or''' frame.}}
 
This will make a 50px width picture with a link to the page [[MediaWiki]]:
 
 
 
<nowiki>[[</nowiki>File:Wiki.png|50px|link=MediaWiki]]
 
 
 
[[File:Wiki.png|50px|link=MediaWiki]]
 
 
 
=== Link directly to the media file ===
 
You can use the pseudo-namespace “{{ns:media}}” to link directly to a file without rendering it, bypassing the description page.
 
 
 
<nowiki>[[</nowiki>{{ns:media}}:{{mediawiki:image_sample}}]]
 
<nowiki>[[</nowiki>{{ns:media}}:{{mediawiki:image_sample}}|Sunflowers]]
 
 
 
results in
 
 
 
[[{{ns:media}}:{{mediawiki:image_sample}}]]
 
[[{{ns:media}}:{{mediawiki:image_sample}}|Sunflowers]]
 
 
 
The same result can be achieved by adding a colon before the namespace (works with categories too):
 
 
 
<nowiki>[[:</nowiki>{{ns:image}}:{{mediawiki:image_sample}}]]
 
 
 
You can also use:&nbsp;
 
 
 
<nowiki>[[</nowiki>{{#special:Filepath}}/{{mediawiki:image_sample}}]]
 
 
 
which can be used to link to a potential file, even if it doesn't exist. You can also use:
 
 
 
<nowiki>{{</nowiki>FILEPATH:{{mediawiki:image_sample}}<nowiki>}}</nowiki>
 
 
 
which generates an external URL to the file inline: {{FILEPATH:{{mediawiki:image_sample}}}}
 
 
 
== Requisites ==
 
Before using images in your page, the system administrator of your wiki must have {{mediawiki|Manual:Configuring file uploads|enabled file uploads}} and a user has to [[Help:Managing files|upload the file]]. System administrators may also set the wiki to accept files from {{mediawiki|Manual:Image Administration#Foreign Repositories|foreign repositories}}, such as the [http://commons.wikimedia.org/wiki/Main_Page Wikimedia Commons]. For server side image resizing it is necessary to have a scaler configured (such as GD2, ImageMagick, etc.).
 
 
 
== 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.  With these syntaxes, the image will not be rendered, but only the text of the link to this image will be displayed.
 
<pre>[http://url.for/some/image.png]</pre>
 
 
 
Or with a different displayed text:
 
<pre>[http://url.for/some/image.png link text here]</pre>
 
 
 
Additional MediaWiki markup or HTML/CSS formatting (for inline elements) is permitted in this displayed text (with the exception of embedded links that would break the surrounding link):
 
<pre>[http://www.example.com/some/image.png Example '''<del>rich</del>''' ''<ins>link text</ins>'' here.]</pre>
 
which renders as: [http://www.example.com/some/image.png Example '''<del>rich</del>''' ''<ins>link text<ins>'' here.]
 
 
 
If it is enabled on your wiki (see {{mediawiki|Manual:$wgAllowExternalImages}}), you can also embed external images. To do that, simply insert the image's url:
 
<pre>http://url.for/some/image.png</pre>
 
Currently, embedded images cannot be resized, but they may be formatted by surrounding MediaWiki markup or HTML/CSS code.
 
 
 
If this wiki option is not enabled, the image will not be embedded but rendered as a textual link to the external site, just like above.
 

Revision as of 22:52, 27 February 2012

1 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 2 ==

=== Level 3 ===

==== Level 4 ====

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

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


  • Skip Level 1 it is page name level.
  • An article with 4 or more headings automatically creates a table of contents.

2 Level 2

2.1 Level 3

2.1.1 Level 4

2.1.1.1 Level 5
2.1.1.1.1 Level 6
Horizontal rule
Text above
----
Text below

Text above


Text below

Bullet list
* Start each line
* with an [[Wikipedia:asterisk|asterisk]] (*).
** More asterisks gives deeper
*** and deeper levels.
* Line breaks<br/>don't break levels.
*** But jumping levels creates empty space.
Any other start ends the list.
  • Start each line
  • with an asterisk (*).
    • More asterisks gives deeper
      • and deeper levels.
  • Line breaks
    don't break levels.
      • But jumping levels creates empty space.

Any other start ends the list.

Numbered list
# Start each line
# with a [[Wikipedia:Number_sign|number sign]] (#).
## More number signs gives deeper
### and deeper
### levels.
# Line breaks<br/>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.
  1. Start each line
  2. with a number sign (#).
    1. More number signs gives 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.

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
Indent text
: Single indent
:: Double indent
::::: Multiple indent
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 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

  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
Preformatted text
 Start each line with a space.
 Text is '''preformatted''' and
 ''markups'' '''''can''''' be done.

Start each line with a space.
Text is preformatted and
markups can be done.
Preformatted text blocks
 <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>
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

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

4 HTML tags

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
Inserted
(Displays as underline in most browsers.)
<ins>Inserted</ins>

or

<span style="text-decoration: underline;">Underline</span>

Inserted

or

Underline

Deleted
(Displays as strikethrough in most browsers.)
<del>Deleted</del>

or

<span style="text-decoration:line-through;">Deleted</span>

Deleted

or

Deleted

Fixed width text
<code>Source code</code>

or

<tt>Fixed width text</tt>

Source code

or

Fixed width text

Blockquotes
text above
text above
<blockquote>blockquote</blockquote>
text below
text below

text above text above

blockquote

text below text below

Comment
<!-- This is a comment -->
Comments are only visible
in the edit window.

Comments are only visible in the edit window.

Completely preformatted text
<pre> Text is '''preformatted''' and
''markups'' '''''cannot''''' be done</pre>

 Text is '''preformatted''' and
''markups'' '''''cannot''''' be done
Customized preformatted text
<pre style="color:red">
Text is '''preformatted'''
with a style and
''markups'' '''''cannot''''' be done
</pre>

Text is '''preformatted'''
with a style and
''markups'' '''''cannot''''' be done
Customized preformatted text with text wrap according to screen width
<pre style="white-space: pre-wrap">
This longer sentence is used to demonstrate text wrapping. </pre>
This longer sentence is used to demonstrate text wrapping.

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



Description You type You get
Internal link
[[Main Page]]
Main Page
Piped link
[[Main Page|different text]]
different text
Hide namespace shortcut
[[Help:Contents|]]

Short for [[Help:Contents|Contents]]

Contents
Word-ending links
[[Help]]s

[[Help]]ing

[[Help]]ers

[[Help]]anylettersyoulikehere

Helps

Helping

Helpers

Helpanylettersyoulikehere

Avoiding word-ending links
[[Help]]<nowiki />ful advice

[[wikipedia:GNU General Public License|GPL]]<nowiki />v3

Helpful advice

GPLv3

Redirect
#REDIRECT [[Main Page]]
Main Page
Internal link to an anchor
[[#See also]]

Section headings and the top of the page are automatically anchored.

#See also
Internal link to an anchor from different text
[[#See also|different text]]
different text
Setting an internal link anchor
<div id="NameOfAnchorHere">optional text</div>

Omit the "optional text" for invisible anchor.

optional text
Internal link to an anchor at another page
[[Help:Images#See also]]
Help:Images#See also
Internal link to the current page's talk page
[[{{TALKPAGENAME}}|Discussion]]
Discussion
Internal link to a category page
[[:Section:Help]]
Section:Help
Internal link to an image or a file of other types
[[media:example.jpg]]

[[media:example.pdf]]

See also Help:Images

media:example.jpg

media:example.pdf

Internal link to the user's user page
[[Special:MyPage]]
Special:MyPage

6 External links

To add an external link, enclose the name of the page you want to link to in single square brackets. When you save the page, you'll see the new link pointing to your page, with an arrow icon after it to show that it was coded with single bracket external link syntax, and thus may lead to another site.

Description You type You get
External link http://mediawiki.org http://mediawiki.org
External link with different label [http://mediawiki.org MediaWiki] MediaWiki
Numbered external link [http://mediawiki.org] [1]
External links with file icons [http://en.wikipedia.org/wiki/.avi video] [http://en.wikipedia.org/wiki/.ogg sound] [http://en.wikipedia.org/wiki/.pdf document]

See external link icons for currently supported icons and extensions.

video
sound
document

External link to the same host http://{{SERVERNAME}}/pagename http://rpm.rcabc.org/pagename
External link to other host passing the pagename http://google.com/search?q={{PAGENAMEE}}
http://google.com/search?q=Contents
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

6.1 External links to internal pages

To add a link to a page on the same wiki using URL query parameters, you may need to use external link syntax.

Description You type You get
External link to the current page's edit page
[http://www.mediawiki.org/w/index.php?title=Help:Links&action=edit Edit]
Edit
External link to the current page's edit page using the fullurl parser function
[{{fullurl:{{PAGENAME}}|action=edit}} Edit]

See also Help:Magic_words#URL_data and #External links

Edit
External link to the current page's edit page, and styled to look like an internal link
<span class="plainlinks">[http://www.mediawiki.org/w/index.php?title=Help:Links&action=edit Edit]</span>

The plainlinks class can be used in cases where you want an external link to look like an internal one, by suppressing the icon that normally appears after it.

Edit

6.2 External link icons

Test link Icon Trigger
[2] external-link-ltr-icon.png .external, http://, gopher://
[3] lock-icon.png https://
[4] mail-icon.png mailto:
[5] news-icon.png news://
[6] file-icon.png ftp://
[7] talk-icon.png irc://
[8] audio-icon.png .ogg, .mid, .midi, .mp3, .wav, .wma
[9] video-icon.png .ogm, .avi, .mpeg, .mpg
[10] document-icon.png .pdf, .pdf#, .pdf?

6.3 How to avoid auto-links

When you put a URL on a wiki page it will be automatically converted into an external link, like this:

http://mediawiki.org

To avoid that effect, put the URL between <nowiki> tags, like this:

<nowiki>http://mediawiki.org</nowiki>

To get this:

http://mediawiki.org

7 Images

Images that are stored on a MediaWiki server are usually rendered by using the File: namespace prefix (but the legacy Image: namespace prefix is still supported as a synonym) as the target of a MediaWiki link. The alternate Media: namespace prefix is also usable to reference the original media file content (for rendering or downloading it separately, out of any MediaWiki page).

8 Supported media types for images

The following file formats are supported by default:

  • .jpg or .jpeg : bitmap image compressed in the standard JPEG format (this lossy format is most suitable for photographs).
  • .png : bitmap image in the Portable Network Graphics format (specified by the W3 Consortium).
  • .gif : bitmap image in the legacy Graphics Interchange Format.

Other formats used on Wikimedia, and commonly enabled elsewhere (these may require extra set-up beyond what is enabled by default):

  • .svg : scalable image in the Scalable Vector Graphics format (specified by the W3 Consortium).
  • .tiff : Tagged image format. Often used for high-resolution archival photographs. <-- Often used with Template:Mediawiki. -->
  • .ogg, .oga, .ogv : Ogg multimedia (audio or video) Not an image format, but treated similarly. <-- Often used with Template:Mediawiki -->
  • .pdf : multipaged documents in the Portable Document Format (initially specified by Adobe). <-- Often used in conjunction with Template:Mediawiki -->
  • .djvu : multipaged bitmap documents in the DejaVu format (most often, scans of books). <-- See Template:Mediawiki -->
    Only a single page of a .pdf or .djvu file is shown at one time.

Other media types may be supported, but it may not be possible to display them inline.

9 Rendering a single image

9.1 Syntax

The full syntax for displaying an image is:

[[File:filename.extension|options|caption]]

where options can be zero or more of the following, separated by pipes (|):

  • Format option: one of border and/or frameless, frame, thumb (or thumbnail);
    Controls how the rendered image is formatted and embedded in the rest of the page.
  • Resizing option: one of
    • {width}px — Resizes the image to fit within the given maximum width in pixels, without restricting its height;
    • x{height}px — Resizes the image to fit within the given maximum height in pixels, without restricting its width;
    • {width}x{height}px — Resizes the image to fit within the given width and height in pixels;
    • upright — Resizes an image to fit within reasonable dimensions, according to user preferences (suitable for images whose height is larger than width).
    Note that the image will always retain its aspect ratio, and can only be reduced (not increased) in size unless it's in a scalable media type (bitmap images cannot be scaled up).
    The default maximum size depends on the format and the internal image dimensions (according to its media type).
  • Horizontal alignment option: one of left, right, center, none;
    Controls the horizontal alignment (and inline/block or floating styles) of the image within a text (no default value).
  • Vertical alignment option: one of baseline, sub, super, top, text-top, middle, bottom, text-bottom;
    Controls the vertical alignment of a non-floating inline image with the text before or after the image, and in the same block (the default vertical alignment is middle).
  • Link option: one of
    • link={target} — Allows to change the target (to an arbitrary page title, or URL) of the generated link, activable on the rendered image surface; e.g. [[File:Example.jpg|20px|link=http://www.wikipedia.org]] renders as Example.jpg (external link), or [[File:Example.jpg|20px|link=MediaWiki]] renders as Example.jpg (internal link).
    • link= (with an empty value) — (Template:Mediawiki) Displays an image without any activable link; e.g. [[File:Example.jpg|20px|link=]] renders as Example.jpg.
! Link does not work with thumb, thumbnail or frame.
  • Other specific options:
    • alt={alternative text} — (Template:Mediawiki) Defines the alternative text (maps to the HTML attribute alt="..." of the generated <image /> element) of an image that will be rendered if either the referenced image cannot be downloaded and embedded, or if the support media must use the alternative description text (e.g. when using a Braille reader or with accessibility options set by the user in its browser).
    • page={number} — Renders the specified page number (currently only applicable when showing a .djvu or .pdf 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 (or thumbnail); frameless and/or border.

If a parameter does not match any of the other possibilities, it is assumed to be the caption text. Caption text shows below the image in thumb and frame formats, or as mouseover text in border, frameless formats or when the format is omitted. Caption text displayed in the thumb and frame formats may contain wiki links and other formatting. In the other options, wiki-formatting will not work though transclusion will.

If no caption text is supplied, a caption is automatically created showing the file name. To completely remove the caption, set it to <span title=""></span>. For example, [[File:Example.jpg|20px|<span title=""></span>]] renders as .

For more help on images see [here].