Kieren Diment wrote:
I think the structure for the module documentation as enumerated below is fine. For the "how to glue things together" bit - the Maypole::Manual namespace, the way that it is structured makes at present difficult to manage and update, although the guidelines below are also fine.

I did also produce a possible revised table of contents a while ago. It's just a slight variation on the current contents. FWIW, here it is. I'd also now add a section on form handling, or possibly a chapter :)

Cheers, Dave


About this Manual (Manual.pod)

Introduction to Maypole (About.pod + )

The Controller and Request Handling
  - define the terms handler, application, driver, request (any more :)
  - workflow
  - The Request Object - data structure and where it comes from

Request Cookbook - don't know quite what to do yet
Authorization - need a section and a cookbook?

The Model
  - procesing
  - data structure

The View
  - overall
  - actions - standard and how to make your own

Templates
  - what's passed in the template variables
  - 'standard' example templates
  - refer to cookbook

Configuration & Initialization

Inheritance & Methods

Debugging & Tuning
  - CLI
  - debugger - Apache logs, m command for methods

Example - Beer
Example - Flox
Example - iBuy



--
No virus found in this outgoing message.
Checked by AVG Anti-Virus.
Version: 7.0.344 / Virus Database: 267.11.14/131 - Release Date: 12/10/05



-------------------------------------------------------
This SF.Net email is sponsored by:
Power Architecture Resource Center: Free content, downloads, discussions,
and more. http://solutions.newsforge.com/ibmarch.tmpl
_______________________________________________
Maypole-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/maypole-devel

Reply via email to