Pautas para escribir una página de Hotmaps Wiki

Pautas para escribir una página de Hotmaps Wiki

Tabla de contenido

Introducción

Las páginas de Hotmaps Wiki se clasifican en cuatro clases:

  • Estructura del repositorio del conjunto de datos de Hotmaps
  • Funcionalidades generales de la caja de herramientas
  • Módulos de Cálculo
  • Cómo aplicar la caja de herramientas Hotmaps
  • Área de desarrolladores

Para cada sección, se sugiere una estructura con varias secciones. Las secciones en negrita deben ser parte de la página WIKI. El resto, por otro lado, debe agregarse si corresponde. Como página de muestra, eche un vistazo a esta página Wiki .

Las páginas wiki pueden llegar a ser muy largas debido a las figuras incrustadas. Para ayudar a los lectores a navegar en una página fácil y fácilmente a encontrar lo que están buscando, agregue una " Tabla de contenido " en la parte superior de cada página que está escribiendo. Además, use un " To Top "Al final de cada sección con un hipervínculo a la" Tabla de contenido "en la parte superior de la página Wiki.

En caso de que deba usar sus propias figuras, primero cree una nueva carpeta para su página wiki aquí y luego inserte todas las figuras en la carpeta. También evite usar imágenes voluminosas ya que el repositorio tiene una capacidad limitada.

Una vez que haya terminado de escribir su página Wiki, solicite a sus colegas que revisen su página y le den su opinión. De esta manera, podemos minimizar los errores escritos y asegurarnos de que las páginas Wiki estén escritas claramente. Agregue el nombre del revisor en la sección "Autores y revisores". Siga la misma estructura que en la página de muestra proporcionada.

NOTA : Las páginas Wiki generalmente están escritas en lenguaje Markdown (también son posibles algunos formatos adicionales). Si no está familiarizado con Markdown, lea aquí el breve tutorial proporcionado por GitHub.

To Top

Estructura del repositorio del conjunto de datos de Hotmaps

Aquí, el punto más importante es hacer un seguimiento de todos los repositorios de Hotmaps en GitLab y mantener actualizados los enlaces. Se sugiere la siguiente estructura para esta página Wiki:

  • Tabla de contenidos
  • Introducción
  • Clasificación del conjunto de datos
    • Clase A
    • Clase B
    • Clase C
    • Etc.
  • Como citar
  • Autores y revisores
  • Licencia
  • Reconocimiento

To Top

Funcionalidades generales de la caja de herramientas.

  • Tabla de contenidos
  • Introducción
  • Funcionalidades
    • Funcionalidad A
    • Funcionalidad B
    • Funcionalidad C
    • etc.
  • Como citar
  • Autores y revisores
  • Licencia
  • Reconocimiento

To Top

Módulos de cálculo

  • Tabla de contenidos
  • Introducción
  • Entradas y salidas
  • Método
  • Repositorio de GitHub de este módulo de cálculo
  • Ejecución de la muestra
    • Prueba de ejecución 1: XXXXX
    • Prueba de ejecución 2: AAAAA
  • Referencias
  • Como citar
  • Autores y revisores
  • Licencia
  • Reconocimiento

To Top

Cómo aplicar la caja de herramientas Hotmaps

  • Tabla de contenidos
  • Introducción
  • Tema A
  • Tema B
  • Tema C
  • etc.
  • Referencias
  • Como citar
  • Autores y revisores
  • Licencia
  • Reconocimiento

To Top

Área de desarrolladores

  • Tabla de contenidos
  • Introducción
  • Tema A
  • Tema B
  • Tema C
  • etc.
  • Referencias
  • Como citar
  • Autores y revisores
  • Licencia
  • Reconocimiento

To Top

Autores y revisores

Esta página está escrita por Mostafa Fallahnejad *.

  • [x] Esta página fue revisada por Lukas Kranzl *.

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

To Top

Licencia

Copyright © 2016-2019: Mostafa Fallahnejad

Creative Commons Attribution 4.0 International License Este trabajo está licenciado bajo una licencia internacional Creative Commons CC BY 4.0.

Identificador de licencia SPDX: CC-BY-4.0

Texto de la licencia: https://spdx.org/licenses/CC-BY-4.0.html

To Top

Reconocimiento

Nos gustaría transmitir nuestro más profundo agradecimiento al Proyecto Horizonte 2020 Hotmaps (Acuerdo de subvención número 723677), que proporcionó los fondos para llevar a cabo la presente investigación.

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* Polish* Portuguese (Portugal, Brazil)* Romanian* Slovak* Slovenian* Swedish*

* machine translated