Inhalt
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
Im öffentlichen Teil sind die Grafikersetzungen wie Smileys nicht eingeplant. Für die interne Organisation werden aber z. B. das Fixme sowie die Ausrufezeichen und Fragezeichen als Symboldarstellung genutzt.
DokuWiki converts commonly used emoticons to their graphical equivalents. Those Smileys and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
8-) 
8-O 
:-( 
:-) 
=) 
:-/ 
:-\ 
:-? 
:-D 
:-P 
:-O 
:-X 
:-| 
;-) 
^_^ 
m( 
:?: 
:!: 
LOL 
FIXME 
DELETEME
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
Die Einklappungen können für ganze Textblöcke (Steuerung über vier Pluszeichen) oder innerhalb von Zeilen erfolgen (Steuerung über zwei Pluszeichen). Eine Verschachtelung von Blöcken ist in Kombination mit einer WRAP-Klammer möglich. Rechts außen ist Navigationsbalken Alles aus/einklappen als Schalter verfügbar. Per Default sind alle Abschnitte einer Seite eingeklappt, wenn diese geladen wird.
Verschachtelte Einklappungen
With the help of the WRAP-Plugin you can create nested folds:
++++ Outer Fold | The trick is to wrap the inner fold: <WRAP> ++++ Inner Fold | This is the content of the inner fold. In addition an inline fold can be used too++| and this is an inline fold++. ++++ The inline fold is realized in the text line++| and this is an inline fold++. It will be expanded too. </WRAP> ++++
Überschriften
Engl. header, Einklappung mit sectiontoggle technisch nicht ausgeschlossen, derzeit werden nur Inhalte darunter mit folded eingeklappt… Tastaturkommandos für die Bildung von Überschriften mit Shift + Alt + …:
- 0 übergeordnete Überschrift
- 1 H1 oberste Überschrift mit tag aus sechs Gleicheitszeichen
- 2 H2 tag aus fünf Gleicheitszeichen
- 3 H3 tag aus vier Gleicheitszeichen
- 4 H4 tag aus drei Gleicheitszeichen
- 5 H5 unterste mit tag aus zwei Gleichheitszeichen
- 8 Überschrift in gleicher Ebene
- 9 Überschrift untergeordnet
Im Editmodus kann im Browser mit Mausklick auf Icons (H-Symbole) eine neue Überschrift eingefügt werden (mit oder ohne Ebenenwechsel oder Ebebenauswahl) (Code)
- HH in gleicher Ebene wie die aktuelle (8)
- H>H untere Überschrift (9)
- H<H übergeordnete Überschrift (0)
- wählbare Überschrift
Beispiele
Level 1 Überschrift
Level 2 Überschrift
Level 3 Überschrift
Level 4 Überschrift
Level 5 Überschrift
Fettschrift
Während ein Level 5-Header direkt adressierbar wäre und immer einen Absatz mit Überschriftenfarbe darstellt, kann die Schriftauszeichnung fett inline im Fließtext eingesetzt werden.
Standardschrift
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
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
- 1a
- 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.