糖衣構文

概要

　サンプルとして、独自の糖衣構文（yakumo記法）を bltxt文書に変換する変換資材 fyakumoが用意されています。
　詳細は resources/io/github/longfish801/yakumo 配下にある変換資材の各ファイルのコメントなどを参照してください。
　bltxt記法上の特殊文字のエスケープには必ずしも対応していません。特殊文字を用いるときには直接 bltxt記法で記述してください。

糖衣構文

見出し

　行頭に「■」「□」「▼」があれば、見出しとみなします。

■おいしいカレーの作り方
□材料の準備
▼牛の飼い方

　上記を以下のbltxt文書に変換します。

【＝見出し：1】おいしいカレーの作り方
【＝見出し：2】材料の準備
【＝見出し：3】牛の飼い方

　全角シャープ（＃）を区切りとして末尾に別名を与えることができます。
　これはドキュメント内リンクに利用できます。
　詳細は 参照 を参照してください。

■ごちそうさまでした＃ごちさま

　上記を以下のbltxt文書に変換します。

【＝見出し：1：ごちさま】ごちそうさまでした

箇条書き

　一文字目に全角中黒（・）があれば、箇条書きとみなします。
　半角空白でインデントすることで、複数行を記述できます。
　項目の間に空行があっても無視します。
　箇条書きを終了するには全角中黒始まりではない行を記述してください。

・じゃがいも
・ニンジンを、
  二本。

・玉ねぎ

　上記を以下のbltxt文書に変換します。

【－箇条書き】
【－項目】
じゃがいも
【項目－】
【－項目】
ニンジンを、
二本。
【項目－】
【－項目】
玉ねぎ
【項目－】
【箇条書き－】

　入れ子にすることもできます。
　インデントとして半角スペース２個が必要です。

・じゃがいも
・ニンジン
・玉ねぎ
  ・刻むときは注意。
    涙がでます。
・カレー粉
  ・ジャワカレー
  ・バーモンドカレー

　上記を以下のbltxt文書に変換します。

【－箇条書き】
【－項目】
じゃがいも
【項目－】
【－項目】
ニンジン
【項目－】
【－項目】
玉ねぎ
【－箇条書き】
【－項目】
刻むときは注意。
涙がでます。
【項目－】
【箇条書き－】
【項目－】
【－項目】
カレー粉
【－箇条書き】
【－項目】
ジャワカレー
【項目－】
【－項目】
バーモンドカレー
【項目－】
【箇条書き－】
【項目－】
【箇条書き－】

手順

　一文字目に全角シャープ（＃）があれば、手順とみなします。
　半角空白でインデントすることで、複数行を記述できます。
　項目の間に空行があっても無視します。
　手順を終了するには全角シャープ始まりではない行を記述してください。

＃まずマスクをつけます。
＃手をよく洗ってください。
  指と指の間や爪の隙間もね。
＃それでは、いただきます！

　上記を以下のbltxt文書に変換します。

【－手順】
【＝項目】まずマスクをつけます。
【－項目】
手をよく洗ってください。
指と指の間や爪の隙間もね。
【項目－】
【＝項目】それでは、いただきます！
【手順－】

用語説明

　行の先頭に全角カンマ（：）２個があれば、用語説明の用語とみなします。
　行の先頭に全角カンマ（：）１個があれば、用語説明の説明とみなします。
　項目の間に空行があっても無視します。
　箇条書きを終了するには全角カンマ始まりではない行を記述してください。

：：甘口
：いちばん辛みが穏やか。子供向け。
：：中辛
：中くらいの辛さ。一般的。
：：大辛
：とても辛い。マニアック。

　上記を以下のbltxt文書に変換します。

【－用語説明】
【＝用語】甘口
【＝説明】いちばん辛みが穏やか。子供向け。
【＝用語】中辛
【＝説明】中くらいの辛さ。一般的。
【＝用語】大辛
【＝説明】とても辛い。マニアック。
【用語説明－】

行範囲タグ

　行範囲タグの代替表現として、全角イコールを用いた区切り行が使えます。
　全角イコール３つで挟んだ内容を行範囲開始タグの内容とします。
　終端の区切り行は開始の区切り行と同じ文字列にしてください。

