This is for everyone who wants or needs to contribute to our wiki. Please read through the notes carefully. Additionally, if you ever encounter problems, please refer to this page first before requesting help. We will update this page from time to time to reflect changes; thus, it is not unlikely to become this page a useful reference for writers!
Table of Contents
Technically
First of all: Some technical information: Our "wiki" is provided by Drupal using a special module to provide some more wiki-like behavior (Drupal itself does not act really like a wiki, though).
Thus, when writing something, you use the same content types that are available also for the rest of our page. Currently, these content types are enabled for the wiki:
- Page - A simple page
Formatting
Formatting of text can be done using ordinary HTML. However, most HTML tags are stripped out, both, for reasons of security and layout. You can get a full list of allowed elements when editing a page: Below the text input box you'll find some help and also the list. Additionally, you will find a link to a more detailed reference. Here, only a short overview:
General Structuring
Use the header tags h1 up to h6 to divide a text into sections. Additionally, insert a "tableofcontents" tag after the initial paragraph: This will create a list (the ToC) showing all headings in the text.
Formatting
For text formatting, you can use the tags em (emphasize), strong (stronger emphasize), sub and sup (subscribe and superscribe) and cite (citations). To create lists, use ul (unordered lists using bullets) or ol (ordered lists) tags together with the li (list item) elements. Beneath, you can use dl, dt and dd for definition lists. To create a table, use table, tr, td and th elements.
If you wish to insert an image, please use the image assistant, which can be invoked by clicking the plus icon below the text box!
Links
Links can be inserted using the "a" HTML element:
<a href="http://somesite.com/page/1.html">This leads to SomeSite!</a>
With href, you specify a target to link to. Currently, two different formats are supported:
- Full URL
- Target can be given using a full-featured URL, i.e. including the used protocol (http://, ftp:// and so forth). Use this to link to external sites.
- Site-internal
- These are given specified using the syntax /home/wiki/Page_Title. You can also link to a recourse outside the wiki, e.g. /home/node/123 or /home/project/issues/project_name. Drupal will automatically add the http://www.rpdev.net/ part.
Additionally, Drupal will auto-detect URLs of the form protocol://site/path/ and make it a link.
Getting Links Right
A wiki lives by it's contents being linked together. Thus, to create a new page, it is a good idea to..
- Edit an existing page and insert a link to a non existing page, i.e. <a href="/home/wiki/Tutorials:This_Surely_Does_Not_Exist">
- Save the page and follow the link: The wiki should tell you now that the page does not exist and provides you a list with available content to create for filling the void ;)
- Select one and start typing!
Available Filters
MediaWiki Filter
There is a filter installed that will parse a subset of the MediaWiki syntax. In detail, the following markup can be used:
- Text surrounded by pairs, triples or quadruples of equal signs will get formatted as headings (h2, h3 or h4, depending on the number of equal signs used).
- Wiki links can be inserted by using double square brackets. So [[Guidelines|Guidelines for Writing Articles]] would become Guidelines for Writing Articles.
By the way: You can suggest other filters as well - the module used can be extended, so adding another formatting is no problem. Either create a new forum topic for discussion or write a feature request targeting the Web project.