Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen gezeigt.

--- wiki:syntax [2009/12/01 00:03]
admin angelegt
+++ wiki:syntax [2018/11/06 21:09] (aktuell)
@@ Zeile 1: / Zeile 1: @@
-====== Syntax (deutsch) ======
+====== Formatting Syntax ======
-===== Einleitung =====
+[[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.
-[[DokuWiki]] zeichnet sich durch einfache Formatierungen aus. Dadurch bleiben die Dateien, die den Inhalt enthalten, gut lesbar. \\
+===== Basic Text Formatting =====
-**Hier wird die Syntax beschrieben um Seiten zu bearbeiten.**
+DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
-Schau dir zum **Beispiel** diese Seite an, indem du den "Diese Seite bearbeiten" Knopf oben oder unten drückst. \\
+  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
-Zum  Ausprobieren oder Üben kannst du den [[Hilfe:Testwiese]] verwenden. \\
+  Of course you can **__//''combine''//__** all these.
-Einfache Formatierungen sind direkt durch [[doku>de:quickbuttons]] in der "Menüleiste" über dem Editor erreichbar. \\
-===== zur Übersetzung =====
+You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-Diese Seite ist eine Übersetzung der [[http://www.splitbrain.org/dokuwiki/wiki:syntax|Syntax-Seite aus DokuWiki (2005-07-13)]].\\
+  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-Sie ist keine wortgleiche Übersetzung. Einige Beschreibungen sind etwas ausführlicher ausgefallen. Fachbegriffe werden nur dort verwendet, wo eine Umschreibung mehr Verwirrung stiftet als nützt.\\
-Ähnliches gilt auch für Begriffe, die dem Englischen entspringen, für manche gibt es keine direkte Übersetzungen. Oder sie sind schon so bekannt, dass eine Übersetzung unsinnig ist.\\
-Der Übersetzer ist sich selbst nicht sicher, ob er lieber den Begriff "Link" oder "Verweis" benutzen soll.\\
-An einigen Stellen befindet sich ein FIXME - hier gibt es etwas, was im Sinne des Übersetzers noch nicht gut umgesetzt wurde.
-  * Anregungen, Bemerkungen oder Hinweise auf Fehler sind willkommen.
-  * euer Sebastian Koch => mr_snede *at* web ~dot~ de
-====== 1 Texte ======
+You can mark something as <del>deleted</del> as well.
-===== 1.1 Formatierungen =====
+  You can mark something as <del>deleted</del> as well.
-DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__ und ''monospaced'' Text. Natürlich kann auch alles **__//''kombiniert''//__** werden. \\
+**Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line.
-  DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__ und ''monospaced'' Text.
+This is some text with some linebreaks\\ Note that the
-  Natürlich kann auch alles **__//''kombiniert''//__** werden.
+two backslashes are only recognized at the end of a line\\
+or followed by\\ a whitespace \\this happens without it.
-Ebenso gibt es <sub>tiefgestellten</sub> und <sup>hochgestellten</sup> Text.
+  This is some text with some linebreaks\\ Note that the
+  two backslashes are only recognized at the end of a line\\
+  or followed by\\ a whitespace \\this happens without it.
-  Ebenso gibt es <sub>tiefgestellten</sub> und <sup>hochgestellten</sup> Text.
+You should use forced newlines only if really needed.
-Text kann als gelöscht <del>deleted</del>((wer eingefügt %%<ins>%% braucht. kann dies über Plugins realisieren. Siehe ganz unten!)) markiert werden.
+===== Links =====
-  Text kann als gelöscht <del>deleted</del> markiert werden.
+DokuWiki supports multiple ways of creating links.
-===== 1.2 Absätze =====
+==== External ====
-Ein Absatz wird durch eine leere Zeile erzeugt. \\
-<nowiki>Eine neue Zeile (Zeilenumbruch) kann durch zwei "backslashes" (umgekehrte Schrägstriche: \\) </nowiki>gefolgt von einem Leerzeichen erzeugt werden.\\
-Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.\\ Beachte die zwei umgekehrten Schrägstriche
+External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too.
-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
+  DokuWiki supports multiple ways of creating links. External links are recognized
-  werden nur erkannt, wenn sie am Zeilenende stehen\\
+  automagically: http://www.google.com or simply www.google.com - You can set
-  oder wenn ihnen ein\\ Leerzeichen folgt\\ so sieht es ohne Leerzeichen aus.
+  link text as well: [[http://www.google.com|This Link points to google]]. Email
+  addresses like this one: <andi@splitbrain.org> are recognized, too.
-Zeilenumbrüche durch zwei "backslashes" (umgekehrte Schrägstriche: \\) sollten nur verwendet werden, wenn sie unbedingt gebraucht werden.
+==== Internal ====
-===== 1.3 Überschriften =====
+Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]].
-Mit fünf unterschiedlichen Ebenen, getrennt durch Überschriften, kann der Inhalt einer Seite strukturiert werden.\\
-Die Überschriften werden mit maximal sechs "=" eingerahmt, 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.
+  Internal links are created by using square brackets. You can either just give
+  a [[pagename]] or use an additional [[pagename|link text]].
-Wenn in einer Seite mehr als 3 Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet.\\
+[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
-Soll dieses Inhaltsverzeichnis nicht erstellt werden, muß der Befehl: ''<nowiki>~~NOTOC~~</nowiki>'' mit in die Seite aufgenommen werden.
-  ====== Überschrift Ebene 1 ======
+You can use [[some:namespaces]] by using a colon in the pagename.
-  ===== Überschrift Ebene 2 =====
-  ==== Überschrift Ebene 3 ====
-  === Überschrift Ebene 4 ===
-  == Überschrift Ebene 5 ==
-Innerhalb von Überschriften können keine weiteren Formatierungen vorgenommen werden!
+  You can use [[some:namespaces]] by using a colon in the pagename.
-===== 1.4 unformatierte Abschnitte =====
+For details about namespaces see [[doku>namespaces]].
-Um Text so anzuzeigen, wie er geschrieben wurde, egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält, kann man jede
+Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax#internal|this Section]].
-Zeile mit zwei Leerzeichen beginnen (so wie es in dieser Seite angewendet wurde) oder einen der Bezeichner "code" bzw "file" benutzen:
-<code>
+  This links to [[syntax#internal|this Section]].
-Mit "code": In diesem Text werden keine überflüssigen Leerzeichen entfernt: wie hier              <-- zwischen
-</code>
-<file>
+Notes:
-Mit "file": Eigentlich das Gleiche wie oben, sieht nur etwas anders aus. \\
-Vielleicht um Zitate zu kennzeichnen oder ähnliches.
-</file>
-Um jegliche Umwandlung durch Dokuwiki abzustellen, umschließe den entsprechenden Bereich mit "nowiki" Bezeichnern oder kürzer mit doppelten Prozentzeichen ''<nowiki>%%</nowiki>''.
+  * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones.
+  * DokuWiki does not use [[wp>CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>config]] file. Hint: If DokuWiki is a link, then it's enabled.
+  * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
-<nowiki>
+==== Interwiki ====
-Dieser Text enthält links wie: http://www.splitbrain.org und **Formatierungen** aber sie werden nicht umgesetzt und erscheinen als normaler Text.
-</nowiki>
-Einfach den Quelltext dieser Seite anschauen (den Knopf "edit" drücken) um zu sehen, wie diese Blöcke angewendet werden.
+DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].
-===== 1.5 Syntax-Hervorhebung =====
+  DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis.
+  For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].
-[[DokuWiki]] kennt Syntax highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Dafür wird [[http://qbnz.com/highlighter/|GeSHi]] "**Ge**neric **S**yntax **Hi**ghlighter" benutzt. Somit wird jede Programmiersprache unterstützt, die GeSHi kennt.\\
+==== Windows Shares ====
-Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält:\\
-''<nowiki><code java> Quelltext </code></nowiki>''
-<code java>
+Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp>Intranet]].
-/**
- * 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.
-    }
-}
-</code>
-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**//
+  Windows Shares like [[\\server\share|this]] are recognized, too.
-===== 1.6 Zitat / Kommentar =====
+Notes:
-Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das "größer als" - Zeichen folgendermaßen verwendet:
-  Ich denke wir sollten es tun.
+  * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone").
+  * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|Mozilla Knowledge Base]]. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in ''conf/userscript.js'':
-  > Nein, sollten wir nicht.
-  >> Doch!
-  > Wirklich?
-  >> Ja!
-  >>> Dann lass es uns tun!
-  >>> Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige 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
+  LANG.nosmblinks = '';
-> Nein, sollten wir nicht.
+==== Image Links ====
->> Doch!
+You can also use an image to link to another internal or external page by combining the syntax for links and [[#images_and_other_files|images]] (see below) like this:
-> Wirklich?
+  [[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
->> Ja!
+[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
->>> Dann lass es uns tun
+Please note: The image formatting is the only formatting syntax accepted in link names.
->>> Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das "größer als" - Zeichen folgendermaßen verwendet
+The whole [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
-====== 2 Links ======
+===== Footnotes =====
-Mit DokuWiki können 5 unterschiedliche Arten von Links benutzt werden:
+You can add footnotes ((This is a footnote)) by using double parentheses.
-===== 2.1 Extern =====
+  You can add footnotes ((This is a footnote)) by using double parentheses.
-Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com\\
+===== Sectioning =====
-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>
-  Externe Links werden automatisch erkannt: http://www.google.com oder einfach  www.google.com\\
+You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string ''<nowiki>~~NOTOC~~</nowiki>'' in the document.
-  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>
-===== 2.2 Intern =====
+==== Headline Level 3 ====
+=== Headline Level 4 ===
+== Headline Level 5 ==
-Interne Links, also Verweise auf Seiten innerhalb von DokuWiki, werden in doppelten eckigen Klammern gesetzt("altgr+8" bzw. altgr+9 auf einer win-tastatur bzw Wahltaste+5 und Wahltaste+6 bei Apple) auf:\\
+  ==== Headline Level 3 ====
-[[doku>pagename]]\\
+  === Headline Level 4 ===
+  == Headline Level 5 ==
-Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:\\
+By using four or more dashes, you can make a horizontal line:
-[[doku>pagename|Beschreibung für einen Link]].
-  Interne Links werden in doppelten eckigen Klammern gesetzt:
+----
-  [[doku>pagename]]
-  Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:
-  [[doku>pagename|Beschreibung für einen Link]].
-Dateinamen für neue Seiten im Wiki werden automatisch in Kleinbuchstaben umgewandelt!\\
+===== Media Files =====
-Umlaute sind genauso wie Sonderzeichen nicht erlaubt!
-Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst: [[de:namespaces]]
+You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them.
-  Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst:[[de:namespaces]]
+Real size:                        {{wiki:dokuwiki-128.png}}
-Weitere Informationen zu Namensbereichen: [[doku>de:namespaces]].
+Resize to given width:            {{wiki:dokuwiki-128.png?50}}
-Anmerkungen:
+Resize to given width and height((when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing)): {{wiki:dokuwiki-128.png?200x50}}
-  * Links zu [[syntax|existierenden Seiten]] werden anders angezeigt als Links zu [[nicht-existierenden]] Seiten.
+Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}
-  * DokuWiki verwendet standardmäßig keine [[wp>CamelCase]] für Links. \\ In der Einstellungsdatei: [[doku>config]] kann das aber geändert werden. \\ **Hinweis**: wenn das Wort: DokuWiki als Link angezeigt wird, dann ist diese Option eingeschaltet.
-===== 2.3 Interwiki =====
+  Real size:                        {{wiki:dokuwiki-128.png}}
+  Resize to given width:            {{wiki:dokuwiki-128.png?50}}
+  Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
+  Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}
-DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>de:interwiki]] Links. \\
-Ein Link zur Wikipedia Seite über Wikis:[[wp>Wiki]]
-  DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>de:interwiki]] Links. \\
+By using left or right whitespaces you can choose the alignment.
-  Ein Link zur Wikipedia Seite über Wikis:[[wp>Wiki]]
-===== 2.4 Windows-Freigaben =====
+{{ wiki:dokuwiki-128.png}}
-DokuWiki kennt auch Links auf Windows-Freigaben: [[\\server\freigabe|freigegebener-Ordner]]. \\
+{{wiki:dokuwiki-128.png }}
-Dies macht allerdings nur in einer homogenen Benutzergruppe Sinn (siehe [[wp>Intranet]]).
-  DokuWiki kennt auch Links auf Windows-Freigaben: [[\\server\freigabe|this]].
+{{ wiki:dokuwiki-128.png }}
-Hinweis:
+  {{ wiki:dokuwiki-128.png}}
-  * Aus Sicherheitsgründen funktioniert direktes Navigieren durch die Freigaben standardmäßig nur mit dem Internet Explorer (und das nur in der "lokalen Zone")!
+  {{wiki:dokuwiki-128.png }}
-  * Für Mozilla und Firefox kann es durch die Option [[http://www.mozilla.org/quality/networking/docs/netprefs.html#file|security.checkloaduri]] eingeschaltet werden, was aber nicht empfohlen wird!
+  {{ wiki:dokuwiki-128.png }}
-  * Opera ingnoriert als Sicherheitsfeature seit [[http://www.opera.com/windows/changelogs/754/|Version 7.54]] alle Links auf //file:// in Webseiten.
-  * Für weitere Informationen siehe: [[bug>151]]
-===== 2.5 Bilder als Links =====
+Of course, you can add a title (displayed as a tooltip by most browsers), too.
-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:
+{{ wiki:dokuwiki-128.png |This is the caption}}
-   [[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
+  {{ wiki:dokuwiki-128.png |This is the caption}}
-[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
+For linking an image to another page see [[#Image Links]] above.
-Bitte beachte: Bildformatierungen sind die einzigen Formatierungen, die in Linknamen benutzt werden können!
+==== Supported Media Formats ====
-====== 3 Bilder und andere Dateien ======
+DokuWiki can embed the following media formats directly.
-===== 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|ACL]] beschränken
-FIXME
-===== 3.2 Größe von Bildern  =====
+| Image | ''gif'', ''jpg'', ''png''  |
-Mit geschweiften Klammern können sowohl externe als auch interne [[doku>images|Bilder]] eingebunden werden. Optional kann deren Größe angegeben werden:
+| Video | ''webm'', ''ogv'', ''mp4'' |
+| Audio | ''ogg'', ''mp3'', ''wav''  |
+| Flash | ''swf''                    |
-Original Größe:                      {{wiki:dokuwiki-128.png}}
+If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
-Eine Breite vorgeben:                {{wiki:dokuwiki-128.png?50}}
+==== Fallback Formats ====
-Breite und Höhe vorgeben:            {{wiki:dokuwiki-128.png?200x50}}
+Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.
-Größe für externe Bilder vorgeben:   {{http://de3.php.net/images/php.gif?200x50}}
+For example consider this embedded mp4 video:
-  Original Größe:                        {{wiki:dokuwiki-128.png}}
+  {{video.mp4|A funny video}}
-  Eine Breite vorgeben:                  {{wiki:dokuwiki-128.png?50}}
-  Eine Höhe vorgeben:                    {{wiki:dokuwiki-128.png?x150}}
-  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 =====
+When you upload a ''video.webm'' and ''video.ogv'' next to the referenced ''video.mp4'', DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.
-Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden(links, mitte, rechts).
-{{ wiki:dokuwiki-128.png|Rechts}}
+Additionally DokuWiki supports a "poster" image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''video.jpg'' file would work.
-{{wiki:dokuwiki-128.png |Links}}
+===== Lists =====
-{{ wiki:dokuwiki-128.png |Zentriert}}
+Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''*'' for unordered lists or a ''-'' for ordered ones.
-  {{ wiki:dokuwiki-128.png}}  <-- Ausrichtung am rechten Seitenrand
+  * This is a list
-  {{wiki:dokuwiki-128.png }}  <-- Ausrichtung am linken Seitenrand
+  * The second item
-  {{ wiki:dokuwiki-128.png }} <-- Ausrichtung an der Seitenmitte
+    * You may have different levels
+  * Another item
-===== 3.4 Tooltips =====
+  - The same list but ordered
-Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden.
+  - Another item
+    - Just use indention for deeper levels
+  - That's it
-{{ wiki:dokuwiki-128.png |Dies ist ein Titel}}
+<code>
+  * This is a list
+  * The second item
+    * You may have different levels
+  * Another item
-  {{ wiki:dokuwiki-128.png |Dies ist ein Titel}}
+  - The same list but ordered
+  - Another item
+    - Just use indention for deeper levels
+  - That's it
+</code>
-===== 3.5 Dateidownload =====
+Also take a look at the [[doku>faq:lists|FAQ on list items]].
-Wenn eine Datei angegeben wird, die kein Bild (''gif,jpeg,png'') ist, so wird sie als Link angezeigt und so zum Download angeboten.
+===== Text Conversions =====
-{{ wiki:dokuwiki-128.txt |Beispiel}}
+DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.
-====== 4 Listen ======
+The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.
-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.
+==== Text to Image Conversions ====
-  * Dies ist ein Eintrag einer unsortierten Liste
+DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
-  * Ein zweiter Eintrag
-    * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
-  * Noch ein Eintrag
-  - Dies ist ein Eintrag einer nummerierte Liste
+  * 8-) %%  8-)  %%
-  - Ein zweiter Eintrag
+  * 8-O %%  8-O  %%
-    - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
+  * :-( %%  :-(  %%
-  - Noch ein Eintrag
+  * :-) %%  :-)  %%
+  * =)  %%  =)   %%
+  * :-/ %%  :-/  %%
+  * :-\ %%  :-\  %%
+  * :-? %%  :-?  %%
+  * :-D %%  :-D  %%
+  * :-P %%  :-P  %%
+  * :-O %%  :-O  %%
+  * :-X %%  :-X  %%
+  * :-| %%  :-|  %%
+  * ;-) %%  ;-)  %%
+  * ^_^ %%  ^_^  %%
+  * :?: %%  :?:  %%
+  * :!: %%  :!:  %%
+  * LOL %%  LOL  %%
+  * FIXME %%  FIXME %%
+  * DELETEME %% DELETEME %%
-<code>
+==== Text to HTML Conversions ====
-  * 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
+Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
-  - Ein zweiter Eintrag
-    - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
+-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
-  - Noch ein Eintrag
+"He thought 'It's a man's world'..."
+<code>
+-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
+"He thought 'It's a man's world'..."
 </code>
-====== 5 Tabellen ======
+The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]].
-Mit DokuWiki können Tabellen ganz einfach erstellt werden:
+There are three exceptions which do not come from that pattern file: multiplication entity (640x480), 'single' and "double quotes". They can be turned off through a [[doku>config:typography|config option]].
-^ hervorgehoben   ^ zum Beispiel für   ^ eine Titelzeile           ^
+===== Quoting =====
-| 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.
+Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
-  ^ hervorgehoben   ^ zum Beispiel für   ^ Titelzeile           ^
+  I think we should do it
-  | Zeile 1 Spalte 1    | Zeile 1 Spalte 2                  | Zeile 1 Spalte 3               |
-  | Zeile 2 Spalte 1    | doppelte Spaltenbreite (beachte den doppelten senkrechten Strich) ||
+  > No we shouldn't
-  | Zeile 3 Spalte 1    | Zeile2 Spalte 2                   | Zeile 2 Spalte 3               |
+  >> 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!
+===== Tables =====
+DokuWiki supports a simple syntax to create tables.
+^ Heading 1      ^ Heading 2       ^ Heading 3          ^
+| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
+| Row 2 Col 1    | some colspan (note the double pipe) ||
+| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
+Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers.
+  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^
+  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
+  | Row 2 Col 1    | some colspan (note the double pipe) ||
+  | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
+To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!
+Vertical tableheaders are possible, too.
+|              ^ Heading 1            ^ Heading 2          ^
+^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
+^ Heading 4    | no colspan this time |                    |
+^ Heading 5    | Row 2 Col 2          | Row 2 Col 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.\\
+As you can see, it's the cell separator before a cell which decides about the formatting:
-Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern "|" oder "^" haben.
-Hervorgehobene Felder in Vertikaler Ausrichtung sind auch möglich.
+  |              ^ Heading 1            ^ Heading 2          ^
+  ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
+  ^ Heading 4    | no colspan this time |                    |
+  ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
-|              ^ hervorgehoben 1            ^ hervorgehoben 2          ^
+You can have rowspans (vertically connected cells) by adding '':::'' into the cells below the one to which they should connect.
-^ 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:
+^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
+| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |
+| Row 2 Col 1    | :::                        | Row 2 Col 3        |
+| Row 3 Col 1    | :::                        | Row 2 Col 3        |
-  |                    ^ hervorgehoben             ^ hervorgehoben 2         ^
+Apart from the rowspan syntax those cells should not contain anything else.
-  ^ 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.
+  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
+  | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |
+  | Row 2 Col 1    | :::                        | Row 2 Col 3        |
+  | Row 3 Col 1    | :::                        | Row 2 Col 3        |
-  *Der Inhalt einer Zelle kann horizontal ausgerichtet werden. Füge 2 Leerzeichen hinzu:\\
+You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.
-    * 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         ^^^
+^           Table with alignment           ^^^
-|        Rechts|    Mitte     |Links         |
+|         right|    center    |left          |
-|Links         |        Rechts|    Mitte     |
+|left          |         right|    center    |
 | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
-So sieht die Formatierung aus:
+This is how it looks in the source:
-  ^          Tabelle mit Ausrichtung         ^^^
+  ^           Table with alignment           ^^^
-  |        Rechts|    Mitte     |Links         |
+  |         right|    center    |left          |
-  |Links         |        Rechts|    Mitte     |
+  |left          |         right|    center    |
   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
-|Hinweis zu dem senkrechten Balken-Zeichen: dieses Zeichen ist erreichbar über die Taste "<" bei zusätzlich gedrückter "AltGr"-Taste. Ist dort auch aufgedruckt.|
+Note: Vertical alignment is not supported.
-====== 6 sonstige Formatierungen ======
+===== No Formatting =====
-===== 6.1 Fußnoten =====
+If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''%%<nowiki>%%'' tags or even simpler, with double percent signs ''<nowiki>%%</nowiki>''.
-Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote)). Der Text zwischen den Klammern wird an das Ende der Seite geschrieben. Die Reihenfolge und somit die Nummerierung übernimmt DokuWiki.
+<nowiki>
+This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
+</nowiki>
+The same is true for %%//__this__ text// with a smiley ;-)%%.
-  Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote))
+  <nowiki>
+  This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
+  </nowiki>
+  The same is true for %%//__this__ text// with a smiley ;-)%%.
-===== 6.2 horizontale Linie =====
+===== Code Blocks =====
-Mit 4 aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden:
-----
-<nowiki>----</nowiki>
-===== 6.3 Smileys =====
+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>%%''.
-Dokuwiki verwandelt oft genutzte [[wp>emoticon]]s zu kleinen Smily-Grafiken.\\
+  This is text is indented by two spaces.
-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  ^
+<code>
-|  %%  8-)  %%  |  %%  8-O  %%  |  %%  :-(  %%  |  %%  :-)  %%  |  %%  =)   %%  |  %%  :-/  %%  |  %%  :-\  %%  |  %%  :-?  %%  |  %%  :-D  %%  |  %%  :-P  %%  |  %%  :-O  %%  |  %%  :-X  %%  |  %%  :-|  %%  |  %%  ;-)  %%  |  %%  :?:  %%  |  %%  :!:  %%  |  %%  LOL  %%  |  %%  FIXME  %%  |  %% DELETEME  %%  |
+This is preformatted code all spaces are preserved: like              <-this
+</code>
-sowie ^_^ %%  ^_^  %% ((lässt sich wohl nicht in einer Tabelle darstellen))
+<file>
+This is pretty much the same, but you could use it to show that you quoted a file.
+</file>
-===== 6.4 Typografie =====
+Those blocks were created by this source:
-[[DokuWiki]] kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln.\\
+    This is text is indented by two spaces.
-Hier eine Liste aller Zeichen, die DokuWiki kennt:
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
+  <code>
-"He thought 'It's a man's world'..."
+  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>
+==== Syntax Highlighting ====
+[[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<nowiki><code java></nowiki>'' or ''<nowiki><file java></nowiki>''.
+<code 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.
+    }
+}
+</code>
+The following language strings are currently recognized: //4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, actionscript3, ada, algol68, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic//
+==== Downloadable Code Blocks ====
+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 do this by specifying a file name after language code like this:
 <code>
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
+<file php myexample.php>
-"He thought 'It's a man's world'..."
+<?php echo "hello world!"; ?>
+</file>
 </code>
-Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden
+<file php myexample.php>
+<?php echo "hello world!"; ?>
+</file>
-===== 6.5 HTML und PHP einbinden =====
+If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''.
-In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden:
-<html>
+===== Embedding HTML and PHP =====
-This is some <font color="red" size="+1">HTML</font>
-</html>
+You can embed raw HTML or PHP code into your documents by using the ''%%<html>%%'' or ''%%<php>%%'' tags. (Use uppercase tags if you need to enclose block level elements.)
+HTML example:
 <code>
 <html>
-This is some <font color="red" size="+1">HTML</font>
+This is some <span style="color:red;font-size:150%;">inline HTML</span>
 </html>
+<HTML>
+<p style="border:2px dashed red;">And this is some block HTML</p>
+</HTML>
 </code>
-Oder hier PHP:
+<html>
+This is some <span style="color:red;font-size:150%;">inline HTML</span>
+</html>
+<HTML>
+<p style="border:2px dashed red;">And this is some block HTML</p>
+</HTML>
-<php>
+PHP example:
-echo 'A logo generated by PHP:';
-echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
-</php>
 <code>
 <php>
-echo 'A logo generated by PHP:';
+echo 'The PHP version: ';
-echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
+echo phpversion();
+echo ' (generated inline HTML)';
 </php>
