Skip to content

リファレンスガイドについて

literalice edited this page Jun 14, 2012 · 5 revisions

http://gradle.monochromeroad.com/docs/dsl/index.html

翻訳の進め方

現在の翻訳対象は、

  • subprojects/docs/src/docs/dsl以下のXMLファイル、CSSファイル
  • subprojects/core/src/main/groovyにあるソースコードのJavadoc、Groovydoc

です。

リファレンスガイドは、基本的にソースコードのコメントから抽出されてビルドされます。

なお、翻訳はユーザーガイド同様、lang/jaブランチ上で進めています。

基本的な方針

  • 翻訳担当の宣言は、ファイルの一部を翻訳してpushすることで行うものとします。
  • 基本的に一つのファイルにつき一人の担当者が翻訳を行います。
  • 訳語一覧を参考、更新しながら翻訳を進めてください。
  • 原文はなるべく残す。

翻訳方法(xml部分)

ユーザーガイドの場合と同じ

翻訳方法(Javadoc部分)

  • 見出し(h*タグ)は、タグ内の原文をoriginalクラスのspanで囲んで、その前に翻訳文を書き込む。
    例: <h3>はじめに <span class="original">Introduction</span></h3>
  • 原文のpタグには属性classをつけ、<p class="original">とする。次の行に新しい<p>タグを作成し、翻訳文を書き込む。
  • それ以外の部分を翻訳するときは、<span class="original">、<p class="original">などで原文を囲んで、その後に翻訳文を追加してください。

上記手順について、詳しくは翻訳済みのxmlファイルや、Javadoc(Projectクラスなど)を参照してください。

訳者名の追加

翻訳された方は、ユーザーガイドの場合と同じように、userguide.xmlのbookinfoタグ内にothercreditタグで氏名を追加してください。

ファイルフォーマット

  • DocBook
  • UTF-8, 改行コードはLF