これはKCS AdventCalendar2021の17日目の記事です。
今期、私が大学のレポート用に使っている環境を紹介しようと思います(まだ1本しか書いてないですが)。
コア部分
190ikp/basic-experiment-report-b2をFolkしたorganic-nailer/eee-report-b3を使っています。
使っているのは
です。本家との違いは、電○情○工学実験用に一部変更を加えているということ、環境構築にコンテナを利用しているということの2点です。
VSCode
軽くて便利なエディタ。上のリポジトリはVSCode用に構築しています。
Pandoc
Haskell製の文書変換ライブラリです。MarkdownからTex形式を経由してPDFに出力させるために使っています。
Markdown
元々HTMLに出力するための簡易な文章記法です。ブログやGitHubのドキュメントなどで書いたりするかと思いますが、Pandocと組み合わせることでレポート製造言語に進化します。
使い方の詳しくはリポジトリを見てほしいのですが、だいたい上の図のような形でレポートが生成できます。
環境の利点としては
- 数式をTeX形式で書ける
- 数式エディタ？なんですかそれ
- データはテキスト形式になるので管理が楽
- バイナリは壊れる
- Imageが用意されているので環境構築が楽
- 日本語LaTeXやPandocの環境構築は骨が折れる
- 図表番号を自動で振ってくれる
- 体裁が自動的に良くなるので評価が上がる
- これ重要(特に1,2年は体裁のウェイトが非常に大きいので効果的)
- 記述がMarkdownでできるのでTeXほどつらくない
といったところです。
便利なのでみんな使ってほしいなぁ...
実験科目ごとに表紙が指定されていると思いますが、これはTeXで自作する必要があります。
参考:
VSCode拡張
eee-report-b3に合わせて使っている拡張たちです。
Remote-Containers
コンテナ内にVSCodeで接続できるだけでなく、`.devcontainer/devcontainer.json`を記述するとプロジェクトを開いただけでコンテナを用意してくれます。
Character Count
特に意味はないですがレポートの文字数をカウントして左下に表示してくれます。
Paste Image from local pc
クリップボードの画像をmarkdown内に貼り付けることができます(画像はカレントディレクトリに保存)。
グラフなどをマウス操作でコピペできるので圧倒的に作業効率upが望めます。
これはPaste ImageのFolkなんですが元だとコンテナ内でコピペできないんですよね...
Markdown+Math
ワークアラウンド的ですが数式のタグ付けに伴うプレビューの崩れを解決してくれます。
mdでこう書くとVSCodeのプレビューが死ぬのをどうにかしたい pic.twitter.com/a4cehT6e9I
— Fastriver (@Fastriver_org) 2021年12月6日
その他
レポート作成に使っているものたち
Google Drive
複数のPCからレポートを書いているのでPC間はGoogle Driveで同期しています。
版管理もしてくれているので万が一やらかしても安心。
Desmos
グラフを書くアプリ。形状を確認したり数式を書いたり方程式を解いたり簡易にできて便利です。
desmos2excel
上のDesmosで書いた数式をExcelで使える形式に変換するやつです。ボード線図の理論値をExcelでプロットしたいときなどに活躍しました。
Excel
グラフ書くのに使ってます。グラフのテーマを保存しておけばある程度体裁も困らないものができます。
iPad+OneNote
レポートに挿入する図やグラフにお絵かきするのに使っています。OneNoteはPCとほぼリアルタイムで同期できるのでiPadで書く->OneNoteで同期->スクリーンショットでクリップボード->mdに貼り付けという完璧な流れを実現できます。
KoClip
クリップボードに画像が入ってきたら自動で保存しておいてくれます。Matlabで大量に画像を保存しないといけないときなどに活躍。
Nuance Power PDF
レポートの末尾に添付資料をつけたいときなどにこれで合体させてました。スキャナを買ったらついてきたなにかです。Win11非対応そうでつらい
使っていないもの
- Word: つらいから
- Google Sheet: グラフの体裁が弱い
- Google Docs: Wordより弱い
- Markdown All in One: 機能が多すぎる
- 生LaTeX: 書けません
- Git: レポートだと必要ないかな
レポート環境は暇なときに整えようね！
