[ZDP] local Zope Documentation

[Kankiewicz]

George Runyan wrote:
> 
> i've started compiling all the how-tos.  and seperateing them into a
> heirarchy tree.  this works well for me.

This was just brought up (again?) recently.

> 
> Why?
> * because I dont like the search results usually spit up when i search for
> something
> * to get to (real) documentation I have to have net access
> * I like to browse how-to's heirarchically (something thats needed badly) -
> you would be amazed how fast you can find 'the right stuff' when its
> organised :P

I Totally agree :)

> 
> ZDoc Effort && ZDP addressing local documentation?  it would be nice if
> there was a centralised up-to-date version of ZDOC.zexp that could be
> downloaded, and imported.  it would provide:
> * preferably 'up-to-date' how-to's, documentaiton, ZBook, etc...
> * all articles on ZOPE (they are growing!)
> * interface into the documentation
> * maybe even a tutorial
> * links to external references (mysql reference, openlink reference, cgi's
> references)
> * all inside a 'easy-to-use' tree structure

I could see one package download all the tutorials and a few other
things but not all the above, IMO.
If its organized then will know what's absolutely needed and what's not.

If we create a *complete* hierarchy on ZDP then we just link to that for
more info, which also reduces the needs to update it continuously.

> 
> issues:
> * keeping things up to date (updates have to be centralized)
Probably on ZDP and have links to zope.org

> * what happens when someone needs to be in two directories at once (I'm
> thinking zope equiv to symlinks)

This can also be done with the repository (really everywhere) directory
and have the zcatalog index 'subject'/'topic' properties of the
docs/link/etc..
The hierarchy can use the current Subject/Topic, grabbed from the
current folder and parent folder (Zclasses meta_type Subject/Topic).

> [ when 'Tutorial on Grokking DTML' could be in both DTML folder and
> Tutorials folder]
> * it being 'bloated' or too big

The number of hierarchy folders can expand... with the above limit on
stuff in the downloadable version.

> * points out the need for a zope dist-utils?

> 
> does anyone think this is a good idea?

Yes, if you willing to help, please stay around and it'll get done
faster. :)

regards,
David
> 
> george runyan           grunyan@emerging.com
> 
> _______________________________________________
> ZDP maillist  -  ZDP@zope.org
> http://lists.zope.org/mailman/listinfo/zdp