イントロダクション

まず KiTTy 自身のご紹介と類似製品との比較、 およびそれらに対する KiTTy の価値と利用シーンについてご紹介いたします。 また、サポート機能の一覧を簡単に提示いたします。

KiTTy とは

KiTTy は Kinx Tiny Typesetting を意味し、 Kinx で実装された簡易組版システムの名称です。 Markdown 形式からの簡易トランスレーターを実装しているため、 Markdown 形式で書かれたドキュメントを美しく組版することができます。 本文書自体も Markdown で記載されているものを自動組版した一つの事例です。

考え方は \LaTeX に近く、 テキスト形式で管理している文書ファイルを美しく組版することを目的としています。 より具体的には、本システムは \LaTeX を置き換えることを目的とはしていませんが、 以下を実現することによって、 より個人的な利用シーンの中で、より簡単に利用できるようにすることを目的としています。

• 小さなシステムを維持すること
• それなりに美しく組版できること
• 直接 PDF ファイルを出力できること

KiTTy は小さなシステムながらある程度美しく組版できる機能を持ち、 Markdown で書かれた文書から直接 PDF ファイルとして出力することができる組版システムです。

Versus \LaTeX

\LaTeX は巨大なシステムです。 拡張性にも優れ、多くの人々に支えられた美しい文書を作成するための組版システムです。 KiTTy も \LaTeX と同じ目的を持つ組版システムですが、 限られた機能しか提供しない代わりに小さなシステムとして提供されます。

\LaTeX の巨大さは、インストールの複雑さにもつながります。 \TeX、\LaTeX では様々な機能を提供するためにディストリビューションそのものが複数存在しています。 それにより、ユーザーはまずどのディストリビューションを使うべきかで悩むことになります。 KiTTy は、Kinx 用のパッケージ（Kinx Tiny Typesetting）として単独で配布されており、 Kinx と共にすぐに使えるようになります。

ただし、小さく、そして簡単に使える代わりにトレードオフとして限られた機能¹しか提供されないといった欠点があります。 また、組版スピードは非常に遅いです。 本文書をコンパイルするのに約 4 分ほどかかります。 パフォーマンスの改善は 1 つの課題ですが、小さなプロジェクトで個人的に利用することにフォーカスしています。

Versus Word

WYSIWYG² のワードプロセッサとして代表的な Word ですが、考え方が異なります。 WYSIWYG では見たままの形式で編集可能ですが、通常バイナリ形式で保存されます。 そのため、中に何が書かれているか知るには一般的に専用のソフトウェア（この場合 Word）が必要となります。 KiTTy は \LaTeX 同様、テキストエディタさえあれば内容を知ることができ、編集することも可能です。

テキストで保存されるということは、別のソフトウェアで処理することも簡単であり、 Git のようなバージョン管理システム上で差分を確認することも容易です。 このことは特に、差分管理をバージョン管理システム上で実現したい場合には必須となる特徴です。

また、文書構造に関しても、 Word では直接その見た目から「構造化されたもの」か「見た目だけ整っているのか」の区別がつきません。 例えば、章番号がきちんと設定され、 文章の配置やレイアウトを変更した際に正しく番号を付け直してくれるかなど判別しづらいといった欠点もあります。 特に、書き方に関わらず「見た目として正しく見えてしまっている」ということにより、 他者の作成したファイルでは正しく設定されていなかった、といった不運もたびたび見られます。

KiTTy では、文書構造をテキストで表現する関係上、 章やセクション、図、表などのリファレンスを常に正しく把握し、 適切な番号付け、および相互参照機能を実現することができます。

その代わり、WYSIWYG のようにその場で出力後の体裁（見た目）を確認することができない、 といった欠点があります。

Versus Vivliostyle

CSS 組版は Web 技術に基づいています。 CSS 組版は今現在最も将来性のある取り組みでしょう。 したがって、本格的に取り組むには CSS 組版がおすすめです。 その中でも Vivliostyle³ は非常に有望なプロジェクトです。

KiTTy ではやはり「小さなシステム」という部分に価値を置いています。 手軽に扱えることが重要です。 時間が解決することではありますが、 CSS 組版は現時点で標準化の推進と並行して活動が行われています。 したがって仕様が未確定な部分も多く、今後仕様変更なども多く行われることが予想されます。 また、大規模に標準化等を進めていますので、 商用にも耐えうるシステムとなる一方でシステム自体は巨大になるでしょう。

KiTTy は小さく手軽に扱えることを一番のポイントとしています。

結論

