Guidelines for writing a Hotmaps Wiki page

Table of Contents

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.

Wiki toolbar

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

toolbar

Classification of Wiki pages

The Hotmaps Wiki pages are categorized in four classes:

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

For each section, a structure with several sections is suggested. 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 content” 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

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 Wiki page:

  • Table of content
  • Introduction
  • Data set classification
    • Class A
    • Class B
    • Class C
    • Etc.
  • How to cite
  • Authors and reviewers
  • License
  • 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
  • License
  • Acknowledgement

To Top

Calculation modules

  • Table of content
  • Introduction
  • Inputs and outputs
  • 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
  • License
  • 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
  • License
  • Acknowledgement

To Top

Developers area

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

To Top

Authors and reviewers

This page is written by Mostafa Fallahnejad*.

☑ This page was reviewed by Lukas Kranzl*.

* Energy Economics Group - TU Wien Institute of Energy Systems and Electrical Drives Gusshausstrasse 27-29/370 1040 Wien

To Top

License

Copyright © 2016-2019: Mostafa Fallahnejad

Creative Commons Attribution 4.0 International License This work is licensed under a Creative Commons CC BY 4.0 International License.

SPDX-License-Identifier: CC-BY-4.0

License-Text: https://spdx.org/licenses/CC-BY-4.0.html

To Top

Acknowledgement

We would like to convey our deepest appreciation to the Horizon 2020 Hotmaps Project (Grant Agreement number 723677), which provided the funding to carry out the present investigation.

To Top

View in another language:

German*

* machine translated