README-template.md

ロボット技術研究会 研究報告書

Build pdf

Book pdf

$ latexmk book.tex

Article pdf

• poyo.texというarticleをpdf化。
• 'poyo.tex'のあるディレクトリで以下を実行。

$ uplatex poyo.tex
$ dvipdfmx poyo.dvi

Put TeX files

• 原稿ファイルは sample/sample-article1.tex を参考に書き、適切な場所へ置く。
  • 原稿ファイルは以下で挙げる必須ファイルと混同しないよう、 main/ 直下ではなく、サブディレクトリか articles/ 等の別ディレクトリへ保存することが推奨される。
• main/files.tex の適切な part で \subfile によって原稿ファイルをインクルードする。

main/files.tex の内容は sample/files.tex を参考にして作る。

必須ファイル

• main/afterword.tex
  • あとがき
• main/colophon-text.tex
  • 奥付ページに、奥付本体以外になにか書くことがあれば書く。
  • 書くことがなければ、空ファイルを置いておく。
• main/files.tex
  • 中で各原稿ファイルを \subfile{} でインクルードする。
• main/frontmatter.tex
  • まえがき等。
• main/params.sty
  • 本のタイトルや発行日等の定数を定義するファイル。
  • 基本的に、 sample/params.sty にoptionalであると明示されているもの以外は全て必須のコマンドなので、内容を適切に設定すること。

Branching

テンプレート

• 変更は feature/poyo のようなブランチを作って行う。
• 完了した変更は develop ブランチへ merge する。
• develop ブランチのテンプレートですべての原稿が問題なく処理できるとわかった場合、 master ブランチへ merge する。
  • master は十分に安定していることが要求される。

原稿リポジトリ

• 原稿や最終的な成果物を生成するデータは、テンプレートとは別のリポジトリで管理する。
  • テンプレートのリポジトリをリモートブランチとして登録する。
• 管理者は、適宜テンプレートをリモートブランチから pull/merge する。
  • 不具合が出れば、原稿やテンプレートを修正する。

原稿を書く人

• 原稿リポジトリの指定されたブランチへ変更を行うだけ。
  • 派生して別のブランチを作って merge しても良い。

For TeXworks(maybe Windows only)

• デフォルトのタイプセットに upLaTeX がない場合設定する必要がある。
• TeXworksの左上のラジオボタン編集から設定を開く。
• タイプセットを選択する。
• 以下を新規作成(＋印のアイコンをクリック)する。

名前: upLaTeX(ptex2pdf)
プログラム: ptex2pdf
引数: -u
      -l
      -ot
      $synctexoption -no-guess-input-enc -kanji=utf8
      $fullname

• エディタに戻りタイプセットを upLaTeX(ptex2pdf) に指定して book.tex をコンパイル/実行すればよい。
• article poyo.texをpdf化する場合も同様。
• cf. TeXworks/設定