現時点で本格的な組版を利用したい場合は \LaTeX を使いましょう。 将来にわたって本格的な組版技術を学び、活用していきたい場合は Vivliostyle などの CSS 組版を学びましょう。 その上で、要約すると以下のケースにおいて KiTTy は有益でしょう。

• \TeX のような巨大なシステムではなく、小さな組版システムで簡単に利用したい
• Git のようなバージョン管理システムを使った差分管理をしたい
• 文書構造を常に適切に把握し、相互参照などを正確に実施したい

ちょっとした文書作成のために \TeX をフルセットで使うには巨大すぎる、と感じている方で、 テキストで文書管理をしたい、と考えている方⁴のために本システムを作成しました。 特に、Git で差分を含めた文書管理を行いたい場合、 WYSIWYG で実現されているワープロソフトでの管理は大変困難です。 主に、ワープロソフトでは管理したくないけれど高機能な組版ソフトは大がかりすぎる、 といった利用シーンを想定しています。

サポート機能

組版機能

KiTTy は組版機能として、以下の機能をサポートしています。 具体的な機能の内容に関しては、「\nameref{機能概要}」を参照してください。 なお、カーニングは現在サポートしていません。

• ハイフネーション・ジャスティフィケーション・行分割
• ウィドウ／オーファン
• マルチカラム
• 箇条書き
• 数式
• イメージ
• グラフ（チャート）
• テーブル
• フォント
• 色
• 合字・特殊文字
• プログラム・コード
• タイトル・カバーページ・目次
• 見出し
• 相互参照
• 引用
• 脚注

日本語用組版機能

基本的な組版機能に加え、以下の日本語特有の処理が組み込まれています。 日本語以外の言語への拡張は私自身に知見が乏しく言語ごとの固有の拡張ポイントを意識していないため、 大幅な修正、もしくは機能追加が必要かもしれません。 ただし、ソースコードは公開されているので必要に応じて拡張することは可能でしょう。

• 日本語禁則処理
• 日本語ルビ

PDF 機能

印刷した際には表面に現れてきませんが、 以下の機能を PDF 機能としてサポートしています。

• 外部リンク
• 相互参照リンク
• しおり

さあ始めよう

KiTTy を実際に始めるための準備と、 簡単な例を通した使い方をご紹介いたします。 なお、準備に関しては Windows と Linux で異なりますが、 あらかじめ準備されているフォントを同じように利用する限り Windows、Linux で同じ出力が得られるようになっていますので、 どちらで使用しても問題ありません。

インストール

KiTTy は現在 Kinx Tiny Typesetting という Kinx のパッケージとして配布されています。 そのため、インストールは以下の 2 ステップを実施します。

1. Kinx のインストール
2. Kinx Tiny Typesetting パッケージのインストール

Kinx のインストール

まずはじめに、Kinx のインストールを行います。

Windows

Windows では Scoop を使います。 以下のようにコマンドラインから実行します。

$ scoop bucket add kinx https://github.com/Kray-G/kinx
$ scoop install kinx
$ kinx --install-path

まず Kinx 用 Bucket の URL を登録します。この登録は最初に 1 度だけ必要です。 Bucket が登録されていれば、scoop install kinx コマンドでインストールできます。 Scoop でインストールした際は、パッケージコマンドへのパスを通すために kinx --install-path コマンドを実行してください。

Linux

Linux(Ubuntu) では、Relases ページから .deb ファイルをダウンロードします⁵。 ダウンロードしたディレクトリに移動し、次のようにインストールします。

$ sudo apt install ./kinx_1.1.0-0_amd64.deb

Kinx Tiny Typwsetting パッケージのインストール

Windows

Kinx のパッケージをインストールするには kip コマンドを使用します。 コマンドプロンプトで以下のように実行することで、自動的に最新版数のパッケージがインストールされます。

$ kip install typesetting

Linux

Linux でも Windows と概ね同じですが、Linux では管理者権限が必要です。 必要に応じて sudo コマンドを使用してください。

$ sudo kip install typesetting

hello, world

次の文書を作成し、helloworld.md ファイルとして保存します。

% Hello Kinx Tiny Typesetting
% Your name
% October 7, 2020

# Greeting
hello, world

以下のように kxkitty コマンドを実行することで、helloworld.pdf が作成されます。

$ kxkitty helloworld.md

機能概要

ここでは機能の概要を説明いたします。 本書自体 KiTTy で組版されていますので、 本書で実現できていることはすべて実現可能です。 まずは色々と試してみましょう。

組版機能

ハイフネーション・ジャスティフィケーション・行分割

