Todolist for Developers Manual

After the wiki reorganisation in 8/2008, all developer information were collected in the devel namespace. These pages have to be reorganized a bit to make new developers feel home quickly. On this page we can track the process, discuss on single issues etc.

Not much work has been done for some time. Added “Getting Started” and are now playing with a new index. — HåkanSHåkanS

Stockholm, Sweden 2011/01/23 15:08

Needed improvements for new programmers during Google Summer of Code.

• Create devel:core_overview — serving pages
• Check & update Git
• Check & update Coding Style
• Check & update Security
• Check & update Unit Testing
• Check & update Patches
• Check & update Directory Layout

(remove dirlayout from getting started)

1. Core Overview [Serving pages]
   1. Directory Layout
   2. Environment – global variables and defines
   3. Callgraph
2. Modifying your installation
   1. CSS
   2. JavaScript
   3. Localization
3. Plugins, how they work and how to write them
   1. Plugin File Structure
   2. Common Plugin Functions
   3. Action Plugins
      • Event System
      • Event Handlers
      • Events Overview
   4. Syntax Plugins
   5. Helper Plugins
   6. Renderer Plugins
   7. Admin Plugins
   8. Plugin Unittests
   9. The Toolbar
   10. Plugin Cookbook
   11. Plugin Programming Tips
4. Templates, how they work and how to write them
   1. first topic
   2. second topic
5. acl backends, how they work and how to write them
   1. first topic
   2. second topic
6. Advanced Stuff [Better name needed]
   1. Action Modes
   2. Caching
   3. Parser
   4. history/diff
   5. Configuration
   6. Preload
   7. File creation modes
   8. media
   9. Locking
   10. Metadata
   11. fulltextindex, how does search work
   12. XMLRPC, split in examples and reference
   13. Scalability
7. 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

See also: other recommended reading

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

• Outline
  • start with general introduction to dw for developers, requirements (php level, unix level)
  • continue with common and easy things for starters: adapting templates, writing an easy plugin
  • then advanced stuff (Events etc)
  • seperate introductory from advanced from reference material
• Navigation
  • have the TOC on every page
  • Links to “Top”, “Next”, “Previous” pages. see below for an example
  • constistent headings
• Examples
  • good and short examples
• Cleanup and merge small pages
• Cleanup old discussions/comments (make them first order info if valuable otherwise remove them)

• Manual fix for Bug 1700
• Ideas/Features of a new Blog Plugin
• $INFO array
• Rewrite Blocks

Here's a list with all pages (generated by hand, new pages have to be added), percentage and comments are to come.

There are a number of pages that are concerned with development in general, but dont fit into the category “technical manual for dw”. These are: darcs, xmlrpc, communications, coding style. These sound to me like a section “development environment” (or similar, I dont have a good name) — Sebastian 2008/10/04 09:08

For the navigation the include plugin would be handy. it seems not to be installed. why? its a very handy plugin … — Sebastian 2008/10/05 18:47

Navigation:

Example outline here: development2