wiki:syntax [PIC Mikrocontroller WIKI]
Mittwoch, 23. Mai 2012
 
 

Syntax-Beschreibung

DokuWiki unterstützt einige Formatierungsmöglichkeiten um die Lesbarkeit der Textseiten zu vereinfachen. Diese Seite enthält alle möglichen Konvertierungen, die DokuWiki unterstützt . Schaut euch einfach mal den Quelltext mithilfe des Diese Seite bearbeiten Button oben links auf der Seite. Wenn du was ausprobieren willst benutze die Spielwiese. Die einfacheren Formatierungen sind auch über quickbuttons benutzbar.

Einfaches Formatieren

DokuWiki unterstützt fett, kursiv, unterstrichen und vorformatiert . Ihr könnt sie natürlich auch kombinieren .

DokuWiki unterstützt **fett**, //kursiv//, 
__unterstrichen__   und ''vorformatiert'' . 
Ihr könnt sie natürlich auch **__//''kombinieren''//__** .

Du kannst den Text auch tiefstellen bzw. höherstellen.

Du kannst den Text auch <sub>tiefstellen</sub> bzw. <sup>höherstellen</sup>.

Du kannst Wörter auch als durchgestrichen markieren.

Du kannst Wörter auch als <del>durchgestrichen</del> markieren.

Ein Absatz wird durch eine leere Zeile erzeugt.
Eine neue Zeile (Zeilenumbruch) kann durch zwei „backslashes“ (umgekehrte Schrägstriche: \\) gefolgt von einem Leerzeichen erzeugt werden.

Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.
Beachte die zwei umgekehrten Schrägstriche werden nur erkannt, wenn sie am Zeilenende stehen
oder wenn ihnen ein
Leerzeichen folgt \\so sieht es ohne Leerzeichen aus.

Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.\\ 
Beachte die zwei umgekehrten Schrägstriche
werden nur erkannt, wenn sie am Zeilenende stehen\\
oder wenn ihnen ein\\ Leerzeichen folgt \\so sieht es 
ohne Leerzeichen aus.

Zeilenumbrüche durch zwei „backslashes“ (umgekehrte Schrägstriche: \\) sollten nur verwendet werden wenn sie unbedingt gebraucht werden.

Links

Mit DokuWiki können 5 unterschiedliche Arten von Links benutzt werden:

1. Extern

Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com
Natürlich können Verweise auch hinter eigenen Begriffen versteckt werden: This Link points to google
E-mail Adressen werden in spitze Klammern gesetzt: andi@splitbrain.org

Externe Links werden automatisch erkannt: http://www.google.com oder
einfach  www.google.com\\ 
Natürlich können Verweise auch hinter eigenen Begriffen versteckt 
werden: [[http://www.google.com|This Link points to google]] \\
E-mail Adressen werden in spitze Klammern gesetzt: <andi@splitbrain.org>

2. Intern

Interne Links, also Verweise auf Seiten die mit DokuWiki erstellt wurden, werden in doppelten eckigen Klammern gesetzt: wiki:pagename Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:Beschreibung für einen Link.

Interne Links werden in doppelten eckigen Klammern gesetzt: [[doku>wiki:pagename]] 
Ein Link kann auch hinter einem Begriff oder einer Beschreibung
versteckt werden:[[doku>wiki:pagename|Beschreibung für einen Link]].

Dateinamen für neue Seiten im Wiki werden automatisch in Kleinbuchstaben umgewanderlt!
Umlaute sind genauso wie Sonderzeichen nicht erlaubt! (Verweis auf erlaubte Zeichen in Dateinamen - englisch)

Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst:namespaces

Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst:[[wiki:namespaces]] 

Weitere Informationen zu Namensbereichen: wiki:namespaces.

Anmerkungen:

  • Links zu existierenden Seiten werden anders angezeigt als Links zu nicht-existierenden Seiten.
  • DokuWiki verwendet standartmäßig keine CamelCase für Links.
    In der Einstellungsdatei: config kann das aber geändert werden.
    Hinweis: wennn das Wort: DokuWiki
    als Link angezeigt wird, dann ist diese Option eingeschaltet.

3. Interwiki

DokuWiki unterstützt auch Links in andere Wikis, sogenannte wiki:interwiki Links.

Ein Link zur englischen Wikipedia Seite über Wikis:Wiki
Um ein Link zur deutschen Wikipedia Seite zu setzen, wird folgende Syntax benutzt:

[[wpde>Mikrocontroller]]

Mikrocontroller

DokuWiki unterstützt auch Links in andere Wikis, sogenannte
[[doku>wiki:interwiki]] Links. \\
Ein Link zur Wikipedia Seite über Wikis:[[wp>Wiki]]

4. Windows Freigaben

DokuWiki kennt auch Links auf Windows Freigaben: freigegebener-Ordner.
Dies macht allerdings nur in einer homogenen Benutzergruppe Sinn:Intranet.

DokuWiki kennt auch Links auf Windows Freigaben: [[\\server\freigabe|this]].

Hinweis:

  • Aus Sicherheitsgründen funktioniert direktes Navigieren durch die Freigaben nur mit dem Internet Explorer!

5. Bilder als Links

Bilder können für einen Link auf eine interne oder externe Datei verwendet werden. Dazu wird die Syntax zur Anzeige von Links einfach mit der zur Anzeige von Bildern (siehe unten) kombiniert:

[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]

Bitte beachte: Bildformatierungen sind die einzigen Formatierungen, die in Linknamen benutzt werden können!

Fußnoten

Fußnoten 1) werden duch eine doppelte runde Klammer dargestellt 2). Der Text zwischen den Klammern wird an das Ende der Seite geschrieben. Die Reihenfolge und somit die Nummerierung übernimmt DokuWiki.

