Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinchoku-tairiku/shinchoku-tairiku.satyh
進捗大陸で使用されたSATySFiファイル
https://github.com/shinchoku-tairiku/shinchoku-tairiku.satyh
satysfi
Last synced: about 2 months ago
JSON representation
進捗大陸で使用されたSATySFiファイル
- Host: GitHub
- URL: https://github.com/shinchoku-tairiku/shinchoku-tairiku.satyh
- Owner: shinchoku-tairiku
- License: lgpl-3.0
- Created: 2019-04-17T10:50:24.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-22T12:41:16.000Z (over 1 year ago)
- Last Synced: 2024-04-08T02:21:54.048Z (5 months ago)
- Topics: satysfi
- Language: Shell
- Homepage: https://shinchoku-tairiku.github.io/web/
- Size: 1.21 MB
- Stars: 12
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-satysfi - shinchoku-tairiku.satyh - 進捗大陸で使用された SATySFi ファイル (Uncategorized / Uncategorized)
README
# shinchoku-tairiku.satyh
進捗大陸で使用された SATySFi クラスライブラリ
- [進捗大陸06](../../tree/book06)
- [進捗大陸05](../../tree/book05)
## インストール
opam と Satyrographos でインストールできます。satyrographos-repo にはアップロードされていません。
紙面のサイズは`B5-Japan`になります。
現状、`master`ブランチは更に裁ち落とし付き(全辺+3mm)。`master+no-offset`ブランチは裁ち落としが無い設定になっています。
(TODO: ブランチではなくパラメータで設定できるようにする。)
```
git clone git://github.com/shinchoku-tairiku/shinchoku-tairiku.satyh
cd shinchoku-tairiku.satyh
opam pin add satysfi-class-shinchoku-tairiku .
satyrographos install
```
## 使い方
```
@require: class-shinchoku-tairiku/shinchoku-tairiku
document '<
+p{
satysfi-class-shinchoku-tairikuはサークル進捗大陸で使用しているクラスライブラリです。
}
> '<
+chapter?*{章タイトル}{謎の名言}<
+p{
これは章
}
+section{セクション}<
+p{
これはセクション
}
+subsection{サブセクション}<
+p{
これはサブセクション
}
>
>
>
>
```
その他のコマンドは `doc/` 以下をご覧ください。
## 開発方法
以下を事前にインストールしてください。
- `opam`
- `opam` によってインストールされた `satysfi`
- `opam` によってインストールされた `satyrographos`
- (テストの実行のみ) [`diff-pdf`](https://github.com/vslavik/diff-pdf)
### クラスライブラリの開発
`src/` 以下を編集し、以下のコマンドを実行すると、更新されたクラスライブラリがインストールされます。
```
make install
```
テストは `test` ディレクトリ以下にあります。以下のコマンドで実行できます。
```
make test
```
`build.sh` で各テストケースのビルド結果 (`${TESTCASE}_actual.pdf`) を生成し、`check.sh` で期待する内容 (`${TESTCASE}_expected.pdf`) と一致するかどうかを確認します。`build.sh` の実行には `satysfi` コマンドが、`check.sh` の実行には `diff-pdf` コマンドがそれぞれ必要です。`check.sh` によって `${TESTCASE}_actual.pdf` と `${TESTCASE}_expected.pdf` との差分 `${TESTCASE}_diff.pdf` が生成されます。
何らかの変更によってテストケースが通らなくなったときは、`${TESTCASE}_actual.pdf` と `${TESTCASE}_diff.pdf` を確認して、問題なさそうであれば `update.sh ${TESTCASE}` を実行して期待する出力結果を更新します。
#### ディレクトリ構造
- `src/shinchoku-tairiku.satyh`
- `class-shinchoku-tairiku` のトップレベルです
- `document` 関数とすべてのコマンドの定義を含みます
- `src/config.satyh`
- `class-shinchoku-tairiku` の設定値です
- `src/components/`
- `class-shinchoku-tairiku` のコンポーネント群 (目次や見出しなど) です
- `block-boxes` あるいは `inline-boxes` を返す `ModuleName.foo-scheme` という名前の関数を持ちます
- `src/lib/`
- `class-shinchoku-tairiku` 以外でも使える汎用的なライブラリです
- ここにあるモジュールは同じ階層のモジュールあるいは外部パッケージにのみ依存するようにします
### マニュアルの執筆
`doc/` 以下を編集し、以下のコマンドでビルドします。結果が `doc/manual.pdf` に出力されます。
```
make doc
```
## 標準ライブラリをコピーして編集したもの
見た目などの理由で標準ライブラリの関数を再実装しています
- `src/itemize.satyh`
## 謝辞
この設定ファイルはSATySFiの標準ライブラリ・先人たちのコード片を大量に集めてきています。
先人たちに感謝します。