Franklin M. Liang のアルゴリズムに基づくハイフネーションをサポートしています。 また、ハイフネーションに伴うジャスティフィケーション（両端揃え）機能をサポートしています。

行分割は Knuth-Plass Line Breaking アルゴリズムを採用しています。 本アルゴリズムは、Box、Glue、Penalty によって分割位置をコントロールするアルゴリズムであり、 \TeX で実装されているアルゴリズムと同様です。 これらハイフネーション・アルゴリズムも行分割アルゴリズムも、 今のところ組版システムでは最良の方法として知られている方法です。 ただし、実装自体は Kinx で改めて行われているため、 必ずしも出力結果は \TeX での出力と同一にはならない場合があります。

ウィドウ／オーファン

ウィドウ、およびオーファンに対するペナルティ処理を一部ですが実施します。 全てのケースで有効ではありませんのでご注意ください。 具体的には以下のケースで有効です。

• セクション名がページの最後に取り残されるケースを抑止。
  • この場合、セクション名ごと次のページに追い出されます。
• 複数行パラグラフにおいて、最初の行のみ前のページに残るケースを抑止。
  • この場合、全ての行が次のページに追い出されます。
  • この処理の結果としてセクションが残る場合、セクション自体も次のページに追い出されます。
• 複数行パラグラフにおいて、最後の行のみ次のページに送られるケースを抑止。
  • この場合、最後の 2 行分が次のページに追い出されます。

これらの処理は自動的に行われます。 特に文書内に指示を記載する必要はありません。 ただし、全てのケースで正しく動作をする訳ではありませんので、 うまくレイアウトされない場合は必要に応じて <pagebreak/> コマンドを使って改ページを行ってください。

*   レベル1
    *   レベル2
        *   レベル3
            *   レベル4

1.  レベル1
    1.  レベル2
        1.  レベル3
            1.  レベル4
            1.  レベル4

*   レベル1
    1.  レベル2
        *   レベル3
            1.  レベル4

```math:label=Math1
\begin{aligned}
    \int_{-\infty}^{\infty} f(x) dx &= \sqrt{\pi}
\end{aligned}
```

\begin{aligned}
    \int_{-\infty}^{\infty} f(x) dx &= \sqrt{\pi}
\end{aligned}

```math:label=Math2(0.2)/Math3(0.6)
\begin{aligned}
    E &= mc^2 \\
    m &= \frac{m_0}{\sqrt{1-\frac{v^2}{c^2}}} \\
\end{aligned}
```

\begin{aligned}
    E &= mc^2 \\
    m &= \frac{m_0}{\sqrt{1-\frac{v^2}{c^2}}} \\
\end{aligned}

![scale=0.6](kinxlogo.png)

ファイルアイコンは ![scale=0.08,offsetY=-5.0](zip256.png) になります。

{
    width: 800,
    height: 400,
    fontSize: 16,
    scale: 1.0,
    label: "Fig:RadarExample",
    caption: "Radar Chart Example",
    options: {
        type: "radar",
        data: {
            labels: [["Eating", "Dinner"], ["Drinking", "Water"],
                "Sleeping", ["Designing", "Graphics"],
                "Coding", "Cycling", "Running"],
            datasets: [{
                label: "My First dataset",
                backgroundColor: "rgba(255, 0, 0, 0.2)",
                borderColor: "red",
                pointBackgroundColor: "red",
                data: [ 10.1, 80.0, 72.2, 73.3, 55.0, 68.5, 92.0 ]
            }, {
                label: "My Second dataset",
                backgroundColor: "rgba(0, 0, 255, 0.2)",
                borderColor: "blue",
                pointBackgroundColor: "blue",
                data: [ 30.9, 77.1, 49.9, 50.0, 67.8, 71.0, 22.8 ]
            }]
        },
        options: {
            legend: {
                position: "top",
            },
            scale: {
                ticks: {
                    beginAtZero: true
                }
            }
        }
    }
}

{
    float: { right: true },
    width: 480,
    height: 300,
    scale: 0.4,
    caption: "Line Chart Example",
    options: {
        type: "line",
        data: {
            labels: ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul"],
            datasets:[{
                lineTension: 0,
                label: "Line A",
                data: [ 10.9, 32.8, 44.1, 56.9, 78.3, 64.2, 91.2],
                backgroundColor: "rgba(0, 0, 255, 0.2)",
                borderColor: "rgb(0, 0, 255)",
                borderWidth: 1
            }]
        },
        options: {
            legend: {
                labels: {
                    fontColor: "#0000ff"
                }
            }
        }
    }
}

