======Technische Infos für iX-Wiki-Autoren======
{nodisp 2}Mitarbeiter der CREM SOUTIONS haben nach Anmeldung im iX-Wiki als Autoren die Möglichkeit, auf der [[playground:playground|Playground-Seite]] erste Schritte insbesondere beim Einsatz neuer Wiki-Funktionen auszuprobieren. Diese [[playground:playground|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 [[playground:technische_infos|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 [[playground:start|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.
{/nodisp}
==== 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:|
* das Lockfile älter als eine bestimmte Zeitspanne wird (Bearbeitungszeit abgelaufen ohne Reaktion des editierenden Benutzers auf den Dialog) (locktime-default: 15 Minuten)
* der editierende Benutzer die Seite speichert
* der editierende Benutzer das Editieren abbricht indem er den ''Abbrechen''-Knopf drückt
* Wenn der Vorschau Knopf gedrückt wird, wird das Alter der Seitensperr-Datei zurückgesetzt - damit ist ein Editieren über eine Zeitspanne von 15 Minuten hinaus gut möglich.
* Eine JavaScript-Meldung informiert den Benutzer eine Minute vor Ablauf der Seitensperre über deren bevorstehendes Auslaufen.
* Wenn JavaScript aktiviert ist, erneuert DokuWiki die Seitensperre im Hintergrund während des Editierens
++
* 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.
++++|
Das ist im iX-Wiki hilfreich bei der allgemeinen Seitengestaltung auf der Startseite des einzelnen Namespaces. Unser Standard ist die Einbindung von den im Inhaltsverzeichnis unsichtbar geschalteten Seiten ''main'', ''howto'', ''parameter'' und ''system'':
====== Titel ======
Mit nodisp 2 geklammerte interne Kommentare sind für User nicht sichtbar!
===== Was mache ich hier? =====
{{page>main&noheader&inline&nofooter}}
===== Wie mache ich es? =====
{{page>howto&noheader&inline&nofooter}}
===== Was brauche ich dazu? =====
{{page>parameter&noheader&inline&nofooter}}
===== Systemeinstellungen =====
{{page>system&noheader&inline&nofooter}}
Bei Bedarf kommen z. B. weitere Parameterseiten hinzu. Noch selten, da einfach noch nicht häufig benötigt, wäre die Einbindung eines Abschnitts einer Seite:
{{section>playground:parameter#abschnitt_2_von_parameter1&noheader&inline&nofooter}}
=>\\
{{section>playground:parameter#abschnitt_2_von_parameter1&noheader&inline&nofooter}}
Der Vorteil hiervon ist, dass hier unsichtbare Seiten als Quelle genutzt werden können und redundanten Informationen z. B. nur einmal in dieser Quelle gepflegt werden müssen. Ein Einsatzgebiet ist z. B. der Aufbau einer vollständigen Liste von Seriendruckfeldern zu einem Modul, welche sich aus diversen Platzhaltergruppen zusammensetzt. So braucht die einzelne Platzhaltergruppe nur einmal redaktionell beschrieben werden, kann aber im jeweiligen Modulkontext eingebaut werden.
Die include-Syntaxt ist umfangreich. So sind auch Links möglich. Die tragen den technischen Namen als Titel, sind also meist nur dann geeigent, wenn das Ziel mit einem markanten Wort auskommt. Besser ist, man besinnt sich des Include-Tags ''title''. Aber generell zu beachten ist, das über Links Seiten sichtbar werden, die ggf. in der Sidebar extra unsichtbar geschaltet wurden! Im Einzelfall ist daher zu prüfen, ob ein Link sinnvoll ist, anstelle eines Includes ggf. mit Einklappungen kombiniert:
{{section>playground:parameter#abschnitt_5_von_parameter1&noheader&title&linkonly&nofooter}}
=>\\
{{section>playground:parameter#abschnitt_5_von_parameter1&noheader&title&linkonly&nofooter}}
{{section>playground:parameter#abschnitt_5_von_parameter1&noheader&nofooter}}
=>\\
{{section>playground:parameter#abschnitt_5_von_parameter1&noheader&nofooter}}
* 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 ====
++++|
Mit einem ''%-tag'' können Wiki-Interpretationen inline deaktiviert werden.
%%''Beispiel''%% vgl. zu ''%%Beispiel%%''
=> %%''Beispiel''%% vgl. zu ''%%Beispiel%%''
Eine weitere Möglichkeit ist das ''nowiki''-tag (s. u. [[playground:technische_infos#keine_formatierungen|Abschnitt Keine Formatierungen]]):
'' ...'' 1234 '' ''
=> '' ...'' 1234 '' ''
Die ''Script''-Hervorhebung für Feldnamen, Modulnamen, Schalter etc. kann inline eingesetzt werden. (Tastaturkommando m)
Mit zwei Leerzeichen beginnende Zeilen führen zu einer Code-Darstellung:
Sript in Blöcken
mehrerer Zeilen
mit zwei vorangestellten Leerzeichen
Das ginge auch mit den tags '' ... ... '' (unterstützt auch mehrfache Leerzeichen?) oder '' ... ... ''.
++++
=== Keine Formatierungen ===
++++|
Ein html-formatierungsfreier Text oder Textabschnitt kann erzeugt werden mit Hilfe des
* ''nowiki''-tag oder einer Klammerung mit doppelten Prozent-Zeichen (sofern nicht andere Formatierungen dem Abschnitt übergordnet werden)
Ein geschützer Code-Abschnitt kann erzeugt werden mit Hilfe von
* ''code''-tag oder mit einer
* Einrückung mit zwei Leerzeichen zu Zeilenbeginn (besonders für Abschnitte geeignet)
Siehe nachfolgende Beispiele oder auch [[https://www.dokuwiki.org/wiki:syntax#no_formatting|no formatting in dokuwiki]].
** %%Eine Doppelprozentklammer [[playground:start#keine_formatierungen|kein Link]]%% sollte vor Codeausführung schützen und so auch Quelltext wie vom Hyperlink anzeigen, ohne diesen als interaktives Element umzuformen, andererseits aber Formate wie hier fett erlauben.**
** Der nowiki-tag [[playground:start#keine_formatierungen|kein Link]] sollte ebenfalls vor Codeausführung schützen, aber Formate wie hier fett erlauben. (Analog zu Doppelprozentklammer?!)**
Der nachfolgende Text ist ein Codeabschnitt, der unverändert kommen sollte [[playground:start#keine_formatierungen|kein Link]] -
aber als Code hervorgehoben wird. (Er bildet, auch wenn er inline eingesetzt ist, einen eigenen Code-Absatz mit eigenem Umbruch bzw. Scrolling) d. h einfacher Zeilenumbruch wird hier umgesetzt und überlange Zeilen sind möglich, ohne dass ein automatischer Umbruch zusammenhängenden Code in mehrere Zeilen zerlegt!
%%Eine Doppelprozentklammer [[playground:start#keine_formatierungen|kein Link]]%% sollte vor Codeausführung schützen und so auch Quelltext wie vom Hyperlink anzeigen, ohne diesen als interaktives Element umzuformen, aber Formate wie hier fett erlauben.
Der WRAP-Tag lässt innerhalb seiner Klammerung Formate und Links zu: [[playground:start#keine_formatierungen|kein Link]] ** Er schützt also nicht vor Codeauführung,... Das voranstehende Codebeispiel zeigt es deutlich.
Das ist ein Block mit Einrückung... [[playground:start#keine_formatierungen|kein Link]]
Der Vorteil liegt beim Schreiben mit dem Editor, da hier der Fließtext fortlaufend eingerückt
geschrieben werden kann und der Redakteur bei Bedarf den Umbruch mit der Returntaste vorgibt.
Zudem muss keine Endbedingung (schließende /code-Klammer gesetzt werden. Es reicht aus,
die Einrückung nach einem Return mit Backspace zu unterbrechen!
Bedienung und Layout-Fehlersuche werden damit einfacher.
Überlange Zeilen sind wie beim Code-Tag möglich und führen zur Scrollbalken-gestützten Codedarstellung. Sie müssen also manuell umgebrochen werden - also aufpassen ... falls der Redakteur mal auf der Tastatur eingeschlafen istttttttttttttttttttttttttttttttttttttttttttttttttttttt ;-=
* Der ''WRAP''-Tag (hilfreich z. B. in Tabellenzellen, um dort Aufzählungen zu generieren)
** Der WRAP-Tag lässt innerhalb seiner Klammerung Formate und Links zu: [[playground:start#keine_formatierungen|kein Link]] ** Er schützt also nicht vor Codeauführung, sondern er erweitert die Möglichkeiten für Code oder Strukturen auch in eingeschränkten Situationen (z. B. in Tabellen). \\ Nach der WRAP-Klammer erfolgt ein automatisches Absatzende! => WRAP als letztes Element in einer Zelle führt zu einer Leerzeile (wie ein p-Tag in html-Code, wirkt optisch wie zwei Zeilenumbrüche)!
Wird der WRAP-Tag für Boxen verwendet, muss die Klasse der Box in der einführenden Tagklammer benannt werden: tip, important, warning. Wird der 'große' WRAP genutzt, entstehen so Boxen. Ohne Prozentangaben wird die Box maximal groß zwischen linkem und rechtem Haupttextseitenrand platziert. Mit einer zusätzlichen Prozentangabe wird die Größe vom Redakteur festgelegt. Auf das Merkmal round sollte man verzichten, wenn man ein einheitliches Bild unabhängig von diversen Browsern anstrebt. Das kann im ungünstigen Fall einen Layoutkonflikt mit dem TOC-Inhalt geben, wenn der WRAP-Block im Kopfbereich einer Seite platziert ist! Er wird dann erst unterhalb des TOC angezeigt => Eine ungewollte Lücke im Kopfbereich kann hierdurch entstehen. Ein 'kleiner' wrap erzeugt die Hervorhebung inline, also in der Zeile. Das ist hilfreich z. B. in Tabellen. WRAP-Klammern sollten nicht über Überschriften hinaus gespannt werden. Wird der Abschnitt z. B. mittels include woanders eingebaut, fehlt dann das schließende Tag!
Die Hintergrundfarben des wrap-plugins sind css-definiert (siehe ''..\lib\plugins\wrap\style.less'') und werden daher nicht sofort nach Änderung des Quellcodes in sichtbar - erst nach Serverneustart oder vergleichbaren Prozessen. Beispiel
/*____________ important ____________*/
.wrap_important { background-color: #ffffe0; }
++++
==== Querverweise ====
++++|
Externe wie interne Querverweise wirken wie Hyperlinks. Wir benennen sie vereinfachend als ''Links''. Für externe Querverweise (Hyperlinks auf eine URL außerhalb des iX-Wiki) muss im Wikitext nur die Webadresse eingetragen werden. Die internen Querverweise (Verweise werden mit tags formuliert und verweisen i. d. R. auf eine Überschrift innerhalb einer Wikiseite. Diese wird aufgrund der wikiinternen Namenskonvention ein paar Übersetzungsregeln (keine Großbuchstaben, Umlaute transkribieren, Leerzeichen werden zu Unterstrich, ...) beachtend hinter einem Hashtag als Parameter angegeben. Einfacher ist es häufig, einen bestehenden Link aus dem TOC oder aus der Adresszeile des Browsers als Kopierquellle zu nutzen. Es gibt auch die Möglichkeit, eigene Sprungmarken zu definieren.\\
Beispiele seiteninterner Links: \\ a) ohne einen Linktext [[]] [[]] (Hier bildet dann der aktuelle Namespace den Linknamen automatisch, i. d. R. ein simpler Link, um an den Seitenanfang der aktuellen Seite zu springen.)\\ b) mit Angabe des aufzurufenden Namespaces und Doppelpunkt am Ende als Standardverweis ((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:]]))\\ c) mit Linktext (Wiki-Standard, um zu anderer Seite zu wechseln)\\ d) Überschriftsnavigation [[playground:start#querverweise|zu Abschnitt Querverweis]] (zur Navigation innerhalb der gleichen Seite oder zu spezifischen Stellen in anderen Seiten).\\ e) zu einem wrap-Marker. Beispielcodes hierzu:
a) [[]]
b) [[playground:]]
c) [[playground:start|Linktext]]
d) Auf Überschriften verweisender Link: [[playground:start#querverweise|zur Abschnitt Querverweis]]
e) Auf wrap-Marker verweisender Link: [[#sprungmarkentechnik]]
**Individuelle Sprungmarken** sind mit Hilfe des ''wrap''-Plugins auch innerhalb der Seiten ohne Überschriften möglich. Man muss dann neben dem Link natürlich auch den Anker definieren (Ähnlichkeiten mit html-code sind evolutionsbedingt...). Der Anker ist praktisch nur im Quelltext erkennbar, darf aber nicht in einer Einklappung verborgen sein. Sonst klappt der Link nicht (wie auch bei den Links auf Überschriften), wird aber auch nicht als toter Wiki-Link angezeigt - das kann Verwirrung beim Anwender oder der Fehlersuche stiften. Groß-Kleinschreibung ist nicht Pflicht, Einheitlichkeit in der Schreibweise erleichtert aber die spätere Bearbeitung. Der einfache Verweis auf eine seiteninterne Überschrift funktioniert auch ohne namespace:seitenname-Nennung ...[[#Querverweise]]
e) Der Link: [[#sprungmarkentechnik]]
Der Anker: text or nothing oder eine entsprechende Überschrift ==== Sprungmarkentechnik ====
Die **Fußzeile**((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... ++|Test 2: mehrfaches indent-Wrapping++ ++|und Test 3: Ankerlink innerhalb einer Fußzeile: [[#Backlink]]++)) bietet eine weitere Form eines Querverweises. Dieser ist bidrektional. \\ Was nicht unterstützt wird, sind multiple Fußzeilen im Format n:1. Die Ankertechnik mit Wrap (Variante d) kann jedoch mit Fußzeilen kombiniert werden: [[#TestAnkerlink]] klappt ;-). Test eines von einer Fußzeile kommend (Backlink) klappt auch :-). Insofern wären hiermit n:1-Konstellationen möglich. Der Status der Einklappung des span-Wrappings kann jedoch nur in der Fußzeile selbst, nicht im Tooltip geändert werden. Letzterer liefert immer ein aktuelles Abbild der referenzierten Fußzeile.
e) ((Fußzeilentext))
Für alle Varianten von Querverweisen gilt:
* Liegt das Sprungziel tief unten am Seitenrand, kann die obere Seitenzeile mitunter nicht identisch mit der Position des Sprungziels sein, die Seite beginnt sozusagen 'früher'.
* Liegt das Sprungziel in einer zugeklappten Einklappung, ist es per default unsichtbar. Je nach Technik verweisen dann die Querverweise auf das übergeordnete Element (i. d. R. wird dann einfach die oberste Zeile der zugrundeliegenden Seite aufgerufen) oder reagieren gar nicht (z. B. Fußzeilen und Ankerlinks).
* Eine Technik, die erste Aufklappung beim Anspringen einer Überschrift über einen Link zu erzeugen, ist noch Wunschdenken. Die Aufklappung ist allenfalls ein benachbartes Element des Sprungziels. ##Hintergrund:| Eine Kommunikation zwischen Überschrift_angesprungen und Einklappung nach Überschrift existiert derzeit nicht. Sie müssten m. E. in den Aufruf, also die Linkdefinition als individueller Parameter oder in der php-Basisprogrammierung als allgemeines Feature integriert werden sinngemäß: Öffne erste Aufklappung in Abhängigkeit der Adresszeile im Browser: Wenn dort ein Hashtag vorkommt, ist die erste Aufklappung nach diesem Ziel gemeint.##
===Formatierung===
* Bei Querverweisen mit Sprungmarken wird in Dokuwiki zwischen internen Verweisen und externen Hyperlinks unterschieden - letztere sind über ein vorangestelltes Weltkugelsymbol erkennbar und öffnen in separatem Browserfenster bzw. Tab.
* Interne Links (Verweise) werden zudem unterschieden in Links auf existierende und nicht existierende Ziele. Existierende interne Links können unterschiedliche Farbgestaltung aufweisen (besucht/nicht besucht) und sind per Default von DokuWiki nur bei MouseOver unterstrichen. In dieser Konfiguration von iX-Wiki haben wir den Unterstrich fest eingebaut (s. u.). Links mit nicht existierendem internen Ziel werden rot und gestrichelt unterstrichen hervorgehoben. Zur Analyse dieser toten internen Links ist auf der Startseite eine interne Abfrage eingebaut (orphan links, nur nach entsprechender Anmeldung sichtbar).
* Operable interne Links werden in DokuWiki per Default nicht automatisch hervorgehoben außer mit Linkfarbe und zusätzlichem Unterstrich bei MouseOver. In vielen Situationen sind solche internen Links im Fließtext verborgen und der Farbkontrast für Farbfehlsichtige leider nicht sonderlich hoch. Eine typographische Hervorhebungmöglichkeit ist daher durch das Unterstrichformat im Wiki gegeben, da dann der Link auch ohne MouseOver farbunabhängig erkennbar ist. Diese Einstellung kann in der CSS-Datei ''..\lib\tpl\dokuwiki\css\_links.css'' im Codeabschnitt zu ''.dokuwiki a.wikilink1'' vorgenommen werden, indem dort die Parameterzeile ''text-decoration: underline;'' eingefügt wird: \\ /* existing wikipage */
.dokuwiki a.wikilink1 {
text-decoration: underline;
}
* Test der generellen Anpassung über \lib\tpl\dokuwiki\css\_link.css => Wirkt diese Unterstreichung auch außerhalb des Fließtextes (z. B. Links in Sidebar oder TOC)? Hier wären die automatisch unterstrichenen Hyperlinks nicht so hübsch ... ++Codevergleich vorher/nachher...|
allgemeiner Standard
...
/* existing wikipage */
.dokuwiki a.wikilink1 {
}
...
Alternative mit Unterstreichung
...
/* existing wikipage */
.dokuwiki a.wikilink1 {
text-decoration: underline;
}
...
++
* unterstrichener normaler Link in Text oder Tabelle: X :-)
* Sidebarlink: ./. :-)
* TOC-Link: ./. :-)
* Fußnoten-Link: ./. :-)
++++
==== 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:
* Suche mit UND: Leerzeichentrennung ''Begriff 1 Begriff2''
* Suche mit ODER: Pipezeichen (anstatt Leerzeichen) ''Begriff1|Begriff2''
* Suche mit Ausschluss: Minuszeichen ''Begriff1 -Begriff2''
* Suche nach Begriff: Doppeltes Anführungszeichen ''"Begriff1 Begriff2"''
* Fragmentsuche: Sternchen-Allquantor ''Begriff1*'' oder ''*Begriff1*''
* Namensraum-(Verzeichnis)Suche mit at-Zeichen: Die Namensraumsuche reduziert die Suche auf bestimmte Bereiche des Wikis. ''@fachadministration:faktura'' führt zu der Suche von Faktura im Namensraum fachadministration (setzt die Kenntnis der Namensräume voraus).
* optionale Integration des Wiki-Suchfeldes im Browser. Diese Option nutzen wir derzeit nicht. ++Details: | DokuWiki folgt dem OpenSearch-Standard und kann somit neben Google oder Yahoo einfach in den jeweiligen Browser integriert werden. Befindet man sich im Wiki, so bieten Browser wie Firefox oder Internet-Explorer bieten im Suchfenster die Möglichkeit weitere Suchmaschinen zu ergänzen. Ist die Anwendung des Wikis ein Glossar, ein Vertriebs-Support-Tool oder eine technische Informationsquelle, so können die Anwender ohne Umweg ihren Informationsbedarf befriedigen.++
* 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|
Siehe auch https://www.dokuwiki.org/de:search
DokuWiki verwendet einen Index um sogar in großen Wikis Suchanfragen sehr schnell zu verarbeiten. Um alles finden zu können, muss der Index mit den aktuellen Daten gefüllt sein. Informationen über den Seiteninhalt werden hinzugefügt und abgeändert, wenn sich ein User die Seite anzeigen lässt. Jede Seite enthält ein unsichtbares Bild (webbug), dass die Index-Aktualisierung aufruft, falls nötig.1) (Die Aktualisierung gilt als nötig, falls der Zeitstempel der Seite neuer ist, als der Zeitstempel der Index-Datei.)
Der Index besteht aus verschiedenen Dateien, die im Verzeichnis data/index liegen. „w[n].idx“ beinhaltet eine Liste aller Wörter (mit Ausnahme von Stoppwörtern), der Länge n, die auf den Wikiseiten vorkommen. Pro Zeile in „w[n].idx“ gibt es eine Zeile in „i[n].idx“, welche die Seiten, auf denen das Wort vorkommt, in der Form „pn*freq“ auflistet. „pn“ ist eine Zeilennummer von „page.idx“, „freq“ ist eine Zahl, die angibt, wie oft das Wort auf der Seite vorkommt. Kommt das Wort auf mehreren Seiten vor, sind die Seitenreferenzen mit einem Komma getrennt.
Der Indexer ''..\inc\indexer.php'' benutzt eine sprachspezifische Stoppwort-Datei ''..\inc\lang\de\stopwords.txt'', die eine Liste von sehr alltäglichen Begriffen, die niemals indiziert werden (z.B. das Wort „das“ im Deutschen). Eine Suche nach einem solchen Begriff wird keine Treffer liefern.
Wenn ein Wiki von einer älteren Version ohne Index upgedatet wird, wird die Suche keine Treffer liefern, bis der Index erstellt wurde. Man kann entweder warten, bis dies durch das Stöbern im Wiki passiert, oder das bereitgestellte Kommandozeilen-Skript bzw. Plugin in der Administration verwenden, um den Index zu aktualisieren (Neuerstellung des Index über 800 Seiten dauert hier ca. 30 Minuten).
Lt. DokuWiki-Entwickler müsse man beachten, dass in den Indexdateien unter Linux der Zeilenumbruch mit LF und nicht mit CRLF erwartet werde. Hier könne es z. B. bei einem Upload mit FTP im ASCII-Mode zu einer Änderung der Indexdateien kommen.
Man könnte den Suchindex auch auf dem Online-Wiki erstellen, ohne dass ein Benutzer in dem Wiki online sein muss oder dass man das searchindex-Plugin via Administration aufrufen muss. Das sollte auch einfach über einen Kommandozeilenaufruf zu realisieren sein und ließe sich sogar automatisieren (z.B. in cron oder dem Script welches die Daten von Windows nach Linux kopiert): vgl. https://www.dokuwiki.org/cli#indexerphp
Hinweise zur Suchproblematik siehe thread im DokuWiki-Forum: https://forum.dokuwiki.org/d/20654-volltextsuche-scheitert-in-online-variante/11
++++
==== Layoutprobleme nach Bearbeitung/Ergänzung von Inhalten ====
++++|
Nach Bearbeitung (bzw. während der Bearbeitung des Seitentextes schon in der Vorschau) fallen Layoutumbrüche oder sogar scheinbar fehlende Inhalte auf. Klassiker für solche Layoutfehler sind meistens Fehler von paarweise erwarteten Steuerzeichen:
* fehlende Apostrophen-Paare (nur ein doppelter %%''%% einzelstehend) oder
* fehlender Apostroph ' %%(''abc' statt ''abc'')%%
* fehlendes/überzähliges Pluszeichen %%+%% bei Klammerebenen: %%++++| bla bla bla +++%%
* fehlender Slash %%/%% bei schließendem Tag: %%%% statt %%%%
* fehlendes Schließen -Tag einer Wrap-Klammer: %%Lore ipsum abc%% statt %%Lore ipsum abc%% => nachfolgende Überschriften werden dann z. B. nicht mehr als solche interpretiert
* Tabellen reagieren sensibel auf bestimmte Layoutanweisungen und werden im Fehlerfall unvollständig dargestellt.
* Zeilenumbruch durch nicht erkannten Return in Tabellenzelle (beachte die Möglichkeit der WRAP-Anweisung für intern formatierte Zellen, um z. B. Aufzählungen zu realisieren)
* unerwünschte Ausrichtung in Tabellenzellen rechtsbündig oder zentriert durch fehlendes/überflüssiges Leerzeichen zu Beginn/Ende einer Tabellenzelle
* gestufte Tabellen durch fehlendes/überflüssiges Pipe-Zeichen %%|%%
* doppelter Backslash statt Zeilenumbruch: fehlendes Leerzeichen hinter dem doppelten Backslash
* zusammengeschobenen Wörter: fehlende Leerzeichen, meist nach einem Format-Tag, oder nach automatischer Übernahme zweier kombinierter Zeilen aus der Vorversion in GoogleSites
=== Überlaufende Hyperlinks ===
* fehlendes %%]%% %%[[namespace:seite#abschnitt|Muster-Abschnitt]%% statt %%[[namespace:seite#abschnitt|Muster-Abschnitt]]%% => nachfolgende Bereiche werden dann (bis zum nächsten Hyperlink) auch als Hyperlink betrachtet.
===Überlaufende Hervorhebung in Codedarstellung===
* Falsch geklammerte Codes sind optisch sichtbar, da hier ggf. auch nachfolgende Leerzeichen als Code ausgezeichnet werden. Eine typografisch saubere Darstellung erreicht man durch Bearbeitung von Leerzeichenpositionierung bzw. dem schließenden Apostrophenpaar: %%''Feldbezeichnung1 '', ''Feldbezeichnung2 '', …%% -> %%''Feldbezeichnung1'', ''Feldbezeichnung2'', …%% Solche Effekte könnennach automatischer Datenübernahme auch am Anfang und Ende von Klammern auftreten. %%( ''code '')%%. Seltener sind auch versetzte Formatklammern %%( ''code) ''%% -> (''code''): ( ''code '') oder ( ''code) '' -> (''code'')
===Überflüssige Zeilenumbrüche===
Überflüssige Zeilenumbrüche werden vom Wikisystem oftmals kompensiert. Folgt auf den Zeilenumbruch kein adäquater Inhalt, wird der Zeilenumbruch nicht ausgeführt und ist somit nur im Editor sichtbar. Der Zeilenenumbruch wird mit doppeltem Backslash %%\\%% gefolgt von einem Leerzeichen codiert.
Aus der automatisierten Datenübernahme sind solche überflüssigen Codes am Ende von Zellen in Tabellen oder Aufzählungen zu finden. Sie können in der weiteren Verarbeitung worst case wirksam werden und sollten daher nach Möglichkeit entfernt werden.
===Multiple Einklappung auf Hauptseite nicht editierbar===
Mittels WRAP-Klammern und Folding können auch Unterabschnitte eingeklappt werden. Wir haben beobachtet, dass dann solche Unterabschnitte nicht mehr über über die einzelnen Bearbeiten-Schalter einer Startseite, wo Seiten per ''include'' integriert sind, mit Inhalt geöffnet werden. Das Editorfenster ist dann unerwartet leer! Abhilfe schafft derzeit, erst die entsprechende Unterseite wie ''parameter'', ''howto'' oder ''technical'' anstelle der ''start''-Seite zu öffnen und dann dort zu bearbeiten.
++++folding A|
=====Abschnitt A eingeklappt=====
++++
++++folding A1|
====Abschnitt A1 eingeklappt====
++++
++++folding A2|
====Abschnitt A2 eingeklappt====
++++
++++
s. a. meine Anfrage bei DokuWiki vom 27.06.2022: https://www.dokuwiki.org/plugin:wrap:discussion#questionedit_of_nested_wrap_in_included_pages_looses_target_in_editor
++++
====Wiki-Vokabular====
++++|
Zum allgemeinen Verständnis und Diskussion über Merkmale oder Funktionen im iX-Wiki ist es hilfreich, die Bedeutung oder auch Differenzierung allgemeiner und Wiki-spezifischer Fachbegriffe zu kennen - oder zumindest zu wissen, wo diese informationen zu finden sind. Nachfolgend ist sozusagen ein quick & dirty-Überblick über die Terminologie, welche wir in der letzten Zeit benötigten, um die redaktionelle Umsetzung unserer Gestaltungswünsche im Wiki zu formulieren.
* **abbreviation** = einzelne Worte können im Wiki anhand einer internen Liste als Abkürzungen erkannt und mit einem Tooltip beschrieben werden. Hierzu wird eine allgemeine Konfigurationsdatei geführt. ++Individuelle Ergänzungen| können unter ''conf/acronyms.local.conf'' im UTF-8-Format gepflegt werden (beachte https://www.dokuwiki.org/abbreviations).++
* **Absatz** = Ein Zeilenumbruch kann durch eine zusätzliche freie Leerzeile oder durch zwei Backslashes gefolgt von einem Leerzeichen im Text einer Wikiseite formuliert werden. Der Zeilenwechsel mit der Return- oder Eingabetaste verusacht nur einen technischen Zeilenumbruch im Editor, der aber im Fließtext der Wikiseite keinen sichtbaren Zeilenumbruch bewirkt. Innerhalb von Tabellen führt dies jedoch zu einem Interpretationsfehler! Nachfolgende Zeilen der Tabelle werden dann nicht mehr interpretiert und sind dann nur im Editormodus sichtbar. In Tabellen muss daher ein Zeilenwechsel zwingend mit %%\\ %% gesetzt werden, wenn man nicht auf andere Formatierungen wie ein WRAP-[[#tag]] zurückgreift. Ein WRAP-tag erzeugt immer einen separaten Absatz und erlaubt in einer Tabellenstruktur den Einsatz von Zeilenumbrüchen mit Leerzeilen oder weiterer Formatierungen, z. B. Aufzählungen. \\ Folgt (in einem Fließtext) nach einem einfachen Return in der Folgezeile eine Headeranweisung, wird für den vorherigen Text ein Absatzende interpretiert. In der Ausgabe im Browser identisch, optisch im Quelltext jedoch eindeutig besser lesbar ist jedoch, eine Leerzeile vor und ggf. auch nach einer neuen Überschrift zu setzen.
* **acronyms** = s. [[#abbreviation]]
* **attic** = Speicher. Vorversionen von Wikiseiten oder Daten werden automatisch in parallel geführten ''attic''-Verzeichnissen gespeichert. So kann i. d. R. jede einzelne Seite mit Wiki-Bordmitteln auf frühere Versionsstände verglichen und auch zurückgeführt werden.\\ Wir setzen zur Versionierung parallel TortoiseSVN ein, ein Dateiversionierungssystem, welches uns erlaubt, z. B. einen Seitenanpassung in iX-Wiki-Version 20.21.0 mittels commit und update auf Dateiebene in die nachfolgenden iX-Wiki-Versionen zu mergen.
* **em** = Einheit zu Größenangabe in html, css oder xml-code
* **Formatauszeichnung** = Markierung eines Textteils z. B. um diesen %%**fett**%% **fett** oder inline in %%''Code-Darstellung''%% ''Code-Darstellung'' wiederzugeben. Wird von den doppelten Zeichen (letzlich sind es ja Pärchen, also vier) eines vergessen bzw. gelöscht, läuft das Format 'ungebremst' bis zur nächsten identischen Formatauszeichnung weiter, manchmal kommt es zum Abbruch der Darstellung der restlichen Seite.\\ %%''CodeX' und das ist nur hier gewollt.' Bla bla...''%% ==> ''CodeX' und das ist nur hier gewollt.' Bla bla...''
* **Fußnote** = mit dem [[#tag]] einer doppelten runden Klammer wird eine automatisch numerierte Fußnote gebildet. Der Inhalt einer Fußnote unterstützt (fast?) alle Wikiformateanweisungen. Der Inhalt wird wie ein Tooltip bei einem Mouseover eingeblendet und ist parallel am Seitenende zu finden. Der Fußnotenindex im angezeigten Fließtext sowie die Fußnote am Seitenende sind wechselseitig verlinkt. Letztere findet ihr Linkziel beim Klick nur, wenn dieses auch 'sichtbar' ist! Bei Einklappungen also ggf. erst alle Abschnitte aufklappen, wenn der Sprung vom Seitenende aus scheinbar nicht funktioniert.
* **header** = Überschrift. Der erste Header wird vom Wiki auch namensgebend für die Seite genutzt, auch im Navigationsmenü. Der technische Name ist hingegen Bestandteil der ''ID'' einer Seite. ((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.).)) \\ Die Überschrift kann als Linkziel angegeben werden, indem deren Umsetzung (unter Berücksichtigung der ''Namenskonvention'' des Wikis) als Bestandteil eines Verweises mit führendem Hashtag an die ''id'' im Verweis-[[#tag]] angegeben wird. \\ Beispiel: %%[[playground:technische_infos#wiki-vokabular|Wiki-Vokabular (internes Glossar)]]%% => [[playground:technische_infos#wiki-vokabular|Wiki-Vokabular (internes Glossar)]]
* **Hyperlink** = ein Pfad zu einer Webadresse. Externe Hyperlinks werden vom Wikisystem automatisch im Fließtext erkannt, z. B. %%https://www.crem-solutions.de/%% wird zu https://www.crem-solutions.de/ (das Weltkugelsymbol setzt DokuWiki automatisch und weist damit auf die Qualität 'externer Link'). Interne Verweise werden im Wiki als [[#tag]]s mit doppelten eckigen Klammern aufgebaut. Sie arbeiten dann analog zu Hyperlinks und ermöglichen Sonderfunktionen. Fußnoten sind mit tags durch doppelte runde Klammern möglich.
* **ID** = namespace(s) und page mit Doppelpunkten getrennt. So hat diese Seite die ID ''playground:technische_infos''. Sie finden diese ID als Bestandteil der Adresse der angezeigten Webseite im Browser und als Registerbeschriftung (rechts oben im Seitenrahmen).
* **inline** = Anweisung oder Ort innerhalb einer Zeile bzw. eines Absatzes. Die ++folded-Funktion| mit zwei Plus-Zeichen ist z. B. eine inline-Variante eine Anweisung für das folded-Plugin ++ und Inlineanweisungen wie diese wrap-Info können oft auch problemlos innerhalb anderer Strukturen wie z. B. Tabellen genutzt werden.
* **Link** = allgemeine Bezeichnung für weiterleitende Elemente wie [[#Hyperlink]], [[#Verweis]] oder [[#Fußnote]]
* **media** = Medien sind im DokuWiki auf bestimmte Dateitypen, Dateigrößen und Berechtigungen beschränkt, wobei hier noch zwischen Uploadberechtigungen und technischen Limits unterschieden werden kann. Mediadateien werden im Hauptverzeichnis oder in einer dem namespace angeglichenen Struktur auf dem Server im Unterverzeichnis ''data\media'' gespeichert. Bilder können als Medien in einzelnen Seiten direkt oder verlinkt eingebunden werden. Nicht zulässige (da nicht direkt anzeigbare) Medien können als Downloadangebot in ZIP-Archiven gepackt werden. \\ ++Einbinden von Grafiken|
Die Integration von Grafiken in iX-Wiki ist in Einzelfällen didaktisch sinnvoll. Bilder werden im Kontext zu einer Wikiseite upgeloadet und integriert. Formatanweisungen: linksbündig, große Grafiken (Breite >= 400) auf Stufe M verkleinert und mit Link, ansonsten in Originalgröße ohne Link. Das Umfließen kleinerer Grafiken kann mit Hilfe leerer Überschriften der Kategorie 5 unterbunden werden. Manchmal gewollt, meist eher unerwünscht, kann der umfließende Modus auch die Positionierung von nachfolgenden Elementen wie Tabellen maßgeblich beeinflussen!
Die Grafiken können hinter dem Pipezeichen im Link tituliert werden (Aktiv bei Anzeige des Titels bei Mouseover oder beim Vorlesen der Seite)\\ Details siehe https://www.dokuwiki.org/wiki:syntax#media_files ++
* **Namenskonvention** = Für namespaces und technische Dateinamen gibt es eine Namenskonvention:
* keine Großbuchstaben
* keine Umlaute: ä => ae
* keine Sonderzeichen (außer Punkt, Bindestrich und Unterstrich)
* keine Leerzeichen (Ersetzung durch Unterstrich)
* Doppelpunkte ('':'') werden zum Erzeugen von Namensräumen (namespaces) verwendet.
* **namespace** = Namensraum. Dateitechnisch gesehen ein Verzeichnisname unterhalb von data\pages auf dem Server. Der namespace dient der inneren Organisation des Wikis. Verschachtelungen sind möglich. Namespaces unterliegen wie die technischen Dateinamen einer Namenskonvention. Sie werden bei Bedarf automatisch angelegt, aber nicht automatisch gelöscht. ((s. auch https://www.dokuwiki.org/de:pagename und https://www.dokuwiki.org/de:namespaces))
* **page** = Seite, technischer Name der Seite, Bestandteil einer [[#ID]]. Als Datei auf dem Server hat der Dateiname die Endung .txt und Unterliegt der [[#Namenskonvention]]. Die Datei liegt immer im Verzeichnis ''data\pages'' bzw. einem Unterverzeichnis davon (s. [[#namespace]]). Eine page kann automatisch durch Bearbeitung angelegt, durch Entfernen des gesamten Inhalts aber auch wieder gelöscht werden.
* **playground** = Spielplatz - ein vom allgemeinen Wiki-Bereich logisch abgetrennter namespace für redaktionelle Tests oder sonstige Informationen, die nichts in der eigentlichen Kundeninformation zu suchen haben. Daher wird dieser Namespace vor der Öffentlichkeit verborgen. Hier finden sich auch ein paar gesammelte Tipps und Infos aus dem Redaktionsleitfaden, um diese auf die Schnelle abrufen zu können. Zugang: ''id=playground:start''
* **plugin** = Zusatzfunktion, welche ergänzend zum DokuWiki weitere Funktionen bereitstellt, meist von einem anderen Autor als vom Hauptentwickler des Wikis. Plugins werden wie Templates administrativ installiert und wirken meist bis in die Editorebene, wo dann neue oder erweiterte Funktionen genutzt werden können. In iX-Wiki ist nur eine Auswahl von Plugins integriert. Die sich hierdurch ergebenden Besonderheiten beschreiben wir an geeigneter Stelle. Über die Wiki-interne Übersicht der Plugins kann der Administrator erkennen, ob es zu den verwendeten Plugins Updates gibt und diese auch installieren. Bei Bedarf verlinken wir in unserer Pluginübersicht hier im Playground Querverweise zu den jeweiligen Plugin-Seiten bei dokuwiki.org.
* **Querverweis** = siehe [[#Verweis]] und [[#Hyperlink]]
* **Sidebar** = Ein in DokuWiki auf der linken Seite eingeblendeter Bereich, der meistens für die Navigation eingesetzt wird. Die hierzu verwendeten ''sidebar.txt''-Dateien können pro Namespace existieren. Im html-Jargon wird der oftmals links angeordnete Bereich einer aufgeteilten Webseiten sidebar genannt. Elemente der Sidebar steuern hierbei oft die Inhalte der Hauptseite.
* **Spielplatz** = siehe [[#playground]]
* **TOC** = Table Of Content: In DokuWiki interaktives Inhaltsverzeichnis für eine Wiki-Seite bzgl. der im Wiki verwendeten Überschriften. Bei ausreichender Anzahl der Einträge wird es automatisch generiert und rechts oben auf der Hauptseite eingeblendet. Text wird verschoben und sonstige (nicht umbruchsfähige) Elemente darunter angezeigt. Der TOC kann eingeklappt werden. Der deutsche Originaltitel in DokuWiki lautete: ''Inhaltsverzeichnis''
* **Tag** = Ein ''tag'' [täg] (wir nutzen hier besser die originale englische Bezeichnung wg. der Verwechselungsgefahr mit dem dt. Tag) ist eine Markierung beginnend mit einer tag-Bezeichnung und ggf. Parametern und endend mit einem tag-Ende, meist mit spitzen Klammern, geschweiften Klammern oder ohne Klammern, dafür dann mit einer Wiederholung von speziellen Codezeichen. Beispiel: \\ ''%%Beim Mischen von mehreren tags bitte die Klammerebenen beachten. Die ++Klammerebenen des folded-Plugins| kommen ohne spitze Klammern aus und sind an doppelten oder vierfachen Pluszeichen zu erkennen und++ sind eigentlich auch tags.%%'' => Beim Mischen von mehreren tags bitte die Klammerebenen beachten. Die ++Klammerebenen des folded-Plugins| kommen ohne spitze Klammern aus und sind an doppelten oder vierfachen Pluszeichen zu erkennen und++ sind eigentlich auch tags.\\ Fehler beim Beenden von tag-Klammern (und von Formatauszeichnungen) fallen meist optisch sehr schnell auf. Nutzen sie die Vorschau-Funktion, mit der Sie (meistens) die Wirkung von tags oder Formateauszeichnungen vor dem Speichern prüfen können. Manche Klammer-Fehler sind leider erst im Kontext des bearbeiteten Textes erkennbar.
* **Themes** siehe [[#Template]]
* **Template** = Templates oder Themes werden z. B. genutzt, um unterschiedliche Layoutfunktionen ansteuern zu können. So haben wir z. B. für das Navigationsmenü ein eigenes Set mit Grafiken erstellt. Templates beeinflussen das 'look & feel' des Wikis. s. a. [[#plugin]].
* **tooltip** = Wiki führt eine Seite mit einer Auflistung einzelner Abkürzungen/Begriffe und deren Erläuterungen, die dann als Tooltip bei einem Mouseover angezeigt werden. Diese generelle Liste kann mit einer individuellen Konfigurationsdatei erweitert werden (s. auch [[#abbreviation]]). Ein separates Plugin wie https://www.dokuwiki.org/plugin:autotooltip hierzu haben wir derzeit nicht im Einsatz. Im Standard wird die Existenz einer Erläuterung auf Basis der Abbreviationkonfiguration für den indexierten Begriff mit einer doppelten Haarlinie punktiert angezeigt. Bei einem Mouseover wird am Mauscursor ein Fragezeichen eingeblendet und die Erläuterung wie ein Tooltip in einer einfachen gerahmten Box angezeigt. Mehr Layoutvarianten wären über vorgenanntes Plugin möglich.
* **Überschrift** = s. [[#header]]
* **Verweis**, der im Wiki führt intern zu einer anderen Stelle des Wikis (welche hierüber direkt angesprungen werden kann) oder zu einer externen Stelle im Internet (welche in einem separaten Browsertab oder Fenster geöffnet werden kann, s. a. [[#Hyperlink]]). Technisch werden Verweise durch das Wikisystem als Hyperlinks interpretiert. Eine besondere Form des internen Verweises ist die [[#Fußnote]], deren Text in doppelten runden Klammern als [[#tag]]-Inhalt definiert wird. Dieser wird zudem als interaktiver Tooltip bei Mouseover eingeblendet. Details und weitere Erläuterungen findet man hier im Abschnitt [[playground:technische_infos#querverweise|Querverweise]]
* **Wiki**, das (Neutrum) = php-gestütztes Multiautoren-Informationssystem - googelt doch selbst ;-) https://de.wikipedia.org/wiki/Wiki \\ DokuWiki ist eine der vielen Varianten, hinreichend bewährt, aktuell gepflegt und OpenSource. Wir haben Dokuwiki für unsere Zwecke angepasst, so dass es größtenteils auch dem CI der CREM SOLUTIONS entspricht.
* **Zeilenwechsel** = siehe [[#Absatz]]
++++