Inhalt

Technische Infos für iX-Wiki-Autoren

Mitarbeiter der CREM SOUTIONS haben nach Anmeldung im iX-Wiki als Autoren die Möglichkeit, auf der Playground-Seite erste Schritte insbesondere beim Einsatz neuer Wiki-Funktionen auszuprobieren. Diese Playground-Seite ist daher für eigene Layouttests vorgesehen und kann auch direkt aus dem Edit-Modus per 'Spielplatz'-Verweis geöffnet werden. 8-o

Im Playgroundbereich Technische Infos für Autoren findet man unterstüzende sachdienliche Basisinfos rund um das iX-Wiki und DokuWiki. Hauptansprechpartner: ARR
Die Informationssammlung dort richtet sich an interessierte Autoren, die hier Erläuterungen und Beispiele zu den häufigsten 'Layoutfragestellungen' nachlesen können, ohne in der jeweiligen Doku von DokuWiki oder einzelner Plugins en detail nachzuforschen. Quasi vorgekauter Stuff reduziert auf die wesentlichen Aspekte für die technische Gestaltung in iX-Wiki. :-?

Der Redaktionsleitfaden liefert vor allem den technischen Redakteuren selbst eine Informationsbasis. Hier sammeln wir praktisch alle relevanten Workflows und Hintergrundinformationen, welche auch unsere technische Redaktion insgesamt betreffen oder erläutern. Gucken erlaubt, ändern bitte nur durch DSN und ARR :-P.

Neuanlage einer DokuWiki-Seite

Nachfolgende Optionen gelten nur für angemeldeten User im Wiki mit ausreichenden Bearbeitungsrechten.

  • Eine neue Seite kann nach Aufruf eines toten internen Links erzeugt werden.
  • Alternativ kann durch Eingabe des kompletten Pfads in der Adresszeile der Erstellungsprozess angestoßen werden. (Angabe der id)
  • Das installierte Plugin Indexmenu erlaubt in der Sidebar ebenfalls die Anlage neuer Seiten (Kontextmenü rechte Maustaste).

Bearbeitung auf Dateiebene im jeweiligen Unterverzeichnis von data\pages (unter Vorbehalt):

  • Eine weitere Form wäre das Kopieren von txt-Dateien in einen Namespace (ein Unterverzeichnis) des Wikis. Daher können theoretisch auch Musterdateien als Vorlagen oder kommandogesteuerte Prozesse zur Erstellung neuer Seiten genutzt werden. Der Name der Seite richtet sich primär nach dem Modulnamen in iX-Haus. Eine Seitenversionierung im Wiki findet hierbei jedoch nicht statt - erst beim späteren Bearbeiten im Wiki. Wiederherstellen einer vorherigen Version mit Wikifunktionen klappt daher bzgl. Manipulationen auf Dateiebene nicht!
  • Die Berechtigung, neue Seiten anlegen zu dürfen, hängt ggf. auch vom verwendeten Userlevel des Anwenders ab. Rückfragen hierzu bitte an ARR stellen (Thema: ACL).
  • Aufgrund der Namenskonventionen wandelt das Wiki Seitennamen automatisch in kleingeschriebene Namen um. An Sonderzeichen sind nur ., - und _ erlaubt, alle anderen Sonderzeichen werden automatisch zu Unterstrichen umgewandelt. Doppelpunkte (:) werden zum Erzeugen von Namensräumen (Namespaces) verwendet. Umlaute werden in Doppelbuchstaben (ü wird zu ue) und akzentuierte Zeichen in Zeichen ohne Akzent (á wird zu a) umgewandelt (Wikikonfiguration deaccent aktiv).

Bearbeiten einer Seite

  • Das Editieren einer Seite ermöglicht der Button Diese Seite bearbeiten sofern die Seite nicht gerade neu erzeugt wird.
    In geschachtelten Strukturen (s. include) oder zur Bearbeitung von Abschnitten mit entsprechend hoher Überschriftskategorie nutzt man am besten die passende Schaltfläche Bearbeiten unterhalb des Eintrags.
  • Eine Seite kann aktuell nur von einer Person bearbeitet werden. Beim edit-Aufruf durch einen weiteren Benutzer erhält dieser eine Sperreninfo. Die Seitensperrung wird wikiintern durch Lockfiles organisiert. Eine Sperre wird aufgehoben, wenn:
  • Vor dem Speichern kann die Vorschau genutzt werden, das Ergebnis zu prüfen. Sie meisten Störeffekte zeigen sich schon dort. Zudem vermeidet dies unnötige Zwischenversionen im attic durch nachträgliches Bearbeiten nach Speichern ;-)).