　たとえば引用は次のように書けます。

＝＝＝引用＝＝＝
　山路を登りながら、こう考えた。
　智に働けば角が立つ。情に棹させば流される。意地を通せば窮屈だ。とかくに人の世は住みにくい。
【＝引用元】夏目漱石『草枕』
＝＝＝引用＝＝＝

　上記を以下のbltxt文書に変換します。

【－引用】
　山路を登りながら、こう考えた。
　智に働けば角が立つ。情に棹させば流される。意地を通せば窮屈だ。とかくに人の世は住みにくい。
【＝引用元】夏目漱石『草枕』
【引用－】

　属性を指定することもできます。

＝＝＝注意：中火とは＝＝＝
　中火とは、フライパンの底に炎の先端がちょうど届くくらいの状態を指します。
＝＝＝注意：中火とは＝＝＝

　上記を以下のbltxt文書に変換します。

【－注意：中火とは】
　中火とは、フライパンの底に炎の先端がちょうど届くくらいの状態を指します。
【注意－】

マスキング

　yakumo記法の糖衣構文で、switemスクリプトによる整形の対象外としたい文章を表現できます。

【－マスキング】
・帰りに綿棒を買ってくること。
【マスキング－】

　上記を以下のbltxt文書に変換します。
　本来なら箇条書きとして整形されるはずですが、マスキングしているため処理の対象外となっています。
　行範囲タグは削除されることにご注意ください。

・帰りに綿棒を買ってくること。

文範囲終了タグの省略

　以下は本来ならば文範囲タグを用いて記述すべきですが、文範囲終了タグを省略して文中タグのように記述することができます。

リンク

　リンクの場合は以下のとおりです。
　一番目の属性にリンクとして表示する文字列を、二番目の属性にリンク先アドレスを指定してください。
　一番目の属性のみ指定した場合は、表示する文字列とリンク先アドレスを同じ値とみなします。

　詳しくは【リンク：ネット検索：https://www.google.com/】してください。
　【リンク：https://www.google.com/】でネット検索できます。

　上記を以下のbltxt文書に変換します。

　詳しくは【｜リンク：https://www.google.com/】ネット検索【リンク｜】してください。
　【｜リンク：https://www.google.com/】https://www.google.com/【リンク｜】でネット検索できます。

　特例として、URLのみが記述された行もリンクとみなして文範囲タグに変換します。

https://www.google.com/

　上記を以下のbltxt文書に変換します。

【｜リンク：https://www.google.com/】https://www.google.com/【リンク｜】

参照

　参照の場合は以下のとおりです。
　一番目の属性にリンクとして表示する文字列を、二番目の属性に別名を指定してください。
　もしくは一番目の属性に見出しの文字列を指定してください。

　もう満腹ですか？ それでは【参照：さようなら：＃ごちさま】。
　詳細は「【参照：おいしいカレーの作り方】」を参照してください。

　上記を以下のbltxt文書に変換します。

　もう満腹ですか？ それでは【｜参照：＃ごちさま】さようなら【参照｜】。
　詳細は「【｜参照】おいしいカレーの作り方【参照｜】」を参照してください。

注目など

　注目の場合は以下のとおりです。

　危ない！ それは【注目：自爆スイッチ】だ！

　上記を以下のbltxt文書に変換します。

　危ない！ それは【｜注目】自爆スイッチ【注目｜】だ！

ルビなど

　ルビの場合は以下のとおりです。
　一番目の属性にルビをふる対象を、二番目の属性にルビを指定します。

　【ルビ：出納：すいとう】係は言った。

　上記を以下のbltxt文書に変換します。

　【｜ルビ：すいとう】出納【ルビ｜】係は言った。

カクヨム記法

　カクヨムのうち、以下に対応しています。

・ルビ（ただし範囲を明示）
・傍点

　ルビの場合は以下のとおりです。

　｜出納《すいとう》係は言った。

　上記を以下のbltxt文書に変換します。

　【｜ルビ：すいとう】出納【ルビ｜】係は言った。

　傍点の場合は以下のとおりです。

　まだ《《午前三時》》じゃないか。

　上記を以下のbltxt文書に変換します。

　まだ【｜傍点】午前三時【傍点｜】じゃないか。