Differences

This shows you the differences between two versions of the page.

--- en:conventions_for_editors [2021/04/26 08:40] – [Pictures] adminwiki
+++ en:conventions_for_editors [2025/08/19 09:12] (current) – [Images] adminwiki
@@ Line 1: / Line 1: @@
-===== Page structure =====
+===== Content rules =====
+These are content rules for authors.
+{{INLINETOC 2-3}}
+==== 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 [[https://www.dokuwiki.org/plugin:deeplautotranslate|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 [[en: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. ''<nowiki>[[</nowiki>'' durch ''<nowiki>[[en:</nowiki>''  (remove spaces between the brackets). External links, e.g. to Wikipedia, must be replaced manually with their equivalent in the other language.//
+==== Salutation ====
+It is formulated using the formal ‘Sie’ form of address. This is a result of the translation with DeepL, in which English descriptions are translated using ‘Sie’ as the form of address, combined with the fact that many descriptions are initially created in English.
+==== Sitebar ====
+The sitebar is maintained manually. Only the page names of the target pages are specified as links, not the display text. The links therefore have the form ''<nowiki>[[Page target]]</nowiki>'' .
+==== Page structure ====
 The individual wiki pages are created with the following structure.
-==== Headings ====
+=== 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: {{ :pfeile.zip | 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 ''<nowiki>{{inlinetoc_3}}</nowiki>'' 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://
+''
+<nowiki><ifauth @admin></nowiki> \\
+  <nowiki>//Only visible for admins//</nowiki> \\
+  Visible only to admins \\
+  <nowiki>//End: Visible only to admins//</nowiki> \\
+<nowiki></ifauth></nowiki>
+''
+==== TODOs ====
+Notes for authors can be marked via the [[https://www.dokuwiki.org/plugin:nodisp|nodisp-Plugin]] button:
+''<nowiki>
+<nodisp 2>
+TODO: Say what needs to be done.
+</nodisp>
+</nowiki>
+''
+These positions are then only visible to editors.
+The TODOs can be accessed by entering ''TODO:'' in the search.
-Each page begins with a 2nd size heading. This is achieved by a text enclosed by 5 equal signs each. The 1st size heading (6 equals) is reserved and will not be used initially.
+==== Translations ====
+For manual translations without the translation plugin, DeepL is used.
-==== Subchapter ====
-Subchapters are given headings of the next lower size. There are at least two subchapters, so one never stands alone.
-===== Pictures =====
-Pictures are inserted in English and used in the same way for all translations. Screenshots are numbered when helpful to the user and are referred to in the text. These graphics are used for this purpose: {{ :pfeile.zip | Graphics for image captions}}
-===== Translations =====
-For the translation DeepL is used.