Inhalt

iX-Wiki - Inhalte erstellen
- Redaktionelle Richtlinien
- Kapitel strukturieren
Titel des Kapitels
Was mache ich hier?
Wie mache ich es?
Was brauche ich dazu?
Abschnitt 2 von Parameter1
Abschnitt 3 von Parameter1
Abschnitt 4 von Parameter1
Abschnitt 5 von Parameter1
Abschnitt 6 von Parameter1
Systemeinstellungen
- Organisatorisches Konzept (neu: zur Übertragung von Minidokus!!)
Formate für iX-Wiki

iX-Wiki - Inhalte erstellen

Redaktionelle Richtlinien

Im Folgenden werden die für die Erstellung der unterschiedlichen Produkte notwenigen formalen sowie inhaltlichen Vorgaben spezifiziert.

Handlungen anweisen

Enthält Standard Fehlerfälle, Ursache und Auflösung
Enthält Beispiele
Enthält Konzept und
(technische, fachliche) Voraussetzungen
Beschreibung der durchzuführenden Schritte in abgeschlossenen, zusammenhängenden Einheiten (z. B. Dokument erstellen, Dokument drucken, Dokument versenden)
Bedientipps und Hinweise sollen durch Icons gekennzeichnet werden, ebenso wie „Warnungen“ vor Bedienfehlern mit schwerwiegenden Folgen.

Terminologie konsistent halten

Die einheitliche Verwendung von Begriffen für dasselbe Element dient der Transparenz und dem Leseverständnis.

Standard	Synonyme
Ansicht	View
Dialog	Maske, Formular
Register	Tab, Reiter, Registerkarte
Schaltfläche/Aktion	Button, Schalter, Taste, Klick
Option	Radiobutton (Einzeloption) (o) ◉ ( ) ◎
Kontrollfeld	Checkbox (auch für Multiselect-Optionen), ☑ [X] ❒ [ ]
aktiv	☑ [X] gewählt, ausgewählt, markiert, selektiert
inaktiv	❒ [ ] ◎ ( )
Schieberegler	Scrollbalken
FIBU	Fibu, FiBu

Kapitel strukturieren

Commit-Prozess: wir veröffentlichen zu jedem Service Pack am Monatsende, was wir haben, auch wenn es noch unvollständig ist und Slavcho aktualisiert dann die Version einmalig, sobald wir fertig sind.
Dokumentation der letzten Jahresversion: nur gravierende Dokufehler, grobe Unstimmigkeiten, Kundenrückmeldungen und Patch-Erweiterungen werden hier dokumentiert bzw. angepasst.
Jeweils aktuelle Servive Pack Version: alle übrigen Erweiterungen plus aktuelle Baustellen plus Umsetzung von Minidokus.

