Re: automatic generation of quickref.html
"Arnaud Desitter" <[email protected]>
| Newsgroups | gmane.comp.web.html-tidy.devel |
|---|---|
| Message-ID | <[email protected]> |
This is now http://tidy.sf.net/feature/1173183. Feel free to add constructive comments, attachements, etc. Regards, ----- Original Message ----- From: "Charlie" <[email protected]> To: "Jelks Cabaniss" <[email protected]> Cc: <[email protected]> Sent: Tuesday, March 22, 2005 4:47 AM Subject: RE: [Tidy-dev] automatic generation of quickref.html >I third the motion. I originally generated quickref.html from an XML > file. The idea being you could generate a man page and quick reference > from the same doc source. I have attached what I think are the original > XSLT stylesheet and XML data file. > > You end up wanting to embed basic HTML within the documentation for each > option. Modularizing HTML is still pretty much broken. What most folks > end up doing is embed CDATA sections, in which case the result is no good > for man pages. > > ...separation of presentation and content tends to be an ideal rarely > achieved in practice... > > > At 01:16 PM 3/21/2005 -0500, Jelks Cabaniss wrote: >>Bjoern Hoehrmann wrote: >> >> The idea is to have a C file (1) containing the description of each >> >> option. Then, a driver (2) generates quickref.html, making sure that >> >> all options are dealt with. The generated HTML is almost a copy >> >> of the current quickref.html. >> > >> > Well, I think I am -0 on this, I quite dislike maintaining the docs >> > in C files; I would prefer to have a proper XML format with the >> > documentation plus a command line tool to retrieve data from Tidy and >> > an XSLT to merge those. >> >>If it were to generate clean XHTML (with IDs for each option), that should >>allow you to parse the output with XSLT or any other tool. >> >>OTOH, I agree with you that it's a good idea to have a succinct XML format >>in place of stuff like this (from the current quickref page) ... >> >> ... >> <tr> >> <td class="tabletitle" valign="top" id="write-back">write-back</td> >> <td class="tabletitlelink" valign="top" align="right"><a >>href="#top">Top</a></td> >> </tr> >> <tr> >> <td valign="top"> >> Type: <b>Boolean</b><br /> >> Default: <b>no</b><br /> >> Example: <b>y/n, yes/no, t/f, true/false, 1/0</b></td> >> <td align="right" valign="top"> >> </td> >> </tr> >> <tr> >> <td colspan="2">This option specifies if Tidy >> should write back the tidied markup to the same file it read from. >> You >>are >> advised to keep copies of important files before tidying them, as on >>rare >> occasions the result may not be what you expect. </td> >> </tr> >> ... >> >>vs. >> <TidyOptions> >> ... >> <option> >> <name>write-back</name> >> <type>Boolean</type> >> <desc>This option specifies if Tidy should write back the >> tidied markup to the same file it read from. You are advised to keep >> copies of important files before tidying them, as on rare occasions the >> result may not be what you expect.</desc> >> </option> >> ... >> </TidyOptions> >> >>I think it would be nice if the latter were generated from Tidy itself, >>where it's all in one place. Then you could run an XSLT on that, changing >>with the times as necessary, and without all the presentational stuff >>hardcoded into the C program. >> >> >>/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. >>_______________________________________________ >>Tidy-develop mailing list >>[email protected] >>https://lists.sourceforge.net/lists/listinfo/tidy-develop > ------------------------------------------------------- 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