Fußnoten ((dies ist eine Fußnote)) werden duch eine doppelte runde 
Klammer dargestellt ((eine zweite Fußnote)) 

Sektionen

Mit 5 unterschiedliche Ebenen, getrennt durch Überschriften, kann der Inhalt einer Seite strukturiert werden.
Wenn in einer Seite mehr als 3 Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet.
Soll dieses Inhaltsverzeichnis nicht erstellt werden muß der Befehl: ~~NOTOC~~ mit in die Seite aufgenommen werden.

Überschrift Ebene 3

Überschrift Ebene 4

Überschrift Ebenel 5
==== Überschrift Ebene 3 ====
=== Überschrift Ebene 4 ===
== Überschrift Ebene 5 ==

Mit 4 aufeinander folgenden Minuszeichen kann eine horrizontale Linie erzeugt werden:


Bilder und andere Dateien

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:

Eine Größe vorgeben:

Eine Größe für externe Bilder vorgeben:

Original Größe:             {{wiki:dokuwiki-128.png}}
Eine Breite vorgeben: {{wiki:dokuwiki-128.png?100}}
Eine Größe vorgeben:  {{wiki:dokuwiki-128.png?100x100}}
Eine Größe für externe Bilder vorgeben: {{http://de3.php.net/images/php.png?100x100}}

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 }}

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

Dies ist ein Titel

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

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

Listen

DokuWiki kennt sortierte 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 werden 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 werden 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 werden durch Hinzufügen 
      von weiteren 2 Leerzeichen erstellt
  * Noch ein Eintrag

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

Smileys

Der Übersicht halber verwendet Wiki kleine „Smileys“ für die einzelnen Beiträge, um zu sehen, was noch geändert werden muss.
Weitere Smiley-Grafiken können im Ordener „smily“ abgelegt und dann in der Datei conf/smileys.conf eingetragen werden.
Die zwei Smileys stehen zur Auswahl:

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

Typografie

DokuWiki kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln.
Hier eine Liste aller Zeichen, die DokuWiki kennt

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

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

Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden

Tabellen

Mit DokuWiki können Tabellen ganz einfach erstellt werden:

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

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

^ hervorgehoben   ^ zum Beispiel für   ^ Titelzeile           ^
| Zeile 1 Spalte 1    | Zeile 1 Spalte 2     | Zeile 1 Spalte 3        |
| Zeile 2 Spalte 1    | dopelte 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.

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

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        |

Anmerkung: Felder über mehrere Zeilen werden nicht unterstützt.

Unformatierte Abschnitte / Nonparsed Blocks

Um Text anzuzeigen so, wie er geschrieben wurde egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält kann man jede Zeile mit zwei Leerzeichen beginnen wie es in dieser Seite angewendet wurde oder einen der Bezeichner „code“ bzw „file“ benutzen:

Mit "code": In diesem Text werden keine überflüssigen Leerzeichen entfernt:
wie hier              <-- zwischen
Mit "file": Eigentlich das Gleiche wie oben, sieht 
nur etwas anders aus. Vielleicht um Zitate zu kennzeichnen 
oder ähnliches.

Um jegliche Umwandlung durch Dokuwiki abzustellen umschließe den entsprechenden Bereich mit „nowiki“ Bezeichnern oder kürzer mit doppelten Prozentzeichen %%.

Dieser Text enthält links wie: http://www.splitbrain.org und **Formatierungen** aber sie werden nicht umgesetzt und erscheinen als normaler Text.

