[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: About the technology being used to build Debian Installer Manual



On Saturday 14 July 2007 08:14, Christian Perrier wrote:
> > Yes I agree with you on this... I just wanted to know the technical
> > aspect of how the D-I installation manual are created. Hope this
> > helps...
>
> Well, on that specific topic, the best is probably looking in the
> manual/ directory in D-I SVN.
>
> Most parts should be self-explanatory and, anyway, some basic
> documentation can be found.

Well, the total setup for the manual (and especially the build system), is 
pretty complex because of the needed support for different architectures 
and translations. Things can be simplified quite a log if all that is not 
needed.

For a very basic docbook-xml document, you can take a look at my DebConf6 
paper in installer/doc/talks/d-i_debconf6 (ignore the .tex file!).

For the manual, buildone.sh is useful to see how different formats can be 
generated, but that script can be simplified *a lot*.
The basic directory structure of the manual is quite useful IMO. Without 
architectures and translations, you'd just have:
- the root directory
- directories per chapter (for large documents)
- a build directory with optionally some subdirs for stylesheets and
  entity definitions

> I don't think that people who wrote the original parts of the D-I
> manual did use specific tools to write them, though. So, this
> basically means that it's a matter of knowing how to write valid
> Docbook XML with a text editor..:-))

Some useful links:
http://www.sagehill.net/docbookxsl/index.html
http://www.oreilly.com/catalog/docbook/chapter/book/ch01.html
http://docbook.sourceforge.net/release/dsssl/current/doc/

Cheers,
FJP

Attachment: pgpwI9qGmaxJ5.pgp
Description: PGP signature


Reply to: