RE: [Zope] Creating help files for Python Products
This got me thinking and I apologize if has been gone over before. Outside of products and special things, how can I create my own 'help' files based upon just a folder? I have 'applications' I have built that are just folders with documents and methods and ZSQL stuff. I would like to add a help file that relates to the process of what goes on in that folder. Like how data is gathered and from where. Order of events for doing things, etc. Stuff like that. Can I just create my own 'folder-help' file and have it added in somehow? Thanks Allen -----Original Message----- From: Jens Vagelpohl [mailto:jens@zope.com] Sent: Thursday, September 13, 2001 7:57 AM To: Gitte Wange Cc: zope@zope.org Subject: Re: [Zope] Creating help files for Python Products gitte, here is an example for creating a help screen:: - in __init__.py in the initialize method call "context.registerHelp()" - write a help file (can be either structured text or HTML) for your management screen tab and put it in a directory named "help" inside your product - "connect" it to the specific management screen tab by adding it to the manage_options dictionary for the given tab, like... manage_options = ( {'label' : 'Configure', 'action' : 'manage_main', 'help' : ('MyProductName','HelpFileName.stx')}, ... ) the first element in the tuple value for the "help" key is the name of your product and tells the help system under which "chapter" (the topmost list of items in the left-hand frame of a help screen) to put the screen designated by the filename in the second tuple element. jens On Thursday, September 13, 2001, at 07:27 , Gitte Wange wrote:
Hello,
I am working on a product for Zope and I was wondering: How do I create help files that will turn up in the online help ??
TIA, Gitte Wange
_______________________________________________ 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 )
participants (1)
-
Schmidt, Allen J.