Timeline authoring for CLI workflows

Timeline DSL

年表をテキストで記述し、CLIで検証・生成するためのツールです。 歴史、創作設定、教材、組織の沿革をGit管理しやすい形式で扱えます。

ドキュメントを読む GitHubを見る
Latest v1.1.0 リリースノート
world-history.tdsl validated 
timeline "架空世界年表" {
  range 980..1260;
}

lane "王国" as realm;
lane "事件" as incident;

span realm 990..1184 "灰都王朝";
event incident 1042 "北方遠征";
event_range incident 1130..1137 "継承戦争";

年表作成を、再現できる作業にする

Timeline DSL は、手作業の図版編集ではなく、レビュー可能な入力ファイルとCLI出力を中心にした年表作成を目指します。

Author

年表をテキストで残す

イベント、期間、レーン、注釈を `.tdsl` として記述し、差分レビューしやすい形で保管できます。

Validate

CLIで壊れた年表を検出

構文、lane参照、重複ID、期間の前後関係をローカルやCIで確認できます。

Render

HTML / SVGへ描画

資料、ドキュメント、GitHub Pagesなどに置きやすいスタンドアロン成果物へ変換できます。

From source to artifact

書く、確かめる、見せるまでを同じ流れに置く

`.tdsl` は成果物そのものではなく、年表を再生成するための入力です。差分、CI、HTML出力がつながるので、長く更新する年表ほど扱いやすくなります。

01

テキストで編集

手書き、CSV取り込み、Wikidata scaffold から年表の材料を作ります。

02

CLIで検証

`tdsl check` と `tdsl lint` で、参照ミスや重複を公開前に見つけます。

03

HTML / SVGに出力

教材、社内資料、ドキュメントサイトへ置ける形で年表を描画します。

専門ツールとして、使い道は広く

一般向けの年表メーカーではなく、更新し続ける年表をテキストとして扱いたい人に向いています。

架空世界年表

物語・ゲーム設定

王朝、戦争、人物の生没、章ごとの事件をレーンで分け、設定資料として更新し続けられます。

日本史 / 世界史

授業・教材

時代区分と出来事を並べ、授業で扱う範囲だけをHTMLとして配布できます。

Company history

組織の沿革

創業、製品発表、拠点展開、制度変更を一つの履歴として保守できます。

Wikidata scaffold

調査・研究メモ

Wikidataの候補探索から手元の追記まで、出典確認前の仮説もテキストで管理できます。

まずはCLIを入れる

Homebrewでの導入を想定しています。詳しいセットアップと最初のファイル作成はQuick Startで確認できます。 

brew install keroway/tap/timeline-dsl