Usage guide

This is a quick guide on the most basic features of the wiki / documentation site / knowledge base. Other features can be discovered and studied eg. from the other guides in the Guides section.

This wiki is organized around a few main namespaces or sections under which pages reside. The different model versions like Eurogreen+ and Fingreen have their own namespaces. Additionally, there are the default namespaces “wiki” (which we use for Guides) and Playground (for trying out things). A namespace is just a page, which has other pages under it. This means that the mentioned namespaces can have subnamespaces inside them. This is evident if you explore the navigation sidebar on the left.

Each model will typically have sections (subnamespaces) for at least input data and some other things. Follow this logic when you create new pages.

In any wiki, the typical way to create a page is to write it's address, land on the empty page, and then choose “Create page”. You can only create pages in places where you have the rights to do so.

The addresses for pages are of the form: https://eurogreen.wiki/doku.php?id=namespace_name:subnamespace_name:page_name, where (sub)namespace(s) are optional. As a user, you should generally only create pages under one of the existing main namespaces. An easy way to create a page is to navigate to the desired place in the wiki, and then edit the address on the address bar.

For ease of use, we have also added a “new page” button on the homepage. You can also use that to create pages.

If you have editing rights in a namespace, you can edit an existing section from the edit button below it (1). You can edit the whole page from the menu in the right margin (2).

Editing a page opens up a window for writing. You can use the row of buttons for formatting text, or directly write Markdown or DokuWiki markup. Guides for both can be found here. Markdown is widely used and easy to learn! It might be good to prefer Markdown: if we ever decide to migrate the content to another system, it would be very easy. But, the buttons only create DokuWiki syntax and not Markdown, so don't worry about it too much.

In certain sections of the wiki, the editing window will be prepopulated with some useful text that you can use as a basis for writing.

You can always preview your changes with the preview button. This is recommended.

To move/rename a page, start by navigating to the page in question. Then select the cogwheel menu from the top.

Scroll down to the “Additional plugins” -section and select “Move pages and namespaces”.

Keep “Move page” selected and type the destination namespace and page name. Don't select “Move namespace”, you generally won't have use for this. Keep “Rewrite links” selected. Click start.

You will be shown the “Move in progress” -page. Click start to actually move the page, or abort to cancel.

Under most pages, there is a comments section where users can discuss the topics of the page. This is a good place to leave clarifying comments on issues, so they can be read by other users of the wiki. You can also subscribe to receive email notifications about new comments on the page. The email notifications are not working yet, Topi-Matti is working on it.

This is a bit technical and you probably don't need to worry about it. In some sections of the wiki, there exist predefined templates for creating new pages. Because we use the templatepagename plugin, these templates, if they exist, are found under https://eurogreen.wiki/doku.php?id=namespacename:c_template and i_template. You can learn more about using templates here.

Dokuwiki has a very basic featureset, which is expanded with plugins. The most relevant plugins that the Eurogreen wiki already uses are

• discussion
• templatepagename
• template:sprintdoc (the theme that we use)
• indexmenu
• addnewpage
• move