Formatierung auf einer Seite in diesem Wiki

Was gibt es hier auf dieser Seite?

Auf dieser Seite wird erklärt, wie das Formatieren von Text in diesem Wiki funktioniert

In einem Wiki werden die Worte und Absätze formatiert, indem bestimmte Zeichen (Steuerzeichen) vor und hinter die Worte oder Absätze gesetzt werden. Damit man nicht gleich mit diesen Zeichen herummachen muß, gibt es in diesem Wiki oberhalb des Bearbeitungsfensters über Formatierungsknöpfe, sogenannte quickbuttons.

Um sie zu benutzen, muß man ein oder mehrere Worte markieren und dann einen der quickbuttons anklicken. Dadurch werden automatisch die richtigen Steuerzeichen gesetzt. Wenn man mit der Maus über die quickbuttons langsam drüberfährt, erscheint eine kurze Erklärung, was der betreffende Button macht. Eine ausführlichere Beschreibung dazu findet Ihr hier: quickbuttons

Wer das Gefühl hat, er/sie könnte hier etwas kaputt machen, wenn er/sie hier einfach drauflos schreibt oder ändert, kann auf unserem Spielplatz nach Herzenslust ausprobieren und herumspielen: Spielplatz. Wenn Du dort bist, klickst Du auf „Diese Seite bearbeiten“ oben auf der Seite in dem dunkelgrünen Streifen.

Was auch hilft, die Logik der Formatierungen besser zu verstehen, ist wenn Du Dir einfach anschaust, wie zum Beispiel diese Seite funktioniert, indem Du auf „Diese Seite bearbeiten“ klickst und schaust, was für Steuerzeichen was machen.

Eine gute Kurzübersicht über die Formatierungsregeln gibt es auch hier: Kurzübersicht zu Formatierungsregeln: Leider funktioniert die Seite bei uns noch nicht richtig. Das funktionierende Original ist hier: Kurzübersicht zu Formatierungsregeln bei Illustrator - hilf Dir selbst

Die Seite ist „work in progress“, nicht alles ist so, wie es schön wäre. Es ist von einer anderen DokuWiki-Seite kopiert und dann teilweise angepaßt. Also, wenn Ihr etwas daran zu verbessern habt, nur zu. An manchen Stellen steht schon ein FIXME - da ist schon klar, daß es hier was zu verbessern gibt, bzw. daß noch was fehlt.

Ansonsten sind natürlich Anregungen, Bemerkungen oder Hinweise auf Fehler herzlichst willkommen.

Schöne Grüße, Thomas

1 Texte formatieren

1.1 Formatierungen

DokuWiki unterstützt fetten, kursiven, unterstrichenen und monospaced Text. Natürlich kann auch alles kombiniert werden.

DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__ und ''monospaced'' Text. 
Natürlich kann auch alles **__''kombiniert''//__** werden.

Ebenso gibt es tiefgestellten und hochgestellten Text.

Ebenso gibt es <sub>tiefgestellten</sub> und <sup>hochgestellten</sup> Text.

Text kann als gelöscht deleted1) markiert werden.

Text kann als gelöscht <del>deleted</del> markiert erden.

1.2 Absätze und neue Zeilen

Ein Absatz erstellt man, indem man eine leere Zeile erzeugt (2x Enter).
Eine neue Zeile (Zeilenumbruch) ohne Abstand zu vorigen bekommt man, wenn man zwei "backslashes" (umgekehrte Schrägstriche: \\) gefolgt von einem Leerzeichen und Enter eingibt.

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.

1.3 Überschriften

Mit 5 unterschiedliche Ebenen, getrennt durch Überschriften, kann der Inhalt einer Seite strukturiert werden.
Die Überschriften werden mit maximal sechs “=“ eingrahmt, je nach Größe. H1 ist die Überschrift auf höchster Ebene. Am einfachsten zur Erzeugung der Überschriften die Symbolleiste verwenden und hier auf die die Buttons H1, H2 oder H3 klicken.

Es ist sinnvoll, wenn immer eine Level 1 Überschrift am Anfang eines Artikels steht.

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 1 ======
===== Überschrift Ebene 2 =====
==== Überschrift Ebene 3 ====
=== Überschrift Ebene 4 ===
== Überschrift Ebene 5 ==

→ Innerhalb von Überschriften können keine weiteren Formatierungen vorgenommen werden!

