Wskazówki dotyczące pisania strony Wiki Hotmaps

Wskazówki dotyczące pisania strony Wiki Hotmaps

Spis treści

Wprowadzenie

Strony Wiki Hotmaps są podzielone na cztery klasy:

  • Struktura repozytorium zestawu danych Hotmaps
  • Ogólne funkcje przybornika
  • Moduły obliczeniowe
  • Jak zastosować zestaw narzędzi Hotmaps
  • Strefa programistów

Dla każdej sekcji sugerowana jest struktura z kilkoma sekcjami. Sekcje BOLD muszą być częścią strony WIKI. Resztę, z drugiej strony, należy dodać, jeśli dotyczy. Jako przykładową stronę zajrzyj na tę stronę Wiki .

Strony Wiki mogą stać się bardzo długie ze względu na osadzone dane. Aby ułatwić czytelnikom poruszanie się po stronie i łatwe znajdowanie tego, czego szukają, dodaj „ Spis treści ” na górze każdej pisanej strony. Dodatkowo użyj „ To Top ”Na końcu każdej sekcji z hiperłączem do„ Spisu treści ”u góry strony Wiki.

Jeśli chcesz użyć własnych figurek, najpierw utwórz nowy folder dla swojej strony wiki tutaj, a następnie wepchnij wszystkie liczby do folderu. Unikaj także używania nieporęcznych obrazów, ponieważ repozytorium ma ograniczoną pojemność.

Gdy skończysz pisać swoją stronę Wiki, poproś współpracowników o przejrzenie twojej strony i przekazanie ci opinii. W ten sposób możemy zminimalizować błędy pisane i upewnić się, że strony Wiki są napisane jasno. Dodaj nazwisko recenzenta w sekcji „Autorzy i recenzenci”. Postępuj zgodnie z tą samą strukturą, co podana przykładowa strona.

UWAGA : Strony Wiki są zwykle pisane w języku Markdown (możliwe są również niektóre dodatkowe formaty). Jeśli nie znasz Markdown, przeczytaj tutaj krótki samouczek dostarczony przez GitHub.

To Top

Struktura repozytorium zestawu danych Hotmaps

Najważniejsze jest tutaj śledzenie wszystkich repozytoriów Hotmaps na GitLab i aktualizowanie linków. Dla tej strony Wiki sugerowana jest następująca struktura:

  • Spis treści
  • Wprowadzenie
  • Klasyfikacja zestawu danych
    • Klasa A
    • Klasa B
    • Klasa C.
    • Itp.
  • Jak cytować
  • Autorzy i recenzenci
  • Licencja
  • Potwierdzenie

To Top

Ogólne funkcjonalności zestawu narzędzi

  • Spis treści
  • Wprowadzenie
  • Funkcjonalności
    • Funkcjonalność A
    • Funkcjonalność B
    • Funkcjonalność C
    • itp.
  • Jak cytować
  • Autorzy i recenzenci
  • Licencja
  • Potwierdzenie

To Top

Moduły obliczeniowe

  • Spis treści
  • Wprowadzenie
  • Wejścia i wyjścia
  • metoda
  • Repozytorium GitHub tego modułu obliczeniowego
  • Przykładowy przebieg
    • Uruchomienie testowe 1: XXXXX
    • Uruchomienie testowe 2: RRRR
  • Bibliografia
  • Jak cytować
  • Autorzy i recenzenci
  • Licencja
  • Potwierdzenie

To Top

Jak zastosować zestaw narzędzi Hotmaps

  • Spis treści
  • Wprowadzenie
  • Temat A
  • Temat B
  • Temat C
  • itp.
  • Bibliografia
  • Jak cytować
  • Autorzy i recenzenci
  • Licencja
  • Potwierdzenie

To Top

Strefa programistów

  • Spis treści
  • Wprowadzenie
  • Temat A
  • Temat B
  • Temat C
  • itp.
  • Bibliografia
  • Jak cytować
  • Autorzy i recenzenci
  • Licencja
  • Potwierdzenie

To Top

Autorzy i recenzenci

Ta strona została napisana przez Mostafa Fallahnejad *.

  • [x] Ta strona została sprawdzona przez Lukasa Kranzla *.

* Energy Economics Group - Instytut Systemów Energetycznych i Napędów Elektrycznych TU Wien Gusshausstrasse 27-29 / 370 1040 Wien

To Top

Licencja

Prawa autorskie © 2016-2019: Mostafa Fallahnejad

Creative Commons Uznanie autorstwa 4.0 Licencja międzynarodowa Ta praca jest licencjonowana na podstawie licencji Creative Commons CC BY 4.0 International.

Identyfikator licencji SPDX: CC-BY-4.0

Licencja-tekst: https://spdx.org/licenses/CC-BY-4.0.html

To Top

Potwierdzenie

Pragniemy przekazać nasze najgłębsze uznanie dla projektu „Hotmaps” programu „Horyzont 2020 (umowa o udzielenie dotacji nr 723677), który zapewnił środki finansowe na przeprowadzenie obecnego dochodzenia.

To Top

This page was automatically translated. View in another language:

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

* machine translated