| New file |
| | |
|---|
| | | # Benutzerhandbücher |
|---|
| | | |
|---|
| | | Die Quelldateien des Handbuchs »Managed Operations Platform« befinden sich im Ordner `source/managed-operations-platform`. |
|---|
| | | Die Steuerdateien für unsere Pandoc-ConTeXt-Engine sind in `control`. |
|---|
| | | |
|---|
| | | Die Inhalte liegen in einzelnen Dateien vor, die sinnvoll in thematischen Unterordnern gegliedert sind. |
|---|
| | | Die Gliederung der Dokumentation befindet sich in einer Datei, die den gleichen Namen trägt wie die Markdown-Datei, aber die Endung `.txt` hat: `source/managed-operations-platform/managed-operations-platform.txt`. |
|---|
| | | Unsere Publikations-Engine baut die Dokumentation nach dieser Gliederung. |
|---|
| | | Wenn also neue Dateien hinzukommen oder wegfallen, muss das in dieser Datei nachgezogen werden. |
|---|
| | | |
|---|
| | | Die Dokumentation wird als PDF und HTML gebaut mit folgendem Befehl: |
|---|
| | | |
|---|
| | | $ cd hs.docs.users |
|---|
| | | $ ../hs.pub.context/build source/managed-operations-platform/managed-operations-platform.md |
|---|
| | | |
|---|
| | | ## Autoren-Hinweise |
|---|
| | | |
|---|
| | | ### Gliederung |
|---|
| | | |
|---|
| | | Jeder Abschnitt kommt in einen eigenen Ordner, wobei die Datei den Namen `index.md` trägt, z.B. |
|---|
| | | |
|---|
| | | `source/managed-operations-platform/einfuehrung/index.md` |
|---|
| | | |
|---|
| | | Jede Datei beginnt mit einer Überschrift der obersten Gliederungsebene: |
|---|
| | | |
|---|
| | | # Überschrift |
|---|
| | | |
|---|
| | | ## Unterüberschrift |
|---|
| | | |
|---|
| | | |
|---|
| | | Die Gliederungstiefe der Ordner wird im Output als Gliederungstiefe der Überschriften übernommen. |
|---|
| | | |
|---|
| | | Jede Datei, die im Output inkludiert werden soll, muss in der Datei `managed-operations-platform.txt` an der entsprechenden Stelle angegeben werden. |
|---|
| | | |
|---|
| | | ## Formatierungen |
|---|
| | | |
|---|
| | | Ordner- und Dateinamen sowie Unix-Befehle und sonstiger Quellcode werden in Backticks \` gesetzt. |
|---|
| | | |
|---|
| | | Beispiel: \`index.md\` --> `index.md` |
|---|
