Annotation of www/translation-explained.html, Revision 1.22
1.1 saad 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2: "http://www.w3.org/TR/html4/loose.dtd">
3: <html>
4: <head>
5: <title>Contributing to the OpenBSD Translation Effort</title>
6: <link rev="made" href="mailto:www@openbsd.org">
7: <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
8: <meta name="resource-type" content="document">
9: <meta name="description" content="Contributing to the OpenBSD Translation effort">
10: <meta name="keywords" content="openbsd,translation,documentation">
11: <meta name="distribution" content="global">
1.19 saad 12: <meta name="copyright" content="This document copyright 2000-2008 by OpenBSD.">
1.1 saad 13: </head>
14:
15: <body bgcolor="#FFFFFF" text="#000000" link="#23238E">
16: <a href="index.html"><img alt="[OpenBSD]" height="30" width="141" src="images/smalltitle.gif" border="0"></a>
17: <!-- Passes validator.w3.org, please keep it this way;
18: please, use a max of 72 chars per line -->
19:
1.2 saad 20: <!-- NOTE TO TRANSLATORS
21: As obvious as it may seem, this page must NOT be translated
22: -->
23:
1.5 saad 24: <h2><font color="#e00000">Contributing to the OpenBSD Translation
25: Effort</font></h2>
1.1 saad 26:
27: <hr>
28:
29: <center>
30: <cite>?Nec verbum verbo curabis reddere fidus interpres?</cite>
31: </center>
32:
33: <hr>
34:
35: <h3>Table Of Contents</h3>
36: <ul>
37: <li><a href="#Intro">Introduction</a>
38: <li><a href="#Purpose">Purpose</a>
39: <li><a href="#Maintenance">Maintenance</a>
40: <li><a href="#Joining">Joining the Translation Team</a>
41: <li><a href="#CVS">Using CVS</a>
42: <li><a href="#Guidelines">Translation Guidelines</a>
43: </ul>
44:
45: <hr>
46:
47: <h3><font color="#0000e0"><a name="Intro">Introduction</a></font></h3>
48:
49: <p>
1.6 saad 50: This document should contain all the information you need to
1.1 saad 51: contribute to the OpenBSD translation effort as described in <a
1.3 saad 52: href="translation.html">Translation of the OpenBSD documentation</a>.
53: Please read this document carefully and if you still have questions,
54: don't hesitate to contact <a href="translation.html#WHO">the translation
1.1 saad 55: coordinators</a>.
56:
57: <p>
58:
59: <h3><font color="#0000e0"><a name="Purpose">Purpose</a></font></h3>
60:
61: <p>
62: The purpose for translating
63: <a href="http://www.openbsd.org/">OpenBSD</a> web pages and other
64: documents is to help those who don't speak nor understand English use
65: OpenBSD or, if they do, they might feel more comfortable through reading
66: in their own language. So, by translating you are not only helping the
67: <a href="http://www.openbsd.org/">OpenBSD project</a> to expand, but you
68: are also helping people to become hooked to the system.
69:
70: <p>
71: And of course, you'll gain good knowledge through reading and
72: translating at the same time.
73:
74: <p>
75: It's important to note that besides <a
76: href="http://www.openbsd.org/">OpenBSD</a>, the OpenBSD project has
77: several websites for associated projects that you may want to translate:
78: <ul>
79: <li><a href="http://www.openssh.com/">OpenSSH</a>
80: <li><a href="http://www.openntpd.com/">OpenNTPD</a>
81: <li><a href="http://www.openbgpd.com/">OpenBGPD and OpenOSPFD</a>
82: <li><a href="http://www.opencvs.com/">OpenCVS</a>
83: </ul>
84:
85: <h3><font color="#0000e0"><a name="Maintenance">Maintenance</a></font></h3>
86:
87: <p>
88: Just translating a few web pages, or even translating the whole site
1.3 saad 89: including the <a href="faq/">F.A.Q.</a>, is <strong>ABSOLUTELY
90: NOT</strong> enough. Actually, you could be doing more wrong than good.
91: <strong>Maintaining the translation up to date is just as
92: important</strong>. Always remember that offering outdated information
93: will just misguide people.
1.1 saad 94:
95: <p>
96: If you are not going to keep your work updated, the translation itself
97: will be pointless. Join us only if you think you're going to commit
98: yourself to your work.
99:
100: <p>
101: <strong>Think first how much time you will be able to dedicate to the
102: translation. If you only have some small spare time, don't go overboard
1.6 saad 103: by translating several files you won't be able to maintain
1.1 saad 104: later.</strong>
105:
106: <p>
107: Some files are easier to maintain than others, either because they are
108: small, or because they don't get updated too often. For instance, <a
1.3 saad 109: href="plat.html">plat.html</a> is a small file, and it doesn't get
110: modified often. On the opposite side, <a href="plus.html">plus.html</a>
111: is a heavy file to translate; it grows bigger and bigger from one
1.6 saad 112: release to another, and the technical and slang wording used is
1.3 saad 113: very difficult to translate with accuracy.
1.1 saad 114:
115: <p>
1.6 saad 116: Needless to say, some files take precedence over others. Such is the
1.3 saad 117: case of <a href="index.html">index.html</a> ... or did you think
118: otherwise?
1.1 saad 119:
120: <h3><font color="#0000e0"><a name="Joining">Joining the Translation
121: Team</a></font></h3>
122:
123: <p>
124: Before joining the translation team, you must make sure that you have
1.6 saad 125: the proper environment for translation. The required environment consists
126: of the following elements:
1.1 saad 127: <ul>
128: <li>an OpenBSD box running a <strong>stable</strong> and
129: <strong>maintained</strong> release
130: <li>OpenSSH
131: <li>CVS
132: <li>a text editor such as vi, vim, mg, etc.
133: <li>an HTML link checker such as linkchecker (available in the ports
134: collection)
135: <li>an HTML validation program such as validate (available in the ports
136: collection)
137: </ul>
138:
139: <p>
140: Once you have the proper environment, you need commit access to the
141: Steelix CVS repository if you want to commit your work directly.
142: Otherwise, you can send them to another translator or one of the
143: translation coordinators to commit them for you (with due credit of
144: course). See <a href="translation.html#WHO">Who is doing this?</a> for
145: more information about the translators and translation coordinators.
146:
147: <p>
148: The Steelix CVS repository, located at <em>steelix.kd85.com</em> is the
149: CVS repository used for translation. The translation work is not
150: committed directly to the OpenBSD CVS repository. Rather, the
151: translation coordinators synchronize the two repositories on a timely
152: basis after checking the new commits.
153:
154: <p>
155: To commit on the Steelix CVS repository you will need an account on
156: <em>steelix.kd85.com</em>. To setup your account, contact one of the
157: <a href="translation.html#WHO">translation coordinators</a>. If he
158: agrees on giving you an account, you will need to give him the following
159: information by email:
160: <ul>
161: <li>Your full name (first name, last name). No surname/scene name is
162: accepted.
163: <li>A permanent email address on which you can be contacted regarding
164: translation work.
1.6 saad 165: <li>A list of three Unix account names sorted by order of preference.
1.1 saad 166: <li>Your SSH2 DSA public key as an attached file and its SHA-1
167: associated hash. A minimum length of 1024 bits is required for the
168: key.
169: </ul>
170:
171: <p>
172: <strong><font color="#ff0000">Warning:</font></strong> you are fully
173: responsible for the security of your working environment and your SSH2
174: DSA key.
175:
176: <p>
177: Our experience shows that some people request an account, commit some
178: work and then vanish without giving any good reason. Creating your
179: account and maintaining the account database is extra work for the
180: translation coordinators. So they might ask you to send the files to
1.6 saad 181: another translator who will validate your work and your commitment to
1.1 saad 182: the translation effort. This way, we make sure you are here to stay.
183:
184: <p>
185: Once a translation coordinator creates your account, he will notify you
186: by email. The final step before starting to use the CVS repository is to
1.15 saad 187: join <i>wwwcvs@docisland.org</i>, the translation mailing list. This
188: is a closed mailing list on which all changes made to the
1.1 saad 189: Steelix CVS repository along with any translation related discussions
190: are posted. To join, please send an email to
1.15 saad 191: <i>wwwcvs-request@docisland.org</i> with a body containing <i>subscribe</i>.
1.1 saad 192:
193: <h3><font color="#0000e0"><a name="CVS">Using CVS</a></font></h3>
194:
195: <p>
196: Now we'll walk you through the basic CVS operations you need to perform
197: as a translator. If you want to have a more in-depth look into CVS
198: usage, please see the
199: <a href="http://www.openbsd.org/cgi-bin/man.cgi?query=cvs&sektion=1">cvs</a>
200: manual page and read
201: <a href="http://cvsbook.red-bean.com/">Open Source Development with CVS,
202: 3rd Edition</a>, a free CVS online book by Karl Fogel and Moshe Bar.
203:
204: <p>
205: You must have a fresh checkout (<em>CVS download</em>, also called a
206: <i>working copy</i> in CVS terminology) of two CVS modules on your disk.
207: These are:
208: <ul>
209: <li>The <i>www translation</i> CVS module. This module must be obtained
210: from <i>steelix.kd85.com</i>, the OpenBSD translation CVS server.
211: This is the module on which all translation work happens.
212: <li>The <i>www</i> CVS module. This module must be obtained from one of
213: the many <a href="anoncvs.html"> anonymous OpenBSD CVS mirrors</a>
1.6 saad 214: out there. This will be your source for the original English files
1.1 saad 215: that you need to translate.
216: </ul>
217:
218: <p>
219: <strong><font color="#ff0000">Note:</font></strong> while the <i>www
1.6 saad 220: translation</i> CVS module holds also the English files, they must not
221: be used since they are rarely kept in sync with the English files found
1.1 saad 222: on the anonymous OpenBSD CVS mirrors.
223:
224: <p>
225: The checkouts and later operations are performed using SSH for
226: transport, as you might have guessed after reading the <a
227: href="#Joining">Joining the Translation Team</a> section.
228:
229: <p>
230: Let's see how the checkouts are performed.
231:
232: <h4>Initial checkout of the 'www translation' CVS module</h4>
233: We will assume that you are going to put all the translation work files
234: and directories under <i>/home/username/devel/openbsd/</i>. Of course,
235: this is absolutely not a requirement. This scheme is solely used for the
236: examples below. Change as needed.
237:
238: <p>
239: Issue the following commands to checkout the <i>www translation</i> CVS
240: module from <i>steelix.kd85.com</i>:
241:
242: <pre>
243: $ cd /home/username/devel/openbsd/
1.7 saad 244: $ cvs -d "username@steelix.kd85.com:/cvs" checkout -d "steelix-www" www
1.1 saad 245: </pre>
246:
247: <p>
248: The latter command will connect to <i>steelix.kd85.com</i> using SSH as
249: user <i>username</i> to retrieve a working copy of the <i>www
250: translation</i> CVS module and store it under <i>steelix-www</i>.
251:
252: <p>
253: The SSH authentication is set up to use your SSH2 key, which requires
254: you to enter your passphrase to proceed. SSH is used for checkout and
255: all other CVS operations. By default, this will ask you everytime for
256: your passphrase. To save some typing, you might want to load your SSH2
257: private key in
258: <i><a
259: href="http://www.openbsd.org/cgi-bin/man.cgi?query=ssh-agent&apropos=0&sektion=0&manpath=OpenBSD+Current&arch=i386&format=html">ssh-agent</a></i> using <i>keychain</i> (available in the ports collection) or some
260: home-cooked recipe.
261:
262: <p>
263: After successfully entering your passphrase, CVS will proceed with
264: checking out your working copy. Depending on your connection speed, this
265: operation may take some time to complete.
266:
267: <p>
268: Once the checkout terminates, you will have a <strong>working copy of
269: the www translation CVS module</strong>.
270:
271: <h4>Initial checkout of the 'www' CVS module</h4>
272: To obtain a working copy of the <i>www</i> CVS module, you need to find
1.7 saad 273: an OpenBSD anonymous CVS mirror near you that is updated frequently.
1.1 saad 274: Suppose you are located in Germany. According to the <a
275: href="anoncvs.html">OpenBSD AnonCVS</a> page,
1.14 grunk 276: <i>anoncvs.de.openbsd.org</i> looks like a good candidate. It is
1.1 saad 277: maintained by one of the OpenBSD developers (Alexander von Gernler) and
278: updated every 2 hours. Moreover, it offers CVS through SSH. Let's use it
279: to obtain the working copy of the <i>www</i> CVS module:
280:
281: <pre>
282: $ cd /home/username/devel/openbsd
1.14 grunk 283: $ cvs -d "anoncvs@anoncvs.de.openbsd.org:/cvs" checkout -d "openbsd-www" www
1.1 saad 284: </pre>
285:
286: <p>
287: The latter command will connect to
1.14 grunk 288: <i>anoncvs@anoncvs.de.openbsd.org</i> using SSH as user <i>anoncvs</i>
1.1 saad 289: to retrieve a working copy of the <i>www </i> CVS module and store it
290: under <i>openbsd-www</i>. SSH won't ask for authentication since we are
291: using an anonymous CVS account. Depending on your connection speed, this
292: operation may take some time to complete.
293:
294: <p>
295: Once the checkout terminates, you will have a <strong>working copy of
296: the www CVS module</strong>.
297:
298: <h4>Organization of the 'www' CVS module</h4>
299: <a name="sections"></a>
300: The <i>www</i> CVS module that the OpenBSD and associated projects'
1.12 steven 301: websites are made of is constituted of ten sections.
302: The table below lists all these sections and what they represent.
1.1 saad 303:
304: <p>
1.12 steven 305: <table border="1">
306: <tr valign="top"><td>
1.1 saad 307: <strong>[base]</strong>
1.12 steven 308: </td><td>
1.1 saad 309: <a href="http://www.openbsd.org/">http://www.openbsd.org/</a> and
310: everything under it <strong>except</strong> for the FAQ available at
1.3 saad 311: <a href="faq/">http://www.openbsd.org/faq/</a>.
1.12 steven 312: </td></tr><tr valign="top"><td>
1.1 saad 313: <strong>[faq]</strong>
1.12 steven 314: </td><td>
1.3 saad 315: <a href="faq/">http://www.openbsd.org/faq/</a>
1.1 saad 316: and everything under it <strong>except</strong> for the PF User Guide
317: available at
1.4 saad 318: <a href="faq/pf/">http://www.openbsd.org/faq/pf/</a>.
1.12 steven 319: </td></tr><tr valign="top"><td>
1.1 saad 320: <strong>[openbgpd]</strong>
1.12 steven 321: </td><td>
1.1 saad 322: <a href="http://www.openbgpd.org/">http://www.openbgpd.org/</a>
323: and the associated subdirectories.
1.12 steven 324: </td></tr><tr valign="top"><td>
1.1 saad 325: <strong>[opencvs]</strong>
1.12 steven 326: </td><td>
1.1 saad 327: <a href="http://www.opencvs.org/">http://www.opencvs.org/</a>
328: and the associated subdirectories.
1.12 steven 329: </td></tr><tr valign="top"><td>
1.1 saad 330: <strong>[openntpd]</strong>
1.12 steven 331: </td><td>
1.1 saad 332: <a href="http://www.openntpd.org/">http://www.openntpd.org/</a>
333: and the associated subdirectories.
1.12 steven 334: </td></tr><tr valign="top"><td>
1.1 saad 335: <strong>[openssh]</strong>
1.12 steven 336: </td><td>
1.1 saad 337: <a href="http://www.openssh.com/">http://www.openssh.com/</a>
338: and the associated subdirectories <strong>except</strong> the usage
339: subdirectory.
1.12 steven 340: </td></tr><tr valign="top"><td nowrap="nowrap">
1.1 saad 341: <strong>[openssh-usage]</strong>
1.12 steven 342: </td><td>
1.1 saad 343: <a href="http://www.openssh.com/usage/">http://www.openssh.com/usage/</a>.
1.12 steven 344: </td></tr><tr valign="top"><td>
1.1 saad 345: <strong>[papers]</strong>
1.12 steven 346: </td><td>
1.3 saad 347: <a href="papers/">http://www.openbsd.org/papers/</a> and the associated
348: subdirectories.
1.12 steven 349: </td></tr><tr valign="top"><td>
1.1 saad 350: <strong>[pf]</strong>
1.12 steven 351: </td><td>
1.3 saad 352: <a href="faq/pf/">http://www.openbsd.org/faq/pf/</a> and everything
353: under it.
1.12 steven 354: </td></tr><tr valign="top"><td>
1.1 saad 355: <strong>[porting]</strong>
1.12 steven 356: </td><td>
1.3 saad 357: <a href="porting/">http://www.openbsd.org/porting/</a> and the
358: associated subdirectories.
1.12 steven 359: </td></tr>
360: </table>
1.1 saad 361:
362: <p>
363: Translated pages in a given language for a given section are located
364: under a subdirectory in that section. The subdirectory name is the
365: two-letter
366: <a href="http://lcweb.loc.gov/standards/iso639-2/englangn.html">ISO 639-1 language code</a>
367: of the language. For example, french [faq] pages are located under
1.3 saad 368: <a href="faq/fr/">http://www.openbsd.org/faq/fr/</a>.
1.1 saad 369:
370: <p>
371: The <i>www translation</i> CVS module is organized in an identical
1.7 saad 372: fashion. While the <i>www</i> CVS module is your source for the English
1.1 saad 373: original files that you need to translate or sync against, the <i>www
374: translation</i> CVS module will host all your translation work as we
375: mentioned earlier.
376:
377: <h4>Working on the 'www translation' module</h4>
378: You <strong>must not</strong> touch any file within the first level of
379: any <a href="#sections">section</a> of the <i>www translation</i> CVS
380: module. If, by mistake, you edited and modified one of the files in the
381: first level, don't edit it back to reverse those changes, the timestamps
382: will have changed and you will mess the remote repository next time you
1.6 saad 383: <kbd>'cvs up -PAd'</kbd> followed by <kbd>'cvs commit'</kbd>. Instead,
1.1 saad 384: just <kbd>rm -f</kbd> that file and follow the instructions to <a
385: href="#update">update</a>. An update from the CVS repository will
1.6 saad 386: restore that file in your working copy. Likewise, avoid changing the
1.1 saad 387: files from languages other than yours.
388:
389: <p>
390: You must do your work within your language directory. If it doesn't
391: exist yet, you can read how to <a href="#add">add</a> a new directory
392: or file in the next section.
393:
394: <p>
395: Thus, for a given language such as Spanish, the language directory will
396: be denoted by the two-letter
397: <a href="http://lcweb.loc.gov/standards/iso639-2/englangn.html">ISO
398: 639-1 language code</a>, <i>es/</i> in this case, and files will be
399: organized as follows:
400: <ul>
401: <li><em>steelix-www/es/</em> - www.openbsd.org/es/ files.
402: <li><em>steelix-www/faq/es/</em> - www.openbsd.org/faq/es/ files.
403: <li><em>steelix-www/openssh/es/</em> - www.openssh.com/es/ files.
404: <li>...
405: </ul>
406:
407: <p>
408: This is important to remember as far as relative <a
409: href="#Links">links</a> go.
410:
411: <a name="add"></a>
412: <h4>Adding directories and files</h4>
413: Suppose that there was no Spanish directory as yet under the
414: <strong>[pf]</strong> section. We would create it first on our local
415: repository:
416:
417: <pre>
418: $ cd ~/devel/openbsd/steelix-www/faq/pf
419: $ mkdir es
420: </pre>
421:
422: and then we would have to <strong>add</strong> it to the CVS repository:
423:
424: <pre>
1.5 saad 425: $ cvs add es
1.1 saad 426: </pre>
427:
428: <p>
1.7 saad 429: That was easy. Next we would copy an English original file that we would
1.1 saad 430: like to translate from the <i>www</i> module (e.g.
431: <i>openbsd-www/faq/pf/index.html</i>) into the es/ directory and would
432: add it as well:
433:
434: <pre>
435: $ cd ~/devel/openbsd
436: $ cp -p openbsd-www/faq/pf/index.html steelix-www/faq/pf/es/
437: $ cd steelix-www/faq/pf/es
438: $ cvs add index.html
439: </pre>
440:
441: <p>
442: <strong>Note<sup>(1)</sup></strong>: while <kbd>cvs add</kbd>'ing a
443: directory will change the remote repository straight away, it won't do
444: so if we were adding a file until we run the <a
445: href="#commit">commit</a> command.
446:
447: <p>
1.6 saad 448: <strong>Note<sup>(2)</sup></strong>: see the <kbd>rm</kbd> command in the
449: CVS manual page to know how to remove a file or directory.
1.1 saad 450:
451: <a name="update"></a>
452: <h4>Updating files</h4>
1.6 saad 453: If, while in the <em>steelix-www/</em> directory, we ran the command and
454: options:
1.1 saad 455:
456: <pre>
457: $ cd ~/devel/openbsd/steelix-www
458: $ cvs up -PAd
459: </pre>
460:
461: the effect would be twofold:
462:
463: <ul>
464: <li>All changes made by others to the <i>www translation</i> module on
465: the CVS repository would be automatically applied to our working
466: copy. The working copy <strong>will</strong> change.
467: <li>All changes made by us to our working copy <em>would be ready to be
468: "uploaded"</em> to the CVS repository. The <i>www translation</i>
469: module on the CVS repository <strong>will not</strong> change until
470: we run the <a href="#commit">commit</a> command.
471: </ul>
472:
473: <p>
474: <strong>Note:</strong> it is suggested to run this command before we
475: start making changes to our working copy, so we can see what changes
476: have been made by others and avoid conflicts.
477:
478: <a name="commit"></a>
479: <h4>Committing changes</h4>
480: This is the mother of all commands:
481:
482: <pre>
483: $ cd faq/pf/es
484: $ cvs commit
485: </pre>
486:
487: <p>
488: This command will load an editor such as <i>vi</i> so you can enter a
489: commit message. This message will allow others to have an idea of the
490: change(s) that you've made. It is automatically posted to the
491: translation mailing list.
492:
493: <p>
494: Needless to say that you only commit when you feel your changes should
1.6 saad 495: definitely go into the <i>www translation</i> of the CVS repository.
1.1 saad 496:
497: <a name="revert"></a>
498: <h4>Reverting a change</h4>
1.9 saad 499: If you have committed a file and you discover that your commit breaks
500: something, you have to revert the commit as soon as possible. Assume the
501: problem lays in a file called <i>somefile</i>. Follow the procedure
502: below to revert it to an unbroken revision:
1.1 saad 503:
504: <pre>
1.9 saad 505: $ cvs log somefile
1.1 saad 506: </pre>
507:
508: <p>
509: At the top of the output, you can see the latest revision of the file
510: (your latest modifications). For example, <i>1.192</i>. You have to
511: checkout the previous revision and commit it to fix the issue.
512:
513: <pre>
1.9 saad 514: $ cvs update -A somefile
515: $ rm somefile
516: $ cvs update -p -r1.191 somefile > somefile
1.1 saad 517: </pre>
518:
519: <p>
1.9 saad 520: <i>1.191</i> is indeed the previous revision. It is now in your working
521: copy. You should commit it to restore the file to a working state:
1.1 saad 522:
523: <pre>
1.9 saad 524: $ cvs commit -m "restoring previous version" somefile
525: </pre>
526:
527: <a name="wrongdir"></a>
528: <h4>Committing in a bad directory</h4>
529: If you have committed a file in a bad directory, you have to fix things
530: by moving it to the right directory as soon as possible. Assume you have
531: committed <i>somefile</i> to <i>baddir</i> while it should really go
532: into <i>gooddir</i>. Here is the procedure to correct your mistake:
533:
534: <pre>
535: $ pwd
536: ...devel/openbsd/steelix-www/.../baddir
537: $ cvs remove somefile
538: $ mv somefile path/to/gooddir
539: $ cd path/to/gooddir
540: $ pwd
541: ...devel/openbsd/steelix-www/.../gooddir
542: $ cvs add somefile
543: $ cvs commit -m "move file to the right location" somefile
1.1 saad 544: </pre>
545:
546: <h3><font color="#0000e0"><a name="Guidelines">Translation
547: Guidelines</a></font></h3>
548:
549: <p>
1.7 saad 550: The following is a set of general translation guidelines that will help you
1.1 saad 551: get your job as a translator done correctly.
552:
553: <h4>Stick to translating the pages!</h4>
554: <strong>Although we really welcome any help to make the webpages better,
555: your job as a translator is _NOT_ to enhance the pages with pictures,
1.18 aanriot 556: tags, email addresses or anything else that hasn't been in the page
1.5 saad 557: before!</strong>
1.1 saad 558:
1.7 saad 559: <p>
1.8 saad 560: If you do have suggestions concerning the content of a page, send them
561: to <a href="mailto:www@openbsd.org">www@openbsd.org</a>. If they are
562: good, they can be included by one of the developers.
1.7 saad 563:
1.1 saad 564: <h4>Translation Tags</h4>
565: If you have freshly translated a page to your language you would like to
566: see it committed. And it should and will be maintained. To make this
567: easier and let everybody see who committed this page and follow changes
568: using CVS we use some special tags at the end of the page.
569:
570: <p>
571: We simply enhance the original $OpenBSD$ tag with two more
572: lines, in which we document from which version our translated file comes
573: from and which version of the translation it is.
574:
575: <p>
576: A typical OpenBSD ID tag looks like this:
577:
578: <pre><small>
579: $OpenBSD: index.html,v1.330 2001/04/24 07:11:44 jufi Exp $
580: <small>
581: </pre>
582:
583: From this, you must change the opening and closing <tt>$</tt>'s and
584: change them to an opening ``<tt>Originally [</tt>'' and closing
585: ``<tt>]</tt>'', and add a <tt>$Translation$</tt> and an
586: <tt>$OpenBSD$</tt> ID tags. Since the <tt>Originally</tt> and
587: <tt>$Translation$</tt> tags are used by translators only, you
588: must comment them so they don't appear when the pages are displayed on a
589: browser:
590:
591: <pre><small>
592: <!--
1.6 saad 593: Originally [OpenBSD: index.html,v 1.330 ]<br>
1.1 saad 594: $Translation$<br>
595: -->
596: $OpenBSD$
597: </small>
598: </pre>
599:
600: Notice that we've also added the <tt><br></tt> tags here, which
601: are needed to have each ID tag on a separate line of its own. And we've
602: also stripped off part of the original OpenBSD ID tag, as that bit is
603: not really needed.
604:
605: <p>
606: As for the <tt>$Translation$</tt> and
607: <tt>$OpenBSD$</tt> tags, the Steelix and OpenBSD CVS servers
608: will take care of each respectively. So, next time you modify that file,
609: all you will have to do is to replace the content within the
610: <tt>Originally [blah... ]</tt> ID tag again.
611:
612: <p>
1.7 saad 613: But you should check from file to file whether everything is correct
614: and compare to other files, your own or even those from other languages.
1.1 saad 615:
616: <p>
617: <strong><font color="#ff0000">Note:</font></strong> the amount and
1.7 saad 618: positions of spaces and words in the tags are absolutely precise and not
619: to be changed!
1.1 saad 620: Otherwise you will find your file not recognized correctly by the
1.17 saad 621: scripts which build the
1.22 ! tobias 622: <a href="http://steelix.bsdfrog.org/status/makereport.html">status page</a>!
1.1 saad 623:
624: <p>
625: It is really helpful to have a look at the pages of the other
626: translators, and watch how they did it.
627:
1.13 saad 628: <h4>Meta tags</h4>
629: Meta tags must not be translated or modified, save for the
630: <strong>title</strong> tag which must be translated of course.
631:
1.1 saad 632: <a name="Links"></a>
633: <h4>Links</h4>
634: When translating a file from the original English html file to another
635: language, we also need to change the relative links to have them point
636: to the right file they reference.
637:
638: <p>
639: As a first example, let's suppose you are translating the
640: <i>index.html</i> file, and you find a link to the orders.html file like
641: this:<br> <tt><strong><a href="orders.html">orders.html</a></strong></tt>.
642:
643: <p>
644: This means that it will link <em>index.html</em> to
645: <em>orders.html</em> <strong>if they are in the same directory
646: level!</strong>. So, if you dont have an <em>orders.html</em> file
647: translated yet in your language directory, it will point to a non-
648: existent file. Just go one directory back to link it to the file in the
649: English directory for this example case:<br> <tt><strong><a
650: href="../orders.html">orders.html</a></strong></tt>.
651:
652: <p>
653: When you have the <em>orders.html</em> file translated and already in
654: your language directory, you can then strip the
1.7 saad 655: <tt><strong>../</strong></tt> off and let it point to the file in your
656: directory.
1.1 saad 657:
658: <p>
659: For a file in the <em>faq/</em> directory, this is a bit different,
660: since your language directory will be something like <em>faq/de/</em>.
661: So, if you were translating <em>faq1.html</em> and found a link to the
662: <em>faq2.html</em> like this:<br>
663: <tt><strong><a href="faq2.html">faq2.html</a></strong></tt>
664:
665: <p>
666: you would have to go back one level as in the previous example to link
667: to the English file (or none if you already have faq2.html translated in
668: your language directory).<br> BUT, if you had to link from your faq
669: language directory to a file, say, in the first level directory (e.g.
670: <em>orders.html</em>), you would have to go back <strong>2
671: levels</strong>:<br> <tt><strong><a
672: href="../../orders.html">orders.html</a></strong></tt>.
673:
674: <p>
675: AND, if <em>orders.html</em> were a translated file, then you would have
1.6 saad 676: to go back two levels and then one level forward to your language
1.1 saad 677: directory:<br> <tt><strong><a
678: href="../../de/orders.html">orders.html</a></strong></tt>.
679:
680: <p>
1.6 saad 681: We know this looks messy, but you will get used to it and the best you
1.1 saad 682: can do to avoid errors is to check links before you commit (and as you
683: are at it, also check the id tags).
684:
685: <p>
686: One final note on links: links must *always* be relative, except for
687: external links and links from www.OpenBSD.org to www.OpenSSH.com and
688: vice versa.
689:
690: <h4>Links to images</h4>
691: You'll find most images inside the <em>images/</em> directory. In fact,
692: all images are kept in there, except for <em>back.gif</em>, which is
693: <em>openbsd-www/back.gif</em>.
694:
695: <p>
696: This means that when a file is translated and goes into its language
697: directory, the links to the images <i>must</i> be changed too. So, the
698: most commonly used image on the website looks like this on any original
699: file:
700:
701: <pre><a href="index.html"><img height="24" width="24" src=<strong>"back.gif"</strong> alt="OpenBSD"></a>
702: </pre>
703:
704: <p>
1.6 saad 705: but since the translated file will be placed in a different directory,
1.1 saad 706: you will have to change the link to <em>back.gif</em> to get it right:
707:
708: <pre><a href="index.html"><img height="24" width="24" src=<strong>"../back.gif"</strong> alt="OpenBSD"></a>
709: </pre>
710:
711: <p>
712: For the remaining cases, where images are kept in the <em>images/</em>
713: directory:
714:
715: <pre><a href="art1.html"><img border="0" src=<strong>"images/openbsd-logo.gif"</strong> height="195"
1.6 saad 716: width="520" alt="[OpenBSD 3.7]"></a>
1.1 saad 717: </pre>
718:
719: <p>
720: should be changed to:
721:
722: <pre><a href="art1.html"><img border="0" src=<strong>"../images/openbsd-logo.gif"</strong> height="195"
1.6 saad 723: width="520" alt="[OpenBSD 3.7]"></a>
1.1 saad 724: </pre>
725:
726: <p>
727: This is easy when dealing with normal web pages, but if the file is in
728: the <em>faq</em> or <em>openssh</em> directories, then you have to use
729: something like:
730:
731: <pre><a href="art1.html"><img border="0" src=<strong>"../../images/openbsd-logo.gif"</strong> height="195"
1.6 saad 732: width="520" alt="[OpenBSD 3.7]"></a>
1.1 saad 733: </pre>
734:
735: <h4>Accentuated letters</h4>
1.7 saad 736: Since some languages such as French make extensive use of accentuated
1.1 saad 737: letters, a translator must make sure that the accents on the letters are
1.7 saad 738: put in the right places and in the right styles (è not é
1.1 saad 739: in a word such as "problème"). The HTML code must not
1.6 saad 740: contain the accentuated letters in HTML codification format (such as
1.1 saad 741: "&eacute;" for "é").
742:
743: <h4>Punctuation</h4>
744: There are also differences in punctuation between English and other
1.7 saad 745: languages, and you need to respect them. Take French for example. The
1.1 saad 746: "!", "?", ":" signs always take a space
747: before and a space after as in "Le français est une
748: sacrée langue ! n'est-ce pas ?".
749:
750: <h4>Line wrapping</h4>
1.6 saad 751: Verify that your HTML editor wraps lines correctly at 80 columns. If your
1.1 saad 752: editor can't do that, there are other ways to do this such as using the
753: Text::Autoformat Perl module. We won't be accepting uncorrectly wrapped
754: files anymore since it requires non-wanted extra work from the
755: coordinators.
756:
757: <h4>English words</h4>
758: English words that cannot be easily translated or that should be kept
759: as-is for clarity must be double-quoted.
760:
1.13 saad 761: <h4>Quotes</h4>
762: Quotes from users, developers, and other people must not be translated.
763: Translating them, without changing meaning, is extremely difficult.
764:
1.1 saad 765: <h4>Spell checking</h4>
766: It is highly recommended to use a spell checker in order to validate
767: your work.
768:
769: <h4>Link checking</h4>
770: It is highly recommended to use a link checker such as the
771: <a href="http://linkchecker.sourceforge.net/">linkchecker</a> program
772: (available in the ports collection) to verify the links in the
773: translated files.
774:
775: <h4>Mistakes and typos in the original versions</h4>
776: As in any translation work, you may notice mistakes and/or typos in the
1.6 saad 777: original English version of the file that you are currently translating.
1.8 saad 778: Please report them back to <a
779: href="mailto:www@openbsd.org">www@openbsd.org</a>, so they can be fixed
780: by one of the developers. It really helps the project to keep up with
781: the quality standards it strives to maintain.
1.1 saad 782:
783: <h4>Translation status</h4>
1.17 saad 784: The
1.22 ! tobias 785: <a href="http://steelix.bsdfrog.org/status/makereport.html">OpenBSD
1.19 saad 786: Translation Status</a>
1.1 saad 787: status. It is generated hourly using <i>makereport</i>, a Perl script
788: that you can find in the <i>trtools</i> module on the Steelix CVS
789: repository. You can run <i>makereport</i> by yourself if you want to
790: have more frequent status updates or want to generate a status page only
791: for your language.
792:
1.11 steven 793: <h4>HTML tag differences report</h4>
1.21 tobias 794: The
1.22 ! tobias 795: <a href="http://steelix.bsdfrog.org/status/tagdiff.html"
1.11 steven 796: >OpenBSD Translation Tag Report</a> page helps translators keep their
797: pages correct with respect to the original versions. It reports any
798: differences found in HTML tags, except allowed differences such as
799: hyperlinks as explained above.
800: The report page contains more instructions on how you can use this tool.
801: A complete tag differences report is generated daily using <i>tagdiff</i>,
802: a Perl script that you can find in the <i>trtools</i> module on the
803: Steelix CVS repository. You can run <i>tagdiff</i> by yourself if you
804: want to have more frequent updates or want to generate a tag report only
805: for your language.
806: Please try to keep the percentage of problem pages as low as possible!
807:
1.1 saad 808: <p>
809:
810: <hr>
811: <a href="index.html"><img height="24" width="24" src="back.gif"
812: border="0" alt="OpenBSD"></a>
813: <a href="mailto:www@openbsd.org">www@openbsd.org</a>
814: <br>
815: <small>
1.22 ! tobias 816: $OpenBSD: translation-explained.html,v 1.21 2008/11/21 13:15:01 tobias Exp $
1.1 saad 817: </small>
818:
819: </body>
820: </html>
![[BACK]](/icons/back.gif){kind=icon}
Return to translation-explained.html CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / www