Documentation:Wiki Basics Handout

From UBC Wiki
Jump to: navigation, search

Formatting

Text

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
Ignore wiki markup <nowiki>no ''markup''</nowiki> no ''markup''
section formatting – only at the beginning of the line
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

Organizing

Headers & Lines

Description You type You get
section formatting – only at the beginning of the line (with no leading spaces)
Headings of different levels
=level 1=
==level 2==
===level 3===
====level 4====
=====level 5=====
======level 6======

Level 1 is normally set aside for the article title. 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 ----

Lists

Description You type You get
section formatting – only at the beginning of the line (with no leading spaces)
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

Links

Let's just say that there are many kinds of links. But they fall into two categories, internal and external.

Internal Links

Name a page with double square brackets and a link appears, if the link is blue that page already exists. If it's red it does not.

Description You type You get
Internal link
[[Main Page]]
Main Page
Link title
[[Main Page|different text]]
different text
Redirect
#REDIRECT [[Main Page]]

See also Help:Redirects

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 a subpage
[[/example]]

Shortcut for [[Help:Links/example]]. See also Help:Subpages.

/example
Internal link to a category page
[[:Category:Help]]

See also Help:Categories

Category:Help
Direct link to an image, pdf, or other file type (rather than linking to the file page)
[[media:example.jpg]]

[[media:example.pdf]]

See also Help:Adding Media

media:example.jpg

media:example.pdf

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

Currently supported extensions: ogm, avi, mpeg, mpg (video); ogg, mid, midi, mp3, wav, wma (audio); and pdf (document)

video
sound
document

Mailto link [mailto:info@example.org email me] email me

Media Formats

Help:Adding_Media/Images_and_Pictures

Conversion From Other Formats

Converting HTML to Wiki markup

Converting Documents (Word, RTF) to Wiki markup

Transclusion

This is a subpage to demonstrate transclusion. Think of this like a copy-paste of a page or subpage into another.

Uses Curly brackets in the form {{Pagename}}

Be careful though, if you don't specify a namespace and parent page the wiki will think you want to create a new template.
When you move a page to a new namespace the transclusion comes with it.

For more help look here.

Widgets

Think of these like ways of transcluding functions or web content from social media sites.