```chart
{
    float: { right: true },
    width: 480, height: 300, scale: 0.4, caption: "Line Chart Example",
    options: {
        type: "line",
        ...(省略)
    }
}
```

<context label="Table:ImageOptions"/>
<context caption="イメージ・オプション"/>
| オプション |       値        |             意味             |
| ---------- | --------------- | ---------------------------- |
| `float`    | `left`, `right` | フローティング位置           |
| `scale`    | 0.0 ～ 1.0      | 実数、版面の幅に対する拡大率 |
| `caption`  | キャプション    | 図のキャプション             |

<context label="Table:TableExample"/>
<context caption="テーブル記述の例"/>
<context vline-left="single"/>
<context vline-right="single"/>
<context vline-inside="single"/>
<context hline-header="double"/>
<context hline-inside="single"/>
<context cell-2-1="$\displaystyle\int_{-\infty}^{\infty} f(x) dx = \sqrt{\pi}$"/>
| 左寄せ |         中寄せ         |        右寄せ         |
| :----- | :--------------------: | --------------------: |
| A1     | Aligned to the center. | Aligned to the right. |
| A2     |  Cell $(1,1)$          |      Cell $(1,2)$     |
| A3     |           -            |      Cell $(2,2)$     |

<font-load info="Name,type,shape,FileName.ttf" />

<font-load info="Parisienne,serif,regular,Parisienne-Regular.ttf" />
Changing the font is available only with a scope like
''\\font\[name=Parisienne\]{This is a pen.},''
and the font will be restored here.

「この後フォントが 7pt に \\font\[size=7pt\]{縮小} します。
また、この後フォントが 15pt に \\font\[size=15pt\]{拡大} します。」
と表現されます。
また、例えば `\font[size=1.2em]{サイズ 1.2 倍}` と記載すると、
\\font\[size=1.2em\]{サイズ 1.2 倍} と表現されます。

次の文章は `\bigger` の例です。
\\bigger{これが「\\bigger{これが「\\bigger{これが「文章」です}」です}」です}、
となります。
また、`\smaller` は、
\\smaller{これが「\\smaller{これが「\\smaller{これが「文章」です}」です}」です}、
となります。

*   \\color\[red\]{\\bold{Red}.
    This line should be colored by the name of `red`.}
*   \\color\[green\]{\\bold{Green}.
    This line should be colored by the name of `green`.}
*   \\color\[blue\]{\\bold{Blue}.
    This line should be colored by the name of `blue`.}
*   \\color\[cyan1\]{\\bold{Cyan}.
    This line should be colored by the name of `cyan1`.}
*   \\color\[magenta1\]{\\bold{Magenta}.
    This line should be colored by the name of `magenta1`.}
*   \\color\[yellow\]{\\bold{Yellow}.
    This line should be colored by the name of `yellow`.}
*   \\color\[R=0,G=64,B=255\]{\\bold{RGB}.
    This line should be colored by RGB value of `RGB=0,64,255`.}
*   \\color\[C=0.5,M=0.8,Y=0.2,K=0.0\]{\\bold{CMYK}.
    This line should be colored by CMYK value of `CMYK=0.5,0.8,0.2,0.0`.}

これは ''サンプル'' です。

```
class Test {
    public test() {
        # Test Method.
    }
}
```

class Test {
    public test() {
        # Test Method.
    }
}

```:lineNumber=false,box=BOX_NORMAL
class Test {
    public test() {
        # Test Method.
    }
}
```

class Test {
    public test() {
        # Test Method.
    }
}

<code-style lang="ruby" name="box" value="shadow" />
<code-style lang="ruby" name="background-color" value="lightcyan1" />

// This is a kinx block.
function fib(n) {
    if (n < 3) return n;
    return fib(n-2) + fib(n-1);
}
System.println(fib(34));

# This is a python block.
def fib(n):
    if n < 3:
        return n
    else:
        return fib(n-1) + fib(n-2)
print fib(34)

# This is a ruby block.
def fib(n)
  return n if n < 3
  fib(n-1) + fib(n-2)
end
p fib(34)

% KiTTy
% Kray-G, Mr.Diamond Global Blue Publisher
% September 18, 2020

小さくて簡単、でも美しいデザイン。

<param style="JBookA4"/>
<param titleSize="78.8"/>
<param subtitleSize="14.4"/>
<param backgroundImage="back.jpg"/>

<toc with="lof,lot"/>

<style-info name="chapter.style" value="BigChapter3" />

