Skip to content
literalice edited this page Jun 14, 2012 · 26 revisions

Gradleのユーザーガイドを日本語に訳してます。

http://gradle.monochromeroad.com/docs/userguide/userguide.html

ご協力いただける方はメッセージください。

ドキュメントのビルド方法

  • git clone [email protected]:literalice/gradle-ja.gitコマンドでプロジェクトをclone
  • git checkout lang/ja コマンドで翻訳ブランチに切り替え
  • プロジェクトのルートディレクトリでコンソールを開き、buildDoc を実行
  • コマンドが正常終了し、subprojects/docs/build/docs/userguide にドキュメントが生成されていることを確認する

翻訳の進め方

リファレンスガイドの翻訳については、リファレンスガイドについてを参照してください。

現在の翻訳対象は、subprojects/docs/src/docs以下のXMLファイル、CSSファイルです。
翻訳は、lang/jaブランチ上で進めています。masterはgradle本体追跡用

基本的な方針

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

翻訳方法

  • xmlルート(chapter)の属性に、xml:lang="ja"を追加する。
  • titleタグ内を翻訳し、担当宣言を行います。原文は<phrase role="original"></phrase>で囲み、titleタグ内に翻訳文を追加してください。
  • 原文のparaタグには属性roleをつけ、<para role="original">とする。次の行に新しい<para>タグを作成し、翻訳文を書き込む。
  • paraタグ以外を翻訳するときは、原文を<phrase role="original"></phrase>で囲み、原文の前に翻訳文を追加
  • xmlタグの属性部分を翻訳する必要があるときは、原文の前に翻訳文を併記する。(例:「初めてのビルドスクリプト / The first build script」)

上記手順について、詳しくは翻訳済みのxmlファイルを参照してください。

訳者名の追加

翻訳された方は、userguide.xmlのbookinfoタグ内にothercreditタグで氏名を追加してください。

<!-- subprojects/docs/src/docs/userguide/userguide.xml -->
<bookinfo>
    <!-- .... -->
    <othercredit class="translator">
        <firstname>[名]</firstname>
        <surname>[姓]</surname>
    </othercredit>
    <othercredit class="translator">
        <firstname>[名]</firstname>
        <surname>[姓]</surname>
    </othercredit>
</bookinfo>

ファイルフォーマット

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

リポジトリの更新について

翻訳に関するコミットはlang/jaブランチ上で行ってください。

以下の条件が合えばいつでもpushしてください。

  • 強制pushなしでpushできること (git pull --rebase でリモートの更新をマージする)
  • gradlew :docs:docs -x :docs:userguidePdf コマンドが正常終了すること
  • 日曜日の21時以降でないこと? (gradle最新版をマージする予定です)

PDFドキュメントのビルド方法

PDFドキュメントをビルドするには、Gradleプロパティでフォントファイルとフォント名を指定してからgradlew :docs:docs を実行してください。

プロパティが未定義の場合、PDFはビルドされません。

# USER_HOME/.gradle/gradle.propertiesなど
gradleDocsPdfFontName=IPAGothic
gradleDocsPdfFontFile=D:/project/literalice/gradle/ipag.ttf

Tips

buildDoc コマンドがエラーになる

gradlew cleanコマンドで一度成果物をクリーンしてください。 それでもダメな場合は、git clean -fxdで不要なファイルを削除してからgradlew cleanを試してみてください。

課題

sampleタグのtitle属性の翻訳

というか、xmlタグの属性部分の翻訳。phraseタグで囲めないため現在訳文を併記することで対応

gradleの最新版を取り込むタイミング

日曜日の21時以降に時間があったら取り込もうと思っています。

その他

以下原文

Gradle documentation is maintained within the source code to this project. Sample code lives at /buildSrc/ and user guide documentation xdoc files are housed at "/subprojects/gradle-docs/src/docs/userguide/":http://github.com/gradle/gradle/tree/master/subprojects/gradle-docs/src/docs/userguide/

Documentation, when compiled, is published to "http://www.gradle.org/documentation.html":http://www.gradle.org/documentation.html