KaiseiYokoyama / coins_graduation_article

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

筑波大学情報科学類卒業論文テンプレート + CI

使い方

  1. このリポジトリをForkします.
  2. ForkしたリポジトリをCloneし,ローカルで卒論を書きます.
  3. PDFを生成したいcommitにvから始まる名前のタグをつけ,タグをPushします.
  4. Github Actionsが作動し(),リリースページのAssetsにPDFgraduation_article_(タグ名).pdfが並びます().

カスタマイズ

.github/workflows/release.yml

Github Actionsの動作を定義するファイルです.Actionsをどのタイミングでトリガするのか,作成するリリースの名前,出力されるPDFの名前などが設定できます.

また,コンパイルする.texファイルの名前やlatexのコンパイラ,コンパイル時の引数,tlmgr経由で追加するtexパッケージの名前などが指定できます.

latexまわりの挙動については,こちらをご覧ください.

.latexmkrc

latexをlatexmkを使ってコンパイルする際のあれこれを設定するファイルです.

注意

タグ名に/が入っていると,Github Actionsがエラーを出します.

その他

tag名(バージョン名)をlatexの文書中で参照したい

Github Actionsの動作中,環境変数 release_version が定義されています.なので,例えばプリアンブルなどで,

\usepackage{catchfile}
\newcommand{\getenv}[2][]{%
  \CatchFileEdef{\temp}{"|kpsewhich --var-value #2"}{\endlinechar=-1}%
  \if\relax\detokenize{#1}\relax\temp\else\let#1\temp\fi}

\getenv[\VERSION]{release_version}

と定義しておけば,文中に\VERSIONと書くだけでタグ名(バージョン名)が出てきます.同期や先輩,先生に読んでもらうときに,タイトルに添えるなどしておくとよいでしょう.

\title{(卒論タイトル名)\\ \VERSION}

ちなみにrelease_versionが定義されていないとき(ローカルでコンパイルするときなど)は,コンパイルエラーにはならず空白が出力されるようです.

LaTeX文書で絵文字が使いたい

.github/workflows/release.ymlBuild PDFのところでuseしているKaiseiYokoyama/latex-build-langja@masterKaiseiYokoyama/latex-build-langja@emojiに変えることで,BXcoloremojiパッケージが使えます.

ライセンス

MIT ただし,予告なく変更される場合があります.

About

License:MIT License


Languages

Language:TeX 95.3%Language:Perl 4.7%