> **KiTTy** は **Ki**nx **T**iny **Ty**pesetting を意味し、
> Kinx で実装された簡易組版システムの名称です。
> > \\noindent Markdown 形式からの簡易トランスレーターを実装しているため、
> > Markdown 形式で書かれたドキュメントを美しく組版することができます。
> > 本文書自体も Markdown で記載されているものを自動組版した一つの事例です。
> 
> 考え方は \\LaTeX に近く、
> テキスト形式で管理している文書ファイルを美しく組版することを目的としています。

この文章に脚注[^f1]を置きます。

[^f1]: これが脚注になります。

> ある日の事でございます。\\ruby\[おしゃかさま\]{御釈迦様}は
> 極楽の\\ruby\[はすいけ\]{蓮池}のふちを、
> 独りでぶらぶら御歩きになっていらっしゃいました。

> ある日の事でございます。\\ruby\[お|しゃ|か|さま\]{御釈迦様}は
> 極楽の\\ruby\[はす|いけ\]{蓮池}のふちを、
> 独りでぶらぶら御歩きになっていらっしゃいました。

$INSTALL/lib/std/typesetting/style/additional/*.kx

$INSTALL/lib/std/typesetting/style/basic/*.kx

$INSTALL/lib/std/typesetting/style/Styles.kx

using typesetting.style.basic.JArticleA4;

namespace Typesetting {
namespace Style {

    class JArticleA4_2Cols : Typesetting.Style.JArticleA4 {
        @style.columns = 2;
    }

} # namespace Style
} # namespace Typesetting

$INSTALL/lib/std/typesetting/style/title/*.kx

<style-info name="title.style" value="yourstylename" />

namespace Typesetting {
namespace Style {

    Typesetting.Style.Title[__FILE__.stem()]
        = function(info, context, core, title, opts) {
            # 描画ロジックを記載。
        };

} # namespace Style
} # namespace Typesetting

$INSTALL/lib/std/typesetting/style/chapter/*.kx

<style-info name="chapter.style" value="yourstylename" />

namespace Typesetting {
namespace Style {

    Typesetting.Style.Chapter[__FILE__.stem()]
        = function(info, context, core, text, opts) {
            # 描画ロジックを記載。
        };

} # namespace Style
} # namespace Typesetting

$INSTALL/lib/std/typesetting/lang/*.kx

<style-info name="hyphenationRule" value="yourprocname" />

Typesetting.insertGlue[__FILE__.stem()] = _function(info, Linebreak, wordlist, nodes) {
    # 禁則処理のロジックを記載。

    wordlist.each { &(node, i):
        # ...
        nodes.push(Linebreak.Glue(0, Linebreak.Infinity, 0));
        nodes.push(Linebreak.Penalty(0, -Linebreak.Infinity, 0));
        nodes.push(node);
        # ...
    };
};

nodes.push(Linebreak.Penalty(0, Linebreak.Infinity, 0));
nodes.push(node);   # 対象のノード

nodes.push(node);   # 対象のノード
nodes.push(Linebreak.Penalty(0, Linebreak.Infinity, 0));

nodes.push(Linebreak.Glue(0, Linebreak.Infinity, 0));
nodes.push(Linebreak.Penalty(0, Linebreak.Infinity, 0));
nodes.push(node);   # 対象のノード

nodes.push(Linebreak.Glue(width, stretch, shrink));
    # width ..... 空白の幅
    # stretch ... 空白が伸びる場合の最大の伸び幅
    # shrink .... 空白が縮む場合の最大の縮み幅
nodes.push(node);   # 対象のノード

$INSTALL/lib/fonts

<font-load info="Times,serif,regular,times.ttf" />

* This is a Regular Style of a default font.
* \\font\[name=Times\]{Times New Roman of Regular Style}

$INSTALL/lib/std/typesetting/command/inline/*.kx
$INSTALL/lib/std/typesetting/command/paragraph/*.kx

namespace Typesetting {
namespace Command {

    class Command(info_, context_) {
        public exec(params) {
            var ws = new Typesetting.WordSet(info_);
            # ...
            return ws;
        }
    }

} # namespace Command
} # namespace Typesetting

namespace Typesetting {
namespace ParagraphCommand {

    class Command(info_, context_) {
        public start() {
            # `{` が開始した際に実施する処理
        }
        public end() {
            # 対応する `}` が現れた際に実施する処理
        }
        public translate(value) {
            # `{` と `}` に挟まれたパラグラフ情報が value として入力される
            # value はパラグラフ処理された後なので、WordSet オブジェクト等の配列
            # value に対して変換が必要、または情報を追加する場合、ここで処理を行う
            # end() 処理の前に呼ばれる
        }
    }

} # namespace Command
} # namespace Typesetting