/eee-report-b3

電情3年が楽に実験レポートを生成するためのリポジトリ

Primary LanguageTeXMIT LicenseMIT

電気情報工学実験 (B3) レポート用テンプレート

これはなに

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

使い方

先人1 先人2 に感謝:pray:

  1. VSCodeとDockerをインストール
  2. VSCodeにRemote - Containersを入れる
  3. コマンドパレットからRemote-Containers: Reopen in Containerを選択してコンテナに入る(初回はビルドするので遅い)
  4. template.mdをもとにいい感じのレポートをMarkdownで書く
  5. Shift+Ctrl+P -> Pandoc Render -> pdfでPDFを生成!(Ctrl+K -> Pでも可)
  6. 実験レポートが生まれる

図表番号について

デフォルトでは図表のラベルが英語で振られます.これを日本語にするには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ファイルの追加も歓迎です.

参考