Development Manual

You are welcome to contribute to DokuWiki and join the development.

What you want to contribute is of course up to you—you should scratch your own itches first. If you need some ideas of what is missing you should have a look at the bugtracker or on the idea pages. You could also consider adopting a plugin or template. Begin by reading the Getting Started chapter.

1. Git – Obtaining the code and working with Git¹⁾
   1. Working with Github Pull Requests
2. Coding Style
3. Composer
4. Editor Setup
   1. VIM
   2. IntelliJ Idea (or PhpStorm)
5. Security
6. Testing
   1. Unit Testing
   2. BrowserStack browser testing
7. Patches
8. Debugging

1. Overview, walk through of how a page request is served
   1. Directory Layout
   2. Environment – global variables and defines
      • Accessing Request Variables
      • Session handling
      • Preload
   3. Autoloader
   4. Callgraph
   5. Logging
   6. Locking
   7. Action Modes
   8. Authentication
   9. Caching facilities
   10. Parser
   11. Metadata
   12. Fulltext Index
2. Plugins
   1. Plugin File Structure
   2. Common Plugin Functions
   3. Action Plugins
      • Event System
      • Events Overview
      • Event Handlers
      • Examples of event handlers code
   4. Syntax Plugins
   5. Helper Plugins
   6. Renderer Plugins
   7. Admin Plugins
   8. Remote Plugins
   9. Auth Plugins
   10. CLI Plugins
   11. Plugin and Template Unittests
   12. The Toolbar
   13. Plugin Programming Tips
3. Templates
   1. Starter template – Basic building block for new templates
   2. Menus
   3. style.ini – CSS: loading styles and setting variables
4. Configuration
5. Localization
6. CSS
   1. LESS preprocessor
7. JavaScript (jQuery, jQueryUI)
   1. jQuery FAQ for Plugin Developers
8. SVG
9. Internal Libraries
   1. UTF-8 String handling
   2. Request (GET/POST) variable handling
   3. E-Mail Sending
   4. HTTP Client Library
   5. RSS Parser
   6. Forms
10. Composer Libraries
    1. GeSHi Syntax Highlighting
    2. Zip and Tgz Compression/Decompression
11. Remote API
    1. XML-RPC
    2. JSON-RPC
12. Further Resources
    1. Development API Reference²⁾
    2. Daily Snapshots
    3. Developers' Release notes
    4. Git Webinterface for browsing the source and patches
    5. Hall of Fame – all DokuWiki contributors

1. How to become a Core Developer
2. Release process and information on building a release

• Planning an external Security Audit of DokuWiki
• Ideas with some concepting that could be picked up and implemented by (new) DokuWiki developers.
• Plans for more radical Template changes
• DokuWiki Refactoring
• Farm - ideas for tips:farm
• Some remarks on Memory footprint reduction
• Brainstorm about scalability, scalability_proposal
• Brainstorm Tagline for dokuwiki.org