Gentoo Archives: gentoo-doc

From: Sven Vermeulen <swift@g.o>
To: gentoo-doc@l.g.o
Subject: Re: [gentoo-doc] Project-specific documentation and dynamic documentation index
Date: Sun, 28 Nov 2004 13:54:55
Message-Id: 20041128135439.GA12308@gentoo.org
In Reply to: Re: [gentoo-doc] Project-specific documentation and dynamic documentation index by Xavier Neys
1 On Fri, Nov 26, 2004 at 07:16:42PM +0100, Xavier Neys wrote:
2 > The only reason gorg makes it an error 500 is that AxKit does.
3 [...]
4 > Missing document()'ed files can be tested in xsl if needed:
5
6 We /can/ develop some XSL magic so that AxKit doesn't 500 as well. It's ugly
7 and I don't want to be the person that implemented it (I'd rather see AxKit
8 go away), but the possible workaround is:
9
10 1. In en/metadoc.xml, define additional entities for each location...
11 <!ENTITY CEEnglishMain SYSTEM "CVS/Entries"!>
12 <!ENTITY CEEnglishHandbook SYSTEM "handbook/CVS/Entries"!>
13 ...
14 <!ENTITY CEInfraMain SYSTEM "/proj/en/infrastructure/CVS/Entries"!>
15
16 2. In en/metadoc.xml, have a location that places all this information
17 on-loading:
18
19 <metadoc>
20 ...
21 <allfiles>
22 <listing location="/doc/en">&CEEnglishMain;</listing>
23 <listing location="/doc/en/handbook">&CEEnglishHandbook;</listing>
24 ...
25 <listing location="/proj/en/infrastructure">&CEInfraMain;</listing>
26 </allfiles>
27 ...
28 </metadoc>
29
30 3. In inserts.xsl, create two functions (func:basename and func:dirname)
31 that return the basename of a url and the dirname
32
33 4. In metadoc.xsl, first verify if func:basename($fileurl) occurs in
34 document($metadoc)/allfiles/listing[@location == func:dirname($fileurl)]
35 before document()'ing it
36
37 Okay, just to say that it "is" possible... probably ;)
38
39 --
40 Documentation & PR project leader
41
42 The Gentoo Project <<< http://www.gentoo.org >>>