Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gfngfn/SATySFi

A statically-typed, functional typesetting system
https://github.com/gfngfn/SATySFi

functional-programming latex markup-language ocaml opam opentype pdf pdf-generation programming-language satysfi typesetting-system

Last synced: 9 days ago
JSON representation

A statically-typed, functional typesetting system

Awesome Lists containing this project

README 

        
![logo1](https://raw.githubusercontent.com/wiki/gfngfn/SATySFi/img/satysfi-logo.png)



[![Build Status](https://github.com/gfngfn/SATySFi/workflows/CI/badge.svg?branch=master)](https://github.com/gfngfn/SATySFi/actions?query=workflow%3ACI)



[English README is here](https://github.com/gfngfn/SATySFi/blob/master/README.md)



## 概要



*SATySFi*（英単語の “satisfy” と同様に発音します）は，静的型つきのいわゆる函数型言語が備わった，新しい組版処理システムです。構文は主にテキスト部分とプログラム部分からなり，前者はLaTeX風の構文で文書を執筆するために，後者はOCaml風の構文でコマンドを定義するために使われます。函数型プログラミングの要領でコマンドが定義でき，かつ静的に型がつけられるため，柔軟な記述とわかりやすいエラー報告が実現されています。



本ソフトウェアは以下のような支援のもと開発されました：



* 2017年度IPA未踏事業（2017年6月–2018年2月．概要は[こちら](https://www.ipa.go.jp/jinzai/mitou/2017/gaiyou_t-4.html)）

* 株式会社ドワンゴ（2018年10月–2019年3月．アルバイトとして）

* [The SATySFi​book](https://booth.pm/ja/items/1127224)を購入頂いた，多くの匿名の支援者の方々



また，2024年2月現在も発展を続けています。



## Satyrographos を使ったインストール方法 (初心者向け)



パッケージマネージャー [Satyrographos](https://github.com/na4zagin3/satyrographos/blob/master/README-ja.md) を用いたインストール方法が用意されています。

詳しくは [SATySFi インストール手引き](https://qiita.com/na4zagin3/items/a6e025c17ef991a4c923) をご覧下さい。



```sh

# Ubuntu 20.04 の場合

sudo apt-get update

sudo apt-get install build-essential git m4 unzip curl pkg-config

sh <(curl -sL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)



# Mac の場合

# 要 homebrew (https://brew.sh/index_ja に従いインストールして下さい)

brew update

brew install opam



# 共通 OPAM の設定

opam init

eval $(opam env)

opam repository add satysfi-external https://github.com/gfngfn/satysfi-external-repo.git

opam repository add satyrographos https://github.com/na4zagin3/satyrographos-repo.git

opam update



# 共通 SATySFi のインストール

opam depext satysfi satysfi-dist satyrographos

opam install satysfi satysfi-dist satyrographos



# 共通 SATySFi 標準ライブラリのセットアップ

satyrographos install

```



## OPAM を使ったインストール方法



### 事前に必要なもの



ビルド前に最低限，以下のソフトウェアが必要です。



* bzip2

* cc

* git

* m4

* make

* unzip

* wget or curl

* [opam](https://opam.ocaml.org/) 2

    * インストール方法：

    * Windows の場合，bubblewrap 関係の問題を回避するため，Windows Subsystem for Linux (WSL) 2 をオススメします。

* ocaml 4.10.0 （OPAM からインストールします）



また，ビルドには外部 OPAM リポジトリの追加が必要です。これは以下のコマンドでできます：



```sh

opam repository add satysfi-external https://github.com/gfngfn/satysfi-external-repo.git

opam update

```



#### 準備例（Ubuntu）



```sh

sudo apt-get update

sudo apt-get install build-essential git m4 unzip curl



sh <(curl -sL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)



# 以下のコマンドは OPAM がファイルに追記してもよいか聞いてきます。

# 必ず説明を読み，環境変数を適切に設定してください。

opam init --comp 4.10.0



eval $(opam env)



opam repository add satysfi-external https://github.com/gfngfn/satysfi-external-repo.git

opam update

```



#### 準備例（OS X Mavericks 以降）



```sh

# このスクリプトを実行する前に，GCC や Make などの基本的なソフトウェアをインストールしておいてください。これらは Xcode Command Line Tools からインストールできます。

# また，Homebrew もインストールしてください。



brew update

brew install opam



# 以下のコマンドは OPAM が（~/.bash_profile などの）ファイルに環境変数に関する設定を追記してもよいか聞いてきます。

# 必ず説明を読み，環境変数を適切に設定してください。

opam init --comp 4.10.0



eval $(opam env)



opam repository add satysfi-external https://github.com/gfngfn/satysfi-external-repo.git

opam update

```



### ビルド



まず，このリポジトリを clone し，OPAM を使って SATySFi をビルドします：



```sh

# clone

git clone https://github.com/gfngfn/SATySFi.git

cd SATySFi



# build

opam pin add satysfi .

opam install satysfi

```



* 再インストール： `opam reinstall satysfi` を実行

* アンインストール： `opam uninstall satysfi` を実行



### セットアップ



使用する前に，フォントをダウンロードし，ライブラリ等を所定の場所に移す必要があります。以下のように2つのシェルスクリプトを順に実行します：



```sh

./download-fonts.sh

./install-libs.sh

```



前者はデフォルトで必要なフォントファイルを Web 上からダウンロードして `lib-satysfi/dist/fonts/` 直下に格納し，後者は `lib-satysfi/` 以下を `/usr/local/share/satysfi/` 以下にそのままコピーします。



ここでインストールされるフォントは以下の通りです。ライセンスを確認した上で使用してください：



* [Junicode](http://junicode.sourceforge.net)

* [IPA Font](https://moji.or.jp/ipafont/)

* [Latin Modern](http://www.gust.org.pl/projects/e-foundry/latin-modern/)

* [Latin Modern Math](http://www.gust.org.pl/projects/e-foundry/lm-math)



## 用法



```sh

satysfi  -o 

```



で `` から `` を出力します。例えばソースファイル `doc.saty` から `output.pdf` を出力したい場合，次のようにします：



```sh

satysfi doc.saty -o output.pdf

```



### コンパイルしてみよう



デモファイルが `demo` フォルダにあるので，初めにこのファイルをコンパイルしてみましょう。

このデモには `MakeFile` が用意されているので，`make` を実行するだけで完了します。



```sh

cd demo

make

```



うまく準備できていれば，`demo.pdf` が作成されます。



### リファレンス



詳細な解説である [The SATySFi​book](https://booth.pm/ja/items/1127224) が BOOTH にて公開されており，無償でダウンロードできます。このほか，SATySFi で文書を作成するためのごく簡単なリファレンスが `doc` フォルダに SATySFi を用いて書かれており，以下の処理で PDF が生成されます：



```sh

cd doc

make

```



## コマンドラインオプション



* `-v`, `--version`: ヴァージョンを表示します。

* `-o`, `--output`: 出力ファイル名を指定します。省略された場合，入力ファイル名の拡張子を `.pdf` に変えた名前を出力ファイル名とします。

* `-b`, `--bytecomp`: 評価前にバイトコンパイルを行ないます（複雑な計算に対して高速化が期待できます）。

* `--full-path`: 標準出力に書き込むログに於いて，ファイル名をすべて絶対パスで表示します。

* `--type-check-only`: 型検査だけをして終了します。

* `--debug-show-bbox`: （デバッグ目的で）各グリフにバウンディングボックスをつけて出力します。

* `--debug-show-space`: （デバッグ目的で）スペース部分に目印をつけて出力します。



## SATySFiを学ぶ



[Wiki](https://github.com/gfngfn/SATySFi/wiki/SATySFi-Wiki#%E5%AD%A6%E7%BF%92%E7%94%A8%E8%B3%87%E6%96%99) に学習用の資料があります。