README_ja.md

mdbook-playscript

戯曲を記述するために記法を拡張したMarkdownをmdBookで利用するためのプリプロセッサです。

インストール

現在はcargoでのインストールのみが可能です。

cargo install mdbook-playscript

使い方

mdbook initを実行した後にbook.tomlに以下の記述を追加してください。 その後、mdbook buildを実行すると拡張した記法を解釈した上でスタイル付けがなされたHTMLが出力されます。

日本語

日本語で書かれた戯曲用のスタイルシートを別に用意してあります。 日本語で戯曲を書く場合は、キーbook.languageの値をjaにしてください。 mdbook-playscriptはbook.languageの値を元にコピーするCSSファイルを決定します。 book.language = "ja"のときは、mdbook initを実行したディレクトリにmdplayscript_ja.cssをコピーします。

また、output.html.additional-cssの値をmdplayscript_ja.cssにする必要があります。 プリプロセッサがコンフィグを書き換えることはできないので手動で設定しなければなりません。

ルビ

book.tomlにpreprocessor.playscript.japanese-ruby.enable: trueを設定することで日本語のテキストにルビを振ることができます。ルビの記法はjapanese-ruby-filterのREADMEを参照してください。

文字数カウント機能

言語を日本語に設定している場合は、文字数カウント機能を有効化することができます。 文字数カウント機能を有効にするときは、book.tomlにpreprocessor.playscript.counting.enable: trueを設定してください。 また、output.html.additional-jsの値をplayscript-count.jsにする必要があります。

文字数カウント機能を利用しないファイルを設定することができます。preprocessor.playscript.counting.ignoreにsrc/から見た相対パスで記述したファイル名のリストを記述してください。

[book]
authors = ["（著者の名前）"]
language = "ja"
multilingual = false
src = "src"
title = "（作品のタイトル）"

[preprocessor.playscript]
command = "mdbook-playscript"
japanese-ruby.enable = true
counting.enable = true
counting.ignore = ["cover.md"]

[output.html]
additional-css = ["mdplayscript_ja.css"]
additional-js = ["playscript-count.js"]

記法

台詞

戯曲の台詞を書くために拡張した記法が導入されています。

記号>を使って登場人物とその台詞を記述することができます。

人物名> 台詞

ただし、>が行頭にある場合はMarkdownのブロッククオートとして解釈されます。

また、半角の括弧()を使うことでト書きを記述することができます。

人物名> 台詞(ト書き)

台詞には改行を含むことができます。ただし、空行は台詞の終わりと解釈されます。

人物名> 台詞1
台詞2

この行は台詞とはみなされない。

記号>を含まない段落でも次のHTMLコメントを記述することで台詞としてフォーマットさせることができます。 monologueという文字列が含まれますが、日本語戯曲では独白のみの場面であっても登場人物名を見出しに立てるようなので、この記法はト書きを独立させたいとき以外には使わないでしょう。

<!-- playscript-monologue-begin -->
(ト書き)
<!-- playscript-monologue-end -->

その他の記法

<!-- playscript-off -->でmdplayscriptによる変換をしないように指示できます。

<!-- playscript-on -->でmdplayscriptによる変換を行うように指示できます。

<!-- playscript-make-title -->でタイトルと著者を出力できます。

<!-- playscript-title -->でbook.tomlに記述したタイトルを出力できます。

<!-- playscript-authors -->でbook.tomlに記述した著者を出力できます。

実例

岡本かの子「取返し物語」をmdbook-playscriptを使って整形した戯曲の例として公開しています。 ソースコードはexamples/torikaeshiにあります。 なお、この戯曲は青空文庫より複製・整形したものです。