DokuWiki Syntax Reference - Optimized

DokuWiki Syntax Reference - Optimized

System: DokuWiki 2024-02-06b "Kaos" | Bootstrap3 | 25+ plugins | PHP 7.4-8.1


1. Text Formatting

1. Text Formatting

Basic Markup

Basic Markup

``` bold italic underline monospace subscript superscript strikethrough combined formatting ```

Line Breaks

Line Breaks

``` Line 1
Line 2 with forced break
End of paragraph

New paragraph starts here ```


2. Headers & Structure

2. Headers & Structure

Header Levels

Header Levels

```

H1 (Main Title)

H1 (Main Title)

H2 (Section)

H2 (Section)

H3 (Subsection)

H3 (Subsection)

H4 (Sub-subsection)

H4 (Sub-subsection)

H5 (Paragraph)
H5 (Paragraph)

```

Control Macros

Control Macros

``` —- horizontal line disable table of contents force page refresh ``` —-

3. Links

External Links

``` http://example.com http://example.com Link text email [at] domain [dot] com ```

Internal Links

``` pagename Display text page Section link This section ```

Special Links

``` wiki Interwiki \\server\share Windows share ``` —-

4. Media & Images

4. Media & Images

Basic Image Syntax

Basic Image Syntax

``` original size width: 200px width x height external image ```

Image Alignment

Image Alignment

``` centered left aligned right aligned Caption text with caption ```

Supported Formats

Supported Formats

- Images: gif, jpg, png, svg - Video: webm, ogv, mp4 - Audio: ogg, mp3, wav —-

5. Lists

5. Lists

Unordered Lists

Unordered Lists

``` * First item * Second item * Nested item * Another nested * Back to first level ```

Ordered Lists

Ordered Lists

``` - First numbered - Second numbered - Nested numbered - Another nested - Back to first level ```

Mixed Lists

Mixed Lists

``` * Unordered - Ordered nested - Another ordered * Back to unordered ``` —-

6. Tables

6. Tables

Basic Table

Basic Table

``` ^ Header 1 ^ Header 2 ^ Header 3 ^ | Cell 1 | Cell 2 | Cell 3 | | Row 2 | Data | More | ```

Advanced Features

Advanced Features

``` ^ Header 1 ^ Header 2 ^ Header 3 ^ | Cell 1 | Colspan || | Rowspan | Cell 2 | Cell 3 | | ::: | Cell 2 | Cell 3 | ```

Alignment

Alignment

``` ^ Centered Header ^ | right| center |left | ``` Rules: 2+ spaces: left→right, right→left, both→center —-

7. Code & Formatting

7. Code & Formatting

Inline Code

Inline Code

``` Use monospace for inline code ```

Code Blocks

Code Blocks

``` <code> Plain code block preserves spaces </code> <code java> Syntax highlighted Java public class Hello {

  public static void main(String[] args) {
      System.out.println("Hello World!");
  }

} </code> ```

File Blocks

File Blocks

```

script.php
<?php
echo "Downloadable file";
?>

```

No Formatting

No Formatting

``` **No formatting** //applied here// **No formatting** //applied here// ```

Supported Languages

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

Complete list: 200+ languages including assembly, fortran, cobol, ada, pascal, delphi, vb, powershell, batch, nginx, apache, docker, terraform, etc.


8. Special Elements

8. Special Elements

Quotes

Quotes

```

“First level quote Second level quote Third level quote”

```

Footnotes

Footnotes

``` Text with footnote ```

Emoticons & Symbols

Emoticons & Symbols

``` 8-) 8-O :-( :-) =) :-/ :-\ :-? :-D :-P :-O :-X :-| ;-) ^_^ :?: :!: LOL FIXME DELETEME → ← ↔ ⇒ ⇐ ⇔ » « – — 640x480 © ™ ® ```


9. RSS/Feeds

9. RSS/Feeds

```

```

Parameters: - Number: max items to display - author: show author names - date: show publication dates - reverse: newest first - 1h/1d/1w: update frequency


10. Plugin Extensions

10. Plugin Extensions

Color Plugin

Color Plugin

``` Red text Blue text on yellow background Hex color ```

Icons Plugin

Icons Plugin

``` Generic icon Font Awesome With tooltip Glyphicon with size ```

Forms Plugin

Forms Plugin

