Gentoo Archives: gentoo-doc

From: Stuart Longland <redhatter@g.o>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] GuideXML: define values & use conditional tags
Date: Sat, 24 Jun 2006 03:42:12
Message-Id: 449CB477.9040303@gentoo.org
In Reply to: [gentoo-doc] GuideXML: define values & use conditional tags by Xavier Neys
1 Xavier Neys wrote:
2
3 > Besides, allowing conditional bodies would let us solve bugs like
4 > http://bugs.gentoo.org/show_bug.cgi?id=52856 or the latest
5 > http://bugs.gentoo.org/show_bug.cgi?id=132816. Paragraphs like "Sparc users or
6 > PPC machines blah blah di blah" are getting more and more common and
7 > inconsistencies such as the partitioning schemes in the the hb-ARCH-disk.xml
8 > files and the common hb-install-config.xml are inevitable without conditionals.
9
10 Well... I had this exact problem with the MIPS handbook. There was
11 quite a bit of information, not relevant to other architectures, that I
12 needed to get across, which related to stageball selection.
13
14 Thus, MIPS is the only ARCH that has it's own stage selection section
15 (hb-install-mips-stage.xml), whereas the others all share a common file
16 (hb-install-stage.xml).
17
18 This meant I could go into greater detail, and thus made (IMHO) a higher
19 quality manual.
20
21 > The good side is we could deliver less encumbered handbooks and please our users.
22 > The drawback is that it makes writing text that flows properly in all cases
23 > more difficult for us.
24
25 Yeah, this is definitely an issue. It'd mean having to write the doc a
26 few times to get it right with all possible selections. Then again, the
27 solution I went with (to get around this issue) also involves a lot of
28 duplication of information, which has its drawbacks too.
29
30 --
31 Stuart Longland (aka Redhatter) .'''.
32 Gentoo Linux/MIPS Cobalt and Docs Developer '.'` :
33 . . . . . . . . . . . . . . . . . . . . . . .'.'
34 http://dev.gentoo.org/~redhatter :.'
35
36 International Asperger's Year (1906 ~ 2006)
37 http://dev.gentoo.org/~redhatter/iay

Attachments

File name MIME type
signature.asc application/pgp-signature