[Zope3-dev] Questions about onlinehelp

Wed May 11 03:34:15 EDT 2005

Hi Peter

> -----Original Message-----
> From: pkoppatz at web.de [mailto:pkoppatz at web.de] 
> Sent: Wednesday, May 11, 2005 9:12 AM
> To: dev at projekt01.ch
> Subject: Re: [Zope3-dev] Questions about onlinehelp
> 
> Hi Roger
> >
> 
> >>
> >> <include package=".help" />
> >>
> >> I got the message:
> >>
> >> NameError: name 'helpsystem' is not defined
> >>
> >> What is the missing piece?
> >
> 
> I have found the error,,
> The biggest error is sitting in front of the keyboard ;-))
> 
> I don't know how, the word "helpsystem" was inserted by me in  
> __init__.py. I haven't realiased the meaning of the messages in the  
> traceback.
> 
> Sorry

No, problem

> >
> >> 2. The content of the online-help says:
> >>
> >> The Online Help supports
> >>
> >>      * plain text documents
> >>      * structured text documents
> >>      * restructured text documents
> >>      * HTML documents
> >>      * Page template based content
> >>
> >> but HTML and ZPT's are rendered as resturctured text, so there is a
> >> difference between reality and online help.
> >> Will that be changing in the future?
> >
> > I don't understand this? What's not working? Do you really use
> > a ZPT and also use the right class for the help:regsiter directive?
> >
> 
> If the help:register directive looks like that:
> 
>     <help:register
>        id="dictum"
>        title="my first application"
>        doc_path="package_intro.pt"
>        class="zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic"
>        />

Use the right class for register ZPT's as help topics.
This should look like this:

<help:register
    id="dictum"
    title="my first application"
    doc_path="package_intro.pt"
    class="zope.app.onlinehelp.onlinehelptopic.ZPTOnlineHelpTopic"
    />

Use:
zope.app.onlinehelp.onlinehelptopic.ZPTOnlineHelpTopic
instead of:
zope.app.onlinehelp.onlinehelptopic.RESTOnlineHelpTopic

otherwise you get "REST" restructured text regsistred like
you propose.

> And the content of packag_intro.pt is:
> 
> <html><head><title  
> tal:content="context/title">Title</title></head><body>This is a ZPT  
> help!</body></html>
> 
> the source of the rendered page is :
> 
>    <p><div class="document">
> &lt;html&gt;&lt;head&gt;&lt;title  
> tal:content=&quot;context/title&quot;&gt;Title&lt;/title&gt;&lt;/ 
> head&gt;&lt;body&gt;This is a ZPT 
> help!&lt;/body&gt;&lt;/html&gt;</div>
> 
> </p>
> 
> 
> > See src\zope\app\onlinehelp\tests\help.zcml this is what we test.
> >
> >> 3. Ok, I am using resturctured text, but I can't use all german
> >> characters. How can I configure other encodings for the 
> online help?
> >
> > What do you need?
> >
> 
> Showing german umlauts in helpscreens. This problem could be solved  
> with the correct rendering of zpt-pages.
> 
> Thanks for your help.
> 
> Regards
> Peter

Regards
Roger Ineichen

Projekt01 GmbH
www.projekt01.ch
_____________________________
END OF MESSAGE  