Wir legen eine modulare Struktur aller Themen und Informationen an, wobei pro Hauptordner oder je nach inhaltlichem Umfang enthaltene Unterordner aller enthaltenen Module alphabetisch angeordnet und somit leicht durchsuchbar sind. Das linke Menü des iX-Wiki soll nur noch Inhalte mit maximal zwei Ebenen Tiefe beinhalten; also Kapitel und Abschnitte; pro Kapitel wird ein neuer Namespace angelegt; Abbildung der Verzeichnisordner der iX-Haus Struktur plus modulweise strukturierte Unterkapitel; Beispiel: Buchhaltung → Auflistung aller nachfolgenden Module als Kapitel: Dialogbuchhaltung, …, Sollstellung, …, Erlösschmälerung Parameter Liste, … Je nach Umfang entstehen so Kapitel mit einzelnen oder mehreren Modulbeschreibungen. Sind mehrere Modulbeschreibungen eines Unterordners der Menüstruktur so umfangreich, dass sie nicht sinnvoll gemeinsam in einem Kapitel nach einer gemeinsamen HowTo usw. Systematik bearbeitet werden können, ziehen wir dieses Kapitel hoch auf die Ebene des übergeordneten Kapitels, siehe zum Beispiel Hilfsprogramme aus der Fachadministration. Die rechte, im Text des Kapitels selbst enthaltene Menüstruktur liefert dann einen leicht durchsuchbaren Überblick zu den Abschnitten, bzw. Themen dieses Kapitels. Buchhaltungs-, Stammdatendruck, sowie übrige modulspezifische Druckmenüs werden jeweils wie ein eigenständiges Modul behandelt (Endknoten in Menüstruktur), d. h. wir fassen alle Drucklisten zu einem Druckkapitel pro Modul zusammen. Der Bereich „Was brauche ich dazu“ enthält alle Drucklisten als Einträge analog zu z. B. Registern anderer Kapitel. Abschnitt „Wie mache ich es“ enthält Details zum Druck etc., welche nicht allgemeiner Natur sind oder es wird auf die allgemeinen Bereiche verwiesen. Diese Strukturierung gibt eine erste Orientierungsmöglichkeit; sobald der Anwender ein Kapitel aufgerufen hat, sieht er eine Liste mit Einleitung, Überschriften aller Funktionen und Ansichten sowie den Administrationseintrag (Parameterbeschreibungen einzelner Register, Handlungsanweisungen, Workflowbeschreibungen), wobei die Textabschnitte eingeklappt sind, um auch bei umfangreichen Inhalten optimale Übersichtlichkeit zu gewährleisten; das rechtsseitige Inhaltsverzeichnis (TOC = Table of Content ) bildet hierbei wie oben beschrieben die interne Struktur pro Kapitel ab. Systematische Strukturierung: pro Kapitel ein Namespace mit vier Seiten plus zusätzlichen Seiten für abweichende Informationen: 1. Menüstruktur mit allgemeinen Bereichen; Seitenname „main“ > Titel der Seite „Was tue ich hier?“ 2. Besonderheiten der Bedienung für ausgewählte Prozesse und Schritt für Schritt Anleitungen mit Verweisen auf Beschreibungen allgemeiner Funktionen in eigenem Kapitel; Seitenname „howto“ > Titel der Seite „Wie tue ich es?“ 3. Beschreibung Benutzeroberfläche mit Tabellen, einzelnen Registern und Dialogen; Seitenname „parameter“ > Titel der Seite „Was brauche ich dazu?“ 4. Systemeinstellungen, Beschränkungen, Voraussetzungen, Lizensierung; Seitenname „system“ > Titel der Seite „Administration“ Die vier Seiten und ihre Spielarten sind in der Enddarstellung im übergeordneten Kapitel = Namespace versteckt, bzw. für den Anwender nicht einzeln aufrufbar (s. Admin ⇒ Konfiguration (Konfigurationsmanager), DokuWiki, Darstellung, hidepages: sidebar|system|main|howto|howto1|howto2|parameter|parameter1|parameter2). Sie dienen uns zu der Möglichkeit, verschiedene Inhalte zu übergreifenden Themen per include Befehl zusammenzustellen, z. B. alle Funktionsbeschreibungen oder alle administrativen Beschreibungen. Die Struktur der Unterseiten wird in der Seite start.txt organsiert und sieht pro Kapitel immer wie folgt aus:

Titel des Kapitels

Was mache ich hier?

Wie mache ich es?

Was brauche ich dazu?

Hallo. Ich bin ein kleiner Blindtext. Und zwar schon so lange ich denken kann. Es war nicht leicht zu verstehen, was es bedeutet, ein blinder Text zu sein: Man ergibt keinen Sinn. Wirklich keinen Sinn. Man wird zusammenhangslos eingeschoben und rumgedreht – und oftmals gar nicht erst gelesen. Aber bin ich allein deshalb ein schlechterer Text als andere? Na gut, ich werde nie in den Bestsellerlisten stehen. Aber andere Texte schaffen das auch nicht. Und darum stört es mich nicht besonders blind zu sein. Und sollten Sie diese Zeilen noch immer lesen, so habe ich als kleiner Blindtext etwas geschafft, wovon all die richtigen und wichtigen Texte meist nur träumen.

Noch mehr gefällig?

Bavaria ipsum dolor sit amet wea ko, dea ko obandeln muass. Auf gehds beim Schichtl i mog di fei is Brezn, an san Weiznglasl barfuaßat gwiss wuid. Glei schüds nei jo mei is owe da Kini, Milli! Wurschtsolod nia need a Prosit der Gmiadlichkeit des wiad a Mordsgaudi, Kuaschwanz greaßt eich nachad mechad Broadwurschtbudn jo mei noch da Giasinga Heiwog etza. Nomoi Gams Namidog, des is a gmahde Wiesn a geh wos nomoi Biawambn! No a Maß hoam wann griagd ma nacha wos z’dringa, gelbe Rüam Sauwedda is. Ham samma soi Mongdratzal, ja, wo samma denn. Servas pfiad de Griasnoggalsubbm om auf’n Gipfe moand Gams Weiznglasl Wurscht, Haberertanz gwiss. So schee zua mogsd a Bussal nomoi Spotzerl auszutzeln, wia hob san Brotzeit ebba! Kloan und i Schdeckalfisch, vui huift vui i hob di narrisch gean a bissal wos gehd ollaweil. Geh singan nia need Blosmusi Kneedl Diandldrahn jo mei is des schee Breihaus Jodler. Ned gscheid san oans Charivari, spernzaln i Brodzeid. Radler o’ha gwihss, lem und lem lossn kumm geh. Om auf’n Gipfe Hendl wo hi Ledahosn Goaßmaß Meidromml back mas, a Prosit der Gmiadlichkeit Stubn.

Gscheid gschmeidig da, hog di hi Brodzeid soi, Resi des wiad a Mordsgaudi. Hoam Gstanzl du dadst ma scho daugn wea ko, dea ko, Baamwach ozapfa Wiesn Spotzerl obacht an Maibam. Ewig und drei Dog oans zünftig des is hoid aso? Jodler vui huift vui am acht’n Tag schuf Gott des Bia Sauwedda Griasnoggalsubbm vo de mogsd a Bussal. Umananda sodala Leonhardifahrt Hendl schaugn san Wurschtsolod! I daad Servas nia need kumm geh Radi i daad abfieseln wos Guglhupf di singd. Hob mechad om auf’n Gipfe, glacht. Prosd noch da Giasinga Heiwog nix, pfiad de. Auszutzeln oba iabaroi allerweil Weibaleid Musi hogg ma uns zamm. Ozapfa Zidern Schmankal, Weiznglasl! Owe Guglhupf hob pfiad de hawadere midananda Watschnpladdla unbandig di, hoggd wolln Wurschtsolod. Mei hob i an Suri gschmeidig oa Obazda Radler i daad? Gscheid i daad da, hog di hi es geh do nackata, Woibbadinga sammawiedaguad. Nomoi glacht griaß God beinand i sog ja nix, i red ja bloß kumm geh gwiss Buam? Weißwiaschd Marei auf der Oim, da gibt’s koa Sünd i moan scho aa des muas ma hoid kenna obandln schaugn Maderln des wiad a Mordsgaudi guad.

So Goaßmaß Sauwedda, Spotzerl: Hemad schaugn Lewakaas i hab an jo mei Watschnbaam gschmeidig di unbandig greaßt eich nachad: Ded boarischer Schneid da, so nia need. Auf der Oim, da gibt’s koa Sünd des basd scho i hob di narrisch gean a Hoiwe ja, wo samma denn a bravs mehra, Graudwiggal. O’ha oans a Prosit der Gmiadlichkeit naa Biaschlegl nomoi, Habedehre! Heimatland sei hob i an Suri di do legst di nieda iabaroi, nimmds gscheckate hi Sauwedda: A bissal kimmt Guglhupf Weibaleid, Kirwa Spotzerl sammawiedaguad Mamalad. Heid sauba kummd o’ha Obazda dahoam. Is gscheid oamoi allerweil pfundig mi Haferl Bussal. Koa Ramasuri kloan griasd eich midnand naa abfieseln gwihss singd: Kimmt Weibaleid Bradwurschtsemmal heid gfoids ma sagrisch guad Mamalad nomoi Diandldrahn Milli Weiznglasl is kumm geh. Gidarn nackata wia sei Wurschtsolod wuid do Bradwurschtsemmal resch des is hoid aso: Heid heid Xaver Stubn hob, Spezi du dadst ma scho daugn: Wos g’hupft wia gsprunga wia Maderln Foidweg, ma d’.

A bravs wann griagd ma nacha wos z’dringa Gaudi, soi des wiad a Mordsgaudi. Da, hog di hi in da greana Au und glei wirds no fui lustiga da Kini kumm geh heid, umma pfenningguat! Zua Spezi vui mei fias oans do sodala. Vo de i bin a woschechta Bayer Kneedl measi Mamalad oamoi? Spotzerl hawadere midananda a bissal wos gehd ollaweil, obacht. Und glei wirds no fui lustiga mim hi Reiwadatschi Maßkruag Wurschtsolod Foidweg Vergeltsgott i sog ja nix, i red ja bloß Diandldrahn. Middn nix Steckerleis, hoggd! Hoid Stubn middn heitzdog Semmlkneedl hod, bittschön bittschön. Hogg ma uns zamm pfiad de Schmankal Schdarmbeaga See zünftig Semmlkneedl, Schorsch gwiss wia da Buachbinda Wanninger heid gfoids ma sagrisch guad muass. Almrausch oa middn, wann griagd ma nacha wos z’dringa Schuabladdla samma. D’ dringma aweng hea d’, Engelgwand! Des is schee Jodler no bitt, am acht’n Tag schuf Gott des Bia. Biawambn nomoi gor de Sonn i mechad dee Schwoanshaxn, dei Brezn naa! Gelbe Rüam sei koa vasteh. Watschnbaam Biazelt Sepp naa Lewakaas ham, des basd scho Kaiwe auffi bitt a! Hogg di hera gschmeidig sodala umananda, wos zünftig do.

Auffisteign zünftig Gstanzl obacht no Weißwiaschd nomoi Bladl so schee. Charivari g’hupft wia gsprunga Schmankal af. Griasd eich midnand Weißwiaschd des is schee ned woar dahoam wolln so schee Semmlkneedl nia vui? Midanand hea hawadere midananda a Prosit der Gmiadlichkeit baddscher Biazelt auf der Oim, da gibt’s koa Sünd Schdeckalfisch is. Baamwach Schmankal und glei wirds no fui lustiga, ognudelt i hob di narrisch gean abfieseln i moan oiwei: Gor Bussal Semmlkneedl gscheckate a Prosit der Gmiadlichkeit o’ha oa Bradwurschtsemmal. Nia need hogg di hera i daad, Fingahaggln Brodzeid eam i hob di liab. Musi sammawiedaguad allerweil Greichats di, mi da, hog di hi amoi Ewig und drei Dog greaßt eich nachad gwihss. Om auf’n Gipfe om auf’n Gipfe unbandig obacht hawadere midananda wos oba, Baamwach Mongdratzal. Liberalitas Bavariae Biaschlegl Wiesn, vo de kimmt? Hoid d’ Ewig und drei Dog hogg di hera, a bissal Milli da, hog di hi. Bladl oa noch da Giasinga Heiwog iabaroi, Radler Ewig und drei Dog Habedehre g’hupft wia gsprunga da Kini a Prosit der Gmiadlichkeit. Sepp ja, wo samma denn auffi, kimmt! Woaß hogg di hera hea Bradwurschtsemmal anbandeln hoid Gamsbart Gstanzl hob, glacht:

Mei is ned dahoam Gams des is a gmahde Wiesn Schbozal barfuaßat de! Abfieseln Vergeltsgott wann griagd ma nacha wos z’dringa und Baamwach pfenningguat Kuaschwanz so schee wia Marterl heitzdog: Spezi Servas Foidweg, pfundig weida Breihaus Schdarmbeaga See Sepp. Nois Fingahaggln Fünferl des is schee, scheans wia da Buachbinda Wanninger Auffisteign und und sei. Nois Hetschapfah Kirwa Wiesn Mongdratzal i hob di narrisch gean da, amoi hea: Es owe aba vui, muass i hab an hod: Marterl Obazda schnacksln i, des is a gmahde Wiesn Sauakraud! Noch da Giasinga Heiwog Maßkruag auf’d Schellnsau eana zünftig schoo Engelgwand, Semmlkneedl Spuiratz unbandig Biazelt. Gfreit mi greaßt eich nachad des muas ma hoid kenna Servas no Xaver schaugn Steckerleis: Is Ohrwaschl luja Wurschtsolod auf’d Schellnsau, i mog di fei? Landla guad eam, Schbozal is des liab Schdarmbeaga See Enzian lem und lem lossn Kuaschwanz da iabaroi! Wo hi vo de Griasnoggalsubbm Semmlkneedl i hob di liab hi mei de di Haberertanz ded. Gscheid Weiznglasl koa vui huift vui:

Abschnitt 2 von Parameter1

Das ist ein Abschnitt zum include-Thema, Details finden Sie im externen Link https://www.dokuwiki.org/plugin:include

Abschnitt 3 von Parameter1

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

Abschnitt 4 von Parameter1

Bavaria ipsum dolor sit amet wea ko, dea ko obandeln muass.

Auf gehds beim Schichtl

i mog di fei is Brezn, an san Weiznglasl barfuaßat gwiss wuid. Glei schüds nei jo mei is owe da Kini, Milli! Wurschtsolod nia need a Prosit der Gmiadlichkeit des wiad a Mordsgaudi, Kuaschwanz greaßt eich nachad mechad Broadwurschtbudn jo mei noch da Giasinga Heiwog etza. Nomoi Gams Namidog, des is a gmahde Wiesn a geh wos nomoi Biawambn! No a Maß hoam wann griagd ma nacha wos z’dringa, gelbe Rüam Sauwedda is. Ham samma soi Mongdratzal, ja, wo samma denn. Servas pfiad de Griasnoggalsubbm om auf’n Gipfe moand Gams Weiznglasl Wurscht, Haberertanz gwiss. So schee zua mogsd a Bussal nomoi Spotzerl auszutzeln, wia hob san Brotzeit ebba! Kloan und i Schdeckalfisch, vui huift vui i hob di narrisch gean a bissal wos gehd ollaweil. Geh singan nia need Blosmusi Kneedl Diandldrahn jo mei is des schee Breihaus Jodler. Ned gscheid san oans Charivari, spernzaln i Brodzeid. Radler o’ha gwihss, lem und lem lossn kumm geh. Om auf’n Gipfe Hendl wo hi Ledahosn Goaßmaß Meidromml back mas, a Prosit der Gmiadlichkeit Stubn.

Abschnitt 5 von Parameter1

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

Abschnitt 6 von Parameter1

Abschnitt 6 ist hier leer…

Systemeinstellungen

