Help:Contents

From RapidWiki

This text is a basic introduction in writing articles for the RapidWiki. On a wiki, it is customary to allow readers to edit content and structure. This is a brief overview of the editing and contributing process. The table of contents to the right contains more information on editing functions.

Start Editing

To start editing a RapidWiki page, click the Edit this page (or just edit) link at one of its edges. This brings you to the edit page: a page with a text box containing the wikitext - the editable code from which the server produces the finished page.

Starting a new Article

Before you start with a new article, check the existing categories for related material here. Maybe you will find a related article which might be suitable for your extensions. At least you will get an idea of the best category you can use for your own article. If no suitable category can be found, just add a category definition to your new article (see below): the missing category will be dynamically added.

If you really want to start a new page (instead of just extending an existing one) you just have to search for the title of the (non-existing) new page. On the search results page, a link to edit this new page will be shown automatically. Clicking on this edit link will add the new page and allow you to edit the content.

Defining (new) Categories

Each article should be in at least one category. For example, you can add the category Programming to your article, by appending the following to your article:

[[Category:Programming]]

If the category didn't exist it will be highlighted in red, like any other missing page in RapidWiki. After you saved your article, click on the red category link and enter a short description of the category and which type of articles you would expect in this category. This is of course not necessary if the category already existed.

If the article belongs to several categories, just add all additional category tags at the end of you article but don't forget to add at least one category at all.

Type your Changes

You can just type your text. However, also using basic wiki markup (described in the next sections) to make links (!) and do simple formatting adds to the value of your contribution.

Preview before Saving

When you have finished, click Show preview to see how your changes will look before you make them permanent. Repeat the edit/preview process until you are satisfied, then click Save page and your changes will be immediately applied to the article.

Links

Here's an example of an internal link, i.e. to another page in RapidWiki:

[[Use Cases]] displayed as Use Cases

An internal link with a different text:

[[Use Cases|A collection of use cases]] displayed as A collection of use cases

External link can also be defined as

[http://rapid-i.com Rapid-I] displayed as Rapid-I

Uploading files

You can upload a file (for example an image) in the Upload Section under the Special pages (the toolbox menu on the left side). After uploading an image you can add it to your articles (see below).

Images

After uploading, just enter the filename, highlight it and press the "embedded image"-button of the edit_toolbar. This will produce the syntax for uploading a file [[Image:filename.png]].

Most frequent wiki markup explained

Here are some of the most frequently used types of wiki markup.

You can ''italicize text'' by putting 2 
apostrophes on each side. 

3 apostrophes will embolden '''the text'''. 

5 apostrophes will embolden and italicize 
'''''the text'''''.

(4 apostrophes doesn't do anything
special -- there's just ''''one left
over''''.)

== Section headings ==

''Headings'' organize your writing into sections.
The Wiki software can automatically generate
a table of contents from them.

=== Subsection ===

Using more equals signs creates a subsection.

==== A smaller subsection ====

Don't skip levels, 
like from two to four equals signs.

Start with 2 equals signs not 1 
because 1 creates H1 tags
which should be reserved for page title.

* ''Unordered lists'' are easy to do:
** Start every line with a star.
*** More stars indicate a deeper level.
*: Previous item continues.
** A new line
* in a list  
marks the end of the list.
* Of course you can start again.

# ''Numbered lists'' are:
## Very organized
## Easy to follow
A new line marks the end of the list.
# New numbering starts with 1.

Here's a link to the [[Main page]].

[[The weather in London]] is 
a page that doesn't exist
yet. You could create it by 
clicking on the link.

<nowiki>
The nowiki tag ignores 
[[Wiki]] ''markup''.
It reformats text by 
removing
newlines    and multiple
 spaces.
It still interprets special
characters: &rarr;
</nowiki>

The pre tag ignores [[Wiki]]
 ''markup''.
It also doesn't     reformat
 text.
It still interprets special
characters: →

<pre>
The pre tag ignores [[Wiki]]
 ''markup''.
It also doesn't     reformat
 text.
It still interprets special
characters: &rarr;
</pre>

A typewriter font for <tt>monospace text</tt>
or for computer code: <code>int main()</code>

Attribute labelAttribute = exampleSet.getAttributes().getLabel();
for (Example e : exampleSet) {
    labelValues += e.getValue(labelAttribute);
}

Use <code><pre> Block of Code </pre></code> around the 
block of code.

* The <pre> tags within the codeblock will create formatting 
issues - to solve, display the tags literally with 
&lt;pre&gt;  and  &lt;/pre&gt;