Inhalt
Technische Infos für iX-Wiki-Autoren
Neuanlage einer DokuWiki-Seite
Bearbeiten einer Seite
Löschen einer Seite
Seite umbenennen
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&nofooter}}
⇒
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 Pluginsindexmenu
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
Nützliche Tastaturkommandos
Code und Sonderdarstellung
Keine Formatierungen
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 [[]] technische_infos (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 1)
c) mit Linktext (Wiki-Standard, um zu anderer Seite zu wechseln)
d) Überschriftsnavigation 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: <wrap #sprungmarkentechnik>text or nothing</wrap> oder eine entsprechende Überschrift ==== Sprungmarkentechnik ====
Die Fußzeile2) 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 Parameterzeiletext-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: <wrap important><wrap> statt <wrap important></wrap>
- fehlendes Schließen -Tag einer Wrap-Klammer: <wrap important>Lore ipsum abc statt <wrap important>Lore ipsum</wrap> 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 | oder ein fehlendes bzw. überflüssiges Apostrophen-Paar (nur ein doppelter '') mit nachfolgender Fehlinterpretationen der Zelleninhalte.
- 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. Führende Leerzeichen in doppelten Apostrophklammern werden nicht als Code dargestellt, nachfolgende hingegen schon. Eine typografisch saubere Darstellung erreicht man durch Bearbeitung von Leerzeichenpositionierung bzw. dem schließenden Apostrophenpaar: ''Feldbezeichnung1 '', ''Feldbezeichnung2 '', … → ''Feldbezeichnung1'', ''Feldbezeichnung2'', … Solche Effekte können nach 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.
Beispiel: s. Beispielseite 1
====== Titel ====== Nicht eingeklappter Text ===== Überschrift 1 ===== ++++| Eingeklappter Text 1 ++++ ===== Überschrift 2 ===== ++++| [hiermit beginnt die übergeordnete Einklappung 2] Eingeklappter Text 2 <WRAP> [hier beginnt mit WRAP-Tag der Block für die untergeordnete Einklappung] ==== Überschrift 2.1 ==== ++++| [hiermit beginnt die erste untergeordnete Einklappung] Eingeklappter Text 2.1 ++++ [Ende Einklappung 2.1] ==== Überschrift 2.2 ==== ++++| [Beginn Einklappung 2.2] Eingeklappter Text 2.2 ++++ [Ende Einklappung 2.2] ==== Überschrift 2.3 ==== ++++| [Beginn Einklappung 2.2] Eingeklappter Text 2.3 ++++ [hiermit schließt die letzte untergeordnete Einklappung 2.3] </WRAP> [hier endet der WRAP-Tag] ++++ [hiermit schließt die übergeordnete Einklappung 2] ===== Überschrift 3 ===== ++++| Eingeklappter Text 3 ++++ Folgetext ...
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
Broken Links (tote Links)
Plugin Orphans Wanted
Dies sind (noch) nicht vorhandene Seiten, zu welchen aber tote Links ermittelt wurden. Dies sind Klärfälle, die höchstwahrscheinlich durch fehlerhafte Schreibweise, manuelle Seitenverschiebung, externe Umbenennung oder unvollständige Erstellung einer Seitenstruktur entstanden sind. Daher ist die Tabelle auch in der einfachen Ansicht versteckt und für Bearbeiter auf der Startseite leicht zu finden.
Die Darstellung erfolgt in einer automatisierten Tabelle mit einer laufenden Nummer in der #-Spalte, dem toten Link und einem Link, der auf die Seite mit dem toten Link verweist. Tote Links werden rot unterstrichen angezeigt. Eine Sonderstellung haben tote include-Anweisungen. Hier hilft es, sich den genauen Wortlaut des toten Links in der ID-Spalte anzusehen. Dieser verweist dann i. d. R. nie auf die start-Seite, sondern auf eine Unterseite wie namespace:main, :howto, :parameter oder :technical, während der Link in der Spalte Links einen auf die start-Seite führt, wo der include-Eintrag zu finden ist.
Grundlegende Frage ist wohl: Gab es den Link schon (Ist er verschwunden?) oder wurde der Link manuell angelegt und es gibt einen Schreibfehler hierbei (initialer Fehler)? Eine Möglichkeit dies zu verifizieren ist ein Blick in die Vorversion. Wurden Seiten nur aktualisiert, existieren die Links wahrscheinlich noch in der Vorversion. Letztlich ist der tote Link zu lokalisieren, meist in einer Unterseite, seltener auf der start-Seite eines betroffenen Namespaces.
Mit der neuen Version von Orphans Wanted werden auch Seiten gemeldet, welche über Include verbunden sind, aber noch keine Treffer aufweisen, weil der Zielabschnitt oder die Zielseite fehlt. Diese lieferten früher ja auch nur die Überschrift über die start-Seite, werden mittlerweile aber auch logisch korrekt als Links ins Leere und somit als potentielle Fehlstellen erkannt. Ursachen können sein: a) Include auf nicht existente Seite od. Abschnitt gesetzt. b) Schreibfehler in Include-Anweisung (Seite/Abschnitt ist existent, wird aber von Anweisung nicht gefunden).
Link öffnen in neuem Tab oder Link öffnen in neuem Fenster als Browserfunktion erlaubt dem Redakteur, den Überblick zur nachfolgenden Tabelle der Orphans Wanted zu halten. In einfachen Fällen, wo definitiv Seiteninhalt komplett fehlt, ist es opportun, die include-Anweisung mit dem Verweis auf fehlende Unterseite(n) aus der Startseite zu entfernen. Diese sind:
{{page>main&noheader&inline&nofooter}} {{page>howto&noheader&inline&nofooter}} {{page>parameter&noheader&inline&nofooter}} {{page>technical&noheader&inline&nofooter}}
# | ID | Links |
---|---|---|
1 | ix-haus_plus:kreditoren_debitoren_plus:system | 1 : Show backlinks |
2 | ix-haus_plus:weg_beschlusssammlung:system | 1 : Show backlinks |
Leere Liste nur mit
# | ID | Links |
---|
Das ist fein …
Orphans
Orphans sind die Seiten, welche wahrscheinlich bewusst nicht verlinkt sind. I. d. R. Hilfsseiten oder Testseiten, die dem Kunden normalerweise auch nicht angezeigt werden. Diese Seiten sind häufig alternativ mittel Include indirekt im Einsatz. Oft sind sie als Unterseiten für ein späteres include auf der start-Seite schon angelegt, aber der include-Eintrag selbst ist noch nicht gesetzt. Problematisch, wenn sie Inhalte aufweisen, welcher dem Leser so entgeht.
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. 3)
Die Überschrift kann als Linkziel angegeben werden, indem deren Umsetzung (unter Berücksichtigung derNamenskonvention
des Wikis) als Bestandteil eines Verweises mit führendem Hashtag an dieid
im Verweis-tag angegeben wird.
Beispiel: [[playground:technische_infos#wiki-vokabular|Wiki-Vokabular (internes Glossar)]] ⇒ 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 tags 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.
- 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. 4)
- 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.
- 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:
<wrap important>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.</wrap>
⇒ 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 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