Help:Contents

From wiki.gpii
Jump to: navigation, search

See also WIKI FOR BEGINNERS - QUICK HINTS.

If you want to test things out, please use the Sandbox page.


Wikipedia defines a wiki "a web application which allows people to add, modify, or delete content in collaboration with others". In a typical wiki, text is written using a simplified markup language (known as "wiki markup") or a rich-text editor.

The GPII wiki uses MediaWiki as wiki engine. This is the same engine that powers Wikipedia, Wiktionary and many other wikis. This page summarises a few basics of editing wiki pages.

You can switch between wiki markup (default, more like TeX) and the Wiki Text Editor (more like Word) using the "[Show RichTextEditor]" link directly above the editing area (if it does not show try going to Special:Preferences and restoring the default settings).

To get started, look at existing pages by clicking "Edit" on them or look at Wikitext examples. Remember that you cannot really destroy anything as all changes can be reverted.

Creating Your First Page

Use the wiki to document your work by creating your own pages. There are two ways:

  • Go on another page and create a link to a nonexisting page with [[New Page Name]] (replace text in double brackets with your chosen page name and see editing below).
  • Enter the new page URL directly into the browser URL bar http://wiki.gpii.net/w/New_Page_Name (replace last part with your freely chosen page name with underscores instead of spaces, be sure to eventually link this page somewhere, e.g. also by adding a category, see also guidelines below)

Editing Content

Headings

Creating headings using wiki markup:

  • == Heading Text == creates a level 2 heading (h2)
  • === Heading Text === creates a level 3 heading (h3)
  • ==== Heading Text ==== creates a level 4 heading (h4)
  • ===== Heading Text ===== creates a level 5 heading (h5)
  • ====== Heading Text ====== creates a level 6 heading (h6)

Creating headings using the visual editor:

  • choose a heading level (2 to 6) from the drop-down list.

Level 1 headings are reserved for the title of the page.

Table of Contents

A page with four or more headings automatically creates a table of contents at the top of the page.

If a page has fewer than four headings, you can still force a table of contents by adding either __FORCETOC__ or __TOC__ where you want the table of contents to appear.

Alternatively, you can suppress the creation of a table of contents by adding the code __NOTOC__ to the markup.

Lists

Simple Lists

There are three types of listed: numbered lists, unnumbered lists and definition lists.

  • For numbered lists, put each list item on a new line preceded by #:
    # list item. (There must be no space before the #.)
  • For unnumbered lists, put each list item on a new line preceded by *:
    * list item. (There must be no space before the *.)

Nested Lists

To create sublists, you can use the following syntax:

* list item
** second level
*** third level

This creates the following list:

  • list item
    • second level
      • third level

You can also combine list types, e.g.:

# list item
#* second level
#* second level
  1. list item
    • second level
    • second level

Definition Lists

Definition lists use the following type of syntax:

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

The above code results in the following definition list:

item 1
definition 1
item 2
definition 2-1
definition 2-2

Links

