Re: automatic generation of quickref.html

----- Original Message ----- 
From: "Charlie" <[email protected]>
To: "Arnaud Desitter" <[email protected]>
Cc: "Jelks Cabaniss" <[email protected]>; <[email protected]>
Sent: Thursday, April 14, 2005 2:43 PM
Subject: Re: [Tidy-dev] automatic generation of quickref.html


> Great idea.

From now on, "quickref.html", "tidy.1" and "tidy-config.7" are all
generated using "tidy -xml-help", "tidy -xml-config" and 3 style sheets.
Arguably, "tidy-config.7" should be folded within "tidy.1".
In other words, the documentation is and will be kept up-to-date.

> My only comment is that I would not include the quickref build target in 
> the default build ("all" target).  This will prevent errors for folks who 
> do not have libxslt installed.

It was decided that using style sheets was the way to go so there is no
point to complain that it will not work on platforms where a xsl engine is 
not
present.
I will change gmake/Makefile and introduce a target "doc". A consequence is
that Terry needs to change his scripts so that quickref.html is generated 
and
uploaded to http://tidy.sf.net.

> For those who haven't installed them, Daniel Veillard and Co.'s LibXslt 
> and LibXml2 are excellent C implementations of XML parsers and an XSLT 
> processor.  They are available at http://www.xmlsoft.org/.

And the variable XSLTPROC in Makefile can be overloaded if necessary.

Regards,

>
>
> At 06:32 PM 4/12/2005 +0100, Arnaud Desitter wrote:
>>Hi,
>>
>>quickref.html is now automatically generated by some style sheets 
>>developed
>>by Jelks and from the output of "tidy -xml-config". "tidy-config.7" is as 
>>well
>>generated. Last, tidy.1 ("man_page.txt") is now up-to-date.
>>Hopefully, that will sort out the documentation problems at least to some
>>extent.
>>
>>"xsltproc" is assumed to be available in build/gmake/Makefile. We will see 
>>if
>>that causes problem but, on balance, the up-to-date documentation is worth 
>>an
>>additional dependency ("xsltproc").
>
> 



-------------------------------------------------------
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_id=6595&alloc_id=14396&op=click