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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Welcome to POI</title>
<link type="text/css" href="../skin/page.css" rel="stylesheet">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<!--================= start Navigation Path ==================-->
<table summary="navigation path" width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td nowrap="nowrap" valign="middle" bgcolor="#CFDCED" height="20"><img height="1" width="5" alt="" src="../skin/images/spacer.gif" class="spacer"><!--===== breadcrumb trail (javascript-generated) ====--><font size="2" face="Arial, Helvetica, Sans-serif"><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script></font></td>
</tr>
<tr>
<td bgcolor="#4C6C8F" height="2"><img height="2" width="2" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
</table>
<!--================= end Navigation Path ==================-->
<!--================= start Banner ==================-->
<table summary="header with logos" width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<!--================= start Group Logo ==================-->
<td bgcolor="#294563"><a href="http://jakarta.apache.org"><img border="0" class="logoImage" alt="Jakarta" src="../resources/images/group-logo.gif"></a></td>
<!--================= end Group Logo ==================-->
<!--================= start Project Logo ==================--><td width="100%" align="center" bgcolor="#294563"><a href="http://jakarta.apache.org/poi/"><img border="0" class="logoImage" alt="POI" src="../resources/images/project-logo.gif"></a></td>
<!--================= end Project Logo ==================-->
<!--================= start Search ==================--><td valign="top" rowspan="2" bgcolor="#294563">
<form target="_blank" action="http://www.google.com/search" method="get">
<table summary="search" border="0" cellspacing="0" cellpadding="0" bgcolor="#4C6C8F">
<tr>
<td colspan="3"><img height="10" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap"><input value="jakarta.apache.org" name="sitesearch" type="hidden"><input size="15" name="q" id="query" type="text"><img height="1" width="5" alt="" src="../skin/images/spacer.gif" class="spacer"><input name="Search" value="Search" type="submit">
<br>
<font face="Arial, Helvetica, Sans-serif" size="2" color="white">
the jakarta site
</font></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td><img alt="" border="0" height="10" width="9" src="../skin/images/search-left.gif"></td><td><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td><img alt="" border="0" height="10" width="9" src="../skin/images/search-right.gif"></td>
</tr>
</table>
</form>
</td>
<!--================= start Search ==================--><td bgcolor="#294563"><img height="10" width="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td valign="bottom" bgcolor="#294563" colspan="2">
<!--================= start Tabs ==================-->
<div class="tab">
<table summary="tab bar" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="6"><img alt="" height="8" width="6" src="../skin/images/spacer.gif"></td><td valign="bottom">
<table summary="selected tab" style="height: 1.8em" border="0" cellpadding="0" cellspacing="0">
<tr>
<td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-left.gif"></td><td valign="middle" bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica, Sans-serif"><b><a class="base-selected" href="../index.html">Home</a></b></font></td><td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="../skin/images/tabSel-right.gif"></td>
</tr>
</table>
</td>
</tr>
</table>
</div>
<!--================= end Tabs ==================-->
</td><td bgcolor="#294563"><img alt="" width="1" height="1" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td bgcolor="#4C6C8F" colspan="4"><img width="1" height="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
</table>
<!--================= end Banner ==================-->
<!--================= start Menu, NavBar, Content ==================-->
<table summary="page content" bgcolor="#ffffff" width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td valign="top">
<table summary="menu" border="0" cellspacing="0" cellpadding="0">
<tr>
<!--================= start left top NavBar ==================-->
<td rowspan="3" valign="top">
<table summary="blue line" border="0" cellpadding="0" cellspacing="0">
<tr>
<td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td bgcolor="#CFDCED"><font color="#4C6C8F" size="4" face="Arial, Helvetica, Sans-serif"> </font></td>
</tr>
<tr>
<td bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
</table>
</td>
<!--================= end left top NavBar ==================--><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap" valign="top" bgcolor="#4C6C8F">
<!--================= start Menu items ==================-->
<div class="menu">
<ul>
<li>
<font color="#CFDCED">Translations</font>
<ul>
<li>
<a href="../index.html">Main Index</a>
</li>
<li>
<span class="sel"><font color="#ffcc00">Guidelines</font></span>
</li>
</ul>
</li>
<li>
<font color="#CFDCED">Languages</font>
<ul>
<li>
<a href="es/index.html">Spanish</a>
</li>
<li>
<a href="de/index.html">German</a>
</li>
<li>
<a href="http://www.terra-intl.com/jakarta/poi/">Japanese</a>
</li>
</ul>
</li>
</ul>
</div>
<!--================= end Menu items ==================-->
</td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td valign="bottom" align="left" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-left.gif"></td><td bgcolor="#4C6C8F"><img height="10" width="10" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td valign="bottom" align="right" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="../skin/images/menu-right.gif"></td>
</tr>
<tr>
<td height="1" bgcolor="#294563"><img width="1" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
</table>
</td><td valign="top" width="100%">
<table summary="content" width="100%" border="0" cellpadding="0" cellspacing="0">
<!--================= start middle NavBar ==================-->
<tr>
<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td align="left" width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td align="left" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
</font><img width="10" height="8" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td align="right" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
</font><img width="10" height="8" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<tr>
<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<!--================= end middle NavBar ==================-->
<!--================= start Content==================-->
<tr>
<td align="left" width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td><td colspan="2" align="left" width="100%">
<div class="content">
<table class="title" summary="">
<tr>
<td valign="middle">
<h1>Welcome to POI</h1>
</td><td nowrap="nowrap" width="40" align="center"><a class="dida" href="guidelines.pdf"><img alt="PDF" src="../skin/images/pdfdoc.gif" class="skin"><br>
PDF</a></td>
</tr>
</table>
<ul class="minitoc">
<li>
<a href="#Purpose">Purpose</a>
</li>
<li>
<a href="#Introduction">Introduction</a>
</li>
<li>
<a href="#Credits">Credits</a>
</li>
<li>
<a href="#Starting+a+new+translation">Starting a new translation</a>
</li>
<li>
<a href="#Need+help%3F">Need help?</a>
</li>
<li>
<a href="#Translation+Conventions">Translation Conventions</a>
</li>
</ul>
<a name="N10015"></a><a name="Purpose"></a>
<h3>Purpose</h3>
<div style="margin-left: 0 ; border: 2px">
<p>This document hopes to serve as a general introduction and helpful set of
guidelines for translating POI documentation into other languages. We hope
to capture both general information here (such as "how do I test my changes")
as well as language specific guidelines and translation conventions.</p>
</div>
<a name="N1001E"></a><a name="Introduction"></a>
<h3>Introduction</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
POI's XML based documentation is built along side the sources. To build poi's documentation
you run "./build.sh docs" (UNIX/cygwin) or "build docs" (Windows) from the jakarta-poi
directory. This will put the documentation under the build/docs directory, you can navigate
there using your browser generally by typing in the path name or File -> Open new web location
(or some similar wording)
and browsing to the "index.html" file. You may also want to run "./build.sh clean docs" or
"build clean docs" so that all documentation previously built is erased before running the build.
The words "clean" and "docs" are called "targets", from here on out we will refer to them as
"targets" in which case you may assume you type "./build.sh" or "build" before them in order to
execute them.
</p>
<p>
To generate all of teh documentation such as it would appear on the
<a href="http://jakarta.apache.org/poi">POI Website</a> you can execute the "site" target (optionally
preceeded by the "clean" target.
</p>
<p>
The source for POI's XML documentation is in src/documentation/xdocs. To edit one of these files you can use
a standard text editor. Translated documentation is under src/documentation/xdocs/trans/xx, where xx is a
two to three letter country code, in general this should match the internet domain suffix of the country where
that language generally evolved or just be generally recognizable and unique. The directory structure under
src/documentation/trans/xx should match the structure of src/documentation (the English edition) minus the
trans directory.
</p>
<p>
The translated documentation should match the content and meaning of the "master" or English documentation.
All documentation should originate in English (this is for simplicity). While documentation written in other
languages is certainly welcome, it must first be translated (perhaps by posting it to the mail list and
requesting it be translated) into English and applied to the master before being applied to a translation.
</p>
<p>
We prefer you donate translations directly to the <a href="http://jakarta.apache.org/poi">Jakarta POI</a>
project rather than hosting them offsite. We will make every effort to accomidate you as we greatly appreciate your
efforts. However, we understand that sites located within a country are the fastest and most searchable. Therefore,
we recommend and welcome folks mirroring the POI site and making the translated page the home page. You can do this
either via an HTML copy with some <a href="http://httpd.apache.org/info/how-to-mirror.html">appropriate software</a>
or the preferred method of executing the POI build directly. You can contact us via the mail list for both push and
pull options. The same scripts which regenerate the POI website every 2 hours, should work for others. These are not
yet in CVS as they are nasty dirty shell scripts ;-). If you mirror us, tell us so we can link you. (This will help google
associate you strongly with the project)
</p>
<p>
Submitting translations is simple, you follow the same
<a href="http://jakarta.apache.org/poi/getinvolved/index.html">instructions</a> as you would for submitting a code patch.
Remeber to always generate patchs in diff -u format preserving the context relative to the jakarta-poi directory. Also remember
to submit any new files in a directory preserving archive format. Never post these to the list, always use
<a href="http://nagoya.apache.org/bugzilla/buglist.cgi?product=POI&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr">Bugzilla</a>
and create attachments per the above linked instructions.
</p>
</div>
<a name="N1004A"></a><a name="Credits"></a>
<h3>Credits</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
Some people feel uncomfortable putting themselves in the <authors> tags at the top of the documentation as they feel that
translation does not give them the right to claim authorship. Please don't feel this way, please add yourself to the authors
tags. It can be assumed that authors on the master documentation are all content creators and any additional authors listed
on the translation that are not on the master document are translators of the documentation. You authored the xx language
version of the document and should freely add yourself there. Additionally, please supply a patch to the
<a href="../who.html">Who We Are</a> page noting you as a developer once you've submitted a few translation patches. You deserve
credit and it helps the project to give you credit. Remember documentation is on par with code contribution.
</p>
</div>
<a name="N10057"></a><a name="Starting+a+new+translation"></a>
<h3>Starting a new translation</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
To start a translation for a language not already in existance you must create a directory under src/documentation/xdocs/trans with a
two or three letter designation of the country where the language originated. (For example es = Spanish, de = German)
Copy the book.xml and index.xml file from src/documentation/xdocs directory into the src/documentation/xdocs/trans/xx directory.
Change all paths in the book.xml and index.xml to match the relative location of the English version. For example if there is a
link in index.html that references ./poifs/index.html, you'd change that to ../../poifs/index.html (up 2 directories from trans/xx).
Create a link from the book.xml file in the src/documentation/trans directory (this is necessary or the build will ignore your
documentation) similar to the other languages.
Run the clean target followed by the docs target. If the build is successful, congradulations! If it fails, you probably got one of
the relative paths incorrect! Go fix it (the first error message generally contains the most useful information). If you need help
post to the poi-dev list and ask for it (send the output from the build).
</p>
<p>
So now you have a directory with a copy of the index from the master documentation...so what? Well now translate book.xml and index.xml.
Try to build again. It probably won't work. Why? The encoding. At the top of every file there is an encoding="UTF-8" (in general).
This encoding will work for many Western European languages, but not for others, or will require some nasty escape sequencing. This is
where trial and error + guess work come in. This <a href="http://www.ibiblio.org/xml/books/xmljava/chapters/ch03s03.html#encoding_table">Table of encodings</a> may help. There is a
catch. Your encoding should work on a Linux system under Java 1.3.1 and of course with the build in general. If in doubt, ask.
(This is a practical consideration as thats the setup of the machine currently running the nightly/site builds.)
</p>
</div>
<a name="N10067"></a><a name="Need+help%3F"></a>
<h3>Need help?</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
Andy Oliver is the cofounder of the POI project and one of its most active documentation contributers. Well, Andy used to think he
spoke very clearly until he traveled abroad and discovered his speech was composed almost entirely of coloquialisms. This can make some
of the POI documentation difficult to translate, if in doubt...ask. Its also appropriate to eliminate these from the master documentation
where it makes it clearer.
</p>
</div>
<a name="N10070"></a><a name="Translation+Conventions"></a>
<h3>Translation Conventions</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
In addition to the above practical guidelines we hope to come up with a set of translation guidelines here (or linked from here) for
general use as well as language specific translation guidelines and conventions. We assume that the POI translators will document
them here as they develop.
</p>
</div>
<div class="attribution">by Andrew C. Oliver</div>
</div>
</td><td width="10"><img width="10" height="1" alt="" src="../skin/images/spacer.gif" class="spacer"></td>
</tr>
<!--================= end Content==================-->
</table>
</td>
</tr>
</table>
<!--================= end Menu, NavBar, Content ==================-->
<!--================= start Footer ==================-->
<table summary="footer" cellspacing="0" cellpadding="0" width="100%" border="0">
<tr>
<td colspan="2" height="1" bgcolor="#4C6C8F"><img height="1" width="1" alt="" src="../skin/images/spacer.gif" class="spacer"><a href="../skin/images/label.gif"></a><a href="../skin/images/page.gif"></a><a href="../skin/images/chapter.gif"></a><a href="../skin/images/chapter_open.gif"></a><a href="../skin/images/current.gif"></a><a href="/favicon.ico"></a></td>
</tr>
<tr>
<td colspan="2" bgcolor="#CFDCED" class="copyright" align="center"><font size="2" face="Arial, Helvetica, Sans-Serif">Copyright ©
2003 The Apache Software Foundation. All rights reserved.<script type="text/javascript" language="JavaScript"><!--
document.write(" - "+"Last Published: " + document.lastModified);
// --></script></font></td>
</tr>
<tr>
<td colspan="2" align="left" bgcolor="#CFDCED" class="logos"></td>
</tr>
</table>
<!--================= end Footer ==================-->
</body>
</html>
|
