## Introduction

The Hotmaps wiki platform provides flexible functionalities for creating and editing the wiki pages. In order to be able to create or modify any wiki page, you must be logged in to the wiki platform. This is only possible if you have a GitHub account and you are assigned a wiki provider permission. To get a permission, send an Email to "support(at)hotmaps.eu" including your GitHub ID. We will then evaluate your request and accordingly respond to it. In order to log in, use the top-right corner login button. Once you are logged in, you can create and modify the pages.

To Top

## Wiki toolbar and sidebar

On top of each page you see the edit toolbar. The figure below shows this toolbar and briefly explains the function of each button.

The sidebar is visible in all wiki pages. Note that any modification in the sidebar is applied to all wiki pages. In other words, the sidebar is not specific to the page that you are editing. In order to modify the sidebar, press the "edit" button on the wiki toolbar. The sidebar modification can be done via the section on the bottom of the edit page as shown in the following figure.

In order to enlarge the edit window, drag it toward the bottom-right corner as shown in the following figure.

In order to add an image to your wiki page you have two options:

Method I:

• First, upload the image into your desired wiki page using the "Upload" button in the toolbar.
• Start editing that wiki page and use the link to the image.

Method II:

• Start editing your desired wiki page.
• Drag and drop the image to the place in text that you would like to show the figure.

To Top

## Classification of wiki pages

The Hotmaps wiki pages are categorized in five different classes:

• Hotmaps data set repository structure
• General functionalities of the toolbox
• Calculation modules
• How to apply the Hotmaps toolbox
• Developers area

For each wiki page class, a structure with several sections is suggested (see next section in this page). The sections in BOLD must be part of the Wiki page. The rest, on the other hand, should be added if applicable. As a sample page, please have a look into this wiki page.

Wiki pages can become very long due to embedded figures. In order to help the readers to navigate in a page easily and easily find what they are looking for, please add a “Table of contents” on top of each page that you are writing. Additionally, use a “To Top” button at the end of each section with a hyperlink to the “Table of contents” at the top of the wiki page.

In case you should use your own figures, please first create a new folder for your wiki page here and then push all the figures into the folder. Please also avoid using bulky images as the repository has a limited capacity.

Once you finished writing your wiki page, ask your colleagues to review your page and give feedback to you. In this way, we can minimize the written mistakes and make sure that wiki pages are written clearly. Add the name of the reviewer in the "Authors and reviewers" section. Follow the same structure as of the provided sample page.

NOTE: The Wiki pages are usually written in Markdown language (some additional formats are also possible). If you are not familiar with Markdown, read here the short tutorial provided by GitHub.

To Top

## Default structures of the wiki pages

### Hotmaps data set repository structure

Here, the most important point is to keep track of all Hotmaps repositories on GitLab and keep the links updated. The following structure is suggested for this class of wiki pages:

• Table of content
• Introduction
• Data set classification
• Class A
• Class B
• Class C
• Etc.
• How to cite
• Authors and reviewers
• Acknowledgement

To Top

### General functionalities of the toolbox

• Table of content
• Introduction
• Functionalities
• Functionality A
• Functionality B
• Functionality C
• etc.
• How to cite
• Authors and reviewers
• Acknowledgement

To Top

### Calculation modules

NOTE I: for the input layers please mention category of the layers as "default layer" or "personal layer" or "default/personal layer"

NOTE II: If a data or data set is being used by CM while it is not part of the default data set, it should be explained and the link to the data set should be provided. Also if you retrieve data from another website, please make sure to provide the link to that website in the input section and reference section.

• Table of content
• In a glance
• Introduction
• Inputs and outputs
• Input layers
• Input parameters
• Output layers
• Output graphics and indicators
• Method
• Interpretation of input parameters
• GitHub repository of this calculation module
• Sample run
• Test Run 1: XXXXX
• Test Run 2: YYYYY
• Interpretation of results
• References
• How to cite
• Authors and reviewers
• Acknowledgement

To Top

### How to apply the Hotmaps toolbox

• Table of content
• Introduction
• Topic A
• Topic B
• Topic C
• etc.
• References
• How to cite
• Authors and reviewers
• Acknowledgement

To Top

### Developers area

• Table of content
• Introduction
• Topic A
• Topic B
• Topic C
• etc.
• References
• How to cite
• Authors and reviewers
• Acknowledgement

To Top

## Authors and reviewers

To Top

To Top
To Top