www/translation-explained.html - diff

Return to translation-explained.html CVS log

Up to [local] / www

Diff for /www/Attic/translation-explained.html between version 1.5 and 1.6

version 1.5, 2005/06/28 11:48:19

version 1.6, 2005/06/28 18:43:45

Line 47

<h3><font color="#0000e0"><a name="Intro">Introduction</a></font></h3>

<p>

This document contains hopefully all the information you need to

This document should contain all the information you need to

contribute to the OpenBSD translation effort as described in <a

href="translation.html">Translation of the OpenBSD documentation</a>.

Please read this document carefully and if you still have questions,

Line 100

<p>

<strong>Think first how much time you will be able to dedicate to the

translation. If you only have some small spare time, don't go overboard

and translate several files you won't be able to maintain

by translating several files you won't be able to maintain

later.</strong>

<p>

Line 109

href="plat.html">plat.html</a> is a small file, and it doesn't get

modified often. On the opposite side, <a href="plus.html">plus.html</a>

is a heavy file to translate; it grows bigger and bigger from one

version release to another, and the technical and slang wording used is

release to another, and the technical and slang wording used is

very difficult to translate with accuracy.

<p>

Needless to say, some files take precedence over anothers. Such is the

Needless to say, some files take precedence over others. Such is the

case of <a href="index.html">index.html</a> ... or did you think

otherwise?

Line 122

<p>

Before joining the translation team, you must make sure that you have

the proper environment for translation. The required environment is

the proper environment for translation. The required environment consists

constituted of the following elements:

of the following elements:

<ul>

<li>an OpenBSD box running a <strong>stable</strong> and

<strong>maintained</strong> release

Line 162

accepted.

<li>A permanent email address on which you can be contacted regarding

translation work.

<li>A list of three Unix account named sorted by order of preference.

<li>A list of three Unix account names sorted by order of preference.

<li>Your SSH2 DSA public key as an attached file and its SHA-1

associated hash. A minimum length of 1024 bits is required for the

key.

Line 178

work and then vanish without giving any good reason. Creating your

account and maintaining the account database is extra work for the

translation coordinators. So they might ask you to send the files to

another translator that will validate your work and your commitment to

another translator who will validate your work and your commitment to

the translation effort. This way, we make sure you are here to stay.

<p>

Line 212

This is the module on which all translation work happens.

<li>The <i>www</i> CVS module. This module must be obtained from one of

the many <a href="anoncvs.html"> anonymous OpenBSD CVS mirrors</a>

out there. This will be your source for the original english files

out there. This will be your source for the original English files

that you need to translate.

</ul>

<p>

<strong><font color="#ff0000">Note:</font></strong> while the <i>www

translation</i> CVS module holds also the english files, they must not

translation</i> CVS module holds also the English files, they must not

be used since they are rarely kept in sync with the english files found

be used since they are rarely kept in sync with the English files found

on the anonymous OpenBSD CVS mirrors.

<p>

Line 397

module. If, by mistake, you edited and modified one of the files in the

first level, don't edit it back to reverse those changes, the timestamps

will have changed and you will mess the remote repository next time you

<kbd>'cvs up - PAd'</kbd> followed by <kbd>'cvs commit'</kbd>. Instead,

<kbd>'cvs up -PAd'</kbd> followed by <kbd>'cvs commit'</kbd>. Instead,

just <kbd>rm -f</kbd> that file and follow the instructions to <a

href="#update">update</a>. An update from the CVS repository will

restore that file on your working copy. Likewise, avoid changing the

restore that file in your working copy. Likewise, avoid changing the

files from languages other than yours.

<p>

Line 462

href="#commit">commit</a> command.

<p>

<strong>Note<sup>(2)</sup></strong>: see the <kbd>rm</kbd> option on the

<strong>Note<sup>(2)</sup></strong>: see the <kbd>rm</kbd> command in the

cvs manual page to know how to remove a file or directory.

CVS manual page to know how to remove a file or directory.

<h4>Updating files</h4>

If, while standing at <em>steelix-www/</em>, we ran the command and options:

If, while in the <em>steelix-www/</em> directory, we ran the command and

options:

<pre>

$ cd ~/devel/openbsd/steelix-www

Line 508

Line 509

<p>

Needless to say that you only commit when you feel your changes should

definetely go into the <i>www translation</i> of the CVS repository.

definitely go into the <i>www translation</i> of the CVS repository.

<h4>Reverting a change</h4>

Line 580

Line 581

<!--

Originally [OpenBSD: index.html,v 1.347 ]<br>

Originally [OpenBSD: index.html,v 1.330 ]<br>

$Translation$<br>

-->

$OpenBSD$

Line 658

Line 659

<p>

AND, if <em>orders.html</em> were a translated file, then you would have

to go back two levels and then one level forwards to your language

to go back two levels and then one level forward to your language

directory:<br> <tt><strong><a

href="../../de/orders.html">orders.html</a></strong></tt>.

<p>

we know this looks messy, but you will get used to it and the best you

We know this looks messy, but you will get used to it and the best you

can do to avoid errors is to check links before you commit (and as you

are at it, also check the id tags).

Line 687

Line 688

</pre>

<p>

but since the translated file will be placed on a different directory,

but since the translated file will be placed in a different directory,

you will have to change the link to <em>back.gif</em> to get it right:

<pre><a href="index.html"><img height="24" width="24" src=<strong>"../back.gif"</strong> alt="OpenBSD"></a>

Line 698

Line 699

directory:

<pre><a href="art1.html"><img border="0" src=<strong>"images/openbsd-logo.gif"</strong> height="195"

width="520" alt="[OpenBSD 2.7]"></a>

width="520" alt="[OpenBSD 3.7]"></a>

</pre>

<p>

should be changed to:

<pre><a href="art1.html"><img border="0" src=<strong>"../images/openbsd-logo.gif"</strong> height="195"

width="520" alt="[OpenBSD 2.7]"></a>

width="520" alt="[OpenBSD 3.7]"></a>

</pre>

<p>

Line 714

Line 715

something like:

<pre><a href="art1.html"><img border="0" src=<strong>"../../images/openbsd-logo.gif"</strong> height="195"

width="520" alt="[OpenBSD 2.7]"></a>

width="520" alt="[OpenBSD 3.7]"></a>

</pre>

<h4>Accentuated letters</h4>

Since some languages such as French makes extensive usage of accentuated

Since some languages such as French makes extensive use of accentuated

letters, a translator must make sure that the accents on the letters are

put in the right places and in the right styles (é not è

in a word such as "problème"). The HTML code must not

contain the accentuated letters in HTML codification format (such

contain the accentuated letters in HTML codification format (such as

"&eacute;" for "é").

<h4>Punctuation</h4>

Line 733

Line 734

sacrée langue ! n'est-ce pas ?".

<h4>Line wrapping</h4>

Verify that your HTML editor wrap lines correctly at 80 columns. If your

Verify that your HTML editor wraps lines correctly at 80 columns. If your

editor can't do that, there are other ways to do this such as using the

Text::Autoformat Perl module. We won't be accepting uncorrectly wrapped

files anymore since it requires non-wanted extra work from the

Line 755

Line 756

<h4>Mistakes and typos in the original versions</h4>

As in any translation work, you may notice mistakes and/or typos in the

original english version of the file that you are currently translating.

original English version of the file that you are currently translating.

Please report them back to one of the maintainers (No diffs please. Send

an email with the lines where the problem is and the suggested

solution). It really helps the project to keep up with the quality