日本語翻訳書式 - pgsql-jp/jpug-doc GitHub Wiki

基本

翻訳対象となる英語をコメント化し、その直後に日本語訳を書きます。元の英語部分は変更せずにコメントと日本語訳のみ追加します。

コメント化

翻訳のためのコメントの開始は対象となる英語の直前に<!--のみの行をインデント無しで追加します。 コメントの終了は-->のみの行をインデント無しで追加します。

※余分なスペースが含まれないようにします。

例外として、コメント内は2つ連続したハイフン--を含むことができないため、--が含まれている場合は&#45;-に書き換えます。

日本語翻訳

日本語翻訳は-->の直後の行から始めます（空行を入れない）

日本語翻訳は基本的にインデントせずに左詰めで書き始めます （複数行のインデントを合わせようとすると手間が掛かるため）。

日本語の場合はスペースで単語を区切らないでワードラップが効かないので「。」の位置で改行します。 「。」以外の位置で改行するとHTMLに変換したときに余計なスペースが含まれるため、避けてください。

翻訳対象の英語にインラインタグが含まれていた場合は、日本語翻訳に同じタグを含めます。

例えば<productname>PostgreSQL</productname>が含まれていた場合は、日本語訳でも<productname>PostgreSQL</productname>を含めます。 そのときに英語では単語と同様に前後にスペースがありますが、日本語訳はスペースを入れないようにします。

例

以下が基本的な書き換え例です。git diffを実行したときに以下のような差分になっている必要があります。

   <para>
+<!--
    In the previous chapter we have covered the basics of using
    <acronym>SQL</acronym> to store and access your data in
    <productname>PostgreSQL</productname>.  We will now discuss some
    more advanced features of <acronym>SQL</acronym> that simplify
    management and prevent loss or corruption of your data.  Finally,
    we will look at some <productname>PostgreSQL</productname>
    extensions.
+-->
+前章では、<productname>PostgreSQL</productname>で<acronym>SQL</acronym>を使用してデータを保存したりアクセスしたりする基本について説明しました。
+ここでは、管理を単純化しデータの喪失や破壊を防止する<acronym>SQL</acronym>のいくつかのより高度な機能について論議します。
+最後に<productname>PostgreSQL</productname>のいくつかの拡張に触れます。
   </para>

改行が必要なところで無い場合はタグを含めてコメント化する（<para>this is...は<para>を含めてコメント化）。

NG

- <para> This is...
+ <para>
+<!--
  This is...
+-->
+これは...
 </para>

OK

+<!--
 <para> This is...
+-->
+<para>これは...
 </para>

注意

原文にコメントがあった場合に「原文コメント」等を入れて修正していたのをやめて変更しない。

文章内にprogramlistingが「間」にある場合に原文になるべく合わせる（一行の途中でも可にする）。つまり以下のように変更します。

 A command like:
 -->
-次のようなコマンドはrootテーブルしか処理しません。
+次のようなコマンドは、
 <programlisting>
 ANALYZE measurement;
 </programlisting>
 <!--
         will only process the root table.
 -->
+rootテーブルしか処理しません。

programlisting の後の行がコメント化だけされて、文が無いのを避けます。特に<literal>等のタグは同じブロックに書くようにします。

タイトル

<title></title>で囲まれたタイトルも翻訳対象です。 タイトルは大抵１行で書かれているため、タグも含めて1行の場合が多いです。 <title>タグが同一行の場合は、タグも含めてコメント化します。

コメントの開始と終了は基本と同じようにインデント無しで書きます。 日本語訳のタイトルは基本と違い見やすさを重視して、英語のインデントに合わせます。

例

+<!--
    <title>Introduction</title>
+-->
+   <title>はじめに</title>

indexterm

文章内には、索引用に<indexterm>``</indexterm>で囲まれた文があります。 indextermは例外として、コメント化しません。 日本語訳の索引に加えて、英語の索引がある方が便利なためです。 例えばビューという索引に加えてViewという索引でも引けた方が便利になります。

indextermは元の英語に続けて、日本語訳のindextermを追加します。indextermが複数ある場合は、英語、日本語、英語、日本語のように間に入れます。

例

    <indexterm zone="tutorial-views">
     <primary>view</primary>
    </indexterm>
+   <indexterm zone="tutorial-views">
+    <primary>ビュー</primary>
+   </indexterm>
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️