-
Notifications
You must be signed in to change notification settings - Fork 0
Dokuwiki
Stephen Winnall edited this page Aug 1, 2020
·
4 revisions
OHR uses Dokuwiki because Dokuwiki is small and runs on embedded machines without much apparent overhead.
OHR generates its reports as text files in a file tree suitable for inclusion in a Dokuwiki installation. The files generated have known names, so users are free to use any other file name for their own own extensions to their Dokuwiki content. The file names currently in use are:
| File | Overwritten? | Purpose |
|---|---|---|
| start.txt | no | The default content for the current folder (like index.html in HTML), generated by OHR if it doesn't exist yet, but can be edited and will not be overwritten. This file should provide – directly or indirectly – links to all other files in the same folder. |
| auto.txt | yes | Automatically generated, this file contains textual information about a specific object. |
| auto-svg.txt | yes | Automatically generated, this file contains the SVG diagram for a specific object. |
| anything else | no | User-specific Dokuwiki file – the user is responsible for ensuring that it is linked to (e.g. through start.txt) |