====== 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''//__** ``` ==== Line Breaks ==== ``` Line 1\\ Line 2 with forced break\\ End of paragraph New paragraph starts here ``` ---- ===== 2. Headers & Structure ===== ==== Header Levels ==== ``` ====== H1 (Main Title) ====== ===== H2 (Section) ===== ==== H3 (Subsection) ==== === H4 (Sub-subsection) === == H5 (Paragraph) == ``` ==== Control Macros ==== ``` ---- // horizontal line ~~NOTOC~~ // disable table of contents ~~NOCACHE~~ // force page refresh ``` ---- ===== 3. Links ===== ==== External Links ==== ``` http://example.com [[http://example.com]] [[http://example.com|Link text]] ``` ==== Internal Links ==== ``` [[pagename]] [[pagename|Display text]] [[namespace:page]] [[#anchor|Section link]] [[syntax#internal|This section]] ``` ==== Special Links ==== ``` [[doku>wiki]] // Interwiki [[\\server\share]] // Windows share ``` ---- ===== 4. Media & Images ===== ==== 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 ``` ==== Image Alignment ==== ``` {{ image.png }} // centered {{image.png }} // left aligned {{ image.png}} // right aligned {{image.png|Caption text}} // with caption ``` ==== Supported Formats ==== - **Images:** gif, jpg, png, svg - **Video:** webm, ogv, mp4 - **Audio:** ogg, mp3, wav ---- ===== 5. Lists ===== ==== Unordered Lists ==== ``` * First item * Second item * Nested item * Another nested * Back to first level ``` ==== Ordered Lists ==== ``` - First numbered - Second numbered - Nested numbered - Another nested - Back to first level ``` ==== Mixed Lists ==== ``` * Unordered - Ordered nested - Another ordered * Back to unordered ``` ---- ===== 6. Tables ===== ==== Basic Table ==== ``` ^ Header 1 ^ Header 2 ^ Header 3 ^ | Cell 1 | Cell 2 | Cell 3 | | Row 2 | Data | More | ``` ==== Advanced Features ==== ``` ^ Header 1 ^ Header 2 ^ Header 3 ^ | Cell 1 | Colspan || | Rowspan | Cell 2 | Cell 3 | | ::: | Cell 2 | Cell 3 | ``` ==== Alignment ==== ``` ^ Centered Header ^ | right| center |left | ``` **Rules:** 2+ spaces: left→right, right→left, both→center ---- ===== 7. Code & Formatting ===== ==== Inline Code ==== ``` Use ''monospace'' for inline code ``` ==== Code Blocks ==== ``` Plain code block preserves spaces // Syntax highlighted Java public class Hello { public static void main(String[] args) { System.out.println("Hello World!"); } } ``` ==== File Blocks ==== ``` ``` ==== No Formatting ==== ``` **No formatting** //applied here// %%**No formatting** //applied here//%% ``` ==== 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 ===== ==== Quotes ==== ``` > First level quote >> Second level quote >>> Third level quote ``` ==== Footnotes ==== ``` Text with footnote((This is the footnote content)) ``` ==== Emoticons & Symbols ==== ``` 8-) 8-O :-( :-) =) :-/ :-\ :-? :-D :-P :-O :-X :-| ;-) ^_^ :?: :!: LOL FIXME DELETEME -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) ``` ---- ===== 9. RSS/Feeds ===== ``` {{rss>http://example.com/feed.rss 5 author date 1h}} ``` **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 ===== ==== Color Plugin ==== ``` Red text Blue text on yellow background Hex color ``` ==== Icons Plugin ==== ``` {{icon>home}} // Generic icon {{fa>home}} // Font Awesome {{fa>user|User Profile}} // With tooltip {{glyphicon>star?24}} // Glyphicon with size ``` ==== Forms Plugin ==== ```
Action mail admin@example.com Thanks "Thank you for your submission" Fieldset "Contact Information" Textbox "Name" "=Your Name" email "Email" @@ textarea "Message" ! submit "Send Message"
``` ==== Tag Plugin ==== ``` {{tag>documentation wiki syntax}} {{topic>wiki +syntax}} {{count>+}} ``` ==== ToDo Plugin ==== ``` Task to complete Completed task Task assigned to user High priority task ``` ==== Struct Plugin ==== ``` ---- struct data ---- schema: person name: John Doe email: john@example.com department: IT ---- ``` ==== DataTables Plugin ==== ``` ^ Name ^ Position ^ Salary ^ | John | Developer | $75,000 | | Jane | Designer | $65,000 | | Bob | Manager | $85,000 | ``` ==== VShare Plugin ==== ``` {{youtube>VIDEO_ID}} {{youtube>VIDEO_ID?large}} {{vimeo>VIDEO_ID}} {{dailymotion>VIDEO_ID}} ``` ==== Wrap Plugin ==== ``` **Information Box** Centered, rounded info box with 60% width Emphasized inline text ``` ---- ===== 11. Reveal.js Presentations ===== ==== Basic Setup ==== ``` ~~REVEAL theme~~ ====== Main Slide ====== Slide content here ===== Horizontal Slide ===== Next slide content ==== Vertical Slide ==== Nested slide content ``` ==== Advanced Features ==== ``` ~~REVEAL theme=sky&transition=fade&controls=1~~ {{background>lightblue}} ===== Slide with Background ===== First point appears Then second point Finally third point Speaker notes here - Point 1 - Point 2 ``` **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 ==== ``` ~~NOCACHE~~ // 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 `~~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 | ==== 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 ==== ``` [[namespace:page]] [[sub:namespace:page]] ``` ==== Anchors ==== ``` [[page#section|Link to section]] ``` ==== Interwiki Links ==== ``` [[doku>wiki]] [[wp>Wikipedia]] [[google>search term]] ``` ==== Include Pages ==== ``` {{page>namespace:page}} {{section>page#section}} ``` ---- ===== 17. Quick Reference ===== ==== 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 | ==== Plugin Shortcuts ==== | **Plugin** | **Syntax** | **Function** | | Color | `text` | Colored text | | Icon | `{{fa>home}}` | Font Awesome icon | | Tag | `{{tag>tag1 tag2}}` | Page tags | | Todo | `task` | Task item | | Mermaid | `graph TD...` | Diagram | ---- **Complete DokuWiki syntax reference for wiki.satware.com** **Version:** 2024-02-06b "Kaos" | **Updated:** {{CURRENTDATE}} {{tag>wiki syntax dokuwiki reference guide}}