Using the Wiki on AtikTeam

The wiki system is a powerful tool for creating and connecting your content and knowledge. It is based on two simple principles:

  • a simple wiki syntax designed to make editing fast and rendering consistent
  • pages are not sorted in folders, but linked to each other. In other words, you do not navigate a wiki by exploring a main menu, but by browsing the content directly from link to link, from page to page. Thus, it is useful to add links to other resources of the wiki whenever relevant, in order to make navigation easier.

Navigating the wiki

Navigating wiki pages is very simple: just follow the links.

Viewing a wiki page
Viewing a wiki page

Note the following:

  • [zone 1]: toolbar for editing a wiki page
  • [zone 2]: copy the wiki link, in order to keep it in the clipboard and paste it into another page. This is how you link pages to each other.
  • [zone 3]: create a new wiki page

Wiki syntax on AtikTeam

The syntax used is close to the Textile format, a format optimized for easy and fast writing. In most text boxes of the interface, you can use this syntax to define the different elements of your text.

Above the text box, there is a toolbar to insert the wiki syntax automatically. You can also see the "quick help" available through the Wiki syntax help link at the top right of the text box.

Formatting toolbar on the wiki
Formatting toolbar on the wiki

The wiki toolbar is laid out as follows:

  • bold (B), italic (I), underlined (U), strikethrough (S)
  • highlight (ab)
  • level 1 heading (H1), level 2 heading (H2), level 3 heading (H3)
  • bullet list, numbered list
  • mathematical formulas (Σ), preformatted text (pre)
  • images (img), tables (tab), wiki links (links)

The wiki syntax is designed to be very fast to use while remaining simple to learn. New users can read the quick reference and use the toolbar buttons to insert the markup; then, once used to the syntax, they can type it directly on the keyboard while writing content.

Writing a page on the wiki
Writing a page on the wiki

The important areas of the editing page are:

  • [zone 1]: content markup toolbar
  • [zone 2]: layout settings
  • [zone 3]: tags to classify the page (optional but always recommended to make your information easier to find)

You can preview the rendering by clicking on the View link. Using this feature helps avoid saving too many times because of minor syntax corrections.

Do not forget to save the wiki page when you are done.

How to create a new wiki page?

You can create a new wiki page by clicking on the button provided for this purpose in the wiki. After creating the page, remember to copy its wiki link and paste it into other pages. By referencing your page, you make it easy to reach and maintain a consistent network of wiki links.

Use links to connect resources

For a wiki to be effective, you need to link resources to each other as often as possible.

Automatic links

A resource that can be linked in a wiki page offers a "Copy wiki link" link (see above, zone 2) that you can click at any time.

Then you can insert this link into your document by clicking on the "Paste wiki link" button in the toolbar.

When writing a long wiki document in which you want to insert a lot of links, it is good practice to use 2 browser tabs: one to browse resources and copy the wiki links, and the other to write the document and paste the copied links.

Link label

When you create a new link, the text displayed is automatically extracted from the target resource. This will be for example the subject of the action, the title of the wiki page or the name of the file. This is called the link label.

Let's take the case of a wiki page titled "Specification". You copy the wiki link, and paste it into another document. In the source, you will have something like {{wiki_page#6}}, while the rendered page will display a "Specification" link.

You can choose the label yourself, to better fit the link into its context. To do this, separate the link text with "||". For example, if you write:

{{wiki_page#6 || the specifications of the mission}}

then the link will be rendered as "the specifications of the mission".

Images

The wiki toolbar lets you insert images from your computer or from the image library of the project. You can put a link on the image with the link property, for example:

{{image#34 || size=original || link=https://www.atikteam.com}}

Find a page

As explained above, the usual way to reach a wiki page is to follow links to the desired resource. You can also use the "Index by title" and "Index by date" links in the right column to display these lists. Finally, you can search by keyword with the search engine.