[Zope] Where are user created help files stored?

[Schmidt, Allen J.]

On a side note I have wondered about in the past...

Do help files HAVE to be attached to products? Since the help link is always
available, I would like to create a help file for a FOLDER that houses all
my content (DTML methods, ZSQL methods, etc.) For example, I created and
maintain a Business directory of local businesses and it lives in a
BusinessDirectory folder off the root. I want to create help files so that
if I get 'Bussed' (run over by a bus) then those that follow me can know
exactly how things are done within the 'app' - i.e. how data gets
transferred in, how images are loaded, how to maintain the admin tool, etc.
Would be great if the help for just this tool was context-linked to the help
link in that folder.

Not sure if I explained it right and maybe a simple solution.

Thanks

Allen

-----Original Message-----
From: Michel Pelletier [mailto:michel@digicool.com]
Sent: Thursday, May 10, 2001 3:16 PM
To: Jason Cunliffe
Cc: zope@zope.org
Subject: Re: [Zope] Where are user created help files stored?


On Thu, 10 May 2001, Jason Cunliffe wrote:

> Zope2.3.2
> Win98se/Redhat6.2
> 
> I am upgrading the READMEs for a simple Zope Product.
> I clicked through the ZMI /Control_Panel/Products/ to add some help files.
> Very nice :-) An example where TTW simple editing really makes sense.
> 
> I added two help pages for: 'install' and 'use' easily called like this:
> http://jasonic/Control_Panel/Products/BSDObject/Help/use
> 
> Then I uploaded my Product folder to remote Linux setup.
> Works fine but my help files are not there :/

Creating help topics through the web is really only meant for associating
them with ZClasses (you know, the little 'help' pull down box next to
ZClass views)

> The principle seems obvious to me -help files belong in each Products own
> folder.

Yep.

> Where are the help files kept?

In a directory in your product named 'help'.  .html, .txt, and .stx files
can be created there, as well as any images you want.  Help topics are
associated with object views in your objects 'manage_options'.  See just
about any core Zope product for an example.

> Various searches show lots of other help folders but not for my product.
> Am I doing something wrong or is the workflow for this not yet well
> developed?

http://www.zope.org/DocProjects/zope_product

-Michel


_______________________________________________
Zope maillist  -  Zope@zope.org
http://lists.zope.org/mailman/listinfo/zope
**   No cross posts or HTML encoding!  **
(Related lists - 
 http://lists.zope.org/mailman/listinfo/zope-announce
 http://lists.zope.org/mailman/listinfo/zope-dev )