Help:Wiki markup

From ProgSoc Wiki

Jump to: navigation, search

Below is a list of wiki markup that people are more likely to want to use. This is not a complete list of everything you can do, but should server for as a starting point for people that don't want to read all the wikimedia documentation. There are links to more detailed information in the External links section.

Contents

HTML

Avoid using HTML in your page creation/editing. There is wiki markup to accomplish most of what you would do with HTML. Adding HTML to pages can make them harder to edit/add to, especially when using compressed HTML.

Case sensitive

Remember that links, rategories, templates and redirects in the wiki are case sensitive (except for the first letter).

Table of Contents

The table of contents is created automatically when there are 4 heading tags in the page. The wiki will create a hierarchical table using the different levels of headings.

If you want to create a table of contents when there are less than 4 headings insert the following code where you want the table to appear:

__toc__

Headings

Heading are created by putting equal signs around text. They make the text larger, bold, and underlined or italic, depending on the level of the heading.

You can use up to 4 levels of headings:

= Heading 1 =
== Heading 2 ==
=== Heading 3 ===
==== Heading 4 ====

Paragraph and Break

Avoid using the html paragraph <p> and break <br> tags.

To create a paragraph in the wiki leave a blank line. You generally don't need breaks as list insert them automatically, and you might be better off making a paragraph break in other circumstances.

Bold and Italics

Bold is created by using3 single quotes

'''Blod'''

Italic is created by using 2 single quotes.

''Italic''

And 5 single quotes produces Bold and Italic.

Categories

On the wiki pages can be put into categories. Actually it would be best if pages are put into at lease one category.

Please have a look at the existing categories and see if your page fits in one of them, before adding extra categories.

You assign a category to a page using the following markup:

[[Category: Category name]]

Category sort order

You can change how a page (or category) is sorted in a category by using a pipe '|' and alternate name after the name.

[[Category: My Category|Page name]]

Links

Links (Internal)

You create links to other pages by surrounding words with double square brackets.

[[word]]

Link with different text displayed

You can create links to a page that displays different text by putting a pipe '|' between the link and the text to display.

[[A page|text displayed]]

Links to anchors/headings

You can link to heading on pages as HTML anchors. To do so just a hash '#' followed by the heading name. This works both internal to a page and to anchors on other pages.

[[#heading|display text]]
[[page#heading|display text]]

Links to a category

You can link to a category, without having the page appear in the category by preceding the word category with a colon ':'.

[[:Category: A category|A category]]

Links (External)

You create external links but putting single square brackets around a url followed by the link text

[http://www.some.url/page.html Link text]

Quotes

Quotation, those things in blue boxes, are created by putting a space as the first character of a line.

Quote

Lists

Below is information for crating bulleted, numbered and definition lists. It is possible to create a hierarchy using multiple list types.

Bulleted lists

To create butteted lists insert stars '*' at the beginning of the line. Use multiple stars for nestled lists.

* text
* text
**  text
** text
* text
  • text
  • text
    • text
    • text
  • text

Numbered lists

To create a numbered list insert hashes '#' at the beginning of the line. Use multiple hashes for nestled lists.

# text
# text
##  text
## text
# text
  1. text
  2. text
    1. text
    2. text
  3. text

Definition lists

To create a definition list insert a semi-colon ';' at the beginning of the line for the item. And inserting a colon ':' for the definition. You can also put the item and the definition on the same line.

; item
: definition
; another item :  definition two
item
definition
another item 
definition two

Images

Images that are uploaded to the wiki are added to pages using the following code.

[[Image:image_name.jpg]]

You can specify other attributes for the image by separating them with a pipe '|'. For example the following sets the image to float right, resixe to 200px and sets the alternate text.

[[Image:image_name.jpg|right|200px|alt=My great image]]

For more details best go read the wikipedia documentsion. (see external links)

Nowiki

If you want to use wiki markup without it being converted surround the test with <nowiki> tags.

Redirect

If you need to redirect one page to another, eg different capitalisation of the same word, you use the '#redirect' markup.

Replace the contents of the page with the #redirect markup, followed by a link to the page to redirect to.

#redirect [[New page]]

Templates

If there are common elements across a number of pages, rather than reproduce that text on every page, it can become a template page that is included on each page. Templates can be useful, but I'm not going to tell you have to create them in this simple markup guide, just how to use them.

Templates are included by including the template name with double curly brackets around it.

{{my template}}

Stub

The stub template is used to mark a page as being incomplete.

Add the following to the end of the page:

{{stub}}

External links

Personal tools