DokuWiki Development

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. You could also consider adopting a plugin or template. Begin with reading the Getting Started chapter.

Working together is more fun. The DokuWiki community needs a lot of different skills and is organized in teams. Please feel free to join one or just hang around the mailinglist and irc channel for development talk. There are also bughunting weekends where eh, bugs are fixed, and sometime developers meet IRL at DokuWiki hackfest.

1. Git – Obtaining the code and working with Git¹⁾
2. Coding Style
3. Security
4. Unit Testing
5. Patches
6. Directory Layout

1. Overview, walk through of how a page request is served
   1. Directory Layout
   2. Environment – global variables and defines
   3. Callgraph
   4. Locking
   5. Action Modes
   6. Parser
   7. Metadata
   8. fulltextindex
2. Plugins
   1. Plugin File Structure
   2. Common Plugin Functions
   3. Action Plugins
      • Event System
      • Event Handlers
      • Events Overview
      • Example 1
      • Example 2
   4. Syntax Plugins
   5. Helper Plugins
   6. Renderer Plugins
   7. Admin Plugins
   8. Remote Plugins
   9. Plugin Unittests
   10. The Toolbar
   11. Configuration
   12. Plugin Cookbook
   13. Plugin Programming Tips
3. Templates
   1. Configuration
4. Localization
5. CSS
6. JavaScript
7. Preload
8. Internal Libraries
   1. UTF-8 String handling
   2. E-Mail Sending
   3. Zip and Tgz compression/Decompression
   4. HTTP Client Library
   5. RSS Parser
   6. JSON Parser/Writer
   7. GeSHi Syntax Highlighting
9. XMLRPC
10. custom webservices
11. Scalability
12. Further Resources
    1. Development API Reference²⁾
    2. Stable API Reference³⁾
    3. Daily Snapshots
    4. Git Webinterface for browsing the source and patches
    5. Hall of Fame – all DokuWiki contributors

1. Release process and information on building a release