Diese Seite erklärt den Umgang mit DokuWiki. Fragen und Anregungen bitte per Email an Martin Züger.

DokuWiki unterstützt fette, kursive, unterstrichene und nichtproportionale Textformatierung. Natürlich kann dies auch beliebig kombiniert werden.

DokuWiki unterstützt **fette**, //kursive//, __unterstrichene__ und ''nichtproportionale'' Textformatierung.
Natürlich kann dies auch **__//''beliebig kombiniert''//__** werden.

Text kann auch ^hoch- oder _tiefgestellt werden.

Text kann auch <sup>hoch-</sup> oder <sub>tiefgestellt</sub> werden.

Auch kann ein Text durchgestrichen werden.

Auch kann ein Text <del>durchgestrichen</del> werden.

Abschnitte werden automatisch durch eine leere Zeile generiert. Um einen einfachen Zeilenumbruch zu erstellen, ohne einen neuen Absatz zu beginnen, können zwei Backslashes verwendet werden, gefolgt von einem Zeilenumbruch oder Leerzeichen.

DokuWiki unterstützt verschiedene Arten von Links.

Externe Links werden automatisch genriert: http://www.ntb.ch oder einfach www.ntb.ch - Der Linktext kann natürlich auch explizit vorgegeben werden: Hier geht's zum NTB!. Emailadressen können selbstverständlich auch verlinkt werden: info@ntb.ch.

