[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml - gentoo-doc-cvs

From:	Xavier Neys <neysx@×××××××××××.org>
To:	gentoo-doc-cvs@l.g.o
Subject:	[gentoo-doc-cvs] cvs commit: doc-tipsntricks.xml
Date:	Fri, 03 Nov 2006 16:53:23
Message-Id:	`20061103165308.AEB8064A66@smtp.gentoo.org`

1

neysx       06/11/03 16:53:07

2

3

  Modified:             doc-tipsntricks.xml

4

  Log:

5

  #153938 We do not use/support axkit anymore

6

7

Revision  Changes    Path

8

1.21                 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml

9

10

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.21&view=markup

11

plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.21&content-type=text/plain

12

diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.20&r2=1.21

13

14

Index: doc-tipsntricks.xml

15

===================================================================

16

RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v

17

retrieving revision 1.20

18

retrieving revision 1.21

19

diff -u -r1.20 -r1.21

20

--- doc-tipsntricks.xml	21 Jul 2006 04:38:47 -0000	1.20

21

+++ doc-tipsntricks.xml	3 Nov 2006 16:53:07 -0000	1.21

22

@@ -1,16 +1,16 @@

23

 <?xml version='1.0' encoding="UTF-8"?>

24

 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">

25

26

-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.20 2006/07/21 04:38:47 rane Exp $ -->

27

+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.21 2006/11/03 16:53:07 neysx Exp $ -->

28

29

 <guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">

30

 <title>Documentation Development Tips &amp; Tricks</title>

31

32

 <author title="Author">

33

-    <mail link="swift@g.o">Sven Vermeulen</mail>

34

+  <mail link="neysx@g.o">Xavier Neys</mail>

35

 </author>

36

-<author title="Editor">

37

-    <mail link="neysx@g.o">Xavier Neys</mail>

38

+<author title="Author">

39

+  <mail link="swift@g.o">Sven Vermeulen</mail>

40

 </author>

41

42

 <abstract>

43

@@ -20,8 +20,8 @@

44

45

 <license/>

46

47

-<version>0.25</version>

48

-<date>2006-07-20</date>

49

+<version>0.26</version>

50

+<date>2006-11-03</date>

51

52

 <chapter>

53

 <title>Setting up your local environment</title>

54

@@ -254,139 +254,6 @@

55

 </chapter>

56

57

 <chapter>

58

-<title>Using an axkit setup</title>

59

-<section>

60

-<body>

61

-

62

-<note>

63

-This chapter is not actively maintained and is kept only for historical

64

-purposes as long as one of our web servers is still using an axkit setup.

65

-You might want to consider trying out <c>gorg</c>.

66

-</note>

67

-

68

-<p>

69

-Some doc developers prefer to use an axkit setup similar to the one running on

70

-<uri>http://www.gentoo.org</uri>.  Here are a few pointers to help you setup a

71

-similar configuration.

72

-</p>

73

-

74

-<warn>

75

-It seems that axkit is very sensitive to the versions of the packages it uses,

76

-especially libxml2. The configuration described below is known to work. Any

77

-other combination of packages might break.

78

-</warn>

79

-

80

-<p>

81

-First, install the required packages:

82

-</p>

83

-

84

-<pre caption="emerging specific versions on required packages">

85

-<comment>(Test if packages are available to portage)</comment>

86

-# <i>emerge -vp =dev-libs/libxml2-2.6.17 =dev-libs/libxslt-1.1.12 \

87

-=dev-perl/AxKit-1.6.1 =dev-perl/XML-XPath-1.13 =dev-perl/XML-LibXML-1.58 \

88

-=dev-perl/XML-LibXSLT-1.57 =dev-perl/XML-Parser-2.34 =net-www/apache-1.3.33</i>

89

-

90

-These are the packages that I would merge, in order:

91

-

92

-Calculating dependencies ...done!

93

-[ebuild   R   ] dev-libs/libxml2-2.x.17  -debug -ipv6 +python +readline  0 kB

94

-[ebuild   R   ] dev-libs/libxslt-1.1.12  +crypt +python  0 kB

95

-[ebuild   R   ] dev-perl/AxKit-1.6.1  +gnome  0 kB

96

-[ebuild   R   ] dev-perl/XML-XPath-1.13   0 kB

97

-[ebuild   R   ] dev-perl/XML-LibXML-1.58   0 kB

98

-[ebuild   R   ] dev-perl/XML-LibXSLT-1.57   0 kB

99

-[ebuild   R   ] dev-perl/XML-Parser-2.34   0 kB

100

-[ebuild   R   ] net-www/apache-1.3.33  +pam  0 kB

101

-

102

-<comment>(Install packages)</comment>

103

-# <i>emerge =dev-libs/libxml2-2.6.17 =dev-libs/libxslt-1.1.12 \

104

-=dev-perl/AxKit-1.6.1 =dev-perl/XML-XPath-1.13 =dev-perl/XML-LibXML-1.58 \

105

-=dev-perl/XML-LibXSLT-1.57 =dev-perl/XML-Parser-2.34 =net-www/apache-1.3.33</i>

106

-</pre>

107

-

108

-<p>

109

-Then, edit the following config files:

110

-</p>

111

-

112

-<pre caption="/etc/apache/conf/commonapache.conf">

113

-<comment>(Inside)</comment>

114

-&lt;IfModule mod_dir.c&gt;

115

-  <comment>(Add index.xml to the list)</comment>

116

-  DirectoryIndex index.xml index.html index.php index.php3 index.shtml index.cgi index.pl index.htm Default.htm default.htm

117

-&lt;/IfModule&gt;

118

-

119

-<comment>(Add the following lines)</comment>

120

-&lt;IfDefine PERL&gt;

121

-  LoadModule perl_module extramodules/libperl.so

122

-#  AddModule mod_perl.c

123

-  PerlModule AxKit

124

-  SetHandler perl-script

125

-  PerlHandler Apache::AxKit::StyleChooser::PathInfo AxKit

126

-  AddHandler axkit .xml .xsp

127

-  AxAddPlugin Apache::AxKit::StyleChooser::QueryString

128

-  AxAddXSPTaglib AxKit::XSP::Util

129

-  AxAddXSPTaglib AxKit::XSP::IfParam

130

-  AxAddXSPTaglib AxKit::XSP::Param

131

-  AxAddStyleMap application/x-xsp Apache::AxKit::Language::XSP

132

-  AxAddStyleMap text/xsl Apache::AxKit::Language::LibXSLT

133

-  &lt;AxStyleName "#default"&gt;

134

-    AxAddProcessor text/xsl /xsl/guide.xsl

135

-  &lt;/AxStyleName&gt;

136

-  &lt;AxStyleName printable&gt;

137

-    AxAddProcessor text/xsl /xsl/guide-print.xsl

138

-  &lt;/AxStyleName&gt;

139

-&lt;/IfDefine&gt;

140

-

141

-<comment>(Inside)</comment>

142

-&lt;IfModule mod_alias.c&gt;

143

-    Alias /icons/ /var/www/localhost/icons/

144

-<comment>(Comment out the following line)</comment>

145

-    #Alias /doc /usr/share/doc

146

-</pre>

147

-

148

-<pre caption="/etc/conf.d/apache">

149

-<comment>(Add -D PERL to the list of options)</comment>

150

-APACHE_OPTS="-D PERL"

151

-</pre>

152

-

153

-<p>

154

-Then, copy the documentation files including the DTDs and stylesheets to

155

-<path>/var/www/localhost/htdocs/</path>. You need the <path>css/</path>,

156

-<path>doc/</path>, <path>dtd/</path>, <path>images/</path> and

157

-<path>xsl/</path> directories. Gentoo developers can copy from or symlink to

158

-their CVS local copy. Other contributors will need to download the files from

159

-our <uri link="http://sources.gentoo.org/gentoo/xml/htdocs/">viewCVS</uri>

160

-interface.

161

-</p>

162

-

163

-<p>

164

-All there is left to do is start your apache server with:

165

-</p>

166

-

167

-<pre caption="Launching apache">

168

-# <i>/etc/init.d/apache start</i>

169

-# <comment>(Add it to your runlevel if you want to start it automatically at boot time)</comment>

170

-# <i>rc-update add apache default</i>

171

-</pre>

172

-

173

-<p>

174

-Point now your browser to <uri>http://your_server/doc/en/</uri> or simply

175

-<uri>http://localhost/doc/en/</uri> if you installed axkit on your workstation.

176

-You can check <path>/var/log/apache/access_log</path> for accesses and

177

-<path>/var/log/apache/error_log</path> for errors.

178

-</p>

179

-

180

-<note>

181

-Mozilla users might need to set <c>keyword.enabled</c> to <c>false</c> in their

182

-<uri>about:config</uri> page when using localhost.

183

-</note>

184

-

185

-</body>

186

-</section>

187

-

188

-</chapter>

189

-

190

-<chapter>

191

 <title>Frequently Asked Questions</title>

192

 <section>

193

 <title>How do I convert a file to UTF-8?</title>

--

198

gentoo-doc-cvs@g.o mailing list

1	neysx 06/11/03 16:53:07
2
3	Modified: doc-tipsntricks.xml
4	Log:
5	#153938 We do not use/support axkit anymore
6
7	Revision Changes Path
8	1.21 xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml
9
10	file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.21&view=markup
11	plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?rev=1.21&content-type=text/plain
12	diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml?r1=1.20&r2=1.21
13
14	Index: doc-tipsntricks.xml
15	===================================================================
16	RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v
17	retrieving revision 1.20
18	retrieving revision 1.21
19	diff -u -r1.20 -r1.21
20	--- doc-tipsntricks.xml 21 Jul 2006 04:38:47 -0000 1.20
21	+++ doc-tipsntricks.xml 3 Nov 2006 16:53:07 -0000 1.21
22	@@ -1,16 +1,16 @@
23	<?xml version='1.0' encoding="UTF-8"?>
24	<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
25
26	-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.20 2006/07/21 04:38:47 rane Exp $ -->
27	+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/gdp/doc/doc-tipsntricks.xml,v 1.21 2006/11/03 16:53:07 neysx Exp $ -->
28
29	<guide link="/proj/en/gdp/doc/doc-tipsntricks.xml">
30	<title>Documentation Development Tips & Tricks</title>
31
32	<author title="Author">
33	- <mail link="swift@g.o">Sven Vermeulen</mail>
34	+ <mail link="neysx@g.o">Xavier Neys</mail>
35	</author>
36	-<author title="Editor">
37	- <mail link="neysx@g.o">Xavier Neys</mail>
38	+<author title="Author">
39	+ <mail link="swift@g.o">Sven Vermeulen</mail>
40	</author>
41
42	<abstract>
43	@@ -20,8 +20,8 @@
44
45	<license/>
46
47	-<version>0.25</version>
48	-<date>2006-07-20</date>
49	+<version>0.26</version>
50	+<date>2006-11-03</date>
51
52	<chapter>
53	<title>Setting up your local environment</title>
54	@@ -254,139 +254,6 @@
55	</chapter>
56
57	<chapter>
58	-<title>Using an axkit setup</title>
59	-<section>
60	-<body>
61	-
62	-<note>
63	-This chapter is not actively maintained and is kept only for historical
64	-purposes as long as one of our web servers is still using an axkit setup.
65	-You might want to consider trying out <c>gorg</c>.
66	-</note>
67	-
68	-<p>
69	-Some doc developers prefer to use an axkit setup similar to the one running on
70	-<uri>http://www.gentoo.org</uri>. Here are a few pointers to help you setup a
71	-similar configuration.
72	-</p>
73	-
74	-<warn>
75	-It seems that axkit is very sensitive to the versions of the packages it uses,
76	-especially libxml2. The configuration described below is known to work. Any
77	-other combination of packages might break.
78	-</warn>
79	-
80	-<p>
81	-First, install the required packages:
82	-</p>
83	-
84	-<pre caption="emerging specific versions on required packages">
85	-<comment>(Test if packages are available to portage)</comment>
86	-# <i>emerge -vp =dev-libs/libxml2-2.6.17 =dev-libs/libxslt-1.1.12 \
87	-=dev-perl/AxKit-1.6.1 =dev-perl/XML-XPath-1.13 =dev-perl/XML-LibXML-1.58 \
88	-=dev-perl/XML-LibXSLT-1.57 =dev-perl/XML-Parser-2.34 =net-www/apache-1.3.33</i>
89	-
90	-These are the packages that I would merge, in order:
91	-
92	-Calculating dependencies ...done!
93	-[ebuild R ] dev-libs/libxml2-2.x.17 -debug -ipv6 +python +readline 0 kB
94	-[ebuild R ] dev-libs/libxslt-1.1.12 +crypt +python 0 kB
95	-[ebuild R ] dev-perl/AxKit-1.6.1 +gnome 0 kB
96	-[ebuild R ] dev-perl/XML-XPath-1.13 0 kB
97	-[ebuild R ] dev-perl/XML-LibXML-1.58 0 kB
98	-[ebuild R ] dev-perl/XML-LibXSLT-1.57 0 kB
99	-[ebuild R ] dev-perl/XML-Parser-2.34 0 kB
100	-[ebuild R ] net-www/apache-1.3.33 +pam 0 kB
101	-
102	-<comment>(Install packages)</comment>
103	-# <i>emerge =dev-libs/libxml2-2.6.17 =dev-libs/libxslt-1.1.12 \
104	-=dev-perl/AxKit-1.6.1 =dev-perl/XML-XPath-1.13 =dev-perl/XML-LibXML-1.58 \
105	-=dev-perl/XML-LibXSLT-1.57 =dev-perl/XML-Parser-2.34 =net-www/apache-1.3.33</i>
106	-</pre>
107	-
108	-<p>
109	-Then, edit the following config files:
110	-</p>
111	-
112	-<pre caption="/etc/apache/conf/commonapache.conf">
113	-<comment>(Inside)</comment>
114	-<IfModule mod_dir.c>
115	- <comment>(Add index.xml to the list)</comment>
116	- DirectoryIndex index.xml index.html index.php index.php3 index.shtml index.cgi index.pl index.htm Default.htm default.htm
117	-</IfModule>
118	-
119	-<comment>(Add the following lines)</comment>
120	-<IfDefine PERL>
121	- LoadModule perl_module extramodules/libperl.so
122	-# AddModule mod_perl.c
123	- PerlModule AxKit
124	- SetHandler perl-script
125	- PerlHandler Apache::AxKit::StyleChooser::PathInfo AxKit
126	- AddHandler axkit .xml .xsp
127	- AxAddPlugin Apache::AxKit::StyleChooser::QueryString
128	- AxAddXSPTaglib AxKit::XSP::Util
129	- AxAddXSPTaglib AxKit::XSP::IfParam
130	- AxAddXSPTaglib AxKit::XSP::Param
131	- AxAddStyleMap application/x-xsp Apache::AxKit::Language::XSP
132	- AxAddStyleMap text/xsl Apache::AxKit::Language::LibXSLT
133	- <AxStyleName "#default">
134	- AxAddProcessor text/xsl /xsl/guide.xsl
135	- </AxStyleName>
136	- <AxStyleName printable>
137	- AxAddProcessor text/xsl /xsl/guide-print.xsl
138	- </AxStyleName>
139	-</IfDefine>
140	-
141	-<comment>(Inside)</comment>
142	-<IfModule mod_alias.c>
143	- Alias /icons/ /var/www/localhost/icons/
144	-<comment>(Comment out the following line)</comment>
145	- #Alias /doc /usr/share/doc
146	-</pre>
147	-
148	-<pre caption="/etc/conf.d/apache">
149	-<comment>(Add -D PERL to the list of options)</comment>
150	-APACHE_OPTS="-D PERL"
151	-</pre>
152	-
153	-<p>
154	-Then, copy the documentation files including the DTDs and stylesheets to
155	-<path>/var/www/localhost/htdocs/</path>. You need the <path>css/</path>,
156	-<path>doc/</path>, <path>dtd/</path>, <path>images/</path> and
157	-<path>xsl/</path> directories. Gentoo developers can copy from or symlink to
158	-their CVS local copy. Other contributors will need to download the files from
159	-our <uri link="http://sources.gentoo.org/gentoo/xml/htdocs/">viewCVS</uri>
160	-interface.
161	-</p>
162	-
163	-<p>
164	-All there is left to do is start your apache server with:
165	-</p>
166	-
167	-<pre caption="Launching apache">
168	-# <i>/etc/init.d/apache start</i>
169	-# <comment>(Add it to your runlevel if you want to start it automatically at boot time)</comment>
170	-# <i>rc-update add apache default</i>
171	-</pre>
172	-
173	-<p>
174	-Point now your browser to <uri>http://your_server/doc/en/</uri> or simply
175	-<uri>http://localhost/doc/en/</uri> if you installed axkit on your workstation.
176	-You can check <path>/var/log/apache/access_log</path> for accesses and
177	-<path>/var/log/apache/error_log</path> for errors.
178	-</p>
179	-
180	-<note>
181	-Mozilla users might need to set <c>keyword.enabled</c> to <c>false</c> in their
182	-<uri>about:config</uri> page when using localhost.
183	-</note>
184	-
185	-</body>
186	-</section>
187	-
188	-</chapter>
189	-
190	-<chapter>
191	<title>Frequently Asked Questions</title>
192	<section>
193	<title>How do I convert a file to UTF-8?</title>
194
195
196
197	--
198	gentoo-doc-cvs@g.o mailing list

Gentoo Archives: gentoo-doc-cvs