There are several types of links.

  • Links to other wiki pages: use the syntax [[Title of Target Page]] (note the double square brackets) or use the button "Internal link" on the editor toolbar.
    • If the link text needs to be different from the title of the target page, use the syntax [[Title of Target Page | linktext]]. (Note the vertical bar character before the linktext).
    • For links to a specific heading in a wiki page, use the syntax [[Title of Target Page#Heading-ID | linktext]]. You can find the heading ID by clicking on the heading in the table of contents at the top of the target page: take the part of the URL that starts with # and add it to the page title.
    • Wiki links that refer to a non-existing page will appear red. The wiki has a list of wanted pages or red links.
  • Links to pages outside the wiki: use the syntax [http//example.com/index.html linktext]. For example, the code [http://gpii.net/ the GPII web site] creates the link the GPII web site.
  • Links to uploaded files:
    • Documents (PDF, etc): use the syntax [[File:File.pdf]] (there is no way to add an alternative linktext).
    • Other media (e.g. video): use the syntax [[Media:File.ogg]].

Adding Images

To add an image to a page, first upload it to the wiki (see below: Uploading Files), then link to the uploaded file:

  • full size: use the syntax [[File:File.jpg]].
  • as thumbnail: use the syntax [[File:File.png|200px|thumb|left|alt text]].

Text Formatting

To make text bold, use the syntax '''bold text''' or use the "Bold text" button on the editor toolbar.

To create text in italics, use the syntax ''italics'' or use the "Italic text" button on the editor toolbar.

To make text both bold and italic, combine the two preceding techniques: '''''bold and italic'''''.

To avoid that example links (e.g. in program code) are turned into real links, use the syntax <nowiki>Insert non-formatted text here</nowiki> or use the button "Ignore wiki formatting" on the editor toolbar. The same technique can also be used for other code that must not be interpreted as wiki code by the wiki engine.

Displaying Source Code

There are several options for displaying code:

  • for inline code <code>...</code> is a good option;
  • for code blocks, you can use <pre>...</pre>.
  • (The tags <syntaxhighlight lang="...">...</syntaxhighlight> and <source lang="...">...</source> no longer work on this wiki.)

<pre>...</pre> has the following effect:

function factorial(n) {
    if (n === 0) {
        return 1;
    }
    return n * factorial(n - 1);
}

Tables

TODO; check Help:Table on Wikimedia's Meta-Wiki.

Other Actions

Uploading Files

To upload a file, use the link "Upload file" at the bottom of the left-hand link menu (under "Tools"). The process should be self-explanatory...

The wiki has a list of uploaded files.

Moving or Renaming a Page

Since the name or title of a page determines its URL, moving and renaming a page are the same thing. To move a page, use the menu with the down arrow at the top of the page (between "View history" and the search field). Select "Move" and choose a new title for the page. The wiki will automatically create a redirect page, so links to the old page will be automatically redirected to the new page. (The wiki has a list of redirects).

This method carries over the history of the old page to the new page. Never move a page by copying the content of the old page to the new page and blanking the old page, since this does not carry over the history of the old page.

To create a redirect, you can use the following wiki syntax:

#REDIRECT [[Title of new page]]

To create a redirect to a category page, you can use the following wiki syntax:

#REDIRECT [[:Category:Title of category]]

Categorising a Page

You can group pages by adding them to a category. To add a page to a category, use the syntax [[Category:Name of category]] at the bottom of the page.

Categories appear as links at the bottom of the page; each of these links takes you to a special page that lists all the other pages in the same category.

When the category is new, the link (which will be read) will lead to a non-existing page. You can create the category page by adding a description of the category. The resulting page will then also display the list of pages in the category.

A page can be in more than one category. You can also categorise the category pages themselves, simply by adding a supercategory at the bottom of the page. Examples on this wiki: the categories and are both subcategories of . Note that this example treats Matchmaking as a topic relevant to all of GPII, while the workpackages include the project name to avoid name conflicts with workpackages from other projects.

The project categories of the funded Prosperity4All project are named P4A/{SHORT NAME} and are organized hierarchically below Category:P4A to allow tracking. To crosslink to DoW categories and not to confuse outsiders such categories can also be added to the discussion pages as a best practice.

Categories are also used to provide automatic component listings. Modular components (Building blocks, Tools, Services) that are part of the Developer Space are assigned to Category:Developer Space/Components using categorizations intuitive towards users(=other developers). If you look at the wiki source, you can see that here a template is used to do the categorization automatically.

To sum up Categories can be used to mark pages as (relevant to) project deliverables, work packages, etc. and to provide automatically updated collections and listing (backward linking)

Note: Adding a page to a category does not absolve you from making sure that there is a navigation path from the home page to the categorised page. (See the general guidelines.)

Watching a Page

You can track the changes to a page by adding it to your "watch list". Go to the menu with the down arrow at the top of the page and select "Watch". You can then go the the Watchlist (see the top of the page) to see a list of recent changes to pages that you are tracking.

There is no mechanism to get notified of changes by e-mail. However, you can subscribe to an RSS feed for recent changes in the whole wiki or to an atom feed.

In order to read the feed without having to log into the page go to http://wiki.gpii.net/index.php/Special:Preferences#mw-prefsection-watchlist to obtain/set your "secret token" and put it into an URL like the following: http://wiki.gpii.net/api.php?action=feedwatchlist&wlowner=<your name here>&wltoken=<your secret token here>.

(The MediaWiki API documentation page describes all API Options.)

Discussions on Talk Pages

Each wiki page can have a Discussion page. Discussion pages can be used for comments on wiki page content (and other aspects). Discussion pages have a few special "rules":

  • For each topic you want to discuss, you use the "Add topic" link (near the Edit link).
  • You indent the first response to a comment by adding a colon (:) in front of it, the second response with two colons, etc. When the indentation becomes too wide, simply add your next response to the left margin without colons; follow-up responses should then follow the indentation convention again.
  • End each response with your signature, otherwise other readers won't know who wrote the response. Both the source editor and the rich text editor have a button for this.
  • Be aware that there is no mechanism to get notified about edits to talk pages. However, you can add talk pages to your watchlist (see above).

General Guidelines

  • Every page should be reachable through a path that starts at the home page.
    • No page should be "orphaned", i.e. unreachable from any other page in the wiki. The wiki has a list of orphaned pages so you can check if the page(s) you created are listed there.
  • Avoid name conflicts: if a page is relevant to a specific project, it is often better to include the project name in the page title.
    For example, a page about testing that applies to all of GPII can be called Testing, while testing activities specific to Cloud4all are described on Cloud4All Testing and testing activities specific to Prosperity4all would probably be described in a page called "Prosperity4all Testing".
  • When a page has headings, use the "Edit" link of the heading above the content you want to edit.
  • When modifying a page, you can optionally leave a "summary"; this makes it easier to track what changes were made when and by whom.
  • Only check the "minor edit" checkbox when the change is merely editorial (markup syntax, typos, grammar, ...). (This enables other users to filter out non-substantive edits when viewing the list of recent changes to the wiki.)

Other Links

This page only provides guidance on editing wiki pages. For editing deliverables, see: