Usage guide

This is a quick guide on the most basic features of this wiki site.

Other features can be discovered and studied from the other guides in the Guides section.

This wiki is organized around a few main namespaces, which are simply sections within which pages reside.

The different model versions like Eurogreen+ (Italian model) and Fingreen (Finnish model) have their own namespaces, which you can browse from the sidebar.

Follow this logic when creating new pages:

• Module documentation (explains how the model works)
  • One page per module, e.g. Population.
  • Subpages for important features , e.g. Skill distribution.
  • Add links to relevant input data pages where useful.
• Input data documentation (explains what enters the model and how it is prepared)
  • One page per input Excel file, e.g. InputsEconomy.
  • One subpage per data sheet, e.g. InputOutput.
  • Each sheet page includes a subheading for each individual variable, listing its source, data year(s), access date, name of downloaded file, processing details, assumptions, and other notes.
  • Create separate variable pages only when more detailed documentation is needed, and link to them within the sheet page.

Visual example:

model_namespace:
├── landing page: overview
├── modules:
│   ├── population
│   ├── production
│   └── ...
└── input_data:
    ├── landing page: input data overview
    ├── important abbreviations
    ├── inputs_economy:
    │   ├── demography
    │   ├── inputoutput
    │   ├── prices
    │   └── ...
    ├── inputs_technology:
    │   └── ...
    └── inputs_environment:
        └── ...

Additionally, the wiki includes the default namespace “wiki” (which we use for Guides) and Playground (for trying out things).

Create a page

1. Enter the desired page ID in the URL or search, for example: fingreen:input_data:input_reference:abbreviations
2. Open the non-existing page.
3. Click Create this page.
4. Add content and save.
5. The first level headline will show up as the headline in the sidebar.

Create a namespace

• You do not create namespaces separately.
• Create a page inside it, for example: fingreen:input_data:input_reference:abbreviations
• DokuWiki automatically creates the namespace structure.

Create a namespace landing page Use: fingreen:input_data:input_reference:start

Delete a page

1. Open the page.
2. Click Edit.
3. Delete all content.
4. Save the empty page.

Delete a namespace

• Delete all pages inside it.
• Once empty, the namespace disappears automatically.

For ease of use, you can also use this new page button to create pages under specified namespaces:

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.

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.

Note that the first level heading in the content will be shown as the heading for your page in the navigation sidebar.

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.

The sidebar is set up in a way that you generally should not have to edit it. The top level namespaces are added manually to collapsable sections, and their content is populated automatically utilizing the indexmenu plugin. If you add a top level namespace, like a new model, it should be added in the sidebar. The sidebar can be edited 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