Inhalt

Redaktionsleitfaden im iX-Wiki

Der Playground-Namespace ist nicht für die Veröffentlichung auf dem Server der CREM SOLUTIONS vorgesehen! Zur Ansicht von Details müssen Sie sich im iX-Wiki anmelden.

Der Playground-Namespace ist nicht für die Veröffentlichung auf dem Server der CREM SOLUTIONS vorgesehen!

Interne Kommentare, Verweise auf todos, fixmes und Vorschläge

werwo (Links)wasstatus
comment000 Mini-todo-Liste (ToDos und Fixmes innerhalb des Playground-Namespaces) mit Links zu Markern, wo sich ein todo/fixme befindet.
Der Marker auf der Zielseite wird so gebildet:
<wrap #comment000></wrap> (mit entsprechender laufender Nummer pro Seite)
Muster

iX-Wiki in Bearbeitung durch DEV / PM

ix-Wiki-LinkThemaDEVPMSybilleWiki-StartdatumInfos
ZahlungstoleranzenBuchhaltungtjiopp2021070100405.08.2021Featurepaket 20.21
ix-Scheduler :?: :?: :?: :?: :?: :?:
ProjektX :?: :?: :?: :?: :?: :?:

Muster

Wir haben eine separate Muster-Seite im Namespace Playground aufgebaut. Die Redaktion bildet für ein neues iX-Wiki-Projekt aus dem Muster eine neue Seite im Playground. Diese wird dann als neue Zeile in der Tabelle im Abschnitt iX-Wiki in Bearbeitung durch DEV/PM verlinkt und dann an die beteiligten Autoren kommuniziert. Diese Projektseite enthält die grundlegenden Strukturen, welche initial vom jeweiligen Bearbeiter ergänzt und bei Bedarf erweitert werden können. Letztere werden nach weitestgehender/abschließender redaktionellen Bearbeitung dann in die jeweilige Branchversion verschoben. Die verwendeten Links werden hierbei berücksichtigt. Developer oder Produktmanager können sich daher in der Anfangsphase auf die inhaltlichen Aspekte des Projekts konzentrieren und ohne Manschetten im Playground editieren und auch kommentieren. Eine Endkontrolle sollte nach der Verschiebung erfolgen. Hier sind dann nur noch kleinere Korrekturen zu erwarten.

ARR: Vorschlag ⇒ Das wrap-Menü bietet auch eine Zu-Erledigen-Box an. Diese sollte markant genug sein, da sie so gar nicht in unser CI passt ;-).
FIXME-tags können an konkreten Punkten eingesetzt werden.
DSN: TOP! Machen wir so.

ARR: Solche tags können in den Quelltexten im page-Verzeichnis notfalls auch mit Total Commander gesucht werden, das der bei Bedarf im Hintergrund.
Inhaltlich lassen sich damit Kommentare vom eigentlichen Wiki-Inhalt in der Erstellungsphase besser abgrenzen

Hilfreiches Wissen rund um Wiki und iX-Wiki

Fragestellung zur Startseite - mehrere Versionen des Wikis parallel?

Welche iX-Wiki-Dateien sollten trunk/branch-spezifisch sein?

  • Indexverzeichnis data\index ⇒ Index für Suchfunktionen in iX-Wiki
  • Plugin in Testphase
  • Neuerungen in Branch (inhaltliche Dateiunterschiede ⇒ Differenzierung ist via TortoiseSVN und update/commit-Workflow zu managen)

Onlineversionen

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)(Beispiel 1). Eine Bildunterschrift kann mit Zeilenumbruch nach dem Link erstellt werden (Beispiele 2 und 3).

Beispiel 1: Beachte dass neben den systembedingten Größenvorschläge auch manuelle Größenangaben möglich sind. (Details hierzu hier.)

== ==
{{:hieran_arbeiten_wir.png?nolink&75 |Infografik Hieran arbeiten wir...}} und der Text fließt weiter...
== ==

== == Infografik Hieran arbeiten wir... und der Text fließt weiter … == ==

Beispiel 2: Grafik ohne Link

== ==
{{:ix-haus_plus:flaechen_plus:leerstandsalarm_aktivitaeten_historie.png?nolink|}}\\ Abb.: Dialog zur Einstellung der Vermietungsaktivitäten  
== ==

== ==
Abb.: Dialog zur Einstellung der Vermietungsaktivitäten == ==

Beipiel 3: Grafik mit Link

