Jason,
good news: I have converted all of the apt man pages to xml docbook 4 format.
The attachment contains the manpages in xml format and the result after they
have been formatted with xmlto.
Can you review the result (compare them for example with the manpages
currently distributed). "My" manpages can be easily viewed with:
MANPATH=doc man apt-get/apt-cache/etc
What you will notice is that there are more empty lines in the manpages. On
the other hand other things are better formatted than the current pages.
The xsl manpages templates
(/usr/share/sgml/docbook/docbook-xsl-stylesheets-1.61.3/manpages/*) needed to
be updated to get the apt manpages formatted correctly. This has been done
already (1 patch remaining) and I have been told that those updated xsl
templates will be released shortly.
The author is mentioned twice in the manpages. I left it like that, but I
think that 1 or the other should be removed. Let me know what should be done
with it.
AUTHOR
APT was written by the APT team <apt@packages.debian.org>.
AUTHOR
Jason Gunthorpe.
Last thing: there is an apt.ent.in file. This is needed to get the processing
date in all manpages.
This is it for now. I hope that the xml pages will be distributed with apt
and apt-rpm. It has been quite some work to get the docs converted, but I
think it was worth the effort of doing it.
Op donderdag 4 december 2003 04:10, schreef Jason Gunthorpe:
> On Wed, 3 Dec 2003, Gustavo Niemeyer wrote:
> > Any chances of giving Richard some attention regarding the
> > APT documentation? I wouldn't like to fork it completely.
>
> Oh yes,
>
> He mailed me while debian.org was all messed up (and so was my mail). Just
> getting through the backlog still
>
> I belive I already told richard that it was a good idea to go ahead with
> the SGML fixups, since it is debian specific behavior that it works at
> all.
>
> Since those fixups basically require the document to become nearly valid
> XML, you might as well use that since it seems to be increasingly common.
>
> I've never really liked the idea of using XML for handwritten
> documentation since the SGML tag minimization features make it alot easier
> to write in SGML, but since the docbook DTD disallows all of them you
> might as well just use XML...
>
> mdz is the one who would have to apply the new docs to the apt cvs - which
> is probably going to be down for at least another week or two while
> debian.org gets put back together.
>
> You may also want to consider adding documentation of RPM behavior with
> conditional inclusion sections within the document. Then docs can be
> produced for both from largely the same source.
--
Looking forward to your reply
Richard
Attachment:
apt-man-xml.tar.bz2
Description: application/tbz