Re: automatic generation of quickref.html

This is now http://tidy.sf.net/feature/1174051.


----- Original Message ----- 
From: "Jelks Cabaniss" <[email protected]>
To: <[email protected]>
Sent: Thursday, March 24, 2005 7:11 PM
Subject: RE: [Tidy-dev] automatic generation of quickref.html


Charlie wrote:
> True enough, the command line args to tidy and all the
> TidyLib config options are two distinct, but slightly
> overlapping sets.  I propose, as many tools do, to split the
> man pages.  "man tidy" could give you a page describing the
> command line args (similar to tidy -?).  "man tidy-config"
> could give you the quick reference in man page format
> (similar to tidy -help-config).  What do you think?

Sounds good.

> The basic tidy man page are slowly moving and can continue to be
> maintained by hand.  The tidy-config man page can be generated using
> your new option description API, the -quickref-xml command line arg,
> plus external transforms per Jelks.

Yes.  (with each man page referencing the other with a "SEE ALSO ...".)

> Jelks, are you volunteering to write quickref-dockbook.xsl (and to
> test the docbook2man process)?  After all, no good deed goes
> unpunished...  Also, if you have experience with it, it would help
> out us poor HTML hackers.  ;-)

Sigh.

OK. :)

I'll first go over your file and compare the options, descriptions and
defaults in it with the current quickref page.  One addition I just noticed
we need for a few cases is a `<see-also>...</see-also>` -- for one example,
see ...

http://tidy.sourceforge.net/docs/quickref.html#join-classes

and how that option references two others.  No problem for updating the
"representative" XML file, but those may be *slightly* tricky to generate in
the code.

Also, I just noticed `slide-style` in the quickref, with a description of
"Currently not used. Tidy Classic only."  Should "legacy" options also be
generated automatically?  Or should they be inserted via the stylesheet?  If
the latter, then

tidy -quickref-xml

or

tidy -help-config-xml

(or whatever we end up using) will *not* show them, only the generated pages
will.  Which is probably OK.  Thoughts?


/Jelks



-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_ide95&alloc_id396&op=ick
_______________________________________________
Tidy-develop mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tidy-develop



-------------------------------------------------------
This SF.net email is sponsored by Demarc:
A global provider of Threat Management Solutions.
Download our HomeAdmin security software for free today!
http://www.demarc.com/Info/Sentarus/hamr30