1.4 unformatierte Abschnitte

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 (so 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.

1.5 Syntax-Hervorhebung

dokuwiki_english kennt Syntax highlighting für Quellcode um dessen Lesbarkeit zu erhöhen. Dafür wird GeSHiGeneric 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:
actionscript, actionscript-french, ada, apache, applescript, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, html4strict, ini, inno, java, javascript, lisp, lua, matlab, mpasm, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smarty, sql, ruby, vb, vbnet, vhdl, visualfoxpro, xml

1.6 Zitat / Kommentar

Um einen Text als Zitat oder Kommentar zu kennzeichen wird das „größer als“ - Zeichen folgendermaßen verwendet:

Ich denke wir sollten es tun.

> Nein, sollten wir nicht.

>> Doch!

> Wirklich?

>> Ja!

>>> Dann lass es uns tun!

>>> Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichen wird das "größer als" - Zeichen folgendermaßen verwendet

Ich denke wir sollten es tun

Nein, sollten wir nicht.
Doch!
Wirklich?
Ja!
Dann lass es uns tun
Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichen wird das „größer als“ - Zeichen folgendermaßen verwendet

2 Aufzählungen & numerierte 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 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

3 Bilder und andere Dateien

3.1 Bilder per Dialogfeld einbauen

Das Hochladen von Bildern muss in der Konfigurationsdatei eingeschaltet sein. Zusätzlich kann der Seitenbetreiber diese Funktion per ACL beschränken FIXME

3.2 Größe von Bildern

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

3.3 Ausrichten von Bildern

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

3.4 Tooltips

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

3.5 Dateidownload

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

4 Links

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

4.1 Extern

Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com
Verweise können auch hinter eigenen Begriffen versteckt werden: hier ist 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\\
Verweise können auch hinter eigenen Begriffen versteckt werden: [[http://www.google.com|hier ist google]] \\
E-mail Adressen werden in spitze Klammern gesetzt: <andi@splitbrain.org>

4.2 Intern

Interne Links, also Verweise auf Seiten innerhalb des Plattsalat-DokuWiki, werden in doppelten eckigen Klammern gesetzt: syntax_english

Ein Link kann auch „hinter“ einem Begriff oder einer Beschreibung versteckt werden, wenn man einen senkrechten Strich hinter den link schreibt und danach die Beschreibung: Beschreibung für einen Link. Den senkrechten Strich bekommt man mit AltGr und der < > Taste (neben dem Ypsilon)

Interne Links werden in doppelten eckigen Klammern gesetzt:
[[wiki:pagename]] oder [[wiki:pagename]] 

Ein Link kann hinter einem Begriff oder einer Beschreibung versteckt werden:
[[namensbereich:seitenname|Beschreibung für einen Link]].

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

Durch einen Doppelpunkt kann man Seiten in einem bestimmten Namensbereich (namespace) im Wiki ansprechen, und zwar so: vor dem Doppelpunkt steht der Namensbereich, nach dem Doppelpunkt die Seite innerhalb des Namensbereichs: syntax_english

Durch einen Doppelpunkt kann man Seiten innerhalb eines
bestimmten Namensbereiches ansprechen: [[wiki:hintergrundinfos:syntax_english]] 

Weitere Informationen zu Namensbereichen: wiki:namespaces.

Anmerkungen:

  • Links zu schon existierenden Seiten werden anders angezeigt als Links zu noch nicht existierenden Seiten.
  • Manche Wikis benutzen den sogenannten CamelCase als automatische Seitennamen. Das heißt, wenn man ein Wort mit Großbuchstaben in der Mitte schreibt, wird automatisch ein link erzeugt. DokuWiki verwendet standardmäßig keine CamelCase für Links. Hier muß also immer mit den eckigen Klammern für links gearbeitet werden.
    In der Einstellungsdatei: config kann das aber geändert werden.

4.3 Interwiki

FIXME - Dieser Punkt muß richtig erklärt werden. Damit fange ich nix an. - Thomas

DokuWiki unterstützt auch Links in andere Wikis, sogenannte wiki:interwiki Links.
Ein Link zur Wikipedia Seite über Wikis:Wiki

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

4.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 standardmäßig nur mit dem Internet Explorer(… und das nur in der „lokalen Zone“)!
  • Für Mozilla und Firefox kann es durch die Option security.checkloaduri eingeschaltet werden, was aber nicht empfohlen wird!
  • Opera ingnoriert als Sicherheitsfeature seit Version 7.54 alle Links auf file: in Webseiten.
  • Für weitere Informationen siehe: 151

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!

Achtung: In unserem Wiki muß man noch den Pfad des Bilder mitangeben, auch wenn das Bild im gleichen namespace (=Ordner) liegt. Es ist etwas rätselhaft, warum das so ist, denn bei Bildern, die man ohne link einbindet, muß man das nicht.

Das geht dann so:

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

und nicht so:

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

5 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 doppelte 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    | 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.

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.

  • 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
Tabelle mit Ausrichtung
Rechts Mitte Links
Links Rechts Mitte
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

So sieht die Formatierung aus:

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

6 sonstige Formatierungen

6.1 Fußnoten

Fußnoten 2) werden durch eine doppelte runde Klammer dargestellt 3). 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)

6.2 horizontale Linie

Mit 4 aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horrizontale Linie erzeugt werden:


----

6.3 Smileys

Dokuwiki verwandelt oft genutzte emoticons zu kleinen Smily-Grafiken.
Weitere Smiley-Grafiken können im Ordener „smily“ abgelegt und dann in der Datei conf/smileys.conf eingetragen werden.
Hier ist nun eine Übersicht der standardmäßig in DokuWiki enthaltenen Smileys:

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

sowie ^_^ ^_^ 4)

6.4 Typografie

dokuwiki_english 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

6.5 HTML und PHP einbinden

FIXME - hier stimmt was nicht - Thomas

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 der Konfigurationsdatei ausgeschaltet werden. Ist dieses geschehen wird der Quellcode dieser Abschnitte als Text angezeigt und nicht ausgeführt.

Achtung: Das Einbinden von HTML und PHP auf einer Seite im Internet ist gewöhnlich ein schweres Sicherheitsrisiko! Diese Funktion ist nur für das Intranet gedacht!

7 Syntax Plugins

DokuWiki's Syntax kann durch Plugins erweitert werden. Wie die einzelnen Plugins benutzt werden steht auf deren Beschreibungsseiten. Die folgenden Plugins sind auf dieser DokuWiki Installation verfügbar:

8 Andere DokuWiki Syntax-Seiten

Syntax-Seite von thewall.de

1) wer eingefügt <ins> braucht. kann dies über Plugins realisieren. Siehe ganz unten!
2) dies ist eine Fußnote
3) eine zweite Fußnote
4) lässt sich wohl nicht in einer Tabelle darstellen
 
/home/doms/plattsalat.de/subs/wiki/data/pages/wiki/anleitungen/syntax_hilfe.txt · Zuletzt geändert: 2008/09/17 11:43 von thomas-becker