1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<?xml version="1.0" encoding="iso-8859-1"?>
<chapter xml:id="chapter-tools" xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Tools and Setup Instructions</title>
<para>
The required tools depends on the Operating System. Linux is recommended,
although several members of the documentation team uses Windows. All
members require the following to commit:
</para>
<para>
<itemizedlist>
<listitem>
<simpara>
A <link linkend="svn-account">SVN account</link>
</simpara>
</listitem>
<listitem>
<simpara>
A SVN client, typically from the command-line.
</simpara>
</listitem>
<listitem>
<simpara>
A <link linkend="chapter-editors-all">text editor</link>
</simpara>
</listitem>
<listitem>
<simpara>
PHP
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
The basic process is to <link linkend="svn-checkout">check out</link>
(~download) a file (or entire SVN module) using the SVN client,
<link linkend="chapter-editors-all">edit</link> the file,
<link linkend="chapter-configure">configure and validate</link> the file,
review the diff/patch, and finally commit (~upload) the file to the server.
Building and <link linkend="chapter-viewing">viewing</link> the file locally
before commit is also an option.
</para>
<para>
Note that the different translation projects use different encodings, so to
work with these the text editor must support these encodings. Although the
English documentation often uses ISO-Latin-1 (ISO-8859-1), it also uses
UTF-8 so the text editor should understand UTF-8. Most do.
</para>
<para>
Testing modifications takes a little time to get used to but after
awhile it becomes natural. See the <link linkend="chapter-configure">
configuration and validation</link> chapter for more information.
</para>
<sect1 xml:id="tools-on-linux-mac">
<title>Tools on Linux and Mac OS X</title>
<para>
SVN:
</para>
<para>
PHP: Several operating systems include PHP by default, but the following
extensions are required: libxml, xmlreader, and DOM. These are enabled by
default since PHP 5.1.0.
</para>
<para>
PhD: See the PhD section for details. This is what builds the manual.
</para>
<para>
PATH: The system terminal uses the PATH environment variable to find shell
commands, such as svn and php. Consider adding the appropriate paths.
</para>
</sect1>
<sect1 xml:id="tools-on-windows">
<title>Tools on Windows</title>
<para>
SVN: Either use cygwin, or install a svn client within the system shell.
</para>
<para>
PHP: Several operating systems include PHP by default, but the following
extensions are required: libxml, xmlreader, and DOM. These are enabled by
default since PHP 5.1.0.
</para>
<para>
PhD: See the PhD section for details. This is what builds the manual.
</para>
<para>
PATH: The system terminal uses the PATH environment variable to find shell
commands such as svn and php. Consider <link xlink:href="&url.path;">adding
the appropriate paths</link>.
</para>
</sect1>
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"howto.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