```

Contact Information

```

Tag Plugin

Tag Plugin

```

SeiteDatumBenutzerBeschreibungDiskussionTags
11.01.2014 06:23 DokuWiki Syntax Reference - Optimized System: DokuWiki 2024-02-06b "Kaos" | Bootstrap3 | 25+ plugins | PHP 7.4-8.1 ---------- 1. Text Formatting Basic Markup ``` bold italic underline monospace subscript superscript strikethrough combined formatting , , , , , , ,
TagMenge
1
1
2
1
1
1
1
1
1
1
1

```

ToDo Plugin

ToDo Plugin

``` Task to complete Completed task [user]Task assigned to user High priority task ```

Struct Plugin

Struct Plugin

``` —- struct data —- schema: person name: John Doe email: john@example.com department: IT


```

DataTables Plugin

DataTables Plugin

```

Name Position Salary
John Developer $75,000
Jane Designer $65,000
Bob Manager $85,000

```

VShare Plugin

VShare Plugin

```

```

Wrap Plugin

Wrap Plugin

```

Information Box Centered, rounded info box with 60% width

Emphasized inline text ```


11. Reveal.js Presentations

11. Reveal.js Presentations

Basic Setup

Basic Setup

```

Main Slide

Slide content here

Horizontal Slide

Next slide content

Vertical Slide

Nested slide content ```

Advanced Features

```

Slide with Background

First point appears Then second point Finally third point

```

Available Themes: white, black, sky, beige, blood, league, moon, night, serif, simple, solarized, dokuwiki


12. Mermaid Diagrams

Flowcharts

```

graph TD A[Start] --> B{Decision} B -->|Yes| C[Action 1] B -->|No| D[Action 2] C --> E[End] D --> E
```

Sequence Diagrams

```

sequenceDiagram participant User participant System participant Database User->>System: Request System->>Database: Query Database-->>System: Response System-->>User: Result
```

Gantt Charts

```

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

Supported Types: flowchart, sequence, gantt, class, git, pie, journey, er, timeline, quadrant


13. System Configuration

Current Installation

- DokuWiki: 2024-02-06b "Kaos" - Template: Bootstrap3 v2024-02-06 (hotfix/20241008) - PHP: 7.4-8.1 compatible - Plugins: 25+ active extensions

Cache Management

``` Force refresh for this page ```

Performance Tips

- Optimize images before upload - Use namespaces for organization - Avoid excessive plugin usage - Regular maintenance and updates —-

14. Troubleshooting

Common Issues

| Problem | Solution | | Page not updating | Use `` 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 |

Browser Compatibility

- Modern browsers: Full support - Mobile devices: Responsive design - Accessibility: Screen reader compatible - Performance: Optimized for speed

Debug Strategies

1. Check browser console for errors 2. Verify plugin compatibility 3. Test with minimal content 4. Use DokuWiki debug mode 5. Check server logs —-

15. Best Practices

Content Organization

- Use logical heading hierarchy - Implement consistent naming conventions - Organize media in folders - Regular content reviews

Accessibility

- Provide alt-text for images - Use descriptive link text - Maintain proper heading structure - Test with screen readers

Security

- Keep DokuWiki updated - Use strong authentication - Review ACL settings regularly - Monitor for suspicious activity

Performance

- Optimize images and media - Use caching effectively - Minimize plugin usage - Regular maintenance —-

16. Advanced Features

Namespaces

``` page page ```

Anchors

``` Link to section ```

Interwiki Links

``` wiki Wikipedia search term ```

Include Pages

``` namespace:page ``` —-

17. Quick Reference

Essential Shortcuts

| Element | Syntax | Result | | Bold | `text` | text | | Italic | `text` | text | | Link | `text` | text | | Image | `` | Image display | | Code | `code` | code | | Header | `===== H2 =====` | Section header | | List | ` * item` | • item | | Table | `^ head ^ head ^` | Table header |

Plugin Shortcuts

| Plugin | Syntax | Function | | Color | `text` | Colored text | | Icon | `` | Font Awesome icon | | Tag | `

` | Page tags | | Todo | ` task` | Task item | | Mermaid | `<mermaid>graph TD…</mermaid>` | Diagram | —- Complete DokuWiki syntax reference for wiki.satware.com Version: 2024-02-06b "Kaos" | Updated: currentdate