Re: automatic generation of quickref.html

Some comments on your comments:
#1 Re. F3. If you want the description of configuration options
in the output of "-help-config-xml", then the descriptions must
be added in tidylib. Fine by me.

So what are the people opinions ? Is it OK to add the documentation
of configuration option in tidylib ? Is the form proposed in
http://tidy.sf.net/patch/1008089 ok ? Is HTML the less worst format
to store these descriptions ?

It is not clear to me what the policy is related adding new features in
tidylib.

Regards,


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


Arnaud Desitter wrote:
> I try below to summarize the debate so far.

Wow, you really did...

I've snipped most of your summary just to make a few comments.

> F3 Users would like a parsable output produced by "tidy". XML is
> the favourite format. It is essentially "tidy -help-config" in a
> more parsable output.
>
> Possible improvements:
> I1 To address F3, an option "-help-config-xml" is added to tidy.c.
> It outputs the information of "tidy -show-config".

...As well as the *descriptions* (as in the quickref)!  See Charlie's
sample.

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 similar).

> I4 Failing to agree on I1, I2, I3 or if nobody volunteers to do the
> work, or as a stop-gap, replacing htmldoc/quickref.html by
> genquickref.c/tidydoc.h looks to me like a step forward rather than
> the current status quo. Moreover, doing that does not preclude
> implementing any of the suggestions above.

Agreed.

> C2 tidy.c contains a lot of hard coded information such as the
> possible values that can be extracted at run-time but are not. See
> genquickref.html for an example what can be done. Likewise, finding
> out whether an Integer is an AutoBool or an Enum is difficult or
> impossible. tidylib can be modified. Is it desirable ?

I would think so.

> Opinions ? To me doing I4 now and working on I1, I2, I3 later looks
> sensible.

Seeing as how you've mostly done the work for I4, I don't see why not.  But
until Tidy can "document itself", I think everything else is pretty much a
stop-gap measure.

Easy for me to say though; I'm not one of you heroes actually implementing
it...


/Jelks



-------------------------------------------------------
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=ick
_______________________________________________
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_id=6883&alloc_id=15149&op=click