Gentoo Archives: gentoo-doc

From: Josh Saddler <nightmorph@g.o>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] 2007.1 Handbook mojo
Date: Fri, 09 Nov 2007 20:46:21
Message-Id: 4734C6C9.2030200@gentoo.org
In Reply to: Re: [gentoo-doc] 2007.1 Handbook mojo by Xavier Neys
1 Xavier Neys wrote:
2 > GOOD news:
3 > I believe I've got it right on my box.
4 > I tested two guides[1][2] (I already had this feature in mind when I rewrote
5 > the quick guide and its lvm+raid sibling), and a bit of a handbook[3].
6
7 That IS good news!
8
9 > BAD news:
10 > I still don't know when, or even whether, this would be available in Gentoo's
11 > own XSL. Almost all templates need to be changed and it's *not* going to
12 > happen overnight.
13 >
14 > [1] http://gentoo.neysx.org/mystuff/gentoo-x86+raid+lvm2-quickinstall.xml
15 > [2] http://gentoo.neysx.org/mystuff/gentoo-x86-quickinstall.xml
16 > [3] http://gentoo.neysx.org/mystuff/handbook/handbook-x86.xml?part=1&chap=4
17 >
18 > The logic is chapters, sections and bodies can all be included, i.e. they
19 > either have the current structure or contain a single <include href=""/>
20 > element. A chapter can include chapters, a section can include sections and a
21 > body can include bodies.
22
23 Awesome. So the includes are all inline, and don't need to be specified
24 in the handbook-$arch.xml files.
25
26 Now, where are those includes being pulled from? Let's take
27 hb-install-sparc-disk.xml. There's quite a bit of common stuff to all
28 the other handbooks, as well as Sparc-specific partitioning sections.
29 For the common stuff, such as the "Block Devices" subsection, is it
30 reading that from a separate xml file? like block-devices.xml, that
31 contains just a tiny bit of xml for the block devices subsection?
32
33 I just want to be clear on how the includes are actually working.
34
35 > It's a bit unfair to let you know all this without knowing when or whether you
36 > can use it, but at least you know...
37
38 No, that's okay. As when I emailed the list back around the 2007.0
39 release, it was understood that it wasn't a change that could be made
40 right away, and I wasn't expecting it to be completely ready for the
41 2007.1 release either.
42
43 However, say it gets ready some time in the next 3 months, about halfway
44 between releases. How about putting it into effect right away on the
45 online handbooks well in advance of the next release? I'm willing to do
46 the work on converting the handbooks myself, if need be. Sure, the docs
47 on the CDs would have a different structure, but we can't do anything
48 about those anyway once they're packaged up.

Attachments

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

Replies

Subject Author
Re: [gentoo-doc] 2007.1 Handbook mojo Xavier Neys <neysx@g.o>