|
From: Jeroen N. W. <jn...@xs...> - 2005-08-18 18:25:56
Attachments:
FAQ-valgrind.patch
|
Greetings, While looking for a way to generate FAQ.txt from FAQ.xml I noticed that in a few places in file docs/xml/FAQ.xml in valgrind 3.1.SVN, screens and program listings are part of the answer where they should be part of the question. Attached patch fixes this problem. Jeroen. |
|
From: Nicholas N. <nj...@cs...> - 2005-08-26 21:03:49
|
On Thu, 18 Aug 2005, Jeroen N. Witmond wrote: > While looking for a way to generate FAQ.txt from FAQ.xml Ah, great... have you worked out how to do it? > I noticed that in a few places in file docs/xml/FAQ.xml in valgrind > 3.1.SVN, screens and program listings are part of the answer where they > should be part of the question. Attached patch fixes this problem. I've committed the changes, thanks very much. N |
|
From: Jeroen N. W. <jn...@xs...> - 2005-08-27 15:31:31
|
> On Thu, 18 Aug 2005, Jeroen N. Witmond wrote: > >> While looking for a way to generate FAQ.txt from FAQ.xml > > Ah, great... have you worked out how to do it? > First step was to look for existing tools that convert xml/docbook to plain text. I found one that produces something that might be usable with some tailoring, but its set of required software is completely disjunct from the software now used for valgrind's documentation. The tool is docbook2txt, which is a wrapper for jw, which is part of debian package docbook-utils, and itself a wrapper for jade. For more information see <http://packages.debian.org/stable/text/docbook-utils>. Second step was to look for tools that could transform one of the outputs or intermediates in the current build processes in docs/. The text-based web browser lynx does a passable job of transforming docs/html/FAQ.html into plain text, which probably could be improved with some sed tweaks. If you have lynx installed, try `lynx -dump docs/html/FAQ.html`. Given this result, I gave up very soon when looking for tools to convert .fo, .pdf or .ps to plain text. But this step still requires the installation (and maintenance) of yet another tool. Third step is still in progress, and consists of borrowing and writing xsl transformations to handle the job. These can then be executed using the same tools as currently used. They should be finished Real Soon Now(TM). I've gotten all constructs used in the FAQ to work but for the lists, but this should be no more than a matter of plumbing. >> I noticed that in a few places in file docs/xml/FAQ.xml in valgrind >> 3.1.SVN, screens and program listings are part of the answer where they >> should be part of the question. Attached patch fixes this problem. > > I've committed the changes, thanks very much. > Just doing my small bit for a great product. Jeroen. |
|
From: Nicholas N. <nj...@cs...> - 2005-08-27 16:52:22
|
On Sat, 27 Aug 2005, Jeroen N. Witmond wrote: > Second step was to look for tools that could transform one of the outputs > or intermediates in the current build processes in docs/. The text-based > web browser lynx does a passable job of transforming docs/html/FAQ.html > into plain text, which probably could be improved with some sed tweaks. If > you have lynx installed, try `lynx -dump docs/html/FAQ.html`. Given this > result, I gave up very soon when looking for tools to convert .fo, .pdf or > .ps to plain text. But this step still requires the installation (and > maintenance) of yet another tool. Yeah, we've looked at lynx for this before, the output requires a lot of cleaning up... > Third step is still in progress, and consists of borrowing and writing xsl > transformations to handle the job. These can then be executed using the > same tools as currently used. They should be finished Real Soon Now(TM). > I've gotten all constructs used in the FAQ to work but for the lists, but > this should be no more than a matter of plumbing. So this would be a replacement for using lynx? That would be best. It surprises me that there aren't readily available Docbook-to-text transformers, but it seems there aren't. > Just doing my small bit for a great product. (: In the next day or two I'm planning to write a list of possible projects for people who are interested in to work on, and put it on the website. Other projects like GCC have this, it seems like a good idea, especially for people who want to contribute but aren't sure where to start. There will be a range of things on it, from easy stuff that a beginner could do, to research-level problems. Nick |