-
Notifications
You must be signed in to change notification settings - Fork 13
Get started with translation of Mozilla documentations
これは、Google、Microsoft、Mozilla が共同でメンテナンスしている Web 開発者向けのドキュメントサイト、MDN Web Docs プロジェクトの開発ドキュメントを翻訳する作業ステップを簡単にまとめたものです。このページのオリジナルは、2015-03-25に行われた MDN 翻訳ミートアップで、marさんが解説してくれた内容を元に、catchさんが整理したものです（元ページ）。MDN の現状に合わせて、適宜更新を加えています。
ミートアップのスライド経由でこのページにいらっしゃった方は「作業ステップ」の内容はすでにスライドで説明済みかと思いますので、「作業上のヒント」や「FAQ」 などのセクションを読むと役立つかもしれません。 （2020年末頃から、MDNのシステム移行に伴い、Wikiによる編集ツールが使えなくなっていますので、翻訳ミートアップでは github のIssueに訳文を書き留めておくなど代わりの方法を案内しています。 作業ステップのセクションは、Wiki編集ツールを対象に書かれています。）
MDN 日本語版では、Web 開発者向けドキュメントである MDN Web Docs の日本語訳を作成しています。
各ドキュメントは、英語ページは en-US、日本語ページは ja の階層に配置します。
(例)
原文 : https://developer.mozilla.org/en-US/Firefox
日本語: https://developer.mozilla.org/ja/Firefox
各ページのLANGUAGE(言語)アイコン(右上)でも、翻訳済みの言語が確認できます。
まだ未翻訳のドキュメントがあった場合、翻訳のリクエストと作業の進捗状況は、以下で確認できます。
- GitHub mozilla-japan/translation
- GitHub mozilla-japan/translation 翻訳リスト
- GitHub mozilla-japan/translation 翻訳Wiki
- 最近の変更リビジョン | Mozilla サポート
API documentation status overview – The MDN project翻訳の進捗状況(Overview – The MDN project)タグ「editorial」の付いた要レビュー記事
MDN Web Docs は、一種の Wiki になっています。 翻訳するには、Webブラウザでログインして、原文(英語)ページから翻訳(日本語)ページを作って、訳していきます。
GitHub のアカウントが必要ですので、持ってない方は取得してください。
右上の Sign In からログインします。
上記の「原文ページと翻訳ページのURL対応」や「翻訳リクエストとステータス」を参考に、作業するページを選びます。自分が得意／知識を持つジャンルや、興味を持つページから始めるのがオススメです。最初から長いページを選ぶと挫折してしまう場合もあるので、ペース配分に注意しましょう。
まだ日本語ページがない場合、LANGUAGE アイコンのメニューから Add a Translation を選択すると言語選択画面が表示されます。
- 右上の「編集」ボタンで編集を開始する
- TITLE：まずタイトルを日本語にする
- URL スラグ：原文のままにする
左側に原文が表示されるので、右側に翻訳した内容を入力します。
このとき「ソース」ボタンで、直接 HTML タグを修正できるモードに切り替わります。 リッチテキストエディタが、けっこう大変。
基本的に HTML で記述されています。MDN 専用テンプレート（{・・・}）もあるので、そこはいじらないよう注意するといいでしょう。HTML タグの中の ID 属性も、修正しないでください。
とはいえ、英語文を日本語にするのが大事です。細かなタグや属性は、レビューで直してもらえる(こともある)。
翻訳作業コミュニティで、レビュー希望を出すといいです。
たとえば、ページ内のリンクが https://developer.mozilla.org/en-US/Firefox となっていたら、en-US/ の部分を ja/ に置換します。
このようにすると、日本語のページに飛ぶようになります（日本語ページがまだない場合は翻訳のお誘いが表示されます）。
※以前は en-US/ を削除するという方法もありましたが、この場合との違いについては、こちらを参照してください。
“編集”ボタンの右の歯車のアイコンをクリックすると、詳細メニューが開きます。
ここで”履歴”を選択すると、そのページの編集履歴を見ることができます。
「ソースの表示」ボタンをクリックすると、Wikiのソースを表示して、直接編集できるようになります。
ソースを直接編集する場合は、タグの閉じ忘れに注意してください。閉じ忘れは自動補完されますが、不完全な場合があるため、構造的によろしくない感じになってしまうことがあります。
ページの末尾に、ページの種類ごとにタグを付与することができます。とりあえず、英語ページと同じタグを割り当てるといいでしょう。
タグが複数ある場合は、カンマで区切ります。
たとえ記事が英語版の翻訳であったとしても、すべてのページに少なくともひとつのタグが付ける必要があります。
検索結果のフィルタリングや貢献者同士の規約として使われているタグは翻訳されるべきではありません。より詳しいルールや使い方などは、How to properly tag pages をご参照ください。なお、既存のタグで記事の中身を表せない場合には、新たなタグを自由に作ることができます。
MDNは、編集を保存すると、すぐに編集結果が公開されます。
以下のフラグで、読者にページの状態を伝えることができます。
- Localizationフラグ：作業中
Reviewフラグは、次のものがあります。
始める前に、とりあえず保存すると、他の人が編集できないようにロックされる。※編集状態フラグを立てても、編集ロックされる仕様はありません。
気にせず翻訳を始めるのが吉です。
一度にページの全部を翻訳しなくても構いません。タイトルと見出しだけとか、テキストを段落ごとに置き換えていくのでもいいです。
※ページ中のセクション id を利用するマクロ（Page マクロ等）やセクション指定のリンクがうまく行かないときも同じ解決手順になります。
ライブサンプル (EmbedLiveSample) を使う場合、要素の中のテキストコンテンツと EmbedLiveSample ライブサンプルの引数が一致する必要があります。また、id 属性には何を付けていても保存時にテキストコンテンツの値で上書きされてしまいます。
これは、name 属性をつけることで防げます。
<!-- 原文 -->
<h2 id="Examples">Examples</h2> <!-- ライブサンプルに使われる見出し -->
{{EmbedLiveSample("Examples")}}
<!-- 日本語訳 -->
<h2 id="Examples" name="Examples">例</h2> <!-- 必ず name 属性を追加する -->
{{EmbedLiveSample("Examples")}}詳しくはこちらの記事をご覧下さい: https://qiita.com/sutara79/items/940948f9ba786cecd985#%E4%B8%8D%E5%85%B7%E5%90%88