POV-Ray : Newsgroups : povray.unofficial.patches : Proposal: common patch documentation form : Re: Proposal: common patch documentation form Server Time
8 Jul 2024 15:34:41 EDT (-0400)
  Re: Proposal: common patch documentation form  
From: ingo
Date: 15 Apr 2002 15:47:25
Message: <Xns91F1DE17AB9BDseed7@povray.org>
in news:3CBAF2B1.F2AD79E2@gmx.de Christoph Hormann wrote:

> - whether patch authors think this is feasible and useful

As a user of patches, to me it would be usefull to have a consistent 
layout of documentation for the various patches.

> - if other methods would be better

The ideal would be if every patcher used docbook and has the tools 
needed for processing it. But simple HTML will do fine, maybe with an 
extra tag or two for indexing keywords.

> - if such a system is created how it should be established (maybe
> something like official patch documentation guidelines?)
> 

HTML template (the povdoc could be the role model here), a guideline and 
some scripts or tools to process the files.

Speaking of tools, here is an interesting one. It takes a set of HTML 
files as input and returns one HTML file as output with an index based 
on the H-tags (tried it with the povdoc and works fine). You can also 
generate PDF and PS with it. Available for several platforms.

http://www.easysw.com/htmldoc/


Ingo


Post a reply to this message

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