[Zope] Creating help files for Python Products

[Jens Vagelpohl]

gitte,

the only "online help" that i know is the help system in the zope 
management interface. it does indeed open in a new window. what i 
described is for that very online help.

jens



On Thursday, September 13, 2001, at 08:20 , Gitte Wange wrote:

> On Thursday 13 September 2001 13:57, you wrote:
>> 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
>
> It's for a CMF product so I would rather put my help in the online help 
> (the
> one that open in a new window) than a help tab ...
>
> Any solutions for this ?
>
> Gitte
>
>> 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 )