[Hamlib-developer] Re: New web pages

[Stephane F. <f4...@fr...>]

Hi Nate!

> The way I see it, the document source is GPL just like program source
> and the formatted result, HTML, PDF, whatever is analogous to a binary
> program.  We don't modify the binary, but the source and it's the same
> with Docbook.  So, I think I shall stick with the GPL for now.
> 
> That covers my thoughts on the manual.  As for the web pages, they're
> nothing spectacular so if folks want to use bits that's just fine and
> I'm sure the GPL is a reasonable choice there.

GPL is fine. I hardly remember there was some special case with editing books,
but that's not our aim.

> I downloaded the latest CVS and will add and commit the SGML tonight.  I
> plan to put it in the docs directory in a subdirectory of sgml (for lack
> of anything more imaginative).  Please tell me more about doxygen as
> I've not heard of it.
 
A subdirectory like "manual" would have been less confusing than sgml,
especially in regards of the html subdirectory. Anyhow, it's up to you.

About doxygen:
<<
Doxygen is a documentation system for C, C++ and IDL. It can generate an on-lineclass browser (in HTML) and/or an off-line reference manual (in LaTeX) from a
set of documented source files. There is also support for generating man pages
and for converting the generated output into Postscript, hyperlinked PDF or
compressed HTML. The documentation is extracted directly from the sources.
>>
In other words, it lets one document an API, program, etc. within the source
code. Have a look at src/rig.c, each "/**" statement will be interpreted
by doxygen, and generate some kind of output in the resulting manual.
The official doxygen web site is at http://www.doxygen.org
Provided doxygen is installed on you system, type "make doc" in the doc/
subdirectory, and doxygen will be executed with the file hamlib.cfg
as an argument. The Hamlib HTML manual and man pages are then generated 
in the html/ and man/ subdirectories.
Have a look at http://f4cfe.free.fr/ham/hamlib/doxygen/ for a glimpse of it.
I think these materials would fit perfectly (with some tune up, of course) 
with your SGML manual. Let me know what you think of it.

Cheers,
Stephane - F8CFE