RE: [Homecomponents-devel] Design Specification

[b r y a n c h e n <me...@br...>]

I do all my work on my Windows XP Professional Edition, using Microsoft =
Word
for both documents and diagrams. For PHP coding, I use Macromedia
Dreamweaver MX 2004.

I'm not very familiar with Smarty, so I'll spend a few days reading its =
API.


-----Original Message-----
From: hom...@li...
[mailto:hom...@li...] On Behalf Of =
Mat
Schaffer
Sent: Thursday, May 06, 2004 3:03 AM
To: hom...@li...
Subject: Re: [Homecomponents-devel] Design Specification

By all means :)
I'm not familiar with the term exactally.  But I'm guessing it would be=20
something that people could post little notes into but not as formal as=20
a guestbook.  I think this would be a great addition, and it seems like=20
a good "starter project" so we can get used to working together (with=20
regards to the HC_Common.php provisions, anyway).

My recommendations would be:
- use a ShoutBox class to encapsulat the whole thing so a user can just=20
say:
   $shoutbox =3D& new ShoutBox("box1");
   $shoutbox->getLatest();

something like that.  getLatest would return the HTML to be printed as=20
a shoutbox.  This HTML should be generated by use of a template (in the=20
HomeComponents/templates/shoutbox) directory, or something of the sort.=20
  Use getSmarty() to retrieve a Smarty instance.

the "box1" will specify which shoutbox to retrieve, or create it if=20
it's not found.
make sure to use HC_PREFIX on any tables you create.
Also, copy down all your SQL stuff into a .sql file.  Later, I'd like=20
to create and installation script that puts the module in place, and=20
loads the database from provided .sql files.

There's definitely some other stuff that I need to add to the spec that=20
I'm noticing.  Things like:
- all HTML should be taken from templates, even the simplest pieces. =20
This will allow the user to make changes to the internal formatting of=20
the components if they want, without having to modify the code.
- all components should return strings to the user.  The use of "echo"=20
should be only done to print error messages.  This will allow the user=20
to easily place components into their existing page layout.
- make any attempts possible to avoid unnecesary memory usage ($obj =3D& =

new Obj(), instead of $obj =3D new Obj()).

I'll poke at in the coming week, and get those in there.

Tonight, I'll load the current HomeComponents stuff into the=20
sourceforge CVS tree.  So you can grab that and start working on the=20
Shoutbox as soon as you're ready.  Let me know if you have any=20
questions.

Good working with you,
Mat

PS., what OS are you working on?  What tools do you use?  We might be=20
able to make recommendations to each other.
I'm on Mac OS X myself, I use Eclipse2 w/ php-eclipse for coding PHP. =20
Lyx for documentation.  Dia for diagraming.

On May 5, 2004, at 12:17 PM, b r y a n c h e n wrote:

> I'd really like to work on a Shoutbox/Tagboard-type of module. Any
> suggestions?
>
>
> -----Original Message-----
> From: hom...@li...
> [mailto:hom...@li...] On Behalf Of
> Mathew Schaffer
> Sent: Wednesday, May 05, 2004 10:25 PM
> To: hom...@li...
> Subject: [Homecomponents-devel] Design Specification
>
> 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
>
>
>
>
>
> -------------------------------------------------------
> This SF.Net email is sponsored by Sleepycat Software
> Learn developer strategies Cisco, Motorola, Ericsson & Lucent use to
> deliver higher performing products faster, at low TCO.
> http://www.sleepycat.com/telcomwpreg.php?From=3Dosdnemail3
> _______________________________________________
> Homecomponents-devel mailing list
> Hom...@li...
> https://lists.sourceforge.net/lists/listinfo/homecomponents-devel
>



-------------------------------------------------------
This SF.Net email is sponsored by Sleepycat Software
Learn developer strategies Cisco, Motorola, Ericsson & Lucent use to=20
deliver higher performing products faster, at low TCO.
http://www.sleepycat.com/telcomwpreg.php?From=3Dosdnemail3
_______________________________________________
Homecomponents-devel mailing list
Hom...@li...
https://lists.sourceforge.net/lists/listinfo/homecomponents-devel