[gentoo-dev] Gentoo doc docbook example

[gentoo-dev] Gentoo doc docbook example

[Achim Gottinger]

Hi there,

I tried to convert our ebuild man pages to Linux Doc style first, but I
found that it misses too much of the
docbook stuff and is only usefull for small howto's.
So I decided to use sgml-docbook-dtd-4.1 for my tests.

There are three new files in gentoo-doc/files.

ebuild.sgml	The Book
refentry/ebuild-1.sgml  The ebuild(1) man page sgmlized
refentry/ebuild-5.sgml  The ebuild(5) man page

If you have a working docbook environment you can make html, pdf and man
output from that (texi makes problems , others should work).

If you run "docbook2man ebuild.sgml" you will get the two man pages
ebuild.1 and ebuild.2 without the other
book stuff.

If you run "docbook2html ebuild.sgml" you will get a bunch of html pages
index.html contains the TOC.

Give "docbook2pdf ebuild.sgml" a try and open ebuild.pdf with acroread.
You will see that you have a nice toc
in there too.

Assuming you have updated kdelibs to the version that installs docbook
stuff in /usr/share/sgml, you can
even run "kdb2html ebuild.sgml".
The result will be a dir called HTML with a bunch of html's, that fit
perfectly into kde's documentation.

Please guys give this stuff a try and me feedback. !


achim~

Re: [gentoo-dev] Gentoo doc docbook example

[Achim Gottinger]

Achim Gottinger wrote:
> 
> Hi there,
> 
> 
> Please guys give this stuff a try and me feedback. !
> 

Here comes more stuff to test.

The file gentoo-doc.tbz2 contains an example ebuild how our doc could
look like. (No dependencies stuff in that
package but it requires the full sgml part of the docbook environment.

gentoo.pdf.bz2 is the pdf output (without images at the moment).

achim~

> achim~
> 
> _______________________________________________
> gentoo-dev mailing list
> gentoo-dev@gentoo.org
> http://www.gentoo.org/mailman/listinfo/gentoo-dev

Re: [gentoo-dev] Gentoo doc docbook example

[Achim Gottinger]

[-- Attachment #1: Type: text/plain, Size: 780 bytes --]

Achim Gottinger wrote:
> 
> Achim Gottinger wrote:
> >
> > Hi there,
> >
> >
> > Please guys give this stuff a try and me feedback. !
> >
> 
> Here comes more stuff to test.
> 
> The file gentoo-doc.tbz2 contains an example ebuild how our doc could
> look like. (No dependencies stuff in that
> package but it requires the full sgml part of the docbook environment.
> 
> gentoo.pdf.bz2 is the pdf output (without images at the moment).
> 
> achim~
> 
> > achim~
> >
> > _______________________________________________
> > gentoo-dev mailing list
> > gentoo-dev@gentoo.org
> > http://www.gentoo.org/mailman/listinfo/gentoo-dev
> 
> _______________________________________________
> gentoo-dev mailing list
> gentoo-dev@gentoo.org
> http://www.gentoo.org/mailman/listinfo/gentoo-dev

[-- Attachment #2: gentoo-doc.tbz2 --]
[-- Type: application/octet-stream, Size: 42110 bytes --]

[-- Attachment #3: gentoo.pdf.bz2 --]
[-- Type: application/octet-stream, Size: 18082 bytes --]