Home How to use the wiki

How to use the wiki

Reading the wiki

The sidebar to the right leads you to more information on a specific topic.

To make it easier to follow there are examples given from time to time. They are marked by using blockquotes. If there is second blockquote following, it is an explanation specific to the example -- you only need to read that if the example is unclear to you. Below is a demonstration to show you what it looks like.

Call foo() and pray.

foo and bar are typical placeholders for examples in computer science. Here's a reference for more information.

Editing and expanding the wiki

The project uses GitHub's wiki function. It is not the most powerful tool, but independent of other products and is deemed sufficient.

GitHub offers to edit the entries online. Alternatively, you can clone the wiki locally and work offline. Since you probably won't have permission to push and edit to the repository, you will most likely need to clone the wiki. Below the sidebar is a link to do that.

All content is written in Markdown, you can find a good tutorial here. Please be aware that if you write a new page it will not automatically show up in the sidebar. You need to edit _sidebar.md to include your page. To keep the structure you should follow the used naming convention, where each 'chapter'/'section' starts capitalized: Section name Title of your page. To have it show up in the sidebar, you then need to link to the page by replacing all spaces with dashes. The sidebar shows several examples.

This page is named Home How to use the wiki.

The link in the _sidebar.md reads as [How to use the wiki](./Home-How-to-use-the-wiki).

Next, directly at the beginning of your file, set the title of your page as the level 1 heading. Here you can choose the capitalization freely: # Title of Your Page

The header for this page is # How to use the wiki.

In Markdown, the number of hash signs (#) represent the level of the heading. Keep in mind to leave one space behind the hash sign.