Instructions pour la rédaction d'une page Wiki Hotmaps

Instructions pour la rédaction d'une page Wiki Hotmaps

Table des matières

introduction

Les pages Hotmaps Wiki sont classées en quatre classes:

  • Structure de référentiel de jeu de données Hotmaps
  • Fonctionnalités générales de la boîte à outils
  • Modules de calcul
  • Comment appliquer la boîte à outils Hotmaps
  • Espace développeurs

Pour chaque section, une structure à plusieurs sections est suggérée. Les sections en gras doivent faire partie de la page WIKI. Le reste, en revanche, devrait être ajouté le cas échéant. Comme exemple de page, jetez un coup d’œil à cette page Wiki .

Les pages wiki peuvent devenir très longues en raison de figures incorporées. Afin d'aider les lecteurs à naviguer facilement dans une page et à trouver facilement ce qu'ils cherchent, veuillez ajouter une " Table des matières " en haut de chaque page que vous écrivez. De plus, utilisez un “ To Top ”À la fin de chaque section avec un hyperlien vers la“ Table des matières ”en haut de la page Wiki.

Au cas où vous utiliseriez vos propres chiffres, créez d'abord un nouveau dossier pour votre page wiki, puis placez tous les chiffres dans le dossier. Évitez également d’utiliser des images volumineuses car le référentiel a une capacité limitée.

Une fois votre page de wiki rédigée, demandez à vos collègues de la consulter et de vous donner son avis. De cette manière, nous pouvons minimiser les erreurs écrites et nous assurer que les pages du wiki sont écrites clairement. Ajoutez le nom du relecteur dans la section "Auteurs et relecteurs". Suivez la même structure que sur la page d’échantillon fournie.

REMARQUE : Les pages Wiki sont généralement écrites en langage Markdown (certains formats supplémentaires sont également possibles). Si vous n'êtes pas familier avec Markdown, lisez ici le court tutoriel fourni par GitHub.

To Top

Structure de référentiel de jeu de données Hotmaps

Ici, le point le plus important est de garder une trace de tous les référentiels Hotmaps sur GitLab et de maintenir les liens à jour. La structure suivante est suggérée pour cette page Wiki:

  • Table des matières
  • introduction
  • Classification de l'ensemble de données
    • Classe A
    • Classe B
    • Classe c
    • Etc.
  • Comment citer
  • Auteurs et relecteurs
  • Licence
  • Reconnaissance

To Top

Fonctionnalités générales de la boîte à outils

  • Table des matières
  • introduction
  • Les fonctionnalités
    • Fonctionnalité A
    • Fonctionnalité B
    • Fonctionnalité C
    • etc.
  • Comment citer
  • Auteurs et relecteurs
  • Licence
  • Reconnaissance

To Top

Modules de calcul

  • Table des matières
  • introduction
  • Entrées et sorties
  • Méthode
  • Dépôt GitHub de ce module de calcul
  • Échantillon échantillon
    • Essai 1: XXXXX
    • Essai 2: AAAA
  • Références
  • Comment citer
  • Auteurs et relecteurs
  • Licence
  • Reconnaissance

To Top

Comment appliquer la boîte à outils Hotmaps

  • Table des matières
  • introduction
  • Sujet A
  • Sujet B
  • Sujet C
  • etc.
  • Références
  • Comment citer
  • Auteurs et relecteurs
  • Licence
  • Reconnaissance

To Top

Espace développeurs

  • Table des matières
  • introduction
  • Sujet A
  • Sujet B
  • Sujet C
  • etc.
  • Références
  • Comment citer
  • Auteurs et relecteurs
  • Licence
  • Reconnaissance

To Top

Auteurs et relecteurs

Cette page est écrite par Mostafa Fallahnejad *.

  • [x] Cette page a été révisée par Lukas Kranzl *.

* Energy Economics Group - TU Wien Institut des systèmes énergétiques et des entraînements électriques Gusshausstrasse 27-29 / 370 1040 Wien

To Top

Licence

Droits d'auteur © 2016-2019: Mostafa Fallahnejad

Licence internationale Creative Commons Attribution 4.0 Ce travail est sous licence Creative Commons CC BY 4.0 Licence internationale.

Identificateur de licence SPDX: CC-BY-4.0

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

To Top

Reconnaissance

Nous souhaitons exprimer notre profonde gratitude au projet Horizon 2020 Hotmaps (accord de subvention n ° 723677), qui a fourni le financement nécessaire à la réalisation de la présente enquête.

To Top

This page was automatically translated. View in another language:

English (original) Bulgarian* Croatian* Czech* Danish* Dutch* Estonian* Finnish* German* Greek* Hungarian* Irish* Italian* Latvian* Lithuanian* Maltese* Polish* Portuguese (Portugal, Brazil)* Romanian* Slovak* Slovenian* Spanish* Swedish*

* machine translated