| commit | author | age | ||
| db6da8 | 1 | # Benutzerhandbücher |
| JUH | 2 | |
| 3 | Die Quelldateien des Handbuchs »Managed Operations Platform« befinden sich im Ordner `source/managed-operations-platform`. | |
| 4 | Die Steuerdateien für unsere Pandoc-ConTeXt-Engine sind in `control`. | |
| 5 | ||
| 6 | Die Inhalte liegen in einzelnen Dateien vor, die sinnvoll in thematischen Unterordnern gegliedert sind. | |
| 7 | 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`. | |
| 8 | Unsere Publikations-Engine baut die Dokumentation nach dieser Gliederung. | |
| 9 | Wenn also neue Dateien hinzukommen oder wegfallen, muss das in dieser Datei nachgezogen werden. | |
| 10 | ||
| 11 | Die Dokumentation wird als PDF und HTML gebaut mit folgendem Befehl: | |
| 12 | ||
| 13 | $ cd hs.docs.users | |
| 14 | $ ../hs.pub.context/build source/managed-operations-platform/managed-operations-platform.md | |
| 15 | ||
| 16 | ## Autoren-Hinweise | |
| 17 | ||
| 18 | ### Gliederung | |
| 19 | ||
| 20 | Jeder Abschnitt kommt in einen eigenen Ordner, wobei die Datei den Namen `index.md` trägt, z.B. | |
| 21 | ||
| 22 | `source/managed-operations-platform/einfuehrung/index.md` | |
| 23 | ||
| 24 | Jede Datei beginnt mit einer Überschrift der obersten Gliederungsebene: | |
| 25 | ||
| 26 | # Überschrift | |
| 27 | ||
| 28 | ## Unterüberschrift | |
| 29 | ||
| 30 | ||
| 31 | Die Gliederungstiefe der Ordner wird im Output als Gliederungstiefe der Überschriften übernommen. | |
| 32 | ||
| 33 | Jede Datei, die im Output inkludiert werden soll, muss in der Datei `managed-operations-platform.txt` an der entsprechenden Stelle angegeben werden. | |
| 34 | ||
| 35 | ## Formatierungen | |
| 36 | ||
| 37 | Ordner- und Dateinamen sowie Unix-Befehle und sonstiger Quellcode werden in Backticks \` gesetzt. | |
| 38 | ||
| 39 | Beispiel: \`index.md\` --> `index.md` | |
