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 .
Nachfolgende Optionen gelten nur für angemeldeten User im Wiki mit ausreichenden Bearbeitungsrechten.
Indexmenu
erlaubt in der Sidebar ebenfalls die Anlage neuer Seiten (Kontextmenü rechte Maustaste).
Bearbeitung auf Dateiebene im jeweiligen Unterverzeichnis von data\pages
(unter Vorbehalt):
Diese Seite bearbeiten
sofern die Seite nicht gerade neu erzeugt wird. Bearbeiten
unterhalb des Eintrags.* 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
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 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.
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)
</nodisp>
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 nicht angemeldete User im Browser 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}}
⇒
Das ist ein Abschnitt zum include
-Thema, Details finden Sie im externen Link https://www.dokuwiki.org/plugin:include
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
hidepages
werden in der Konfiguration folgende Seiten unsichtbar und somit in der Navigation der Sidebar nicht gelistet: sidebar|playground
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.Die meisten Bedienelemente sind selbsterklärend oder weisen einen erläuternden Tool-Tip auf.
Seite bearbeiten
/ Seite anzeigen
.Ä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.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.PDF exportieren
Erstellung einer PDF von der aktuellen Seite (PlugIn)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)Nach oben
: Home-Schalter, identisch mit Funktion von Pos1-Taste (für Laptop-User ohne diese Navigationstaste interessant).
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)
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. Abschnitt Keine Formatierungen):
''<nowiki> ...'' 1234 '' </nowiki>''
⇒ ...'' 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 <code> … … </code>
(unterstützt auch mehrfache Leerzeichen?) oder <file> … … </file>
.
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 einerSiehe nachfolgende Beispiele oder auch 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. <WRAP>Der WRAP-Tag lässt innerhalb seiner Klammerung Formate und Links zu: [[playground:start#keine_formatierungen|kein Link]]</WRAP> ** 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 ;-=
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: 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; }
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:
..\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; }
... /* existing wikipage */ .dokuwiki a.wikilink1 { } ...
Alternative mit Unterstreichung
... /* existing wikipage */ .dokuwiki a.wikilink1 { text-decoration: underline; } ...
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:
Begriff 1 Begriff2
Begriff1|Begriff2
Begriff1 -Begriff2
„Begriff1 Begriff2“
Begriff1*
oder *Begriff1*
@fachadministration:faktura
führt zu der Suche von Faktura im Namensraum fachadministration (setzt die Kenntnis der Namensräume voraus).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
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:
code
): ( code
) oder ( code)
→ (code
) Ü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.
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
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.
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.
conf/acronyms.local.conf
im UTF-8-Format gepflegt werden (beachte https://www.dokuwiki.org/abbreviations). 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.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…
ID
einer Seite. 3) Namenskonvention
des Wikis) als Bestandteil eines Verweises mit führendem Hashtag an die id
im Verweis-tag angegeben wird. playground:technische_infos
. Sie finden diese ID als Bestandteil der Adresse der angezeigten Webseite im Browser und als Registerbeschriftung (rechts oben im Seitenrahmen). 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. :
) werden zum Erzeugen von Namensräumen (namespaces) verwendet.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.id=playground:start
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. Inhaltsverzeichnis
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.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.).