Der Befehl noheader sorgt dafür, dass die Unterseiten ohne deren 1. Überschrift eingebunden werden und damit die von uns gewünschte Struktur für die Inhaltsverzeichnisse der einzelnen Kapitel entsteht. Somit können die Unterseiten eine organisatorisch bedingte Überschrift behalten, welche beim Include nicht ausgegeben wird. Über die Inhaltsverzeichnisse, die abhängig von der Strukturierung links wie rechts am Seitenrand generiert werden, können sich Nutzer neben unserer geplanten Suchanleitung mittels Schlagwort-Umfeld-Suchen zusätzlich orientieren oder sie bei Bedarf, z. B. bei zu kleinem Bildschirm, einfach ausblenden. Die linke Navigation wird durch die Datei sidebar.txt gesteuert und bei reduzierter Fensterbreite automatisch in den Kopfbereich verschoben. Als Resultat sollen die Beschreibungen aller Module von iX-Haus und iX-Haus plus auf diese Weise vernetzt ineinandergreifen, über Querverweise Beziehungen untereinander herstellen und damit als Ausgangspunkt zur Selbsthilfe bei Anwendungsfragen dienen. Parameterbeschreibungen realisieren wir als einfache, zweispaltige Auflistungen, wobei in der linken Spalte die Feldbezeichnung etc. in Code-Formatierung und in der rechten Spalte der beschreibende Text enthalten ist. Achtung! Der beschreibende Text in Tabellen darf niemals als direkte Anrede formuliert sein, sondern sollte immer nur sachbezogen und im Passiv formuliert sein, z. B. „Schaltfläche xy dient dem Zurücksetzen des Passwortes. Die Schaltfläche muss dazu etwa drei Sekunden gedrückt werden.“ Die Bezeichnungen oberhalb von Abschnitten, Eingabefeldern oder Bereichen, welche optisch mehrere Eingabefelder und Schaltflächen etc. eines Dialogs oder Registers zusammenfassen, dienen uns fortan zur Strukturierung der Tabellen. Statt einer Zeile, in die diese Bezeichnung als Zwischenüberschrift eingetragen wird, setzen wir diese Bezeichnung als echte Überschrift, passend zur Ebene der gesamten Ansicht zum Beispiel als Überschrift 3 und legen darunter einen einzelnen Tabellenabschnitt an, der wiederum als Dropdown-Text formatiert und somit ausgeblendet werden kann. Gleichzeitig können wir so auch Querverweise aus beliebigen anderen Abschnitten und Kapiteln auf die Überschriften setzen, so dass aus anderen Parameterbeschreibungen ein Link zu genau dieser Stelle der Registerbeschreibung möglich ist. So kann zum Beispiel die Überschrift Adressdaten mit Parameterbeschreibungen für natürliche Personen aus anderen Parameterbeschreibungen des gleichen Moduls aufgerufen werden, wenn die konkreten Datenfelder äquivalent sind und der Querverweis damit Sinn macht. Beim erstmaligen Aufruf einer Seite ist so nur eine Liste der Bereiche eines Dialogs oder eines Registers sichtbar. Blendet der Benutzer alle Tabellenabschnitte beim Lesen nacheinander ein, erhält er eine vollständige Übersicht des Registers / Dialogs. Eine Schaltfläche rechts der Hauptseite ermöglich das komplette Ein- /Aus-Klappen aller folded-Elemente der Seite (folded-Plugin). Bei PDF-Erstellung werden alle folded-Elemente ausgeklappt wiedergegeben.

Organisatorisches Konzept (neu: zur Übertragung von Minidokus!!)

Minidokus sind einzelne, modul- oder themenspezifische Dokumente, die von Entwicklern und Produktmanagement zur Erstellung von Benutzerdokumentation verwendet werden, siehe Abschnitt Minidokumentation. Dabei handelt es sich um kurze Beschreibungen von Programmfunktionalitäten. Sie werden bei Neuentwicklungen angelegt und danach weiter gepflegt. Sobald Mini-Dokumentationen vollständig in die online Benutzerhilfe (zukünftig ins Wiki) eingeflossen sind, werden sie vom Redakteur archiviert (C:\Work\w_trunk\Intern\Technische Redaktion\Minidoku_integriert). Auf Info durch den Redakteur an den zuständigen Entwickler wird für die Datei im Patch bzw. ServicePack auch in der update.cmd entsprechend ein Löschbefehl eingebaut, damit beim Kunden keine veralteten Mini-Dokus mit aktueller Online-Doku konkurrieren. Zur formalen Struktur des Dokumentes siehe unten, Abschnitt „Interne Wordvorlagen“.

ACHTUNG: der folgende Abschnitt ist inhaltlich veraltet!!!!

