Re: automatic generation of quickref.html

Do we have convergence?  Terry, Björn?

At 02:43 PM 3/24/2005 +0000, Arnaud Desitter wrote:

>----- Original Message ----- From: "Charlie" <[email protected]>
>To: "Arnaud Desitter" <[email protected]>; "Jelks Cabaniss" 
><[email protected]>
>Cc: <[email protected]>
>Sent: Thursday, March 24, 2005 2:30 PM
>Subject: Re: [Tidy-dev] automatic generation of quickref.html
>
>
>>I second Jelks' proposed usage.  Arnaud, you are a fast moving target. 
>>Have you already implemented this?  If not, what is the difference as it 
>>stands?
>
>A doc API exists in the doc patch since September 2004. It gives a HTML
>string describing each option.
>"-quickref-xml" could be coded quite easily in tidy.c if the API above is
>added to tidylib.c.
>If not, the fallback is to add genquickref.c/tidydoc.h which work and is 
>better
>than nothing.
>
>>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?
>
>It makes sense.
>
>>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.
>
>It makes sense.
>
>>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.  ;-)
>>
>>
>>Arnaud wrote:
>>>Jelks wrote:
>>>>Arnaud wrote:
>>>>>But it's more than just `tidy -help-config` + descriptions "in a more
>>>>>parseable output".  Because it's a simple XML format, it's *much*
>>>>>easier (there are tons of tools, including XSLT), to create the
>>>>>quickref, man page, what have you from it.
>>>>>
>>>>>tidy -quickref-xml | xsltproc quickref.xsl > quickref.html
>>>>
>>>>or
>>>>
>>>>  tidy -quickref-xml | xsltproc quickref-docbook.xsl | \
>>>>      docbook2man -o tidy.1
>>>>
>>>>to create the manpage.
>>>>
>>>>http://docbook2x.sourceforge.net/latest/doc/wrapper-scripts.html
>>>
>>>It is more complicated as "tidy.1" contains as well the description of
>>>the options of tidy. quickref.html describes only the configuration
>>>options.
>>
>>
>
>
>
>-------------------------------------------------------
>This SF.net email is sponsored by Microsoft Mobile & Embedded DevCon 2005
>Attend MEDC 2005 May 9-12 in Vegas. Learn more about the latest Windows
>Embedded(r) & Windows Mobile(tm) platforms, applications & content.  Register
>by 3/29 & save $300 http://ads.osdn.com/?ad_id=6883&alloc_id=15149&op=click
>_______________________________________________
>Tidy-develop mailing list
>[email protected]
>https://lists.sourceforge.net/lists/listinfo/tidy-develop



-------------------------------------------------------
This SF.net email is sponsored by Microsoft Mobile & Embedded DevCon 2005
Attend MEDC 2005 May 9-12 in Vegas. Learn more about the latest Windows
Embedded(r) & Windows Mobile(tm) platforms, applications & content.  Register
by 3/29 & save $300 http://ads.osdn.com/?ad_idh83&alloc_id149&op=click