| 1 |
Josh Saddler wrote: |
| 2 |
> Xavier Neys wrote: |
| 3 |
>> GOOD news: |
| 4 |
>> I believe I've got it right on my box. |
| 5 |
>> I tested two guides[1][2] (I already had this feature in mind when I rewrote |
| 6 |
>> the quick guide and its lvm+raid sibling), and a bit of a handbook[3]. |
| 7 |
> |
| 8 |
> That IS good news! |
| 9 |
|
| 10 |
If you say so ;-) |
| 11 |
Wait until you have to start using it. |
| 12 |
|
| 13 |
>> BAD news: |
| 14 |
>> I still don't know when, or even whether, this would be available in Gentoo's |
| 15 |
>> own XSL. Almost all templates need to be changed and it's *not* going to |
| 16 |
>> happen overnight. |
| 17 |
>> |
| 18 |
>> [1] http://gentoo.neysx.org/mystuff/gentoo-x86+raid+lvm2-quickinstall.xml |
| 19 |
>> [2] http://gentoo.neysx.org/mystuff/gentoo-x86-quickinstall.xml |
| 20 |
>> [3] http://gentoo.neysx.org/mystuff/handbook/handbook-x86.xml?part=1&chap=4 |
| 21 |
>> |
| 22 |
>> The logic is chapters, sections and bodies can all be included, i.e. they |
| 23 |
>> either have the current structure or contain a single <include href=""/> |
| 24 |
>> element. A chapter can include chapters, a section can include sections and a |
| 25 |
>> body can include bodies. |
| 26 |
> |
| 27 |
> Awesome. So the includes are all inline, and don't need to be specified |
| 28 |
> in the handbook-$arch.xml files. |
| 29 |
|
| 30 |
They appear where they are supposed to be included, just like in the current |
| 31 |
handbook format, e.g. a <chapter> either contains its content as it does now |
| 32 |
*xor* a single <include> element that points to an xml files that contains |
| 33 |
chapter(s). |
| 34 |
|
| 35 |
Including chapters in a guide: |
| 36 |
|
| 37 |
<chapter id="foo" test="1"> |
| 38 |
<include href="bar.xml"/> |
| 39 |
</chapter> |
| 40 |
|
| 41 |
or in a handbook: |
| 42 |
|
| 43 |
<section id="foo" test="1"> |
| 44 |
<include href="bar.xml"/> |
| 45 |
</section> |
| 46 |
|
| 47 |
The included file is expected to contain one or more <chapter> |
| 48 |
|
| 49 |
|
| 50 |
Including sections in a guide: |
| 51 |
|
| 52 |
<section id="foo" test="1"> |
| 53 |
<include href="bar.xml"/> |
| 54 |
</section> |
| 55 |
|
| 56 |
or in a handbook: |
| 57 |
|
| 58 |
<subsection id="foo" test="1"> |
| 59 |
<include href="bar.xml"/> |
| 60 |
</subsection> |
| 61 |
|
| 62 |
The included file is expected to contain one or more <section> |
| 63 |
|
| 64 |
|
| 65 |
Including bodies: |
| 66 |
|
| 67 |
<body id="foo" test="1"> |
| 68 |
<include href="bar.xml"/> |
| 69 |
</body> |
| 70 |
|
| 71 |
The included file is expected to contain one or more <body> |
| 72 |
|
| 73 |
BTW, I still think it sucks to have different names for the same things in |
| 74 |
guides and books, and even more to have the same names for different things :( |
| 75 |
|
| 76 |
Conditional still apply to the same elements, nothing's changed at all. |
| 77 |
Nothing is preventing an included chapter from including sections. |
| 78 |
|
| 79 |
> Now, where are those includes being pulled from? Let's take |
| 80 |
> hb-install-sparc-disk.xml. There's quite a bit of common stuff to all |
| 81 |
> the other handbooks, as well as Sparc-specific partitioning sections. |
| 82 |
> For the common stuff, such as the "Block Devices" subsection, is it |
| 83 |
> reading that from a separate xml file? like block-devices.xml, that |
| 84 |
> contains just a tiny bit of xml for the block devices subsection? |
| 85 |
> |
| 86 |
> I just want to be clear on how the includes are actually working. |
| 87 |
|
| 88 |
Take a look at the xml I posted links to. |
| 89 |
I only used the file systems part of hb*disk*xml as an example. |
| 90 |
Maybe I'll factor out more common bits from the hb*disk*xml files in the |
| 91 |
coming days. |
| 92 |
|
| 93 |
Please note that it's very much useless to factor out just a couple of |
| 94 |
sentences. It adds unnecessary complexity and it makes it harder to evaluate |
| 95 |
the impact of a change to a shared file. |
| 96 |
|
| 97 |
>> It's a bit unfair to let you know all this without knowing when or whether you |
| 98 |
>> can use it, but at least you know... |
| 99 |
> |
| 100 |
> No, that's okay. As when I emailed the list back around the 2007.0 |
| 101 |
> release, it was understood that it wasn't a change that could be made |
| 102 |
> right away, and I wasn't expecting it to be completely ready for the |
| 103 |
> 2007.1 release either. |
| 104 |
|
| 105 |
It won't be available for the next release and it wouldn't be reasonable to |
| 106 |
implement this right before a release. |
| 107 |
|
| 108 |
> However, say it gets ready some time in the next 3 months, about halfway |
| 109 |
> between releases. How about putting it into effect right away on the |
| 110 |
> online handbooks well in advance of the next release? I'm willing to do |
| 111 |
> the work on converting the handbooks myself, if need be. Sure, the docs |
| 112 |
> on the CDs would have a different structure, but we can't do anything |
| 113 |
> about those anyway once they're packaged up. |
| 114 |
|
| 115 |
Right between two releases would be ideal. |
| 116 |
I don't know about 3 months and I don't know between which two releases this |
| 117 |
could become available. |
| 118 |
At least, if I had an ETA, I'd make it public ;) |
| 119 |
|
| 120 |
|
| 121 |
Cheers, |
| 122 |
-- |
| 123 |
/ Xavier Neys |
| 124 |
\_ Gentoo Documentation Project |
| 125 |
/ |
| 126 |
/\ http://www.gentoo.org/doc/en/ |
Archives