Zum Release des iX-Wikis Sommer 2020 möchten wir einen möglichst vollständigen und möglichst aktuellen Stand der Benutzerdokumentation erreichen. Da die Übertragung der bestehenden Inhalte aktueller Kapitel in die neue Struktur einen zu hohen personellen Aufwand erfordert, legen wir der pünktlichen Bereitstellung der Inhalte folgendes Konzept zugrunde: Wir übertragen alle bestehenden iX-Haus Inhalte aus Google Sites (im Wiki Textformat) in die mit „main“ bezeichneten Textdateien der entsprechenden Kapitel der iX-Wiki Struktur. Fallen hierbei oder bei der Bearbeitung von Inhalten aus den Service Packs veraltete Textstellen auf, markieren wir diese in einer geeigneten Form und tragen den Bereich als ToDo in die gleichnamige Exceltabelle im internen Ordner der Technischen Redaktion auf Ebene des branch im work-Verzeichnis ein. Ansonsten bleibt die iX-Haus Dokumentation bis auf bestimmte Ausnahmen in der bisherigen Struktur bestehen. iX-Haus plus Inhalte werden wir nach Abwägung der Prioritäten modulweise in die neue Struktur überführen, bzw. fehlende Inhalte direkt in der neuen Struktur anlegen. Die Prioritäten legen wir dabei anhand der Anzahl Features fest, die sich während der Sprints für einzelne Module ergeben, z. B. erhält die höchste Priorität ein solches Modul, für das besonders viele Funktionen oder große Bereiche entwickelt oder überarbeitet wurden. Da die Arbeit an den Release Notes einhergeht mit der Arbeit an den iX-Wiki Inhalten, können wir bei der Erstellung der Release Notes entsprechende Einträge in der ToDo Liste anlegen und in der Folge parallel abarbeiten.

Formate für iX-Wiki

Code- und Sonderzeichendarstellung

Für Code oder Sonderzeichen bietet das Wiki-System unterschiedliche Varianten an. Hintergrund ist entweder, einen ganzen Block im Wiki exemplarisch hervorzuheben, einzelne Wörter oder Zeichen, die ansonsten vom Wiki als Steuercode interpretiert werden.

Die einfachste Lösung ist, eine Zeile mit zwei Leerzeichen beginnen zu lassen.
So können mehrzeilige Blöcke, notfalls auch mit Scrollbalken für besonders langen Text geniert werden. In Codeblöcken gibt es in der Regel keine weiteren Auszeichnungen des Textes wie **fett** //kursiv//  __unterstrichen__ oder Ähnliches.

Einzelne Wörter oder Textabschnitte werden mit doppelten Apostrophzeichen geklammert wie Code dargestellt.
Achtung1: Auch eingeklammerte Leerzeichen sind dann Bestandteil des Codeformats… F2 -Taste oder F2-Taste?
Achtung2: Das versehentliche Weglassen eines Apostrophs hat Einfluss auf das Layout des nachfolgenden Wikitextes.

Einzelne Wörter oder Textabschnitte werden mit ''doppelten Apostrophzeichen'' geklammert wie Code dargestellt. Achtung: auch eingeklammererte Leerzeichen sind dann Bestandteil des Codeformats... ''F2 ''-Taste oder ''F2''-Taste?
Achtung1: Auch eingeklammerte Leerzeichen sind dann Bestandteil des Codeformats... ''F2 ''-Taste oder ''F2''-Taste?\\
Achtung2: Das versehentliche Weglassen eines Apostrophs hat Einfluss auf das Layout des nachfolgenden Wikitextes.

Mit dem code-Tag können ebenfalls ganze Abschnitte als Code tituliert werden, wodurch Wiki-Interpretationen entfallen.

So können auch Zeichen wiedergegeben werden, die sonst als Wikiformatierungszeichen ''geschluckt'' werden.

Auch wenn ein code-Tag inline geschrieben ist, sorgt er dafür, dass der code-Abschnitt als separater Absatz dargestellt wird!

Daher gibt es auch noch einen nowiki-Tag für das Aussetzen von Wiki-Innterpretationen. So können auch Zeichen wiedergegeben werden, die sonst als Wikiformatierungszeichen ''geschluckt'' werden. Wenn ein nowiki-Tag inline geschrieben ist, bleibt der nowiki-Abschnitt inline!

Für das nowiki-tag gibt es eine auch verkürzte Schreibweise mit doppelten Prozentzeichen. Ich empfehle, das nowiki-tag auszuschreiben, da es in der späteren Bearbeitung transparenter ist: man sieht wo der Block startet und wo er endet. Ein doppeltes %-Zeichen kann Anfang oder Ende eines unformatierten Blockes sein, somit versehentlich größere Abschnitte 'entformatieren'.

