Wiki¶
The integrated documentation system (Wiki) is used for the central management of technical documentation and manuals -- e.g., for user information, QM documents, IT policies, or process manuals. It comprises five sub-areas:
- Documentation Overview -- Management of documentation categories
- Page List -- Management of individual chapters
- New Page -- Creation of new documentation pages
- Document List -- Management of document files
- Language List -- Management of documentation languages
Documentation Overview¶
The overview displays all documentation maintained in the system with title, language, creation date, last modification time, and page count.
| Column | Description |
|---|---|
| View | Preview of the documentation in read mode |
| Title | Name of the documentation category (e.g., "Manual 1") |
| Language | Language of the documentation (e.g., German, English) |
| Created | Creation timestamp |
| Updated | Last modification timestamp |
| Pages | Number of contained pages |
Via the action menu, documentation can be edited, exported, or deleted. Selected entries can be bulk exported as PDF.
Page List (Chapters)¶
The page list manages individual chapters that belong to documentation. Chapters are independent, versionable units assigned to a documentation.
| Column | Description |
|---|---|
| View | Preview of the chapter content in read mode |
| Title | Heading of the chapter |
| Documentation | Associated documentation (e.g., "IT Manual") |
| Created | Creation date |
| Updated | Last editing timestamp |
| Language | Language of the chapter (e.g., "de" for German) |
Chapters with identical titles in different languages can be differentiated by the language field. The preview function opens the chapter in a reader-friendly layout.
New Page¶
The page creation form enables the creation of individual pages within a documentation.
| Field | Description | Required |
|---|---|---|
| Language | Definition of the language of the documentation page | Yes |
| Documentation | Assignment to an existing documentation | No |
| Belongs to Page | Optional linking as a subpage (chapter structure) | No |
| Title | Heading of the page, used as navigation entry and page header | Yes |
| Content | Editor field with rich text and HTML support | Yes |
Via the "Belongs to Page" field, pages can be organized hierarchically and multi-level documentation trees can be created. The editor supports formatted text, tables, images, and source code embedding.
Document List¶
The document list manages individual document files that are maintained as attachments or supplementary material within a documentation -- e.g., technical instructions, forms, or checklists.
| Column | Description |
|---|---|
| View | Preview or download of the document |
| Name | Name of the document |
| Description | Explanation or additional text for the document |
| Creator | Person who created the document |
| Created | Creation date |
| Updated | Date of last modification |
| Documentation | Associated documentation |
Via the action menu, documents can be edited, deleted, or exported (e.g., as PDF or ZIP). An "Add Document" function allows manual uploading and categorization of new documents.
Language List¶
The language management defines the available documentation languages in the system.
| Column | Description |
|---|---|
| Code | Language code according to ISO 639-1 (e.g., "de", "en") |
| Name | English name of the language (e.g., "German") |
| Family Name | Localized language name (e.g., "Deutsch") |
New language codes can be added to maintain content in additional languages. Deleting a language is only possible if no pages, chapters, or documents exist in that language.
Note
The codes must be unique system-wide and follow the ISO 639-1 standard. The "Family Name" column is displayed in user interfaces, export files, and PDF titles.