User manual for OPUS 4.
CSS HTML Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes
_layouts
admin
config
configext
css
datasecure
documenttypes
features
img
import
installation
reference
update
.gitignore
Gemfile
Jenkinsfile
README.md
_config.yml
gitopus.md
index.md
introduction.md
migration.md
opus45.md

README.md

OPUS 4 Handbuch

OPUS 4 Handbuch für Anwender und Administratoren. Das Git-Repository für das Handbuch befindet sich hier:

https://opus4.github.io/userdoc

Probleme mit der Dokumentation, Hinweise und Vorschläge, können als Issues gemeldet werden. Bitte dabei vorher prüfen, ob es eventuell schon ein entsprechenden Issue gibt.

Bei der Dokumentation helfen

Fehlerkorrekturen und Änderungen können als Pull Requests zur Verfügung gestellt werden. Hinweise dazu finden sich in der GitHub Dokumentation. Auf diesem Weg kann die OPUS 4 Community mit der Dokumentation helfen. In der Regel sollte ein Issue angelegt werden before an neuen Inhalten gearbeitet wird, um die Änderungen koordinieren zu können und doppelte Arbeit zu vermeiden.

Die Dokumentation verwendet GitHub Pages, um aus Markdown Dateien (.md) statische Webseiten zu generieren. Dafür wird Jekyll verwendet. Für das Rendern der Markdown Dateien verwendet GitHub Pages momentan Kramdown.

Eine Referenz für die von Kramdown unterstützte Synstax ist online verfügbar. In der Entwicklerdokumentation von OPUS 4 finden sich weitere Hinweise zum Erstellen der Dokumentation.

Hinweise zur Verwendung von Jekyll finden sich in der Dokumentation zu GitHub Pages. Dort steht auch wie man Jekyll lokal einrichten kann, um die generierten Seiten lokal prüfen zu können bevor die Änderungen zu GitHub hochgeladen werden.