Einfach den Quelltext dieser Seite anschauen (den Knopf „edit“ drücken) um zu sehen wie diese Blöcke angewendet werden.

Syntax highlighting

DokuWiki kennt Syntax highlighting für Quellcode um dessen Lesbarkeit zu erhöhen. Dafür wird GeSHi Generic Syntax Highlighter benutzt. Somit wird jede Programmiersprache unterstützt, die GeSHi kennt.
Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält: <code java> Quelltext </code>.

/** 
 * 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.
    }
}

Es werden folgende Sprachen unterstützt:

  • ada
  • apache
  • asm
  • bash
  • c
  • css
  • html4strict
  • java
  • nsis
  • pascal
  • php-brief
  • php
  • perl
  • qbasic
  • sql

Es kann auch ein Source Code mit Überschrift ausgegeben werden. Dafür verwendet man z.B. <code php|Beispielüberschrift> Hier ist der Source-Code </code>

Hier ein Beispiel:

Code
/** 
 * 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.
    }
}

HTML und PHP einbinden

In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden:

This is some HTML

<html>
This is some <font color="red" size="+1">HTML</font>
</html>

Oder hier PHP:

echo 'A logo generated by PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';

<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

Achtung: Das Einbinden von HTML und PHP in einer Seite kann in de Konfigurationsdatei ausgeschalted werden. Ist dieses geschehen wird der Quellcode dieser Abschnitte als Text angezeigt und nicht ausgeführt.

Mathe Formeln erstellen

Eine Dokumentation wie man coole Mathe Formeln erstellt gibts unter: www.xm1math.net

Durch die Syntax <m> </m> kann eine Formel dargestellt werden.

Beispiel:
<m>S(f)(t)=a_{0}+sum{n=1}{+infty}{a_{n} cos(n omega t)+b_{n} sin(n omega t)}</m>

Ein weitere Möglichkeit ist die Größe der Formel anzugeben. Dazu gibt man in der Syntax eine Größe an, z.b. <m 32>S(f)(t)=a_{0}+sum{n=1}{+infty}{a_{n} cos(n omega t)+b_{n} sin(n omega t)}</m>.
Und so sieht es dann aus:
<m 32>S(f)(t)=a_{0}+sum{n=1}{+infty}{a_{n} cos(n omega t)+b_{n} sin(n omega t)}</m>

Keyboard-Tasten grafisch anzeigen

Ein weiteres Feature ist grafisch bestimmte Tastenkürzel anzuzeigen. Wenn man z.B. CTRL-ALT-L anzeigen benutzt man <key>CTRL-ALT-L</key>

Hier das Beispiel:

CTRL+ALT+L

Dadurch werden bei Erklärung von Tastenkürzel dies im Text übersichtlicher dargestellt.

Notiz Boxen

Um ein Hinweis oder Warnung besser darzustellen gibt es sogenannte Notiz-Boxen. Mit der Syntax <note keyword> Notiz </note> kann die Notiz dargestellt werden. Als keyword gibt es

  • important
  • classic
  • warning
  • tip

Also ersetzt das Wort keyword mit eines der oben genannten Wörtern.

Beispiele:

Sehr wichtig

Classic

Eine Warnung

Ein kleiner Tipp

Individuelle Boxen

Ich habe bemerkt das man in der Code- und file-Syntax nichts fettgedrucktes ausgeben kann. Deshalb habe ich dieses Feature eingebaut. Es ist eine, die nach Aussehen und Farbe variieren kann. In dieser Box funktioniert auch eine andere Syntax.

Beispiel:

a title

Eine Box in orange

Hier ist die Syntax:

<box width classes | title text> contents text </box| caption text>

; //classes// : any number of classes which use the styles in your 
                template or the plugin's own stylesheet to determine 
                the look of the box. 

The box plugins comes with the following classes already defined:

  • round — box will have rounded corners
  • blue — blue colour scheme
  • red — red colour scheme
  • green — green colour scheme
  • orange — orange colour scheme
  • left — box is floated left on the page
  • right — box is floated right on the page
; //width// : a percentage value from 1-100%.
; //title text// : text (including dokuwiki markup) displayed as a
                   title above box contents.
; //caption text// : text (without dokuwiki markup) displayed as a 
                     caption below box contents.


width & classes can be specified in any order.
If a title is used a space MUST precede the pipe “|“

1) dies ist eine Fußnote
2) eine zweite Fußnote
 
wiki/syntax.txt · Zuletzt geändert: 2010/04/28 07:44 (Externe Bearbeitung)
 
Falls nicht anders bezeichnet, ist der Inhalt dieses Wikis unter der folgenden Lizenz veröffentlicht:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki
 
Top! Top!