Löschen einer Seite

Eine Seite wird im Wiki automatisch gelöscht, wenn sie leer (ohne Inhalt) gespeichert wird. (Ältere Versionen der Seite bleiben im attic erhalten.)

Wenn alle Seiten innerhalb eines Namensraums gelöscht wurden (siehe Löschen einer Seite), dann existiert auch der Namensraum nicht mehr. DokuWiki löscht normalerweise auch das nun leere Verzeichnis. Hierzu gibt es ein Tool.

Seite umbenennen

Wurde ein Seite schon eingebaut und vernetzt, sollte sie nicht einfach auf Dateiebene umbenannt werden, da dann alle darauf zeigenden Links ins Leere gehen! Es gibt ein Tool im wiki zum Umbenennen, welches die abhängigen Links in anderen Seiten anpasst. (Ansprechpartner im Zweifelsfall: ARR)

Include

Mit dem include-PlugIn können ganze Seite oder Seitenabschnitte integriert werden. Sie ermöglichen somit auch eine Art von Querverweistechnik.

Und nochmal weils so schön ist: Zu fast jedem Plugin gibts eine Doku… der Admin gibt notfalls die benötigte Info.

Die Syntax von include wird hier beschrieben: https://www.dokuwiki.org/plugin:include#syntax

  • Insbesondere section-includes können Opfer von redationellen Änderungen der verwendeten Überschriften werden! Daher ist es ggf. ratsam, innerhalb der includeten Sektion, also direkt nach dem Abschnittstitel in der Quelle einen internen Hinweis bzgl. des/der hierauf zeigenden includes zu benennen und die section-includes erst in fortgeschrittener Bearbeitungsphase einzubinden, wenn die Abschnittsnamen 'sicher' sind.
  • folded-Abschnitte können, wie hier zusehen, vorzeitig gekappt werden. Das Zusammenspiel von include, wrap und foldet ist daher im Einzelfall zu prüfen, nicht jede Kombination ist sinnvoll.
  • Über die Funktion hidepages werden in der Konfiguration folgende Seiten unsichtbar und somit in der Navigation der Sidebar nicht gelistet: sidebar|playground
    Weitere Standardseiten wie technical|system|main|howto|howto1|howto2|parameter|parameter1|parameter2 sollen durchsuchbar sein und werden daher nicht via hidepages systemisch ausgeklammert! Sie können jedoch in den Parametern des Plugins indexmenu aus dem Navigationsmenü ausgeblendet werden. Dort sind Definitionen für auszublendende Namespaces und Seiten (genauer: Bestandteile von Seitennamen oder konkrete IDs einzelner Seiten) möglich.

Funktionen im Editormodus

Die meisten Bedienelemente sind selbsterklärend oder weisen einen erläuternden Tool-Tip auf.

  • Die Symbolleiste oberhalb des Textbereichs dient für Formatierungen, Überschriften, Links, Aufzählungen, …. Hier vorhandene Schaltflächen mit kleinem Dreieck rechts unten öffnen ein Auswahlmenü, das mit erneutem Klick auch wieder geschlossen werden kann. Fast alle lassen sich auch durch Tastaturkommandos bedienen.
  • Rechts außen sind allgemeine Schaltflächen zu finden - die auch außerhalb des Editormodus operabel sind.
    • Interessant hier vor allem der kontextsensitive Schalter Seite bearbeiten / Seite anzeigen.
    • Verlaufs-Uhr liefert Versionsvergleiche für Ältere Versionen der aktuellen Seite. Beachten Sie, dass bei Analyse von includeten Seiten ggf. zuerst auf die jeweilige Unterseite z. B. die parameter.txt eines Namespaces gewechselt werden sollte, um diese besser im Verlauf analysieren zu können.
    • Kette: Links hierher zeigt an, welche Seiten auf diese aktuelle Seite verweisen. Interessant bei Änderungen, wenn diese z. B. auf Abschnitte verlinken, deren Namen man ändern möchte oder um den weiteren Kontext einer Seite zu ergründen. Eine umgekehrte Sicht liefert dem Redakteur die dynamische Tabelle Ophans wanted, welche auf der Startseite eingebaut ist (für Kunden nicht sichtbar. Diese findet tote Links und zeigt an welche Seiten auf welche aktuell nicht vorhandene Seiten verweisen.
    • Adobe-PDF-Zeichen: PDF exportieren Erstellung einer PDF von der aktuellen Seite (PlugIn)
    • Drei Dreiecke: Alles Aus-/Einklappen betriftt alle Einklappungen, die mit ++++| ... ++++ oder ++| ... ++ erzeugt wurden. Standardmäßig wird eine Seite mit sämtlichen Einklappungen gestartet. Die Suche z. B. mit Strg+F im Browser oder das Springen via Verweis auf eine Überschrift in einen durch Einklappung nicht sichtbaren Bereich sind nicht erfolgreich. Dieser Schalter macht im Edit-Modus keinen Sinn. (PlugIn)
    • Pfeil Nach oben: Home-Schalter, identisch mit Funktion von Pos1-Taste (für Laptop-User ohne diese Navigationstaste interessant).
  • Links unten sind die Schaltflächen für Speichern, Vorschau und Abbrechen zu finden. Die Vorschau erfolgt über die Schaltfläche Vorschau. Sie wird unterhalb des Editorbereichs aufgebaut, also ggf. nach unten Scrollen.
  • Rechts unten können der automatische Zeilenumbruch ein/ausgeschaltet sowie mit den Pfeilen oder dem 'Griff' die Größe des Editorbereichs geändert werden.

Nützliche Tastaturkommandos

z. B. in Firefox mit Shift + Alt + …

  • e Editor aufrufen
  • p Vorschau (im edit-Modus)
  • s speichern (im edit-Modus)
  • b fetter Text (im edit-Modus)
  • m code Text (im edit-Modus)
  • l intern Link (im edit-Modus)
  • - sorted list (im edit-Modus)
  • . unsorted list (im edit-Modus)
  • 8 Überschrift in gleicher Ebene (im edit-Modus)
  • 9 Überschrift eine Ebene tiefer (im edit-Modus)
  • 0 Überschrift ein Ebene höher (im edit-Modus)

Code und Sonderdarstellung

Keine Formatierungen

Querverweise

Suchfunktionen

DokuWiki (somit auch iX-Wiki) bietet eine Volltextsuche an, basierend auf einem zuvor gebildeteten Index. Der Index wird automatisch gebildet über alle Seiten und Namespaces, außer den per hidepage-Parameter ausgenommen Seiten (sidebar und playground). Das Suchfeld rechts oben auf jeder Wiki-Seite erlaubt eine einfache wie auch spezifische Suche:

  • Die Suche nach einem Teilbegriff ist sinnvoll, wenn die Suche anch einem komplexen Begriff erfolglos war.
  • In der über die Volltextsuchergebnisse geöffneten Seite wird der Suchbegriff optisch hervorgehoben. Wollen Sie innerhalb der aufgeklappten Seite zu den jeweiligen Einzeltreffern springen, können Sie die Browsersuche (Strg + F) nutzen.

PHP-Technik der Suchfunktion und Indexierung in DokuWiki

Layoutprobleme nach Bearbeitung/Ergänzung von Inhalten

Wiki-Vokabular

1)
Zu welcher Seite der Verweis führt, hängt von der Existenz verschiedener Dateien ab. Hier wird i. d. R. dann die start-Seite gefunden. Beispiel: playground
2)
Fußzeilen finden Sie dann auf der gleichen Seite unten. Sie sind automatisch bidirektional verlinkt! Der Fußzeilentext steht im Quellcode in Doppelklammern direkt an der Stelle, wo später dann der verlinkte Fußzeilenindex aufauchen soll. Die Fußzeilen werden automatisch nummeriert. Der Fußzeilentext tritt zudem als Tooltip auf. Test eines Ankerlinks in einer Fußzeile Weitere Tests…
3)
Wir verwenden die Wikioption Useheading („Erste Überschrift als Seitennamen verwenden“). Hierdurch wird anstelle des (klein geschriebenen) Seitennamens die erste Überschrift von der verlinkten Seite als anzuzeigender Name genutzt. Das beeinflusst u. a. die Anzeige des Seitentitels in der Browserleiste und in den Ergebnissen von Suchanfragen, den angezeigten Text nach dem Erzeugen eines Links auf eine Wiki-Seite (solange kein expliziter Name angegeben wird). Die im iX-wiki verwendete Konfiguration ist useheading: navigation ⇒ die Überschrift wird für alles andere außer dem Seiteninhalt genutzt (z. B. Krümelpfad, Backlinks, Suchergebnisse, Titel in Browserleiste und Browsertab usw.).