Translations of this page?:

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.

General Issues

  • 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)

List of pages

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

Link / Section Percentage comments
Overview
Coding Style % reference, move somewhere else
Darcs % is a tool that dw depends upon, not needed to write e.g. a plugin
Communication % offtopic, doesnt document dw itself
Directory Layout % very good for starters
Locking % advanced
Environment % reference, but important for starters
Action Modes %
Parser %
Metadata %
Security %
Unit Testing %
Patches %
Plugins %
Plugin File Structure %
Common Plugin Functions %
Action Plugins %
Event System %
Event Handlers %
Events Overview %
Syntax Plugins %
Helper Plugins %
Renderer Plugins %
Admin Plugins %
General
The Toolbar %
Plugin Cookbook % merge with tips or move info to the “right place”
Plugin Programming Tips % merge with cookbook or move info to the “right place”
Templates % interesting for starters, similar to CSS and javascript
Configuration %
Localization %
CSS % interesting for starters, similar to Templates and javascript
Javascript % interesting for starters, similar to CSS and Templates
XMLRPC % does not deal with dw development itself, but with “talking to dw”. Move
Scalability % advanced stuff

Discussion

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

Examples

 
devel/manual.txt · Last modified: 2008/10/05 18:53 by bastl_do
 

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported

Imprint Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki
WikiForumIRCBugsDarcsXRefTranslate