{{:ix-haus_plus:flaechen_plus:leerstandsalarm_aktivitaeten_historie.png?direkt&400|}}\\ Abb.: Dialog zur Einstellung der Vermietungsaktivitäten  


Abb.: Dialog zur Einstellung der Vermietungsaktivitäten

Um Grafiken einzubinden, werden diese mit dem Medien-Manger bereitgestellt. Der Link hierzu befindet sich rechts oben im Browserfenster. Hier ist zu beachten, dass der Aufruf des Medien-Managers mit einfachem Klick die aktuelle Seite verlässt und als Speicherort den aktuellen Standort vorschlägt. Daher bietet es sich an, den Medienmanager von einer zweiten gespiegelten Browsersitzung zu starten. Steht man also z. B. in der Seite fachadministration:docuware_integration:start, wird beim Start des Medien-Managers diese Seite geschlossen (auch wenn diese im Editmodus aufgerufen war!) und der Medien-Manager-Dialog im Namespace fachadministration:docuware_integration aktiviert. Soll ein Upload woanders gespeichert werden, stellt man im Medien-Manager unter Namensraum wählen den gewünschten Standort ein oder begibt sich vor dem Aufruf erst an die gewünschte Stelle. So ist eine strukturierte Medienablage möglich. Allgemeine, ggf. mehrfach zu verwendende Grafiken legt man am besten in der obersten Ebene ab, ab der die Grafiken in unterschiedlichen Unterverzeichnissen benötigt werden.

Einbinden von Video

Noch Zukunftsmusik, aber denkbar… ich schlage vor, Minivideos nur als Link, also nicht eingebettet zu realisieren. Später dazu ggf. mehr.

Bearbeiten der Seite sidebar

Die Sidebar ist die in DokuWiki festgelegte Seite (hier: sidebar.txt) innerhalb eines Namespaces oder einem übergeordneten Namespace, die vor allem für Navigationselemente benutzt wird. Ihre Breite ist abhängig von einer wahlweise festen oder prozentualen Breitenangabe in der Konfiguration von DokuWiki. Sie wird oft selbst im Menü nicht angezeigt (administrativ ausgeblendet via hidepages) und ist daher dann nur auf Verzeichnisebene sichtbar. Sie kann im Browserfester durch direkte Eingabe der id sidebar aufgerufen werden.

In der Sidebar nutzen wir für die Erstellung der Navigation das Plugin-basierte Indexmenu. Dieses verfügt über eine javascriptgesteuere Navigation mit Unterebenen. Das Grafikset ist dem CI angepasst individuell erstellt. Der Speicherort der individuellen Symbole ist aktuell lib\plugins\indexmenu\images\ix-wiki.png.

Bestimmte Seiten/Namespaces werden administrativ als Navigationselemente ausgeschlossen und somit in der Sidebarnavigation selbst auch nicht benannt. Die Seite sidebar.txt wird zudem generell auch von der Volltextsuche ausgeschlossen. Derzeit sind dies somit (s. Anweisung im Admin-Bereich für Darstellung) die Seiten bzw. Namespaces:

SeiteNamespaceausgeschlossen durchin Volltextsuchein Sidebar-Navigation
sidebar DokuWiki-Parameter hidepages sidebarneinnein
main indexmenu-Parameter skip_pages

/(:main|:howto|:parameter|:technical)/

janein
howto
parameter
technical
parameter1
howto1
playgroundindexmenu-Parameter skip_index

/(playground|wiki)/

janein
wiki

Im Playground setzen wir eine separate sidebar.txt ein. Da hier der Inhalt nicht per indexmenu sondern manuell generiert ist, sind die Links dort unterstrichen und es gibt dort keine indexmenu-typischen Features im Kontextklick.

Interne Links können im Wiki auf Seitenebene automatisch erkannt werden. Diese Links sind dann rot und punktiert unterstrichen dargestellt, wenn ihr Ziel noch nicht existiert. Vorteil: So kann in einer Seite beim Bearbeiten schon ein Link definiert werden, dessen Ziel dann (ggf. von anderem Wikiredakteur) einfach erstellt werden kann, indem man dem Link folgt und das Ziel bearbeitet. Bis dahin ist der Link für den normalen Anwender tot.

Am Ende der Startseite ist ein Abschnitt eingebaut, in welchem den angemeldeten Usern eine automatische gefüllte Tabelle toter interner Links angezeigt wird (orphans wanted). I. d. R. kann man hierüber die Seiten mit den toten Links ermitteln und zwecks Korrektur aufrufen. Diese Tabelle sollte daher redaktionell beachtet und möglichst immer leer sein. Sie befindet sich auch im Kopf des Redaktionsleitfadens. Treffer werden nur von den Seiten ignoriert, die per hidepages ausgeschlossen sind (dies sind die sidebar und der playground). Daher ist diese Tabelle nach der Verschiebung eines Projekts von playground in den allgemeinen Wiki-Bereich besonders zu beachten.

Verwaiste Seiten können analog mit dem Parameter orphans gesucht werden. Auf der Startseite macht diese große Tabelle redaktionell jedoch wenig Sinn. Die verwaisten Seiten sind eher ein Indiz auf fehlende Vernetzung solcher einzelstehenden Seiten mit anderen Seiteninhalten im Wiki, wobei include-Vernetzungen leider nicht berücksichtigt werden, sondern nur interne Hyperlinks! Benannt werden die Seiten hier nach dem Namen der ersten Überschrift, ansonsten leer). Daher kann man in dieser Liste dann wohl alle Seiten mit Strukturtiteln wie Was mache ich hier? ausklammern bzw. ungewöhnliche Bezeichnungen erkennen und bei Bedarf ausmerzen.

Orphans-Tabelle

Links, welche auf nicht auffindbare Abschnitte innerhalb existenter Seiten zeigen, werden nicht als tote Links betrachtet. In solchen Fällen wird die Seite aufgerufen, ohne die Sicht auf einen bestimmten Abschnitt festzulegen. Dass Abschnitte nicht auffindbar sind kann unterschiedliche Ursachen haben:

  • Schreibfehler im Link: der Zusatz im internen Link nach dem # unterliegt Vereinfachungsregeln (keine Großbuchstaben, Umlaute durch ausgeschriebene Diphtonge ersetzen, Ersetzungen von Leerzeichen durch Unterstrich, Auslassung von Sonderzeichen, …)
  • Die Überschrift, auf die verwiesen wird, wurde geändert und ist somit nicht mehr aktuell (s. Schreibfehler).
  • Die Überschrift wurde eingeklappt. Gefunden werden nur Überschriften, welche auch ohne Ausklappen sichtbar sind! (Fehlbedienung)
  • In vielen Fällen kann der Link sicher generiert werden, indem auf der Zielseite der Abschnitt über den TOC angesteuert wird. Dann steht in der Browseradresse die ID der Seite inklusive des mit # beigefügten Abschnitts. Kopiert man diese ID, kann man damit die Linkanweisung leicht und sicher aufbauen. Der interne Link besteht aus einer doppelten eckigen Klammer mit den Parametern id#abschnitt|titel. z. B.

[[playground:start#loeschen_einer_seite|Beispiel interner Link]]Beispiel interner Link

  • Die Suche nach dem toten Link über den Backlink ist auf umfangreichen Seiten mit vielen Einklappungen ggf. mühsam. Ist die optische Suche (alles Ausklapen und über die Seite scrollen) nicht erfolgreich, hilft die Suche nach dem toten Link im Quelltext mittels Textsuche im Browser (Str+F) nach dem angegebenen Code des toten Links.
  • Eine häufige Ursache für tote Links sind nachträgliche Umbenennungen von Überschriften, Seiten oder Namespaces. Nimmt man solche manuell vor, ist es ratsam, im Anschluss die orphans wanted-Liste auf der Startseite zu checken.
  • Das Umbenennen von Seiten oder Namespaces kann mit dem administrativen Wiki-Plugin move durchgeführt werden. Entsprechende Links werden hierbei mit angepasst und tote Links vermieden.
Weitere (alte) Seiten im Namespace Playground

Erstellung einer neuen DokuWiki-Seite

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. Das Plugin indexmenu erlaubt in der Sidebar via Kontextmenü ebenfalls die Anlage neuer Seiten. 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 nach dem Modulnamen in iX-Haus. Für neue Projekte stellen wir eine vorgefertigte Seite dem jeweiligen Produktmanager und Entwickler im Playgound zur Verfügung. Alle Beteiligten haben schreibende Zugriffsrechte für diesen Bereich.

Erstellung eines Namespaces

Verschieben/Umbenennen einer Seite

Erzeugen einer Basisstruktur für neue Programmversion

Upgrade DokuWiki

Known Bugs/Missed Features

Kommandozeilen Werkzeuge

Tuning von DokuWiki zu iX-Wiki