Table of Contents
This is an old revision of the document!
Content rules
These are content rules for authors.
Language
- The main language of the wiki is German
- Pages are translated from German to English
- Screenshots are always inserted in English
- For the translation the plugin Deepl Auto Translate is used for the translation
- A page is automatically translated from the main language (German) to English if the English page was empty
- To retranslate: Empty the page and then re-translate it, then review the entire page and correct any external links (see note below) or other issues
- deepL is also used to translate parts of the pages
Note: When translating sidebar from German to English, all links must be supplemented with en:, as the automatic assignment to the language does not work automatically for pages that are already assigned to a namespace. This can be achieved by adding en: to all links in the translated sitebar text. [[
durch [[en:
(Leerzeichen zwischen den Klammern entfernen) ersetzt werden. Externe Links, z. B. zu Wikipedia, müssen manuell durch ihre Entsprechung in der anderen Sprache ersetzt werden.
Anrede
Es wird in der förmlichen “Sie”-Anrede formuliert. Dies ist eine Folge der Übersetzung mit DeepL, in der englische Beschreibungen mit “Sie” als Anrede übersetzt werden verbunden damit, dass viele Beschreibungen zunächst in englischer Sprache erstellt werden.
Sitebar
Die Sitebar wird manuell gepflegt. Es werden lediglich die Seitenname der Zielseiten als Link angegeben, nicht der Anzeigetext. Die Links haben also die Form [[Seitenziel]]
.
Page structure
The individual wiki pages are created with the following structure.
Headings
Each page begins with a 2nd size heading. This is achieved via a text surrounded by 5 equals signs. The 1st size heading (6 equal times) is reserved and is not used initially.
Sub-chapters
Sub-chapters are given headings of the next lowest size. There are at least two sub-chapters, so one never stands alone.
Anchors
A plugin is used for anchors: https://www.dokuwiki.org/plugin:anchor#examples_usage
Images
Images are inserted in English and used in the same way for all translations. If it is helpful for the user, the screenshots are provided with numbering, which is referred to in the text. These graphics are used for this purpose: Graphics for image captions
Notes on plugins
Table of contents
The table of contents is derived from the headings and is displayed in the sidebar.
It can be opened via {{inlinetoc_3}}
to display a table of contents on the page. See: https://www.dokuwiki.org/plugin:toctweak
Hide content
This plugin is used to display content only for certain user groups: https://www.dokuwiki.org/plugin:ifauthex
Notes: - A heading is still visible to everyone. Therefore, no headings may be used. - Block comments should always be added so that the section can only be read by admins.
Example:
<ifauth @admin>
//Only visible for admins//
Visible only to admins
//End: Visible only to admins//
</ifauth>
TODOs
Notes for authors can be marked via the nodisp-Plugin button:
<nodisp 2>
TODO: Say what needs to be done.
</nodisp>
These positions are then only visible to editors.
The TODOs can be accessed by entering TODO:
in the search.
Translations
For manual translations without the translation plugin, DeepL is used.