wiki:syntax

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung		 Vorhergehende Überarbeitung
wiki:syntax [21.09.2015 08:06] – ToDo erledigt: mach das nicht selbst Damian Solkawiki:syntax [16.07.2025 11:54] (aktuell) – Updated syntax reference with optimized structure and comprehensive plugin coverage Jane Alesi
Zeile 1: Zeile 1:
-<todo>Übersetzen der Wiki Syntax Seite mit Bezug auf bp Richtlinien</todo> +====== DokuWiki Syntax Reference - Optimized ======
-<todo @mw #ds:2015-09-21>mach das nicht selbst</todo> +
- --- //[[:mitarbeiter:mw|Michael Wegener]] 21.09.2015 05:37// +
-====== Formatting Syntax ======+
  
-[[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.+**System:** DokuWiki 2024-02-06b "Kaos" | Bootstrap3 | 25+ plugins | PHP 7.4-8.1
  
-===== Basic Text Formatting =====+----
  
-DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.+===== 1. Text Formatting =====
  
-  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. +==== Basic Markup ==== 
-  Of course you can **__//''combine''//__** all these.+``` 
 +**bold** //italic// __underline__ ''monospace'' 
 +<sub>subscript</sub> <sup>superscript</sup> <del>strikethrough</del> 
 +**__//''combined formatting''//__** 
 +```
  
-You can use <sub>subscript</sub> and <sup>superscript</sup>, too.+==== Line Breaks ==== 
 +``` 
 +Line 1\\ 
 +Line 2 with forced break\\ 
 +End of paragraph
  
-  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.+New paragraph starts here 
 +```
  
-You can mark something as <del>deleted</del> as well.+----
  
-  You can mark something as <del>deleted</del> as well.+===== 2. Headers & Structure =====
  
-**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.+==== Header Levels ==== 
 +``` 
 +====== H1 (Main Title) ====== 
 +===== H2 (Section) ===== 
 +==== H3 (Subsection) ==== 
 +=== H4 (Sub-subsection) === 
 +== H5 (Paragraph) == 
 +```
  
-This is some text with some linebreaks\\ Note that the +==== Control Macros ==== 
-two backslashes are only recognized at the end of a line\\ +``` 
-or followed by\\ a whitespace \\this happens without it.+----                    // horizontal line 
 +~~NOTOC~~              // disable table of contents 
 +~~NOCACHE~~            // force page refresh 
 +```
  
-  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.+
  
-You should use forced newlines only if really needed.+===== 3. Links =====
  
-===== Links =====+==== External Links ==== 
 +``` 
 +http://example.com 
 +[[http://example.com]] 
 +[[http://example.com|Link text]] 
 +<email@domain.com> 
 +```
  
-DokuWiki supports multiple ways of creating links.+==== Internal Links ==== 
 +``` 
 +[[pagename]] 
 +[[pagename|Display text]] 
 +[[namespace:page]] 
 +[[#anchor|Section link]] 
 +[[syntax#internal|This section]] 
 +```
  
-==== External ====+==== Special Links ==== 
 +``` 
 +[[doku>wiki]]          // Interwiki 
 +[[\\server\share]]     // Windows share 
 +```
  
-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.+----
  
-  DokuWiki supports multiple ways of creating links. External links are recognized +===== 4. Media & Images =====
-  automagically: http://www.google.com or simply www.google.com - You can set +
-  link text as well: [[http://www.google.com|This Link points to google]]. Email +
-  addresses like this one: <andi@splitbrain.org> are recognized, too.+
  
-==== Internal ====+==== Basic Image Syntax ==== 
 +``` 
 +{{image.png}}                    // original size 
 +{{image.png?200}}               // width: 200px 
 +{{image.png?200x100}}           // width x height 
 +{{https://example.com/img.png}} // external image 
 +```
  
-Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]].+==== Image Alignment ==== 
 +``` 
 +{{ image.png }}                 // centered 
 +{{image.png }}                  // left aligned 
 +{{ image.png}}                  // right aligned 
 +{{image.png|Caption text}}      // with caption 
 +```
  
-  Internal links are created by using square brackets. You can either just give +==== Supported Formats ==== 
-  a [[pagename]] or use an additional [[pagename|link text]].+- **Images:** gif, jpg, png, svg 
 +- **Video:** webm, ogv, mp4 
 +- **Audio:** ogg, mp3, wav
  
-[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.+----
  
-You can use [[some:namespaces]] by using a colon in the pagename.+===== 5. Lists =====
  
-  You can use [[some:namespaces]] by using a colon in the pagename.+==== Unordered Lists ==== 
 +``` 
 +  * First item 
 +  * Second item 
 +    * Nested item 
 +    * Another nested 
 +  * Back to first level 
 +```
  
-For details about namespaces see [[doku>namespaces]].+==== Ordered Lists ==== 
 +``` 
 +  - First numbered 
 +  - Second numbered 
 +    - Nested numbered 
 +    - Another nested 
 +  - Back to first level 
 +```
  
-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]].+==== Mixed Lists ==== 
 +``` 
 +  * Unordered 
 +    - Ordered nested 
 +    - Another ordered 
 +  * Back to unordered 
 +```
  
-  This links to [[syntax#internal|this Section]].+----
  
-Notes:+===== 6. Tables =====
  
-  * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. +==== Basic Table ==== 
-  * 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.+^ Header 1 ^ Header 2 ^ Header 3 ^ 
 +| Cell 1   | Cell 2   | Cell 3   | 
 +| Row 2    | Data     | More     | 
 +```
  
-==== Interwiki ====+==== Advanced Features ==== 
 +``` 
 +^ Header 1 ^ Header 2 ^ Header 3 ^ 
 +| Cell 1   | Colspan  || 
 +| Rowspan  | Cell 2   | Cell 3   | 
 +| :::      | Cell 2   | Cell 3   | 
 +```
  
-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]]. +==== Alignment ==== 
- +``` 
-  DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. +^     Centered Header     ^ 
-  For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. +|  right|  center  |left  | 
- +``` 
-==== Windows Shares ==== +**Rules:** 2+ spaces: left→right, right→left, both→center
- +
-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]]. +
- +
-  Windows Shares like [[\\server\share|this]] are recognized, too. +
- +
-Notes: +
- +
-  * 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/lang/en/lang.php'' (more details at [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localization]]): <code - conf/lang/en/lang.php> +
-<?php +
-/** +
- * Customization of the english language file +
- * Copy only the strings that needs to be modified +
- */ +
-$lang['js']['nosmblinks'] = ''; +
-</code> +
- +
-==== Image Links ==== +
- +
-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: +
- +
-  [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] +
- +
-[[http://www.php.net|{{wiki:dokuwiki-128.png}}]] +
- +
-Please note: The image formatting is the only formatting syntax accepted in link names. +
- +
-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). +
- +
-===== Footnotes ===== +
- +
-You can add footnotes ((This is a footnote)) by using double parentheses. +
- +
-  You can add footnotes ((This is a footnote)) by using double parentheses. +
- +
-===== Sectioning ===== +
- +
-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. +
- +
-==== Headline Level 3 ==== +
-=== Headline Level 4 === +
-== Headline Level 5 == +
- +
-  ==== Headline Level 3 ==== +
-  === Headline Level 4 === +
-  == Headline Level 5 == +
- +
-By using four or more dashes, you can make a horizontal line:+
  
 ---- ----
  
-===== Media Files =====+===== 7. Code & Formatting =====
  
-You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them. +==== Inline Code ==== 
- +``` 
-Real size:                        {{wiki:dokuwiki-128.png}} +Use ''monospace'' for inline code 
- +```
-Resize to given width:            {{wiki:dokuwiki-128.png?50}} +
- +
-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}} +
- +
-Resized external image:           {{http://de3.php.net/images/php.gif?200x50}} +
- +
-  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}} +
- +
- +
-By using left or right whitespaces you can choose the alignment. +
- +
-{{ wiki:dokuwiki-128.png}} +
- +
-{{wiki:dokuwiki-128.png }} +
- +
-{{ wiki:dokuwiki-128.png }} +
- +
-  {{ wiki:dokuwiki-128.png}} +
-  {{wiki:dokuwiki-128.png }} +
-  {{ wiki:dokuwiki-128.png }} +
- +
-Of course, you can add a title (displayed as a tooltip by most browsers), too. +
- +
-{{ wiki:dokuwiki-128.png |This is the caption}} +
- +
-  {{ wiki:dokuwiki-128.png |This is the caption}} +
- +
-For linking an image to another page see [[#Image Links]] above. +
- +
-==== Supported Media Formats ==== +
- +
-DokuWiki can embed the following media formats directly. +
- +
-| Image | ''gif'', ''jpg'', ''png''  | +
-| Video | ''webm'', ''ogv'', ''mp4'' | +
-| Audio | ''ogg'', ''mp3'', ''wav''  | +
-| Flash | ''swf''                    | +
- +
-If you specify a filename that is not a supported media format, then it will be displayed as a link instead. +
- +
-By adding ''?linkonly'' you provide a link to the media without displaying it inline +
- +
-  {{wiki:dokuwiki-128.png?linkonly}} +
- +
-{{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image. +
- +
-==== Fallback Formats ==== +
- +
-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. +
- +
-For example consider this embedded mp4 video: +
- +
-  {{video.mp4|A funny video}} +
- +
-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. +
- +
-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. +
- +
-===== Lists ===== +
- +
-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. +
- +
-  * This is a list +
-  * The second item +
-    * You may have different levels +
-  * Another item +
- +
-  - The same list but ordered +
-  - Another item +
-    - Just use indention for deeper levels +
-  - That's it+
  
 +==== Code Blocks ====
 +```
 <code> <code>
-  * This is a list +Plain code block 
-  * The second item +preserves   spaces 
-    * You may have different levels +</code>
-  * Another item+
  
-  - The same list but ordered +<code java> 
-  - Another item +// Syntax highlighted Java 
-    - Just use indention for deeper levels +public class Hello { 
-  - That's it+    public static void main(String[] args) { 
 +        System.out.println("Hello World!"); 
 +    } 
 +}
 </code> </code>
 +```
  
-Also take a look at the [[doku>faq:lists|FAQ on list items]].+==== File Blocks ==== 
 +``` 
 +<file php script.php> 
 +<?php 
 +echo "Downloadable file"; 
 +?> 
 +</file> 
 +```
  
-===== Text Conversions =====+==== No Formatting ==== 
 +``` 
 +<nowiki>**No formatting** //applied here//</nowiki> 
 +%%**No formatting** //applied here//%% 
 +```
  
-DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.+==== Supported Languages ==== 
 +**Popular:** java, php, python, javascript, html, css, xml, json, yaml, bash, sql, c, cpp, csharp, go, rust, swift, kotlin, scala, ruby, perl, lua, r, matlab, latex, markdown
  
-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.+**Complete list:** 200+ languages including assembly, fortran, cobol, ada, pascal, delphi, vb, powershell, batch, nginx, apache, docker, terraform, etc.
  
-==== Text to Image Conversions ====+----
  
-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:+===== 8. Special Elements =====
  
-  * 8-) %%  8-)  %% +==== Quotes ==== 
-  * 8-O %%  8-O  %% +``` 
-  * :-( %%  :-(  %% +> First level quote 
-  * :-) %%  :-)  %% +>> Second level quote 
-  * =)  %%  =)   %% +>>> Third level quote 
-  * :-/ %%  :-/  %% +```
-  * :-\ %%  :-\  %% +
-  * :-? %%  :-?  %% +
-  * :-D %%  :-D  %% +
-  * :-P %%  :-P  %% +
-  * :-O %%  :-O  %% +
-  * :-X %%  :-X  %% +
-  * :-| %%  :-|  %% +
-  * ;-) %%  ;-)  %% +
-  * ^_^ %%  ^_^  %% +
-  * :?: %%  :?:  %% +
-  * :!: %%  :!:  %% +
-  * LOL %%  LOL  %% +
-  * FIXME %%  FIXME %% +
-  * DELETEME %% DELETEME %%+
  
-==== Text to HTML Conversions ==== +==== Footnotes ==== 
- +``` 
-Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.+Text with footnote((This is the footnote content)) 
 +```
  
 +==== Emoticons & Symbols ====
 +```
 +8-) 8-O :-( :-) =) :-/ :-\ :-? :-D :-P :-O :-X :-| ;-) ^_^ 
 +:?: :!: LOL FIXME DELETEME
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
-"He thought 'It's a man's world'..."+```
  
-<code> +----
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) +
-"He thought 'It's a man's world'..." +
-</code>+
  
-The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]].+===== 9. RSS/Feeds =====
  
-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]].+``` 
 +{{rss>http://example.com/feed.rss 5 author date 1h}} 
 +```
  
-===== Quoting =====+**Parameters:** 
 +- Number: max items to display 
 +- **author:** show author names 
 +- **date:** show publication dates 
 +- **reverse:** newest first 
 +- **1h/1d/1w:** update frequency
  
-Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:+----
  
-<code> +===== 10. Plugin Extensions =====
-I think we should do it+
  
-> No we shouldn't+==== Color Plugin ==== 
 +``` 
 +<color red>Red text</color> 
 +<color blue/yellow>Blue text on yellow background</color> 
 +<color #FF0000>Hex color</color> 
 +```
  
->> Well, I say we should+==== Icons Plugin ==== 
 +``` 
 +{{icon>home}}              // Generic icon 
 +{{fa>home}}                // Font Awesome 
 +{{fa>user|User Profile}}   // With tooltip 
 +{{glyphicon>star?24}}      // Glyphicon with size 
 +```
  
-> Really?+==== Forms Plugin ==== 
 +``` 
 +<form> 
 +Action mail admin@example.com 
 +Thanks "Thank you for your submission"
  
->> Yes!+Fieldset "Contact Information" 
 +Textbox "Name" "=Your Name" 
 +email "Email" @@ 
 +textarea "Message" !
  
->>> Then lets do it! +submit "Send Message" 
-</code>+</form> 
 +```
  
-I think we should do it+==== Tag Plugin ==== 
 +``` 
 +{{tag>documentation wiki syntax}} 
 +{{topic>wiki +syntax}} 
 +{{count>+}} 
 +```
  
-> No we shouldn't+==== ToDo Plugin ==== 
 +``` 
 +<todo>Task to complete</todo> 
 +<todo #>Completed task</todo> 
 +<todo @user>Task assigned to user</todo> 
 +<todo !>High priority task</todo> 
 +```
  
->> Well, I say we should+==== Struct Plugin ==== 
 +``` 
 +---- struct data ---- 
 +schema: person 
 +name: John Doe 
 +email: john@example.com 
 +department: IT 
 +---- 
 +```
  
-> Really?+==== DataTables Plugin ==== 
 +``` 
 +<datatables> 
 +^ Name ^ Position ^ Salary ^ 
 +| John | Developer | $75,000 | 
 +| Jane | Designer | $65,000 | 
 +| Bob | Manager | $85,000 | 
 +</datatables> 
 +```
  
->> Yes!+==== VShare Plugin ==== 
 +``` 
 +{{youtube>VIDEO_ID}} 
 +{{youtube>VIDEO_ID?large}} 
 +{{vimeo>VIDEO_ID}} 
 +{{dailymotion>VIDEO_ID}} 
 +```
  
->>> Then lets do it!+==== Wrap Plugin ==== 
 +``` 
 +<WRAP center round info 60%> 
 +**Information Box** 
 +Centered, rounded info box with 60% width 
 +</WRAP>
  
-===== Tables =====+<wrap em>Emphasized inline text</wrap> 
 +```
  
-DokuWiki supports a simple syntax to create tables.+----
  
-^ Heading 1      ^ Heading 2       ^ Heading 3          ^ +===== 11. Reveal.js Presentations =====
-| 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.+==== Basic Setup ==== 
 +``` 
 +~~REVEAL theme~~
  
-  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ +====== Main Slide ====== 
-  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | +Slide content here
-  | 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!+===== Horizontal Slide ===== 
 +Next slide content
  
-Vertical tableheaders are possible, too.+==== Vertical Slide ==== 
 +Nested slide content 
 +```
  
-|              ^ Heading 1            ^ Heading 2          ^ +==== Advanced Features ==== 
-^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | +``` 
-^ Heading 4    | no colspan this time |                    | +~~REVEAL theme=sky&transition=fade&controls=1~~
-^ 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:+{{background>lightblue}} 
 +===== Slide with Background =====
  
-  |              ^ Heading 1            ^ Heading 2          ^ +<fragment>First point appears</fragment> 
-  ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | +<fragment>Then second point</fragment> 
-  ^ Heading 4    | no colspan this time |                    | +<fragment>Finally third point</fragment>
-  ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |+
  
-You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect.+<notes> 
 +Speaker notes here 
 +- Point 1 
 +- Point 2 
 +</notes> 
 +```
  
-^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ +**Available Themes:** white, black, sky, beige, blood, league, moon, night, serif, simple, solarized, dokuwiki
-| 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        |+
  
-Apart from the rowspan syntax those cells should not contain anything else.+----
  
-  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ +===== 12. Mermaid Diagrams =====
-  | 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        |+
  
-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.+==== Flowcharts ==== 
 +``` 
 +<mermaid> 
 +graph TD 
 +    A[Start] --> B{Decision} 
 +    B -->|Yes| C[Action 1] 
 +    B -->|No| D[Action 2] 
 +    C --> E[End] 
 +    D --> E 
 +</mermaid> 
 +```
  
-^           Table with alignment           ^^^ +==== Sequence Diagrams ==== 
-|         right|    center    |left          | +``` 
-|left          |         right|    center    | +<mermaid> 
-| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |+sequenceDiagram 
 +    participant User 
 +    participant System 
 +    participant Database 
 +     
 +    User->>System: Request 
 +    System->>Database: Query 
 +    Database-->>System: Response 
 +    System-->>User: Result 
 +</mermaid> 
 +```
  
-This is how it looks in the source:+==== Gantt Charts ==== 
 +``` 
 +<mermaid> 
 +gantt 
 +    title Project Timeline 
 +    dateFormat YYYY-MM-DD 
 +    section Planning 
 +    Requirements :done, 2024-01-01, 2024-01-05 
 +    Design      :active, 2024-01-06, 3d 
 +    section Development 
 +    Coding      :2024-01-10, 7d 
 +    Testing     :2024-01-15, 5d 
 +</mermaid> 
 +```
  
-  ^           Table with alignment           ^^^ +**Supported Types:** flowchart, sequence, gantt, class, git, pie, journey, er, timeline, quadrant
-  |         right|    center    |left          | +
-  |left          |         right|    center    | +
-  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |+
  
-Note: Vertical alignment is not supported.+----
  
-===== No Formatting =====+===== 13. System Configuration =====
  
-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>''.+==== Current Installation ==== 
 +- **DokuWiki:** 2024-02-06b "Kaos" 
 +- **Template:** Bootstrap3 v2024-02-06 (hotfix/20241008) 
 +- **PHP:** 7.4-8.1 compatible 
 +- **Plugins:** 25+ active extensions
  
-<nowiki> +==== Cache Management ==== 
-This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. +``` 
-</nowiki> +~~NOCACHE~~              // Force refresh for this page 
-The same is true for %%//__this__ text// with a smiley ;-)%%.+```
  
-  <nowiki> +==== Performance Tips ==== 
-  This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. +- Optimize images before upload 
-  </nowiki> +- Use namespaces for organization 
-  The same is true for %%//__this__ text// with a smiley ;-)%%.+- Avoid excessive plugin usage 
 +- Regular maintenance and updates
  
-===== Code Blocks =====+----
  
-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>%%''.+===== 14. Troubleshooting =====
  
-  This is text is indented by two spaces.+==== Common Issues ==== 
 +| **Problem** | **Solution** | 
 +| Page not updating | Use `~~NOCACHE~~` or Ctrl+F5 | 
 +| Images not displaying | Check file path and permissions | 
 +| Syntax not working | Verify plugin activation | 
 +| PHP errors | Check PHP version compatibility | 
 +| Plugin conflicts | Disable plugins individually |
  
-<code> +==== Browser Compatibility ==== 
-This is preformatted code all spaces are preserved: like              <-this +- **Modern browsers:** Full support 
-</code>+- **Mobile devices:** Responsive design 
 +- **Accessibility:** Screen reader compatible 
 +- **Performance:** Optimized for speed
  
-<file> +==== Debug Strategies ==== 
-This is pretty much the same, but you could use it to show that you quoted a file. +1. Check browser console for errors 
-</file>+2. Verify plugin compatibility 
 +3. Test with minimal content 
 +4. Use DokuWiki debug mode 
 +5. Check server logs
  
-Those blocks were created by this source:+----
  
-    This is text is indented by two spaces.+===== 15. Best Practices =====
  
-  <code> +==== Content Organization ==== 
-  This is preformatted code all spaces are preserved: like              <-this +- Use logical heading hierarchy 
-  </code>+- Implement consistent naming conventions 
 +- Organize media in folders 
 +- Regular content reviews
  
-  <file> +==== Accessibility ==== 
-  This is pretty much the same, but you could use it to show that you quoted a file. +- Provide alt-text for images 
-  </file>+- Use descriptive link text 
 +- Maintain proper heading structure 
 +- Test with screen readers
  
-==== Syntax Highlighting ====+==== Security ==== 
 +- Keep DokuWiki updated 
 +- Use strong authentication 
 +- Review ACL settings regularly 
 +- Monitor for suspicious activity
  
-[[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>''.+==== Performance ==== 
 +- Optimize images and media 
 +- Use caching effectively 
 +- Minimize plugin usage 
 +- Regular maintenance
  
-<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//+===== 16. Advanced Features =====
  
-==== Downloadable Code Blocks ====+==== Namespaces ==== 
 +``` 
 +[[namespace:page]] 
 +[[sub:namespace:page]] 
 +```
  
-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:+==== Anchors ==== 
 +``` 
 +[[page#section|Link to section]] 
 +```
  
-<code> +==== Interwiki Links ==== 
-<file php myexample.php> +``` 
-<?php echo "hello world!"; ?> +[[doku>wiki]] 
-</file> +[[wp>Wikipedia]] 
-</code>+[[google>search term]] 
 +```
  
-<file php myexample.php> +==== Include Pages ==== 
-<?php echo "hello world!"; ?> +``` 
-</file>+{{page>namespace:page}} 
 +{{section>page#section}} 
 +```
  
-If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''.+----
  
 +===== 17. Quick Reference =====
  
-===== Embedding HTML and PHP =====+==== Essential Shortcuts ==== 
 +| **Element** | **Syntax** | **Result** | 
 +| Bold | `**text**` | **text** | 
 +| Italic | `//text//` | //text// | 
 +| Link | `[[page|text]]` | [[page|text]] | 
 +| Image | `{{image.png}}` | Image display | 
 +| Code | `''code''` | ''code'' | 
 +| Header | `===== H2 =====` | Section header | 
 +| List | `  * item` | • item | 
 +| Table | `^ head ^ head ^` | Table header |
  
-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.)+==== Plugin Shortcuts ==== 
 +| **Plugin** | **Syntax** | **Function** | 
 +| Color | `<color red>text</color>` | Colored text | 
 +| Icon | `{{fa>home}}` | Font Awesome icon | 
 +| Tag | `{{tag>tag1 tag2}}` | Page tags | 
 +| Todo | `<todo>task</todo>` | Task item | 
 +| Mermaid | `<mermaid>graph TD...</mermaid>` | Diagram |
  
-HTML example: +----
- +
-<code> +
-<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> +
-</code> +
- +
-<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 example: +
- +
-<code> +
-<php> +
-echo 'The PHP version: '; +
-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> +
- +
-<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 | +
-| nosort     | do not sort the items in the feed | +
-| //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. +
- +
-By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''. +
- +
-**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 | +
- +
-===== 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:+
  
-~~INFO:syntaxplugins~~+**Complete DokuWiki syntax reference for wiki.satware.com**   
 +**Version:** 2024-02-06b "Kaos" | **Updated:** {{CURRENTDATE}}
  
 +{{tag>wiki syntax dokuwiki reference guide}}
  • wiki/syntax.1442815613.txt.gz
  • Zuletzt geändert: 21.09.2015 08:06
  • von Damian Solka