byterock

I guess it is the POD-pen now.

The third POD post in as many days and really noting to do with Dist::Zilla so I guess I will have to find some other pictures to post.

After yesterday's post I took some time and had a look at a large number of different CPAN modules to get some ideas on the contents and style of my Accessor POD.

One thing that I have seem many modules do is break their documentation into separate PODs, under the names-pace and I will do that with Accessor as well.

I am going to keep some things in the Accessor.pm proper as it is good to have some basic info present, most of the other items I have been working on over the past few days I think I will break into separate POD.

So here is the first draft (outline) of my documentation in all its glory by Names-pace

Database::Accessor

• Abstract
• Synopsis
• Description
• Getting Started
• Resources

The above POD is just a starting point for the documentation. I want someone who comes to this page to be able to easily find out what Accessor is and isn't and where to go for further info. The real smart cookies should be able to use Accessor just by looking at the Synopsis so I am going to have to make it a good one. I left out of the above list the usual things you find on a POD splash page, copyright contributors etc.

Database::Accessor::Tutorial::GettnigStarted

A quick document on what you will need to get Accessor working with a few examples of its usage, i.e. you will need a DB and the following schema.

Database::Accessor::Tutorial::Basics

A document that will introduce the two most basic parts of Accessor 'View' and 'Elements' collection, the five control flags, and the four CRUD functions on a static DA.

Database::Accessor::Tutorial::Conditions

This document will expand on the basics by introducing the concept of a 'predicate' in the way of a simple 'Condtion' and also introduce the 'Param' element.

Database::Accessor::Tutorial::BasicDynamic

This document will add in the concept of dynamic attributes for the Elements and 'conditions'

Database::Accessor::Tutorial::Links

This POD will introduce the concept of a link.

Database::Accessor::Manual::MoreElements

This POD will look at the basic usage of Functions and Expressions in the elements Array

Database::Accessor::Tutorial::Sorts

This POD will look at the rather basic topic of the Sorts attribute

Database::Accessor::Tutorial::GatherFilter

This POD will introduce the more advanced topic of Gathers and Filters.

Database::Accessor::Tutorial::AdvancedElements

This POD will look at element Aggregates with Gather and Filters. mixing function, expression and other elements in advanced predicates

Database::Accessor::Tutorial::AdvancedCondtions

This POD will look at multi predicate condtions, functions and expression in conditions and an special conditions like 'IN'

Database::Accessor::Tutorial::AdvancedLinks

This POD will look at using multiple links on a view, functions and expression on a link and multiple predicates on a link

Database::Accessor::Manual::Basics

The four crud expressions explianed and the 5 control flags.

Database::Accessor::Manual::Attributes

A listing of all the attributres

Database::Accessor::Manual::Methods

A listing of all the methods

Database::Accessor::Manual::View

A detailed look at the view

Database::Accessor::Manual::Element

A detailed look at the Element Class and its various incarnations

Database::Accessor::Manual::Predicate

A detailed look at the Predicate Class

Database::Accessor::Manual::Condition

A detailed look at the Condition Class

Database::Accessor::Manual::Link

A detailed look at the Link Class

Database::Accessor::Manual::Sort

A detailed look at the Sort Class

Database::Accessor::CookBook

a place for all the cool stuff that doesn't have a place above

Database::Accessor::Driver::WritersGuide

A doc for people who are fool hardy enough to try and write a DAD

So there you have it. Even more boring posts coming up.