Externe Links werden automatisch genriert: http://www.ntb.ch oder einfach www.ntb.ch - Der Linktext kann natürlich auch explizit vorgegeben werden:
[[http://www.ntb.ch | Hier geht's zum NTB!]]. Emailadressen können natürlich auch verlinkt werden: <info@ntb.ch>.

Interne Links werden mit eckigen Klammern erstellt. Dazu wird einfach entweder nur der Seitenname oder alternativ noch ein Linktex angegeben.

Interne Links werden ebenfalls mit eckigen Klammern erstellt. Dazu wird einfach entweder nur der [[Seitenname]] oder alternativ noch ein [[Seitenname | Linktex]] angegeben.

Wiki Seitennamen werden automatisch in Kleinbuchstaben umgewandelt. Sonderzeichen sind nicht erlaubt und werden durch Underlines ersetzt. Auf dem Infoportal sind nur Seitennamen mit normalen Buchstaben, Zahlen und Leerzeichen erlaubt.

Für eine hirarchische Strukturierung werden Namensräume unterstützt. Diese werden durch Doppelpunkte getrennt: Seitentitel.

Für eine hirarchische Strukturierung werden Namensräume unterstützt. Diese werden durch Doppelpunkte getrennt: [[Namensraum:Seitentitel]].

Eine detailierte Erklärung ist auf der DokuWiki-Seite vorhanden: namespaces.

Es ist sogar möglich auf Abschnitte bestimmter Seiten zu verweisen, wie zum Beispiel auf diesen hier.

Es ist sogar möglich auf Abschnitte bestimmter Seiten zu verweisen, wie zum Beispiel auf [[.:dokuwiki#Intern|diesen hier]].

DokuWiki unterstütz auch sogenannte Interwiki Links. Damit lassen sich einfach Links auf andere Wikis erstellen. Beispiel für einen Link zum Wikipedia Artikel über die NTB.

DokuWiki unterstütz auch [[doku>Interwiki]] Links. Damit lassen sich einfach Links auf andere Wikis erstellen. Beispiel für einen Link zum Wikipedia Artikel über die [[wpde>Interstaatliche Hochschule für Technik NTB Buchs | NTB]].

Windowsfreigaben wie z.B. dieses hier werden auch unterstütz. Solche Links sollten jedoch wenn immer möglich vermieden werden, da sie einerseits nur NTB-intern funktionieren und auch hier nicht mit jedem Browser.

Windowsfreigaben wie z.B. [[\\ntb\exchange|dieses hier]] werden auch unterstütz.

Es können natürlich auch Bilder verlinkt werden, nicht nur Texte. Dazu ist einfach der Text in einem Link durch die entsprechnde Syntax für ein Bild (siehe weiter unten) zu ersetzen:

[[http://www.php.net|{{Intern:NTB-Logo_blau_grau.png}}]]

DokuWiki unterstützt bis zu 5 Überschrift-Hirarchien. Überschrift 1 wird für den Seitentitel verwendet. Die Stufen 2-5 können für die Textgliederung verwendet werden. Beispiel für eine Überschrift der Stufe 4:

Alle Möglichen Überschriften:

====== Headline Level 1 ======
===== Headline Level 2 =====
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

Für die Überschriften 2 bis 4 wird automatisch ein Inhaltsverzeichnis auf der linken Seite erstellt (erst wenn min. drei Überschriften vorhanden sind). Dies kann mit ~~NOTOC~~ unterbunden werden (siehe im Abschnitt Makros.

Fussnoten können ebenfalls hinzugefügt werden ¹⁾.

Fussnoten können ebenfalls hinzugefügt werden ((Wie zum Beispiel diese hier)).

Werden mehr als 4 Bindestriche ( ---- ) hintereinander geschrieben, so wird eine horizontale Linie gezeichnet.

Bilder und Dateien zum Herunterladen können einfach über die Schaltfläche Bilder und andere Dateien einfügen ²⁾ eingefügt werden. In diesem Dialog können die Dateien auch direkt hochgeladen werden. Dabei ist zu beachten, das diese direkt in den Namespace der gerade bearbeiteten Seite geladen werden. Es ist somit nicht notwendig, die Dateien systemweit eindeutig zu benennen, jedoch zwingend innerhalb eines Namespaces. Folgende Dateiformate sind zu verwenden:

• Bilder: JPEG oder PNG
• Dokumente: PDF
• Archive: ZIP

Aus Sicherheitsgründen nicht akzeptabel sind ausführbare Dateien ³⁾!

Word-, Excel, PowerPoint oder OpenOffice-Dokumente sind nur dann zu verwenden, wenn sie von den Studenten bearbeitet werden müssen, ansonsten sind PDF-Dokumente vorzuziehen.

Mit geschweiften Klammern können sowohl externe als auch interne Bilder eingebunden werden. Optional kann deren Größe angegeben werden:

Original Größe:

Eine Breite vorgeben:

Breite und Höhe vorgeben:

Größe für externe Bilder vorgeben:

Original Größe:                        {{wiki:dokuwiki-128.png}}
Eine Breite vorgeben:                  {{wiki:dokuwiki-128.png?50}}
Breite und Höhe vorgeben:              {{wiki:dokuwiki-128.png?200x50}}
Größe für externe Bilder vorgeben:     {{http://de3.php.net/images/php.gif?200x50}}

Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden(links, mitte, rechts).

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Bei der Verwendung eines Titels sollte man drauf achten dass der Titel nach dem Leerzeichen kommt:

{{ wiki:dokuwiki-128.png|Rechtsbündig}}
{{wiki:dokuwiki-128.png |Linksbündig}}
{{ wiki:dokuwiki-128.png |Zentriert}}

Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden.

{{ wiki:dokuwiki-128.png |Dies ist ein Titel}}

Mit einer zusätzlichen eckigen Klammer wird der Titel als Legende unter dem Bild dargestellt:

Legende

[{{ wiki:dokuwiki-128.png |Legende}}]

Wenn eine Datei angegeben wird, die kein Bild (gif,jpeg,png) ist, so wird sie als Link angezeigt und so zum Download angeboten.

Beispiel

Bilder werden automatisch mit einer Verlinkung zur Ihren Metadaten erstellt - Bsp.:

Dieses Verhalten kann über die Option ?nolink⁴⁾ unterbunden werden⁵⁾:

{{wiki:dokuwiki-128.png?15&nolink}}

Ausserdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, direkt verlinkt werden:

{{wiki:dokuwiki-128.png?15&direct}}

DokuWiki kennt unsortierte und nummerierte Listen. Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit 2 Leerzeichen. Diesen Leerzeichen folgt dann ein „*“ für unsortierte oder ein „-“ für nummerierte Listen.

• Dies ist ein Eintrag einer unsortierten Liste
• Ein zweiter Eintrag
  • Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
• Noch ein Eintrag

1. Dies ist ein Eintrag einer nummerierte Liste
2. Ein zweiter Eintrag
   1. Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
3. Noch ein Eintrag

  * Dies ist ein Eintrag einer unsortierten Liste
  * Ein zweiter Eintrag
    * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
  * Noch ein Eintrag

  - Dies ist ein Eintrag einer nummerierte Liste
  - Ein zweiter Eintrag
    - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
  - Noch ein Eintrag

Boxen können relativ leicht erzeugt werden. Einige Beispiele:

<box | Titel > Das ist die einfachste möglichkeit für eine Box </box>

Das selbe noch mit etwas Farbe und rechts ausgerichtet:

<box 70% right green | Titel > Das ist die einfachste Möglichkeit für eine farbige Box </box>

Oder als Warnung:

<box red 100% | Titel > Das ist eine einfache Möglichkeit für eine Warnung </box>

Die blauen Boxen bedürfen noch einer Überarbeitung:

<box blue | Titel > Blaue Boxen sehen noch sehr hässlich aus... </box>

Natürlich können auch Boxen mit Code-Abschnitten erstellt werden. Dies eignet sich hervorragend für Beispiele:

public class HalloWelt {
  public static void main(String[] args) {
    System.out.println("Hallo Welt!");
  }
}

<box 50% center green | Beispiel>
Das ist ein Beispiel mit etwas Code:
<code java>
public class HalloWelt {
  public static void main(String[] args) {
    System.out.println("Hallo Welt!");
  }
}
</code>
Und hier könnte noch eine Erkärung stehen.
</box>

DokuWiki kann einfache Textfolgen durch Grafiken oder typografisch korrekte Zeichen ersetzen.

Dokuwiki verwandelt oft genutzte Emoticons zu kleinen Smily-Grafiken

8-)	8-O	:-(	:-)	=)	:-/	:-\	:-?	:-D	:-P	:-O	:-X	:-|	;-)	:?:	:!:	^_^	LOL

DokuWiki kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln.

Hier eine Liste aller Zeichen, die die NTB-Installation von DokuWiki kennt:

640×480

„He thought 'It's a man's world'…“

640x480
"He thought 'It's a man's world'..."

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!

Mit DokuWiki können Tabellen ganz einfach erstellt werden:

Felder einer Tabelle starten mit „|“ für ein normales Feld oder mit einem „^“ für hervorgehobenes Feld.

^ hervorgehoben       ^ zum Beispiel für                                                  ^ eine Titelzeile         ^
| Zeile 1 Spalte 1    | Zeile 1 Spalte 2                                                  | Zeile 1 Spalte 3        |
| Zeile 2 Spalte 1    | doppelte Spaltenbreite (beachte den doppelten senkrechten Strich) ||
| Zeile 3 Spalte 1    | Zeile2 Spalte 2                                                   | Zeile 2 Spalte 3        |

Zellen über mehrere Spalten werden erzeugt, wenn man, wie oben gezeigt, am Ende einer solchen Spalte soviele „|“ oder „^“ ohne Leerzeichen dazwischen hintereinander setzt, wie Spalten überbrückt werden.
Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern „|“ oder „^“ haben.

Hervorgehobene Felder in Vertikaler Ausrichtung sind auch möglich.

Wie wir sehen, entscheidet der Feldtrenner („|“ oder „^“) vor einer Zelle über ihr Aussehen:

|                    ^ hervorgehoben 1           ^ hervorgehoben 2         ^
^ hervorgehoben 3    | Zeile 1 Spalte 2          | Zeile 1 Spalte 3        |
^ hervorgehoben 4    | Zeile 2 Spalte 2          |                         |
^ hervorgehoben 5    | Zeile 3 Spalte 2          | Zeile 3 Spalte 3        |

Felder über mehrere Zeilen (vertikal verbundene Zellen) lassen sich durch hinzufügen von ::: in der zu verbindenden Zelle zusammenfügen.

Außer den drei Doppelpunkten darf die zu verbindende Zelle keine weiteren Inhalte haben.

^ Titelzeile 1        ^ Titelzeile 2                       ^ Titelzeile 3            ^
| Zeile 1 Spalte 1    | Diese Zelle ist vertikal verbunden | Zeile 1 Spalte 3        |
| Zeile 2 Spalte 1    | :::                                | Zeile 2 Spalte 3        |
| Zeile 3 Spalte 1    | :::                                | Zeile 3 Spalte 3        |

• Der Inhalt einer Zelle kann horizontal ausgerichtet werden. Füge 2 Leerzeichen hinzu:
  
  • 2 Leerzeichen Links vom Text: rechtsbündig
  • 2 Leerzeichen Rechts vom Text: linksbündig
  • 2 Leerzeichen Links und Rechts vom Text: zentriert

So sieht die Formatierung aus:

^          Tabelle mit Ausrichtung         ^^^
|        Rechts|    Mitte     |Links         |
|Links         |        Rechts|    Mitte     |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags <code> or <file>.

This is text is indented by two spaces.

This is preformatted code all spaces are preserved: like              <-this

This is pretty much the same, but you could use it to show that you quoted a file.

Those blocks were created by this source:

  This is text is indented by two spaces.

<code>
This is preformatted code all spaces are preserved: like              <-this
</code>

<file>
This is pretty much the same, but you could use it to show that you quoted a file.
</file>

DokuWiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax is the same like in the code and file blocks in the previous section, but this time the name of the used language is inserted inside the tag. Eg. <code java> or <file java>.

/**
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

The following language strings are currently recognized: abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoit, avisynth, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cmake, cobol, cpp, cpp-qt, csharp, css, d, dcs, delphi, diff, div, dos, dot, eiffel, email, erlang, fo, fortran, freebasic, genero, glsl, gml, gnuplot, groovy, gettext, haskell, hq9plus, html, idl, ini, inno, intercal, io, java5, java, javascript, kixtart, klonec, klonecpp, latex, lisp, locobasic, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, make, matlab, mirc, modula3, mpasm, mxml, mysql, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, pascal, perl, per, php-brief, php, pic16, pixelbender, plsql, povray, powershell, progress, prolog, properties, providex, python, qbasic, rails, rebol, reg, robots, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, tcl, teraterm, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xml, xorg_conf, xpp, z80

When you use the <code> or <file> syntax as above, you might want to make the shown code available for download as well. You can to this by specifying a file name after language code like this:

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>

myexample.php

<?php echo "hello world!"; ?>

If you don't want any highlighting but want a downloadable file, specify a dash (-) as the language code: <code - myfile.foo>.

Die folgenden Makros stehen zur Zeit zur verfügung: