Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Nächste Überarbeitung | Vorhergehende ÜberarbeitungNächste ÜberarbeitungBeide Seiten der Revision | ||
wiki:syntax [2008/05/05 19:10] – Externe Bearbeitung 127.0.0.1 | wiki:syntax [2009/10/21 16:03] – cg301 | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | ====== | + | ====== |
- | [[wiki: | ||
- | ===== Basic text formatting | + | ===== Seite erstellen |
- | DokuWiki supports **bold**, //italic//, __underlined__ and '' | + | Um einen neuen Artikel zu erstellen, klicken Sie im Navigationskasten links auf " |
- | DokuWiki supports | + | **Neue Seiten können Sie alternativ auf folgende Weise anlegen:** |
- | Of course you can **__//'' | + | |
- | You can use <sub>subscript</sub> and <sup>superscript</sup>, too. | + | Verlinken Sie auf einer bestehenden Seite ein Wort mit doppelten eckigen Klammern |
- | You can use < | + | ===== Seite bearbeiten ===== |
- | You can mark something as < | + | Um eine Seite zu bearbeiten, klicken an der oberen Leiste auf "Seite bearbeiten" |
- | You can mark something as < | + | * Wählen Sie eine aussagekräftige Überschrift. |
+ | * Mit Hervorhebungen aller Art (fett, kursiv, bunt etc.) bitte sparsam umgehen. | ||
- | **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. | ||
- | This is some text with some linebreaks\\ Note that the | + | ===== Schlagwörter / Tags ===== |
- | two backslashes are only recognized at the end of a line\\ | + | |
- | or followed by\\ a whitespace \\this happens without it. | + | |
- | This is some text with some linebreaks\\ Note that the | + | Jedem Artikel können Schlagwörter zugeordnet werden. Dies erleichtert die Navigation im Wiki, denn die verschlagworteten Seiten erscheinen automatisch auf einer Übersichtseite. Wählen Sie unter jedem Artikel die passenden Stichwörter aus. |
- | two backslashes are only recognized at the end of a line\\ | + | |
- | or followed by\\ a whitespace \\this happens without it. | + | |
- | You should use forced newlines only if really needed. | ||
- | ===== Links ===== | + | ===== Wiki-Syntax |
- | DokuWiki supports multiple ways of creating links. | ||
- | ==== External | + | ==== Textformatierung |
- | External links are recognized automagically: | + | === Schrift === |
- | DokuWiki supports multiple ways of creating links. External links are recognized | + | ^Syntax^Ergebnis^ |
- | | + | |%%**fett**%%|**fett**| |
- | | + | |%%//kursiv// |
- | | + | |%%__unterstrichen__%%|__unterstrichen__| |
+ | |%%'' | ||
+ | |%%< | ||
+ | |%%<sup>hochgestellt</ | ||
+ | |%%< | ||
- | ==== Internal ==== | ||
- | Internal links are created by using square brackets. You can either just give a [[doku> | + | ===Absätze === |
+ | Ein Absatz wird erzeugt durch | ||
+ | * eine leere Zeile oder | ||
+ | * %%\\%% am Ende einer Zeile oder | ||
+ | * %%\\%% plus ein Leerzeichen | ||
- | Internal links are created by using square brackets. You can either just give | + | === Überschriften ==== |
- | | + | Überschriften werden mit maximal sechs " |
- | | + | |
+ | | ||
+ | ==== Überschrift Ebene 3 ==== | ||
+ | === Überschrift Ebene 4 === | ||
+ | == Überschrift Ebene 5 == | ||
- | You can use [[wiki: | + | Innerhalb von Überschriften können keine weiteren Formatierungen vorgenommen werden! |
- | You can use [[wiki: | + | Überschrift 1 steht am Anfang eines Artikels. Wenn in einer Seite mehr als 3 Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet. |
- | For details about namespaces see [[doku> | + | Soll kein Inhaltsverzeichnis erstellt werden, muss der Befehl: ''< |
- | 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# | ||
- | This links to [[syntax# | + | === unformatierte Abschnitte === |
- | Notes: | + | Um Text unformatiert in einer Box erscheinen zu lassen, beginnt man jede Zeile mit zwei Leerzeichen oder verwendet %%< |
- | | + | |
- | * DokuWiki does not use [[wp> | + | |
- | * When a section' | + | |
- | ==== Interwiki ==== | + | oder %%< |
- | DokuWiki supports [[doku>wiki: | + | <file>mit file sieht es etwas anders aus .. </file> |
- | | + | Um jegliche Umwandlung durch DokuWiki |
- | For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. | + | |
- | ==== Windows Shares ==== | + | === Zitat / Kommentar |
+ | Zitate oder Kommentar werden mit dem " | ||
- | Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogenous user group like a corporate [[wp>Intranet]]. | + | %%> Zitat 1%% |
- | Windows Shares like [[\\server\share|this]] are recognized, too. | + | %%>> Antwort auf Zitat 1%% |
- | Notes: | + | %%>>> |
- | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone" | + | ergibt: |
- | * For Mozilla and Firefox it can be enabled through the config option [[http:// | + | |
- | * See [[dokubug> | + | |
- | ==== Image Links ==== | + | > Zitat 1 |
- | You can also use an image to link to another internal or external page by combining the syntax for links and [[# | + | >> Antwort auf Zitat 1 |
- | [[http:// | + | >>> |
- | [[http:// | + | |
- | Please note: The image formatting is the only formatting syntax accepted in link names. | + | ==== Links ==== |
- | The whole [[# | + | Mit DokuWiki können 5 unterschiedliche Arten von Links benutzt werden: |
- | ===== Footnotes ===== | + | ^Externe Links|Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: %%http:// |
+ | ^ |Links können auch hinter Begriffen versteckt werden: %%[[http:// | ||
+ | ^E-Mail-Adressen|%%< | ||
+ | ^ |oder ebenfalls hinter Begriffen versteckt %%[[andi@splitbrain.org|Mail an Andi]]%%|[[andi@splitbrain.org|Mail an Andi]]| | ||
+ | ^Interne Links|%%[[syntax]]%% Namen für neue Seiten werden automatisch in Kleinbuchstaben umgewandelt. Umlaute sind genauso wie Sonderzeichen nicht erlaubt!|[[syntax]]| | ||
+ | ^ |Interne Links können ebenfalls hinter Beschreibungen versteckt werden %%[[syntax|Hilfe zur Wiki-Syntax]]%%|[[syntax|Hilfe zur Wiki-Syntax]]| | ||
+ | ^ |Links zu [[syntax|existierenden Seiten]] werden anders angezeigt als Links zu [[nicht-existierenden]] Seiten.| | | ||
+ | ^Links zu anderen Wikis|%%[[doku> | ||
- | You can add footnotes ((This is a footnote)) by using double parentheses. | ||
- | You can add footnotes | + | ==== Bilder und andere Dateien ==== |
+ | * Laden Sie nur Bilder und Medien auf das RZ-Wiki hoch, die Sie selbst gemacht haben oder die unter einer Freien Lizenz veröffentlicht wurden | ||
+ | * Nur Bilder verwenden, die jeweils zum Thema passen. | ||
+ | * Größe Bilder vor dem Hochladen verkleinern. | ||
- | ===== Sectioning ===== | + | Bilder werden mit geschweiften Klammern in Texte eingebunden werden. Optional kann deren Größe angegeben werden: |
- | 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 | + | ^Original Größe|%%{{wiki: |
+ | ^Breite vorgeben|%%{{wiki: | ||
+ | ^Breite und Höhe vorgeben|%%{{wiki: | ||
- | ==== Headline Level 3 ==== | ||
- | === Headline Level 4 === | ||
- | == Headline Level 5 == | ||
- | | + | === Ausrichten von Bildern |
- | === Headline Level 4 === | + | Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden(links, |
- | == Headline Level 5 == | + | |
- | By using four or more dashes, you can make a horizontal line: | + | {{ wiki:dokuwiki-128.png|Rechts}} |
- | ---- | + | {{wiki: |
- | + | ||
- | ===== Images and other files ===== | + | |
- | + | ||
- | You can include external and internal [[doku> | + | |
- | + | ||
- | Real size: {{wiki: | + | |
- | + | ||
- | Resize to given width: | + | |
- | + | ||
- | Resize to given width and height: {{wiki: | + | |
- | + | ||
- | Resized external image: | + | |
- | + | ||
- | Real size: {{wiki: | + | |
- | Resize to given width: | + | |
- | Resize to given width and height: {{wiki: | + | |
- | Resized external image: | + | |
- | + | ||
- | + | ||
- | By using left or right whitespaces you can choose the alignment. | + | |
- | + | ||
- | {{ wiki: | + | |
- | + | ||
- | {{wiki: | + | |
- | {{ wiki: | + | {{ wiki: |
{{ wiki: | {{ wiki: | ||
Zeile 151: | Zeile 132: | ||
{{ wiki: | {{ wiki: | ||
- | Of course, you can add a title (displayed as a tooltip by most browsers), too. | ||
- | {{ wiki: | + | === Tooltipps === |
+ | Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden. | ||
- | | + | %%{{ wiki: |
- | If you specify a filename (external or internal) that is not an image ('' | + | === Bilderrahmen === |
+ | Mit einfachen eckigen Klammern wird ein Bilderrahmen erzeugt. Hier wird der Titel nicht als Tooltipp, sondern im Rahmen als Bilduntertitel angezeigt: | ||
- | For linking an image to another page see [[#Image Links]] above. | + | %%[{{ wiki: |
- | ===== Lists ===== | ||
- | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a '' | + | === Dateidownload ==== |
- | * This is a list | + | Alle Dateien außer Bilder ('' |
- | * The second item | + | |
- | * You may have different levels | + | |
- | * Another item | + | |
- | | + | %%{{ wiki: |
- | | + | |
- | | + | |
- | - That's it | + | |
- | < | ||
- | * This is a list | ||
- | * The second item | ||
- | * You may have different levels | ||
- | * Another item | ||
- | - The same list but ordered | + | === Automatische Verlinkung === |
- | - Another item | + | |
- | - Just use indention for deeper levels | + | |
- | - That's it | + | |
- | </ | + | |
- | ===== Smileys ===== | + | Bilder werden automatisch mit einer Verlinkung zur Ihren [[wp> |
+ | %%{{wiki: | ||
- | DokuWiki converts commonly used [[wp> | + | Dieses Verhalten kann über die Option ? |
- | * 8-) %% | + | %%{{wiki:dokuwiki-128.png?50& |
- | * 8-O %% 8-O %% | + | |
- | * :-( %% :-( %% | + | |
- | * :-) %% :-) %% | + | |
- | * =) %% =) %% | + | |
- | * :-/ %% :-/ %% | + | |
- | * :-\ %% :-\ %% | + | |
- | * :-? %% :-? %% | + | |
- | * :-D %% :-D %% | + | |
- | * :-P %% :-P %% | + | |
- | * :-O %% :-O %% | + | |
- | * :-X %% :-X %% | + | |
- | * :-| %% :-| %% | + | |
- | * ;-) %% ;-) %% | + | |
- | * ^_^ %% ^_^ %% | + | |
- | * :?: %% :?: %% | + | |
- | * :!: %% :!: %% | + | |
- | * LOL %% LOL %% | + | |
- | * FIXME %% FIXME %% | + | |
- | * DELETEME %% DELETEME %% | + | |
- | ===== Typography ===== | + | Außerdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, |
- | [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. | + | %%{{wiki: |
- | -> <- < | + | ==== Listen ==== |
- | "He thought ' | + | Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit 2 Leerzeichen. Diesen Leerzeichen folgt dann ein "*" für unsortierte oder ein " |
- | < | + | < |
- | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | + | |
- | "He thought ' | + | |
- | </ | + | |
- | Please note: These conversions can be turned off through a [[doku> | + | * Ein zweiter Eintrag |
- | ===== Quoting ===== | + | * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen</ |
- | Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: | ||
- | | + | |
- | + | | |
- | > No we shouldn' | + | * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen |
- | + | ||
- | >> Well, I say we should | + | |
- | + | ||
- | > Really? | + | |
- | + | ||
- | >> Yes! | + | |
- | + | ||
- | >>> | + | |
- | I think we should do it | ||
- | > No we shouldn' | + | <code> - Dies ist ein Eintrag einer nummerierte Liste |
- | >> Well, I say we should | + | - Ein zweiter Eintrag |
- | > Really? | + | - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen</ |
- | >> Yes! | ||
- | >>> | + | - Dies ist ein Eintrag einer nummerierte Liste |
+ | - Ein zweiter Eintrag | ||
+ | - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen | ||
- | ===== Tables ===== | ||
- | DokuWiki supports a simple syntax to create tables. | + | ==== Tabellen ==== |
- | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | + | Tabellenfelder werden mit senkrechten Stricken erzeugt. Felder einer Tabelle starten mit " |
- | | 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 2 Col 2 | Row 2 Col 3 | | + | |
- | Table rows have to start and end with a '' | ||
- | ^ Heading 1 | + | ^ hervorgehoben |
- | | Row 1 Col 1 | Row 1 Col 2 | + | | Zeile 1 Spalte |
- | | Row 2 Col 1 | some colspan | + | | Zeile 2 Spalte |
- | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | | + | | Zeile 3 Spalte |
- | To connect cells horizontally, | ||
- | Vertical tableheaders are possible, too. | + | ^ hervorgehoben |
+ | | 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 | | ||
- | | ^ 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 | | ||
- | As you can see, it's the cell separator before a cell which decides about the formatting: | + | Zellen über mehrere Spalten werden erzeugt, wenn man am Ende einer solchen Spalte soviele " |
+ | Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern " | ||
- | | ^ Heading 1 ^ Heading 2 ^ | + | Hervorgehobene Felder in Vertikaler Ausrichtung sind auch möglich. |
- | ^ 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 | | + | |
- | Note: Vertical spans (rowspan) are not possible. | + | | ^ 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 | | ||
- | 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. | ||
- | ^ Table with alignment | + | | |
- | | | + | ^ hervorgehoben 3 |
- | |left | + | ^ hervorgehoben 4 |
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | + | ^ hervorgehoben 5 |
- | This is how it looks in the source: | + | Anmerkung: Felder über mehrere Zeilen werden nicht unterstützt. |
- | | + | |
- | | + | |
- | | + | * 2 Leerzeichen Rechts vom Text: linksbündig |
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | + | |
- | ===== Non-parsed Blocks ===== | + | ^ Tabelle mit Ausrichtung |
+ | | Rechts| | ||
+ | |Links | ||
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | You can include non-parsed blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags '' | + | So sieht die Formatierung aus: |
- | < | + | ^ Tabelle mit Ausrichtung |
- | This is preformatted code all spaces are preserved: like <-this | + | |
- | </ | + | |
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | <file> | + | <note tip>Den senkrechten Strich erhält man folgendermaßen: |
- | This is pretty much the same, but you could use it to show that you quoted a file. | + | </note> |
- | </file> | + | ==== sonstige Formatierungen ==== |
- | To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with '' | + | === Fußnoten === |
- | < | + | Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt: %%((dies ist eine Fußnote))%%. Der Text zwischen den Klammern wird an das Ende der Seite geschrieben. Die Reihenfolge und somit die Nummerierung übernimmt DokuWiki. |
- | This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, | + | |
- | </ | + | |
- | See the source of this page to see how to use these blocks. | ||
- | ===== Syntax Highlighting ===== | + | === horizontale Linie === |
+ | Mit 4 aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden: | ||
- | [[DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http:// | + | < |
- | <code java> | + | ---- |
- | /** | + | |
- | * The HelloWorldApp class implements an application that | + | |
- | * simply displays "Hello World!" | + | |
- | */ | + | |
- | class HelloWorldApp { | + | |
- | public static void main(String[] args) { | + | |
- | System.out.println(" | + | |
- | } | + | |
- | } | + | |
- | </ | + | |
- | The following language strings are currently recognized: //abap actionscript-french, | + | === Smileys === |
+ | Dokuwiki verwandelt oft genutzte [[wp> | ||
- | ===== RSS/ATOM Feed Aggregation ===== | ||
- | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | ||
- | ^ Parameter | + | ^ |
- | | any number | + | | |
- | | reverse | + | |
- | | author | + | |
- | | date | show item dates | | + | |
- | | description| show the item description. If [[doku> | + | |
- | | // | + | |
- | The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[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 [[DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered. | + | ===Typografie === |
+ | Einfache Textzeichen werdem in ihre typografischen Entsprechungen umgewandelt.\\ | ||
- | **Example: | + | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) |
+ | "He thought ' | ||
- | {{rss> | ||
- | |||
- | {{rss> | ||
- | |||
- | |||
- | ===== Embedding HTML and PHP ===== | ||
- | |||
- | You can embed raw HTML or PHP code into your documents by using the '' | ||
< | < | ||
- | <html> | + | -> <- <-> => <= < |
- | This is some <span style=" | + | "He thought ' |
- | </html> | + | |
- | <HTML> | + | |
- | <p style=" | + | |
- | </ | + | |
</ | </ | ||
- | < | ||
- | This is some <span style=" | ||
- | </ | ||
- | < | ||
- | <p style=" | ||
- | </ | ||
- | |||
- | < | ||
- | <php> | ||
- | echo 'A logo generated by PHP:'; | ||
- | echo '< | ||
- | echo ' | ||
- | </ | ||
- | <PHP> | ||
- | echo '< | ||
- | echo '< | ||
- | echo '</ | ||
- | </ | ||
- | </ | ||
- | |||
- | <php> | ||
- | echo 'A logo generated by PHP:'; | ||
- | echo '< | ||
- | echo ' | ||
- | </ | ||
- | <PHP> | ||
- | echo '< | ||
- | echo '< | ||
- | echo '</ | ||
- | </ | ||
- | |||
- | **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. | ||
- | |||
- | ===== 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~~%% | ||
- | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%< | ||
- | |||
- | ===== Syntax Plugins ===== | ||
- | DokuWiki' | + | ====Kontroll Makros ==== |
- | ~~INFO:syntaxplugins~~ | + | Manche Syntax Befehle beeinflussen, |
+ | ^Macro^ Description^ | ||
+ | |%%~~NOTOC~~%%|Wenn dieses Makro im in eine Seite eingebunden ist, wird das [[:toc|Table of Content]] nicht erstellt.| | ||
+ | |%%~~NOCACHE~~%%|Dokuwiki Seiten werden standardgemäß in einen Zwischenspeicher gesichert. Manchmal ist das aber nicht gewollt ( z.B. bei <php> Syntax Befehlen). Beim einfügen dieses Makros wird Dokuwiki gezwungen bei jedem Aufruf die Seite neu einzulesen.| | ||
+ | ====== Backgroundinfos zu dieser Seite====== | ||
+ | Grundlage für diese Seite war die [[http:// | ||
+ | Für das RZ-Wiki wurde sie grundlegend überarbeitet von --- // | ||
+ | {{tag> |