POV-Ray : Newsgroups : povray.documentation.inbuilt : Request for offline HTML documentation Server Time: 23 Oct 2019 02:03:10 GMT
  Request for offline HTML documentation (Message 1 to 5 of 5)  
From: Wolf
Subject: Request for offline HTML documentation
Date: 4 Jan 2007 20:10:00
Message: <web.459d5e4c3fda500eedd244720@news.povray.org>
Dear Povray Team,

My eclipse plugin for editing Povray scene files (PovClipse,
http://povclipse.sourceforge.net) is making good process.
However, I very important part missing is the syntax documentation
support.

This means:
* if the mouse pointer is held over a 'box' keyword a hover should pop
up displaying the help section for the box statement.
* If the 'box' keyword is selected, pressing 'F1' should open the
online help displaying the box syntax reference.

In order to achieve this I would need the Povray documentation in a
standalone HTML format, which would be distributed with my PovClipse
plugin.
Each documentation chapter has to be a single HTML page and all Povray
keywords should be linkable within the pages using HTML anchors.

Is there any chance you can support my PovClipse project by providing
such HTML documentation?

I can not link to the official Povray online help because:
* the URL can not be derived using the keyword (e.g.
http://www.povray.org/documentation/view/3.6.1/276/ for the 'box'
documentation)
* the pages do not have anchors
* the help should work in an offline environment as well

Many thanks!

Best regards,
Wolf


Post a reply to this message

From: Thorsten Froehlich
Subject: Re: Request for offline HTML documentation
Date: 4 Jan 2007 20:40:11
Message: <459d662b$1@news.povray.org>
Wolf wrote:
> Is there any chance you can support my PovClipse project by providing
> such HTML documentation?

Windows help files can usually be accessed by other applications. Windows
API documentation will tell you how.

> I can not link to the official Povray online help because:
> * the URL can not be derived using the keyword (e.g.
> http://www.povray.org/documentation/view/3.6.1/276/ for the 'box'
> documentation)

Of course not! The documentation is structured by chapters, not keywords.

> * the pages do not have anchors

The pages do have anchors, they are just not (always) used in the online
version. The anchors exist for every chapter by numbering and follow a
precise pattern because they are actually automatically generated.

> * the help should work in an offline environment as well

Both the Mac and Linux version supply raw HTML versions not within a Windows
help file. However, you should really be using the Windows help file - it is
HTML internally, just packed in the Microsoft standard common format with
index!!!

	Thorsten


Post a reply to this message

From: Christoph Hormann
Subject: Re: Request for offline HTML documentation
Date: 5 Jan 2007 08:20:03
Message: <enl1l7$bkv$1@chho.imagico.de>
Wolf wrote:
> 
> In order to achieve this I would need the Povray documentation in a
> standalone HTML format, which would be distributed with my PovClipse
> plugin.
> Each documentation chapter has to be a single HTML page and all Povray
> keywords should be linkable within the pages using HTML anchors.
> 
> Is there any chance you can support my PovClipse project by providing
> such HTML documentation?

Have a look at the HTML version coming with the Unix version of POV-Ray. 
  It is split into various HTML files that contain anchors for each 
section.  Also there is an index (idx.html) that connects keywords with 
filename+anchor.

You might also have a look at the POV-Ray documentation search tool on 
http://www.imagico.de/kminpovgui/index.html that implements a full text 
search on the documentation.

Christoph

-- 
POV-Ray tutorials, include files, Landscape of the week:
http://www.imagico.de/ (Last updated 15 Oct. 2006)
MegaPOV with mechanics simulation: http://megapov.inetart.net/


Post a reply to this message

From: Wolf
Subject: Re: Request for offline HTML documentation
Date: 5 Jan 2007 11:50:01
Message: <web.459e3b5c20e397e4aea43a440@news.povray.org>
Christoph Hormann <chr### [at] gmxde> wrote:
> Have a look at the HTML version coming with the Unix version of POV-Ray.
>   It is split into various HTML files that contain anchors for each
> section.  Also there is an index (idx.html) that connects keywords with
> filename+anchor.

Thanks for the hint, I'm going for the Unix documentation.
The idx file is exactly what I need to connect the keywords to the pages.

Wolf


Post a reply to this message

From: Chris Cason
Subject: Re: Request for offline HTML documentation
Date: 6 Jan 2007 07:58:51
Message: <459f56bb@news.povray.org>
Wolf wrote:
> Christoph Hormann <chr### [at] gmxde> wrote:
>> Have a look at the HTML version coming with the Unix version of POV-Ray.
>>   It is split into various HTML files that contain anchors for each
>> section.  Also there is an index (idx.html) that connects keywords with
>> filename+anchor.
> 
> Thanks for the hint, I'm going for the Unix documentation.
> The idx file is exactly what I need to connect the keywords to the pages.

If you need anything more please feel free to email me directly; I have a set
of perl scripts that post-process the intermediate output of our docgen tools
that can provide additional information.

-- Chris


Post a reply to this message

Copyright 2003-2008 Persistence of Vision Raytracer Pty. Ltd.