Zum Hauptinhalt springen
Wiki Behnke-Station

Redaktionsrichtlinien

Verbindliche Regeln für Inhalt und Format im Wiki der Behnke-Station. Diese Richtlinie gilt für alle Sprachversionen des Wikis. Maßgebliche Referenzen: die Vorlage templates/Vorlage_TK_Anlage.md und die Vorzeigeseite 3CX.

Hinweis

Übersetzte Wikis übernehmen Struktur, Platzhalter-Namen und Formatregeln unverändert (gleiche %[…]%-Includes, gleiche Bild-/Callout-/Benennungsregeln). Übersetzt wird ausschließlich der Fließtext.


1. Seitenaufbau

  • Erste Zeile jeder Inhaltsseite: der Tag-Kopf, Kategorien wie in der Seitenleiste, durch ; getrennt, mit abschließendem ;:
    <tags data-tags="Netzwerk;Einrichtungshilfen;"/>
    
  • Genau eine H1 (#) als Titel.
  • Abschnitte nummeriert: ## 1. …, Unterabschnitte ### 1.1. ….
  • Schema einer Einrichtungshilfe (Reihenfolge fix):
    1. ## 1. Einrichtungshilfe → Einleitung → %[NOTE_REQUIRES_BASIC_SETUP]%
    2. ### 1.1. Einrichtung der Gegenseite (TK-Anlage o. Ä.) → %[NOTE_MINIMAL_SETUP_OF_TK_USER]%
    3. ### 1.2. Konfiguration der Behnke-Station
    4. ## 2. FAQ
    5. %[LEGAL_NOTES]%
    6. Prüfvermerk

2. Sprache & Hervorhebung

  • Höflichkeitsform („Klicken Sie …"), klare und knappe Schritt-Anweisungen.
  • UI-Elemente (Buttons, Felder, Optionen, Werte, Menüpunkte) fett: **SIP-Konto 1**, **ja**.
  • Keine Doppelhervorhebung (nicht gleichzeitig fett und Anführungszeichen).

3. Bilder

  • Ausschließlich Markdown: ![Beschreibung](/de/files/…).
  • Kein HTML-<img>, kein width/style.
  • Der Alt-Text beschreibt den Bildinhalt bzw. was markiert ist — nicht „Abb. 1":
    • ![Behnke-Station Weboberfläche, Abschnitt SIP-Konto 1 markiert](/de/files/…/bild.png)
    • <img src="/de/files/…/bild.png" width="40%"> <br> <i>Abb. 7: …</i>
  • Keine separaten Bildunterschriften (<i>…</i> nach dem Bild) — die Beschreibung steht im Alt-Text.

4. Hinweise & Warnungen (Callouts)

Als GitHub-Style-Alert: Blockzitat, dessen erste Zeile der Typ-Marker ist. Der Marker wird beim Build zu einer Box mit Icon + Titel (der Marker selbst verschwindet):

> [!WARNING]
> Gerät vor der Wartung spannungsfrei schalten.
Marker Titel Farbe Verwendung
> [!NOTE] Hinweis blau allgemeine Information
> [!TIP] Tipp grün Empfehlung, optionaler Kniff
> [!IMPORTANT] Wichtig lila Voraussetzung, unbedingt beachten
> [!WARNING] Warnung amber Vorsicht, sonst Fehlfunktion
> [!CAUTION] Achtung rot kritisch, Schaden/Datenverlust möglich
  • Kein INFO-Typ.
  • Verboten: <div class="cpp_error">…</div>, GitLab-Markup {-…-} / {+…+}, eigene Fett-Labels wie **ACHTUNG:** (der Alert hat einen eigenen Titel).
  • Mehrzeilig: jede Zeile mit > beginnen.

5. Wiederverwendung (Includes & Platzhalter)

  • Wiederkehrende Bausteine einbinden statt kopieren: %[Anzeigename](/de/platzhalter)%.
  • Platzhalterdateien: Name komplett GROSSBUCHSTABEN, keine Sonderzeichen, _ statt Leerzeichen.
  • Standard-Bausteine (nie verändern/entfernen):
    • %[NOTE_REQUIRES_BASIC_SETUP]%, %[NOTE_MINIMAL_SETUP_OF_TK_USER]%
    • %[SIP_KONFIGURATION_BS_1]% / %[SIP_KONFIGURATION_BS_2]% (Abschnitt 1.2 — nur die Zuordnungstabelle ist anbieterspezifisch)
    • %[LEGAL_NOTES]%
  • Leerer Abschnitt → `> [!NOTE]

Zur Zeit sind hier noch keine Inhalte verfügbar` (kein freier „keine Inhalte"-Text).

6. Benennung & Verlinkung

  • Seitennamen bewusst und sprechend wählen.
  • Keine Umbenennungen. Falls doch unvermeidbar: alle Verweise händisch ändern — niemals über redirects.yml.
  • Interne Links per Seitenname ohne .md: [Anleitungen](/de/anleitungen).
  • Neue Seite in die passende Übersicht einhängen (Einrichtungshilfen, EINRICHTUNG_*-Listen).

7. Variablen statt Hartkodierung

Versionen, Download-Links etc. über Variablen: 6.33, https://2.behnke.support/de/file?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovLzIuYmVobmtlLnN1cHBvcnQiLCJhdWQiOiJodHRwczovLzIuYmVobmtlLnN1cHBvcnQiLCJ0eXBlIjoiZmlsZV9kb3dubG9hZCIsInVpZCI6NDc3LCJpYXQiOjE3ODIzOTA3NDIsIm5iZiI6MTc4MjM5MDc0MiwiZXhwIjoxNzgyMzk0MzQyfQ.QXkVJUw5OMbMHG-J4q6103ryT7IL42ic6OhcqkYLSXU,

. Nicht fest eintragen.

8. Pflicht-Footer jeder Anleitung

  1. Rechtliche Hinweise:
    <br>