+<PHP>
+echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
+echo '<td>'.phpversion().'</td>';
+echo '</tr></table>';
+</PHP>
 </code>
-**Achtung**: Das Einbinden von HTML und PHP in einer Seite kann in der Konfigurationsdatei ausgeschaltet werden((Konfigurationsoptionen [[config:htmlok]] bzw. [[config:phpok]])). Ist dieses geschehen, wird der Quellcode dieser Abschnitte als Text angezeigt und nicht ausgeführt.
+<php>
+echo 'The PHP version: ';
+echo phpversion();
+echo ' (inline HTML)';
+</php>
+<PHP>
+echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
+echo '<td>'.phpversion().'</td>';
+echo '</tr></table>';
+</PHP>
+**Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.
+===== RSS/ATOM Feed Aggregation =====
+[[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:
+^ Parameter  ^ Description ^
+| any number | will be used as maximum number items to show, defaults to 8 |
+| reverse    | display the last items in the feed first |
+| author     | show item authors names |
+| date       | show item dates |
+| description| show the item description. If [[doku>config:htmlok|HTML]] is disabled all tags will be stripped |
+| //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). |
+The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.
+**Example:**
+  {{rss>http://slashdot.org/index.rss 5 author date 1h }}
+{{rss>http://slashdot.org/index.rss 5 author date 1h }}
+===== Control Macros =====
+Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
+^ Macro           ^ Description |
+| %%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created |
+| %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call |
-**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!
+===== Syntax Plugins =====
-====== 7 Syntax-Plugins ======
+DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:
-DokuWikis Syntax kann durch [[doku>plugins|Plugins]] erweitert werden. Wie die einzelnen Plugins benutzt werden, steht auf deren Beschreibungsseiten. Die folgenden Plugins sind auf dieser DokuWiki Installation verfügbar:
 ~~INFO:syntaxplugins~~
-====== Diskussion ======
-Seite grundlegend überarbeitet von  --- //[[dokuwiki.20.baucki@spamgourmet.com|Konrad Bauckmeier]] 2005-12-02 09:05//

wiki/syntax.txt · Zuletzt geändert: 2018/11/06 21:09 (Externe Bearbeitung)

Nach oben