Zum Verständnis, was als Sonderzeichen betrachtet wird, ist eine Liste der Codes sinnvoll, die einer Interpretation im Wiki unterliegen. Es gibt bestimmte Zeichenfolgen, die zu Bildern oder Sonderzeichen gewandelt werden. Hier eine Sammlung aus der Dokuwikisyntax:

Text to Image Conversions

Text to HTML Conversions

Hier sind für iX-Wiki die Pfeile, Copyright und ggf. die spitzen Klammern (für Variablendarstellung) interessant.

Typography: DokuWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „He thought 'It's a man's world'…“

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

The same can be done to produce any kind of HTML, it just needs to be added to the pattern file.

There are three exceptions which do not come from that pattern file: multiplication entity (640×480), 'single' and „double quotes“. They can be turned off through a config option.

Quoting

Der Einsatz von Quoting-Darstellung in iX-Wiki ist nicht vorgesehen. Aber man stößt u. U. auf den Effekt, sollte man Zeilen mit schießenden spitzen Klammern beginnen…

Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn't

Well, I say we should

Really?

Yes!

Then lets do it!

Einklappung per Folded-PlugIn

Überschriften

Layoutelemente

Pfade

Der Zugang / Pfad zu einem Modul / Dialog / Ansicht / Funktion etc. wird wie folgt abgebildet (Beispiel):

Buchhaltung > Raten-/Stundungsvereinbarung > Ratenvereinbarung

Positioniert wird der Pfad direkt unterhalb der Hautüberschrift mit einer Zeile Abstand bzw. bei Funktionen im Fließtext.

Tabellen

Abschnitte in Tabellen, welche die Bereiche eines Dialogs kennzeichnen, werden mit Überschriften der niedrigsten Ebene formatiert. Beispiel: Bereich Info im Dialog Meldung

Dialog Meldung

Info

Feld	Beschreibung
`Betreff`	Benennung des Betreffs der Meldung, z. B. „Wasserrohrbruch“ manueller Umbruch in Tabellenzelle ansonsten <WRAP>-Tag nutzen!

Manueller Umbruch (auch in Tabellen): doppelter Backslash gefolgt von Leerzeichen Umbruch mit Absatz (in Tabellen nur innerhalb einer WRAP-Klammer): mit doppeltem Enter.
Bitte unnötig geklammerte manuelle Umbrüche vermeiden: "Wasserrohrbruch\\ " → "Wasserrohrbruch" \\ (Dies funktioniert zwar oftmals beides, Variante 1 ist jedoch anfällig für Folgefehler und beim Bearbeiten schlechter zu lesen.)

Auszeichnung von Schaltern oder Modulnamen durch inline Code (Klammer durch doppelte ‘‘Apostrophen‘‘). |

Die Kombination aus zwei Leerzeichen zu Absatzbeginn und Markierung kompletter Zeile mit einer Code-Klammer erzeugt einen Block-Code (→ Absatzformat, breiterer Coderahmen, dies ist i. d. R. nicht erwünscht).

Nummerierte Handlungsschritte mit <leer><leer>-, Einrückung von Unterkategorien ist möglich mit zwei weiteren Leerzeichen

erster
1. 1a
2. 1b
zweiter
dritter

Unsortierte Listen mit <leer><leer>*, Einrückung ist möglich mit zwei weiteren Leerzeichen <leer><leer>* <leer><leer>* <leer><leer><leer><leer>*

Aufzählung
- Subaufzählung
- Subaufzählung
Aufzählung
Aufzählung

Internes

Dokumentation von Stellen mit Klärungsbedarf über nodisp-Tag mit Parameter 2:

Was noch zu tun ist oder Fragestellung

⇒ soll nur im Editormodus gezeigt werden. <nodisp> ToDo … oder Frage … wäre auch ohne Anmeldung sichtbar! In Tabellen muss zur korrekten Ausführung von nodisp die Anweisung innerhalb eines <WRAP>-Tags stehen!

Größere Baustellen können mit einer

Zu-Erledigen-Box

abgehandelt werden.