Stanマニュアルの日本語への翻訳プロジェクト
CSS Shell HTML
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Circle CI

Modeling Language User’s Guide and Reference Manual, v2.16.0 (日本語訳)

最新版の翻訳 pdf は releases から取得できます.

目的

Modeling Language User’s Guide and Reference Manual, v2.16.0 の日本語訳の作成です.

文章のルール

pdf(閲覧したい)とhtml(検索エンジンでヒットさせたい)の両方へ自動的に変換したいためMarkdownで書くことを採用しました(そのため, 変換は便利ですが数式やリファレンスの記述でやや苦労しています).

Markdown関連

  • Markdownのルール
  • 数式・コード・画像の前後や段落分けのために 空行 が必要となることに注意.
  • Part XX は #
  • Chapter は ##
  • sub chapter は ###

文体関連

  • 文体は丁寧語にしてください.
  • 句読点は翻訳者の自由にしてください. 最終的なpdfとhtmlにする時には.に, ,に置換します.

数式関連

  • ブロック数式は$$$$で囲んでTeX記法を使ってください(ただし1行で書いてください).
$$ TeX記法 $$
  • TeX記法がよくわからない場合は, 数式の画像を作成して以下のように数式画像への相対パスを記載してください(参考).
![適当な文字列](数式画像への相対パス)
  • インライン数式は$$で囲んでTeX記法を使ってください.
  • TeX記法を統一するための議論もここに存在します.
  • なお, 過去はGitHub上のMarkdown表示でも数式を閲覧したかったため, ブロック数式をこのように 書いていました.

ソースコードやその他のルール

  • 複数行に渡るStanコードは```と```で囲む
  • インラインのStanコードは`と`で囲む
  • 自信のない箇所は英文のままにしておく. できれば, **と**で囲んで強調しておく.
  • 脚注については、「本文です。^[脚注です。]」のようにします.

運用のルールとgitの初歩

プロジェクト全般に関すること

翻訳の流れ

  • 作業のはじめに, 各自のPCからGitHub上の最新のmaster branchを取得します.
  • 各自のPCでbranchを切ります.
    • 新しく記事を作成する場合は, ブランチ名の接頭語に create/ をつけます.
    • 修正する場合は, ブランチ名の接頭語に fix/ をつけます.
    • ブランチ名に fix/chapXX のように chapXX が含まれているとPull Request作成時にpdfが自動で作られます. レビューに便利です.
      • それ以外の例外的な部分も作業内容がわかるようにbranch名を決めてください.
  • 翻訳します.
  • addおよびcommitします. そしてGitHubへそのbranchをpushします.
  • GitHub上で「そのbranchをmaster branchへマージするためのPull Request」を作成します. レビュワーを募ります(最低1名).
  • レビュワーはレビューをします.
    • レビュワーはPull Request上でコメントします. 「Files changed」のページで行単位でコメントできます.
    • Pull Requestの際に作られるpdfまたはhtmlを見ながらレビューを行います.
    • レビュワーの指摘を受けて, 訳者はコメントに返事をしたり, 議論します. 
    • 各自のPCで訳を修正して, commitおよび同じbranchにpushします.
  • レビュワーのLGTM(Looks Good To Me = いいと思うよ)が出るまで上記のレビューを繰り返します.
  • 松浦もしくは訳者がPull Requestをmergeします.

gitの初歩

  • master branchを取得
git checkout master
git pull origin master

レポジトリ自体を初めて取得する場合は

git clone https://github.com/stan-ja/stan-ja
  • 作業用のbranchを切る
git checkout -b 'create/partXX/chapYY'
  • 修正したファイルをステージングする
git add hoge/huga.md
  • インデックスに追加した更新をローカルブランチにcommitする

何を修正したのかがわかるようにコミットメッセージを追加しましょう.

git commit -m '1章を翻訳しました'
  • コミット内容をリモートブランチにpushする
git push origin create/partXX/chapYY

レビュー時にpdfとhtmlへのリンクが見つからない場合の確認方法

GitHub上でPull Requestを作成するとCircleCIで自動的にpdfとhtmlに変換処理が行われます. Pull Requestページのcommit履歴の横にチェックマークまたはバツ印がつきます. これらはCircleCIのビルドページへのリンクになっています.

ビルドが成功している場合はArtifactsというタブが表示されます(ログインしている必要があります). その中をドリルダウンしていくとpdfとhtmlへのリンクが表示されています. ビルドが失敗している場合はTest Resultsというタブの$ build/build_chapter.shというブロックをクリックするとエラー詳細が表示されます.

PR

CircleCI

参考サイト