/basic-experiment-report-b2

理工学部2年が楽に実験レポートを生成するためのリポジトリ

Primary LanguageTeXMIT LicenseMIT

理工学部基礎実験 (B2) レポート用テンプレート

これはなに

慶應の理工学部2年生がMarkdown + Pandocで実験レポートを楽に生産するためのテンプレート

使い方

先人に感謝:pray:

ディレクトリとかは自分の環境によって適宜読み替えてください.

  1. texlive, pandoc, pandoc-citeproc, pandoc-crossrefをインストール
    (PandocのインストールはStackを使うと楽,texliveはググってどうぞ)
  2. template.mdをもとにいい感じのレポートをMarkdownで書く
  3. pandoc your_report.md -o your_report.pdf -F pandoc-crossref --filter pandoc-citeproc --pdf-engine=lualatex -N --template=/dist/to/your/template.texでビルド
    template.texのパスはフルパスを書いておいたほうが安全です.
  4. PDFでレポートが出力されるので確認する
  5. 実験レポートが生まれたよ!かわいいね

図表番号について

デフォルトでは図表のラベルが英語で振られます.これを日本語にするにはpandoc-crossrefのconfigを書いてあげる必要があります.
ホームディレクトリ直下に.pandoc-crossrefディレクトリを作ってtemplate/pandoc-crossref.yamlを置いてあげると,特にオプションで指定しなくても反映されるようになります. この場合,pandoc-crossref.yamlの設定はシステム全体に適用されます.
もしくは,Pandocでのビルド時に--metadataオプションでcrossrefYamlキーを使って,このconfigファイルを指定してください. この場合はこのレポートのビルドにのみ設定が適用されます.

なお,後述のTasksやvscode-pandocプラグインを利用してビルドする場合は,デフォルトで図表ラベルが日本語になるようにしてあります.

参考文献の書き方について

詳細は http://sky-y.github.io/site-pandoc-jp/users-guide/#citations に書いてあります.
ここに書くと長くなるので読んで,どうぞ.
ただ理工学基礎実験の場合,レポート内で参考文献のリンクを貼る必要までは無いので,参考文献のリストのところに雑に書いてあげる程度で十分です.

参考文献を直接本文に書き込む場合は,# 参考文献の後ろに {-}を入れましょう (番号振られるのを避けるため). テンプレートファイルでは入れてあります.

ショートカットを使用してPDFをビルドする

VSCodeを入れてvscode-pandocを使うと,settings.jsonに"pandoc.pdfOptString": "--filter pandoc-crossref --metadata=crossrefYaml:/dist/to/your/pandoc-crossref.yaml --filter pandoc-citeproc --pdf-engine=lualatex -N --template=/dist/to/your/template.tex"と書いておけばShift+Ctrl+P -> Pandoc Render -> pdfでビルドできていい感じに楽できます.
.vscode/settings.json.exampleに例があります.
/dist/to/your/の箇所は適切なファイルパスに変更する必要があります.絶対パスを指定すると安全です.)

別の方法として,VSCodeのTasksを利用することでサードパーティへの依存を減らしました.
こちらはvscode-pandocのインストールやsettings.jsonの修正が必要なくPDFのビルドが可能です.
Ctrl+Shift+PTasks: Run Build Task > build a pdfを選択するか,Ctrl+Shift+Bbuild a pdfを選択するとビルドできます.
また,上記の操作をショートカットキーに設定することも可能です. 詳しくはこちらをご覧ください.
(ファイル保存時の自動ビルドは行いません.)

その他

書き方のサンプルを追加しました.画像のレイアウトなどについてわからなければこちらを読んでください.

質問とかはquestionラベルを付けてissueに投げてください.
不具合とかあったら直してプルリクしてください.喜びます.
カスタムcslファイルの追加も歓迎です.

参考