[Homecomponents-devel] Design Specification

[Mathew S. <mt...@dr...>]

Here's the specification for the design so far.  Section 1 covers all 
the coding practices I've been doing so far.  Section 2 covers what the 
main system provides for the modules right now.
None of this is ever to be set in stone, but as more modules develop, 
changes to the specifications will require more work.  So, if you have 
any recommendations, it's better to discus them now.

I've been working on the blog module so far.  Is there a particular 
module you'd like to work on?

Oh, there's one thing that's not in this document that just occured to 
me.  I'll add it later which is:
HC_DB_INCLUDE references a class called Db.  This is a wrapper class 
for the database, not Pear's Db class. I felt that Pear's Db class was 
too confining, so I built my own simple wrapper.
One of the next things I want to do is rename my "Db" class to "HC_Db" 
so that it could eventually enclose Pear's Db class if desired.  I'll 
update the document and send a notice out once that's done.

Also, I'm storing design docs in the HomeComponents-Design module in 
the CVS tree.  I'll send this one via email, but in the future I'll 
probably just send an email out and you can sync your copy.  I'd 
encourage you to make changes to these documents as you see fit as 
well.  I'm using lyx as a designer.  If you're more comfortable with 
another format, we could keep two seperate files, but we'll need to 
make sure we notify each other when we make changes so we can update 
the other file.
Lyx is available on most popular platforms, and I highly recommend it 
as an alternative to writing documents in straight LaTeX.  It can 
export to LaTeX, PDF, or DVI which are all highly portable document 
formats.

Anyway, here's the PDF.
-Mat