POV-Ray : Newsgroups : povray.unofficial.patches : format for documentation Server Time
2 Sep 2024 20:16:57 EDT (-0400)
  format for documentation (Message 26 to 35 of 55)  
<<< Previous 10 Messages Goto Latest 10 Messages Next 10 Messages >>>
From: Nathan Kopp
Subject: Re: format for documentation
Date: 24 Jan 2000 09:34:02
Message: <388c62da@news.povray.org>
Glen Berry <7no### [at] ezwvcom> wrote...
> I think it might also be nice to allow end-user modification of the
> help file.  If the help file is in a modular HTML format, it would be
> possible for the end-user to add some new pages, correct a typo on an
> existing page, or make whatever personal notes they wanted. It would
> become more of a personalized "workbook" in a sense. I can't do these
> things to a PDF, PostScript, or Windows Help document.

The problem with multiple files is that they are more difficult to maintain
and distribute than a single file that contains the entire document.

> As for Windows users of MegaPov, it might be nice to simply launch a
> Windows Help file, but I can easily live without this if it will be
> too much work to create.

Like I said, if I can get free tools to export from a word processor to HLP,
I'll give it a try.  I'll try that tool that Tony recommended.

-Nathan


Post a reply to this message

From: Ron Parker
Subject: Re: format for documentation
Date: 24 Jan 2000 10:10:44
Message: <slrn88oqsc.v8.ron.parker@ron.gwmicro.com>
On Mon, 24 Jan 2000 06:30:41 -0800, Ken wrote:
>  "I use Windows, and I'd like HLP."

I use Windows and Unix, and I'd like DocBook because you can easily transform
it into PDF, HTML, RTF, TeX, and lots of other formats.

-- 
These are my opinions.  I do NOT speak for the POV-Team.
The superpatch: http://www2.fwi.com/~parkerr/superpatch/
My other stuff: http://www2.fwi.com/~parkerr/traces.html


Post a reply to this message

From: Jim Kress
Subject: Re: format for documentation
Date: 24 Jan 2000 12:42:40
Message: <388c8f10@news.povray.org>
I use Windows and I prefer HTML.

Jim

--

