SATySFiを呼び出す

[output.satysfi]テーブルの中にpdf = trueというコードを入れると、自動でSATySFiが呼び出され、出力したsatyファイルがコンパイルされてPDFファイルが生成されます。

デフォルトではpdf = falseで、SATySFiは呼び出されません。

高度な設定

[output.satysfi]
  [output.satysfi.pdf]
    # 各種設定

とすることで高度な設定を行うことができます。

SATySFiの起動コマンドを変更する

以下のようにcommandsというkeyに対してSATySFiを起動するためのコマンドを文字列か文字列のリストで与えることでSATySFiの起動コマンドを変更することができます。デフォルトはsatysfiです。

[output.satysfi]
  [output.satysfi.pdf]
    commands = ["wsl", "satysfi"]

上のように、["wsl", "satysfi"]と与えると、SATySFiを起動するために

wsl satysfi main.saty

というコマンドが実行されます。

このままではLinuxでもwslコマンドが呼ばれてしまうため、OSごとに切り替えることができるようになっています。

[output.satysfi]
  [output.satysfi.pdf]
    commands = {
      windows = ["wsl", "satysfi"],
      macos = ["satysfi"],
      linux = "satysfi",
      others = "satysfi"
    }

のようにすることでOSごとに呼び出しコマンドを切り替えることができます(この場合も、コマンド名として文字列または文字列のリストを与えます)。

現在、選択できるのは

  • Windows
  • MacOS
  • Linux

の3種類のみで、それ以外のOSはothersでひとまとめにされています。

省略した場合はデフォルトのsatysfiが起動コマンドとして選択されますので、

[output.satysfi]
  [output.satysfi.pdf]
    commands = {windows = ["wsl", "satysfi"]}

と書けば「Windowsのときにはwsl satysfi <file name>で起動させ、それ以外のOSではsatysfi <file name>で起動させると設定できます。

SATySFiに与えるオプションの変更

SATySFiに与えるオプションを変更することができます。

  • 変更するためにTOMLに与える時に使うキーの名前
  • 対応して変更されるSATySFiのオプション
  • キーに対応して与える値の種類
  • デフォルトの値

の一覧のリストは以下のようになっています。

なお、text-mode-configsで文字列を与える場合は、

[output.satysfi]
  [output.satysfi.pdf]
    text-mode-cofings = "tex,latex"

のようにカンマ区切りで文字列を与えてください。

文字列のリストで与える場合はそのまま

[output.satysfi]
  [output.satysfi.pdf]
    text-mode-cofings = ["tex", "latex"]

のように与えてください。

また、config-pathに与えるパスは「“{build-dir}/satysfi”フォルダ」からの相対パスにしてください。

output-file-nameに与えるファイルのパスはconfig-path同様に、「“{build-dir}/satysfi”フォルダ」からの相対パスにしてください。

キーSATySFiのオプションデフォルト
is-bytecomp--bytecomp真偽値false
is-type-check-only--type-check-only真偽値false
is-debug-show-bbox--debug-show-bbox真偽値false
is-debug-show-space--debug-show-space真偽値false
is-debug-show-block-bbox--debug-show-block-bbox真偽値false
is-debug-show-block-space--debug-show-block-space真偽値false
is-debug-show-overfull--debug-show-overfull真偽値false
is-full-path--full-path真偽値false
is-show-fonts--show-fonts真偽値false
is-no-default-config--no-default-config真偽値false
config-path--config文字列オプションがつかない
page-number-limit--page-number-limt数値オプションがつかない
output-file-name--output文字列オプションがつかない
text-mode-configs--text-mode文字列・文字列のリストオプションがつかない