Nathan Kopp <Nat### [at] Koppcom> wrote in message
news:388b6675@news.povray.org...
>
> What would be the desired format for MegaPov documentation for Windows and
> Unix?
>
> Available formats to choose from:
>
> WordPerfect
> MS Word 97
> MS Word (simple, read by WordPad)
> PostScript
> PDF (only if I can generate it with free tools)
> HTML (export from MS Word)
> Some other format that I could easily generate from a MS Word file using
> free tools.
>
> (Sorry, but I don't have any tools to generate HLP files for Windows.)
>
> -Nathan
>
>


Post a reply to this message

From: TonyB
Subject: Re: format for documentation
Date: 24 Jan 2000 13:15:40
Message: <388c96cc@news.povray.org>
>I am a Japanese,and Official manual is very difficult to uderstand for me.
>So in my case,
>I take out mainly Syntax from manual and put them into header of source
file.
>
>And I check Token.c,Parser.c etc. files,
>and I add comments(Of cource Japanese) each function,pattern and so on.
>Now I make all images of all functions,pattern and so on,
>then I can not make pattern of  "facets" inside pigments,
>so I check source and add only use inside  "normal" message like this.
>
>I hope plain text is better.
>I attach half way of my manual of functions.
>Of cource I put this in source file.


:O   Bakemono!


Post a reply to this message

From: Bob Hughes
Subject: Re: format for documentation
Date: 24 Jan 2000 14:12:50
Message: <388ca432@news.povray.org>
Win. HTML.
Couldn't some sort of generic html be made as a single page (file)?

Bob


Post a reply to this message

From: Francois Dispot
Subject: Re: format for documentation
Date: 24 Jan 2000 17:58:37
Message: <388CD91B.54D834F@club-internet.fr>
Nathan Kopp wrote:
> 
> What would be the desired format for MegaPov documentation for Windows and
> Unix?
> 
> Available formats to choose from:
> 
> WordPerfect
> MS Word 97
> MS Word (simple, read by WordPad)
> PostScript
> PDF (only if I can generate it with free tools)
> HTML (export from MS Word)
> Some other format that I could easily generate from a MS Word file using
> free tools.
> 
> (Sorry, but I don't have any tools to generate HLP files for Windows.)
> 
> -Nathan

I use Unix and I prefer ps/pdf for printed documentation, and CLEAN (ie.
not word-generated) HTML for browsing.

-- 

      __  __ __  __  _
|  | /  \  /  / |_  /  |/
\/\/ \__/ /_ /_ |__ \_ |\


Post a reply to this message

From: Nathan Kopp
Subject: Re: format for documentation
Date: 24 Jan 2000 18:01:06
Message: <388cd9b2@news.povray.org>
Ron Parker <ron### [at] povrayorg> wrote...
>
> I use Windows and Unix, and I'd like DocBook because you can easily
transform
> it into PDF, HTML, RTF, TeX, and lots of other formats.

Ron,

I develop on a Windows computer.  Are there free tools available for me to
use easily DocBook?  Also, the Smellenbergh brothers work primarily on the
Mac, so free Mac tools are necessary as well.

If that is possible, could you please point me a the general direction to
get started.  I've been to a few websites about DocBook, SGML, and XML, and
they all provided far too much information to be useful for me (I don't have
three years to learn a new tool for creating the MegaPov 0.4 documentation.)
;-)  You can email me with your reply or just post it here.  I'll get it
either way.

Otherwise, we'll probably end up using HTML as the primary format and
converting from that to other formats.

-Nathan


Post a reply to this message

From: Brendt Hess
Subject: Re: format for documentation
Date: 24 Jan 2000 19:05:22
Message: <388ce8c2@news.povray.org>
Jon A. Cruz wrote in message <388BA0BB.67F6720A@geocities.com>...
>Nathan Kopp wrote:


>> (Sorry, but I don't have any tools to generate HLP files for Windows.)
>>
>> -Nathan
>
>Hmmm. If you sign up for the free MSDN membership, you might get free
access
>to their help compiler. It's worth looking into.
>

I doubt it.  MS is now pushing HTML-Help, and, quite honestly, I have yet to
see a good
HTMLHelp file.  (The first HTML output I ever saw from MS Word was probably
better!)

Brendt


Post a reply to this message

From: Mark Gordon
Subject: Re: format for documentation
Date: 24 Jan 2000 22:55:28
Message: <388D1F2F.7B0FA87@mailbag.com>
Ron Parker wrote:
> 
> On Sun, 23 Jan 2000 15:35:55 -0500, Nathan Kopp wrote:
> >
> >What would be the desired format for MegaPov documentation for Windows and
> >Unix?
> >Some other format that I could easily generate from a MS Word file using
> >free tools.
> 
> DocBook!  DocBook!

I second that.

-Mark Gordon


Post a reply to this message

From: Axel Hecht
Subject: Re: format for documentation
Date: 25 Jan 2000 04:40:10
Message: <388D6F7D.FE419FAF@numerik.uni-kiel.de>
Hi Nathan,
so I guess my links confused you, so I take the chance and answer your
question to Ron :-)

As I found out, jade is available for Windows, and I would think, that
someone could get it running on Mac. I am not so much into mac, so don't
ask me for tools.

As of starting with docbook:
Use the definite docbook reference at http://www.docbook.org and an
editor that will support sgml (xml) editing.

I use xemacs and psgml-mode, which are available for windows as well.
But any editor with a DESCENT support will do.

Such an editor will give you some grammar checking based on the DTD you
specify for the file. And then you don't have the choice of some 100
elements, but just about 10-20, and the one you want is generally quite
obvious. psgml gives you a context menu with all valid elements at the
point of the cursor, so that is simple. And you can't do wrong grammar
that way.

So taking good tools, you should be able to get going with docbook in
just a day.

So look for DTD parsing editors with context sensitive element
insertion.

Axel


Post a reply to this message

<<< Previous 10 Messages Goto Latest 10 Messages Next 10 Messages >>>

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