Inline Syntax Specification
@Doc Inline Syntax Specification v1.5
⚠️ この文書は AI による翻訳です。誤りが含まれる可能性があります。 正確な内容を確認したい場合は、繁體中文版 または English 版 をご参照ください。
0. 目次
- 1. 設計思想
- 2. Lexer の動作定義
- 3. 曖昧性解消ルール
- 4. 完全なEBNF文法定義
- 5. エスケープ規則
- 6. 未知コマンドのフォールバック
- 7. @mark / @color / @bordered スタイル意味論
- 8. @link URI 意味論
- 9. @raw 不透明ドメイン
- 10. ネストされたパース
- 11. パーサーのリカバリー戦略
- 12. アーキテクチャ
- 13. コア原則
- 14. 簡易構文エイリアス
- 15. Semantic Inline: @spoiler and @hex
1. 設計思想
@Doc は次を採用する:
Only Known Commands Trigger Parsing
既知の命令だけが構文上の意味を持つ。
未知の命令は常に通常のテキストとして扱われる。
この設計の目標:
- 学習コストを下げる
- Email、Mention システムとの衝突を避ける
- AI のパース安定性を高める
- エディタの耐障害性を高める
- DSL の拡張性を保つ
- 安定して予測可能な AST を構築する
2. Lexer の動作定義
コマンド解析規則
Lexer が @ をスキャンしたとき、以下の優先順位で処理すべきである:
- 直後が
@@の場合- 単一のプレーンテキスト
@としてパースする
- 単一のプレーンテキスト
- 直後が登録済みの命令名に一致する場合
- 対応する構文解析フローに入る
- どの既知の命令にも一致しない場合
- 全体を通常のテキストとして出力する
例
| 入力 | 結果 |
|---|---|
@mark[hello] | mark ノードとしてパースされる |
@@mark | @mark を出力 |
[email protected] | プレーンテキスト |
@GitHub | プレーンテキスト |
@unknown | プレーンテキスト |
3. 曖昧性解消ルール
@Doc は次を採用しているため:
Known Command Recognition
Lexer は先に既知の命令の認識を試み、それから通常のテキストモードにフォールバックしなければならない。
言い換えれば:
inline-nodeの優先度はplain-text-charより高い。
Lexer は次に従わなければならない:
@ で始まる
↓
@@ かどうか?
↓
Command Registry に存在するか?
↓
はい → Inline Node
いいえ → Plain Textしたがって:
@mark[hello]必ず次のようにパースされなければならない:
InlineNode(mark)次のようにではない:
Text('@')
Text('m')
Text('a')
Text('r')
Text('k')
...4. 完全なEBNF文法定義
(* ==========================================================================
Entry Point
========================================================================== *)
inline-stream =
{ inline-node | plain-text-char } ;
inline-node =
mark
| color
| bordered
| bold
| italic
| underline
| del
| raw
| sup
| sub
| fn
| defn
| kbd
| link
| spoiler
| hex
| br
| escape ;
(* ==========================================================================
Inline Nodes
========================================================================== *)
mark = "@mark" , [ styles ] , content ;
color = "@color" , [ styles ] , content ;
(* @bordered shares @color's exact {styles} slot and swatch (see §7),
applied as a text border instead of a foreground color. *)
bordered = "@bordered" , [ styles ] , content ;
bold = ( "@bold" | "@b" ) , content ;
italic = ( "@italic" | "@i" ) , content ;
underline = ( "@underline" | "@u" ) , content ;
del = "@del" , content ;
raw = "@raw" , raw-content ;
sup = "@sup" , content ;
sub = "@sub" , content ;
(* Footnotes:
fn = 本文中の参照点(上付き番号)であり、番号のみを持つ
defn = 脚注定義の本体であり、番号と実際の内容を持つ
*)
fn = "@fn" , "[" , integer , "]" ;
(* The modifier of defn is the footnote id. It must be an integer to be
referenceable at all — fn's own "[...]" only accepts an integer, so a
non-numeric id can be written but no @fn can ever point at it. The Parser
reports it (see §11 Diagnostics). *)
defn = "@defn" , modifier , content ;
kbd = "@kbd" , "[" , key , "]" ;
link = "@link" , uri , content ;
(* v0.1.2. spoiler takes ordinary nestable content; hex takes a restricted
slot (like kbd's key), NOT generic content. See §15. *)
spoiler = "@spoiler" , content ;
hex = "@hex" , "[" , hex-code , "]" ;
hex-code = "#" , ( 3 * hex-digit | 6 * hex-digit ) ;
br = "@n" ;
escape = "@@" ;
(* ==========================================================================
Shared Components
========================================================================== *)
content =
"[" ,
{ content-element } ,
"]" ;
content-element =
inline-node
| plain-text-char ;
(* raw-content の実際の終了規則は「角括弧の深さカウント」であり、「最初に
現れたエスケープされていない ]」ではない —— balanced-bracket-group は
再帰的な生成規則によって「内部で左右の括弧が対応している限り、自由に
ネストでき、エスケープはまったく不要」であることを表現している。真に
対応していない角括弧だけがエスケープを必要とする。詳細は 9. @raw 不透明
ドメイン を参照。 *)
raw-content =
"[" , { raw-unit } , "]" ;
raw-unit =
escaped-at-close-bracket (* "@@]" → リテラルの "@]" *)
| escaped-at-open-bracket (* "@@[" → リテラルの "@[" *)
| escaped-close-bracket (* "@]" → リテラルの "]"(対応しない ] にのみ使用) *)
| escaped-open-bracket (* "@[" → リテラルの "["(対応しない [ にのみ使用) *)
| balanced-bracket-group (* 対応が取れた、ネスト可能なリテラルの角括弧。内容に制限はない *)
| raw-char ;
balanced-bracket-group =
"[" , { raw-unit } , "]" ;
escaped-at-close-bracket = "@@]" ;
escaped-at-open-bracket = "@@[" ;
escaped-close-bracket = "@]" ;
escaped-open-bracket = "@[" ;
raw-char =
any-unicode-char - "]" - "[" ;
uri =
"(" ,
{ text-char - ")" } ,
")" ;
modifier =
"(" ,
{ text-char - ")" } ,
")" ;
(* Lexer 側の追加的な制約:`text-char` 自体は改行を含むため、文字どおりに
解釈すると「閉じられていない "{" は文書の後方にあるどの "}" までも
一気に飲み込める」ことになってしまう —— 作者がまだ入力中の "{" が、
途中にあるすべてのノード(例えば下記の @code ブロック内の、波括弧より
前にあるものすべて)を styles の中に飲み込み、AST から黙って消えて
しまう。styles の実際の意味論は、数個のカンマ区切り token であり、
複数行にまたがる例は一つもない。エディタの Monarch ルール
(/\{[^}]*\}/、1 行ずつの比較)ももともと複数行をサポートしていない
ため、Lexer は "}"、行末、"["(コンテンツスロットの開始)のうち
最初に現れた位置でスキャンを停止し、行末と "[" の 2 つのケースは
未閉合として扱う。詳細は src/Lexer.ts の scanStylesEnd() を参照。 *)
styles =
"{" ,
{ text-char - "}" - newline - "[" } ,
"}" ;
key =
{ text-char - "]" } ;
(* @color の {styles} の内容に対する意味論的な制約 —— 完全な検証規則
(/^#[0-9a-fA-F]{6}$/ に一致しなければならない)は §7 を参照。終端記号
自体は構文レベルのものにすぎず、桁数や大文字小文字の厳密な検証は
意味論レベルであり、下記の `styles` と同じ切り分けである。 *)
hex-color =
"#" , hex-digit , hex-digit , hex-digit , hex-digit , hex-digit , hex-digit ;
hex-digit =
digit
| "a" | "b" | "c" | "d" | "e" | "f"
| "A" | "B" | "C" | "D" | "E" | "F" ;
integer =
digit ,
{ digit } ;
digit =
"0" | "1" | "2" | "3" | "4"
| "5" | "6" | "7" | "8" | "9" ;
(* ==========================================================================
Character Sets
========================================================================== *)
(* Note:
plain-text-char は inline-node よりも優先度が低い。
Lexer は常に、プレーンテキストにフォールバックする前に
既知のコマンド認識を試みなければならない(MUST)。
*)
plain-text-char =
any-unicode-char ;
text-char =
any-unicode-char ;
letter =
Unicode Letter ;
symbol =
Unicode Symbol ;5. エスケープ規則
構文
@@出力
@用途
ユーザーが構文キーワード自体を出力したい場合に使用する。
これはグローバルなエスケープ規則であり、通常の inline-stream の コンテキストに適用される。
@rawの内部には独立したエスケープ規則があり、詳細は 9. @raw 不透明ドメイン を参照。
例
入力:
@@mark出力:
@mark入力:
@@bold[hello]出力:
@bold[hello]入力:
Email: test@@example.com出力:
Email: [email protected]この書き方は正当だが、次の理由により:
exampleは既知の命令ではないため、実際には直接次のように書ける:
Email: [email protected]エスケープする必要はない。
6. 未知コマンドのフォールバック
@ の後ろが正当な命令名でない場合、パーサーは必ずプレーンテキストモードにフォールバックしなければならない。
例:
@github出力:
@github出力:
@my_custom_tag出力:
@my_custom_tagこの規則は、次のものとの衝突を効果的に回避できる:
- ソーシャルアカウント
- Discord Mention
- GitHub Username
- Chat Mention System
7. @mark / @color / @bordered スタイル意味論
@mark は任意の styles 修飾構文をサポートする:
@mark{style}[content]ここで:
styleはカンマ区切りのスタイルトークン文字列(style token list)である。contentはマークされるテキスト内容である。stylesは任意(optional)の構文であり、省略した場合は純粋なハイライトマークと同じになる:
@mark[重要な内容]Style Token の意味論
style の内容はカンマ区切りの色トークン(Color Token)文字列であり、ハイライトの色を表す。Renderer は意味論に従って実際の色値に対応付ける。2 種類の書き方をサポートしており、どちらか一方を選んで使用できる:
- named token(Renderer が実際の色値を独自に定義する): text
yellow / red / green / blue / orange / purple / gray - 16 進数 Hex Token(
#で始まり、6 桁の 16 進数、大文字・小文字どちらでも可。Renderer は指定された値を MUST でそのまま使用しなければならず、再マッピングしてはならない):text#ff0000 / #3366FF / #00c896/^#[0-9a-fA-F]{6}$/の形式に一致しない token(例えば#f00、#gggggg)は正当な hex token とはみなされず、一般規則に従って Unknown Command Fallback の寛容な精神で処理される(下記の Renderer の挙動を参照)。
変更履歴:以前のバージョンでは
underline/strikethrough/borderedという 3 つの修飾 Token が別に定義されていたが、これらは削除された。underlineは@underlineノードと意味が重複していた。strikethroughは@delノードと意味が重複していた。borderedは独立したノード@bordered(下記参照)に昇格した。styleは現在、色の意味論のみを担い、修飾の意味論と混在することはなくなった。
例
@mark[デフォルトのハイライト]
@mark{yellow}[黄色のハイライト]
@mark{red}[赤色のハイライト]
@mark{#3366ff}[16進数の背景色]@color — 文字の色を変える
@mark が変えるのは背景(ハイライト)であり、文字自体の色は変えられない。@color はこの能力を補う:
@color{#ff0000}[この文字列は赤色です]@color は @mark と同じ {styles} フィールドを共有しており(上記 EBNF 参照)、それ自体は任意である——省略した場合、Renderer はデフォルトの色にフォールバックする。これは @mark[content] が {styles} を省略した場合と同じ挙動である。
@color{blue}[この文字列は濃い青色です]@color は @mark と同じ 7 つの named color token(yellow/red/green/blue/orange/purple/gray)を受け付け、単一の 16 進数 hex token(/^#[0-9a-fA-F]{6}$/)も受け付ける。両者は構文上同じ token 名の集合を共有しているが、対応する実際の色値はそれぞれ独立している:@mark の色調は薄いハイライト背景向けに調整されており、そのままテキストの前景色として使うとコントラストが不足して読みにくくなる。そのため Renderer は通常、@color 専用の、より濃い色調の対照表を(@mark のものを再利用するのではなく)別に維持する。Renderer は形式に合わない値や認識できない値を MUST で無視し、エラーを投げるのではなく何らかのデフォルト値へフォールバックしなければならない:
@color{not-a-color}[この文字列は色を指定していないため、優雅にデフォルト色へフォールバックします]@bordered — 文字の外枠
@bordered は文字に外枠を付ける。@color とまったく同じ {styles} フィールドを共有しており——同じ括弧、同じく任意、同じ 7 つの named token に加えて hex も使え、同じ色対照表も共有する(実装上は @color の resolver をそのまま再利用できる)。ただし適用先が文字色ではなく外枠である点だけが異なる:
@bordered[デフォルトの外枠]
@bordered{blue}[青色の外枠]
@bordered{#3366ff}[16進数の外枠色]{styles} を省略した場合や、認識できない値が与えられた場合、Renderer はエラーを投げるのではなく、デフォルトの外枠スタイルへフォールバックする。これは §6 Unknown Command Fallback の寛容な精神と呼応している。このノードは、@mark の以前の {styles} にあった bordered 修飾 token を置き換え、独立した第一級ノードとなったものであり、underline(すでに @underline がある)、strikethrough(すでに @del がある)と同じ役割を果たす。
Renderer の挙動
- Renderer は、少なくとも
styles省略時のデフォルトのハイライトスタイル(@mark)/デフォルトの外枠スタイル(@bordered)を MUST でサポートしなければならない。 - Renderer は、各 named color token に対応する実際の色値を自由に決定してよい(MAY)(例えばダークモードとライトモードで
yellowが異なってもよい。@markと@color/@borderedもそれぞれ異なる対照表を維持してよく、通常はそうすべきである。理由は上記参照)。16 進数 hex token については、指定された値を MUST でそのまま使用し、再マッピングしてはならない。 - Renderer は認識できない token(形式に合わない hex token を含む)を MUST で無視しなければならず、エラーを投げるのではなく何らかのデフォルト値へ SHOULD でフォールバックすべきである——この挙動は 6. 未知コマンドのフォールバック における「未知の命令はプレーンテキストにフォールバックする」という寛容の精神と一致するが、その作用範囲は
stylesの内部に限定され、@mark[content]/@color[content]/@bordered[content]自体は通常どおり対応するノードとしてパースされる。fallback の具体的な見た目は Renderer が自由に決定してよい:「追加の色を付けない」(デフォルトの文字色/外枠色を維持する)でもよいし、@markがstylesを省略したときのデフォルトのハイライト色を再利用してもよい(3 つのノードは同じフィールドの形を共有しているため、こうしても視覚的に自然である)。 - token 同士の区切り文字は半角カンマ
,に固定されており、前後には任意の数の空白を置くことができる(Parser が自動的に trim すべきである)。この規則は@markのstylesに適用される。@color/@borderedの{}の中は単一の token(color token または hex 値)のみが許可され、カンマ区切りは使用しない。
EBNF 補足説明
以下は 4. 完全なEBNF文法定義 の中の、次の部分に対応する:
(* Lexer 側の追加的な制約:`text-char` 自体は改行を含むため、文字どおりに
解釈すると「閉じられていない "{" は文書の後方にあるどの "}" までも
一気に飲み込める」ことになってしまう —— 作者がまだ入力中の "{" が、
途中にあるすべてのノード(例えば下記の @code ブロック内の、波括弧より
前にあるものすべて)を styles の中に飲み込み、AST から黙って消えて
しまう。styles の実際の意味論は、数個のカンマ区切り token であり、
複数行にまたがる例は一つもない。エディタの Monarch ルール
(/\{[^}]*\}/、1 行ずつの比較)ももともと複数行をサポートしていない
ため、Lexer は "}"、行末、"["(コンテンツスロットの開始)のうち
最初に現れた位置でスキャンを停止し、行末と "[" の 2 つのケースは
未閉合として扱う。詳細は src/Lexer.ts の scanStylesEnd() を参照。 *)
styles =
"{" ,
{ text-char - "}" - newline - "[" } ,
"}" ;styles 自体は字句レベルでは「波括弧で囲まれた任意の文字列」としか定義されておらず、実際の token 分割(カンマ区切り、color token と modifier token の識別)は意味論レベル(semantic level)の処理に属する。これは Lexer/Parser の構文レベルの責務ではなく、Renderer や後続の意味解析フェーズに委ねられる。この設計により、次のことが保証される:
- 新しい style token(例えば将来
italic、boldなどを追加する場合)を加えても、EBNF の文法定義自体を変更する必要はない。 - 異なる Renderer が独自にサポートする token 集合を拡張・削減できるのは、1. 設計思想 にある「DSL の拡張性を保つ」という目標に合致している。
8. @link URI 意味論
@link は正当な URI、または URI らしき識別子(URI-like Identifier)を受け入れる。
@link(uri)[content]ここで:
uriはターゲットとなるリソースの識別子である。contentは表示されるテキストである。
Renderer による URI 推論
Renderer は uri の内容から URI Scheme を自動的に推論してもよい(MAY)。
例えば:
| 入力 | Renderer が実際に使う URI |
|---|---|
@link(example.com)[公式サイト] | https://example.com |
@link([email protected])[お問い合わせ] | mailto:[email protected] |
@link(+886912345678)[カスタマーサポート電話] | tel:+886912345678 |
uri にすでに Scheme が明示的に指定されている場合:
@link(https://example.com)[公式サイト]
@link(mailto:[email protected])[お問い合わせ]
@link(tel:+886912345678)[カスタマーサポート電話]Renderer は MUST で指定された値をそのまま使用しなければならず、推論や変更を行ってはならない。
サポートされる URI の例
以下はすべて正当な uri である:
https://example.com
mailto:[email protected]
tel:+886912345678
ftp://example.com/file.zip
discord://channel/123
vscode://file/path
file:///tmp/test.txt@Doc 自体は URI の種類を制限しない。
URI の実際のサポート能力は Renderer が決定する。
9. @raw 不透明ドメイン
@raw が属するのは:
Opaque Domain
パーサーが次に入ると:
@raw[その後:
- 内部の構文は一切解析しない。
@mark、@bold、@linkなどのキーワードはすべてプレーンテキストとして扱われる。- グローバルな
@@エスケープ規則(5. エスケープ規則)はもはや適用されず、raw 域内には独立したローカルな規則のセットがある(下記参照)。
終了規則:角括弧の深さカウントであり、「最初の ] に出会うこと」ではない
@raw[...] の実装モデルは角括弧の深さカウントである。これはまず明確にしておく必要がある。なぜなら、それがエスケープ規則をいつ使うべきか、いつ使うべきでないかを直接決定するからだ:
[は深さを +1 し、]は深さを -1 する。深さがゼロに戻ったその]こそが、本当の終端である。- 言い換えれば、角括弧が対応してさえいれば、そのまま書けばよく、エスケープはまったく不要である——
@raw[@mark[hello]]の中の@mark[hello]は、それ自体の左右の括弧が対応しているため、Parser は正しく一番外側の]で終了し、@mark[hello]をそのままのテキストとして出力する。 - エスケープ規則が存在するのは、対応していない角括弧のために特化してのことである——例えば、単独の字面
]だけを書きたい場合や、それ自体の括弧が不均衡な内容の断片を引用したい場合である。もともと対応していた角括弧に余計にエスケープを加えてしまうと(例えば@mark[hello]の終わりを@mark[hello@]と書いてしまうと)、エスケープによって消費された]は深さカウントをゼロに戻さない。そのため、前にある@mark[の[によって生じた深さ +1 は、対応する]で相殺されることが永遠になく、Parser はそのまま先へ先へと探し続け、外側のより多くの内容(文書全体すら)を飲み込んでからようやくエラーになる。対応が取れている括弧はそのまま書く。対応が取れていない括弧は必ずエスケープする。エスケープ文字は深さカウントに参加しない。
エスケープ規則は対称的である——] と [ はそれぞれ「単一文字のエスケープ」と「『@』自体の後にその文字が続くもののエスケープ」の 2 種類を持ち、合計 4 つの規則がある。スキャン時には以下の優先順位で比較される(長く、より明確なシーケンスが優先される):
| 優先順位 | 入力 | 出力 | 説明 |
|---|---|---|---|
| 1 | @@] | @] | リテラルの @] 2 文字を出力 |
| 2 | @@[ | @[ | リテラルの @[ 2 文字を出力 |
| 3 | @] | ] | 対応していないリテラルの ] を出力(深さカウントに影響しない) |
| 4 | @[ | [ | 対応していないリテラルの [ を出力(深さカウントに影響しない) |
例
入力:
@raw[@mark[hello]]出力:
@mark[hello]説明:
@mark[hello]自体は括弧が対応しており、深さカウントは 1→2→1 と変化し、一番外側の]でようやく深さがゼロに戻り@rawが終了する。エスケープはまったく不要——これが最も一般的な使い方である(raw の内容の中で、完全で括弧の対応が取れた @Doc の構文の例を示す)。
入力:
@raw[@@]出力:
@@説明:ここでは
@@の直後に raw-content の終端]が続くため、@@]の特例(@@]は連続する 3 文字でなければならない)は発火せず、次のように分解される:通常の文字@@(グローバルなエスケープが無効化されているためそのまま出力される)+ 終端の]。
入力:
@raw[今日は@]が検出されるのが怖い]出力:
今日は]が検出されるのが怖い説明:ここでの
@]は対応していないリテラルの](前に対応する[がない)であり、必ずエスケープしなければならない。そうしないと、これが@raw自体の終端として扱われてしまい、後ろの「が検出されるのが怖い」が raw の内容の外に出てしまう。
入力:
@raw[今日は@@]が検出されるのが怖い]出力:
今日は@]が検出されるのが怖い入力(エスケープを使うべきでない場所で使ってしまった例——反例):
@raw[ここの @mark[hello@] はそのまま保持される]レンダリング意味論:インラインコード
上記の規則が定義するのは Parser の挙動(内容を解析せず、そのまま保持する)です。レンダリング側の対応する意味論はインラインコード——Markdown のバッククォート `code` と同じものです:
- Renderer は
@rawを等幅(monospace)のインライン要素として出力すべきです(SHOULD)。HTML Route では<code>を使用します。 - これは
@codeとは区別されます:@codeはブロック(HTML では<pre><code>)であり、@rawはインラインです。 @kbdとも区別されます:@kbdは物理キーを表し、慣例として枠線とキーキャップ風の外観を持ちます。@rawはコードテキストであり、等幅フォントと背景色のみで十分です。- これにより Renderer が内容を解析してよいことにはなりません——レンダリング意味論の追加は opaque domain の解析規則を変更しません。
なぜ別ノードではなく
@rawなのか:raw-escapedは言語全体で唯一、正規のエスケープ機構(@]/@[と角括弧の深度カウント)を備えた内容モードであり、「内容が解析されてはならない」ことはまさにインラインコードの定義的要件だからです。両者の利用場面はほぼ完全に重なります——本節の上記の例はすべてコードを示しています。
10. ネストされたパース
次の理由により:
content-element =
inline-node
| plain-text-char ;@Doc は完全な再帰的ネストをサポートしている。
例えば:
@bold[
これは太字で、
中には
@mark{yellow}[重要なハイライト]
と
@underline[下線]
がある
]その AST 構造は次のとおりである:
Bold
├── Text
├── Mark
└── Underline11. パーサーのリカバリー戦略
Parser が閉じられていない構造に遭遇したとき:
@bold[helloあるいは:
@mark{red}[hello2 つのモードを提供することが推奨される:
Strict Mode
直接構文エラーを投げる:
Unexpected EOF while parsing @boldDiagnostics
閉じられていない構造以外にも、Parser は「文法的には正しいが、ほぼ確実に作者の意図ではない」ケースを報告する——これらはこれまで、きれいにパースされたあとで誤って描画され、どこにも通知がなかった。それぞれ、ソース範囲とメッセージを持つ DocDiagnostic として報告される。いずれもパースを中断せず、文書の残りの部分が生成する AST も変えない。
| ケース | 重大度 | 備考 |
|---|---|---|
@data の行の幅(@span を含む)≠ @cols の列数 | error | 問題のある行に対して報告。自動的な補完や切り詰めは決して行わない。Block Spec 第 5 節 Table を参照 |
@span(n) の n が正の整数でない | error | 行の幅の検査では幅 1 として数えられるため、1 つの根本原因に対して diagnostic は 1 件だけ |
@data のセルの外にある @span(@cols 内、段落内、セル内の他の内容との混在) | error | @tabs の外の @tab と同じ配置制限の規則 |
@hex[...] の内容が #RGB/#RRGGBB でない | error | 名前付きカラー、4/5/8 桁のコード、または # の欠落。8 桁の #RRGGBBAA は現時点では意図的に拒否される(第 15 節) |
@img の align の値が認識できない | warning | その値は無視され(配置なし)、文書は引き続きレンダリングされる。Block Spec 第 5 節 Image を参照 |
ノードの {styles} 内に認識できない token がある | error | 例:@card{blue}、@mark{bluee}、@img{radius-x}。その token はレンダリング時には引き続き無視される。範囲は token 自体を指す |
@defn(id) の id が整数でない | error | @fn[...] は整数のみ受け付けるため、その脚注は決して参照できない。id が選ばれた場所である @defn に対して報告される |
@color/@bordered に {styles} の値がない | error | 虹色の見た目/意味のある枠線色なし、にフォールバックする |
内容を飲み込む @raw のエスケープ、または消費されたあらゆるエスケープ | warning/info | 第 9 節を参照 |
「重大度」は diagnostic が持つ値である。error が Strict Mode でブロックするか、Editor Mode で下線を引くだけかは、上で説明したとおり利用側が決める。
Editor Mode
エディタが不足している閉じ記号を自動補完することを許可する:
]これによりリアルタイムの編集体験を向上させる。
12. アーキテクチャ
推奨されるパースの流れ:
Source Text
↓
Lexer
↓
Token Stream
↓
Parser
↓
AST
↓
RendererRenderer は自由に次を出力できる:
- HTML
- React
- DOCX
- Markdown
- Discord
- Terminal
- Custom UI
13. コア原則
@Doc の中核的な目標は Markdown を置き換えることではない。
そうではなく、次のものを作ることである:
Human Editable Machine Deterministic AI Friendly Cross Platform
という、次世代の文書中間フォーマットを。
14. 簡易構文エイリアス
@bold/@italic/@underline には簡略化されたエイリアス @b/@i/@u が用意されている——これは純粋に入力時の省略表記であり、Parser はそれを正典の名前に正規化してから AST ノードを作成する(node.type は常に正典の名前になる)。Renderer は作者が実際にどちらの書き方を入力したかを区別する必要がなく、実際に区別することもない。
| Canonical | Alias |
|---|---|
@bold | @b |
@italic | @i |
@underline | @u |
(Block Syntax の @heading/@paragraph のエイリアス @h/@p は Block Syntax Specification §11 で定義されている。)
15. Semantic Inline: @spoiler and @hex
構文 v0.1.2 で追加された 2 つのインラインノード。どちらも通常のインラインノードであり、inline-stream が現れられる場所ならどこにでも置ける。
@spoiler
この映画のラストで、@spoiler[主人公が実は悪役だった]ことが明かされ、展開が非常に見事だ。spoiler = "@spoiler" , content ;文レベルの隠しスパン:読者が自分で開示するかどうかを選べる内容で、周囲の文章を独立したブロックに分断しない。content は標準のネスト可能な生成規則なので、@spoiler[@bold[衝撃の逆転]] は有効であり、隠されていても書式は保たれる。
@detailsのブロックレベル版ではない。@detailsはタイトル付きのブロックレベルの段階的開示——読者が展開するのはセクション全体である。@spoilerは文の中の断片であり、開示後も 1 つの段落として読める。ブロックレベルの spoiler ノードは意図的に設けていない:ブロックレベルのネタバレは「ネタバレ注意」のようなタイトルを付けた@detailsにすぎず、同じ役割に 2 つのノードを与えると、言語に同じことを言う方法が 2 通りできてしまう。- テーブルのセル。
@spoilerはテーブルのセルの許可リストには含まれない(Block Spec 第 5 節 Table)。 - レンダリング(Web)。 参照 renderer は
<span class="spoiler" tabindex="0">…</span>を出力する。背景とテキストはどちらもデフォルトで隠され、:hover/:focusで両方とも解除される。スクリプトは不要。tabindexによりキーボードで到達できるようになり focus が発火し、同時に支援技術が内容を読み上げるためのフックにもなる。 - 操作による開示ができない出力先(プレーンテキスト、検索インデックス、LLM 向けの抽出結果、PDF):具体的な代替表示は renderer が決めるが、renderer はネタバレの本文を検索インデックスや自動生成される要約に黙ってコピーしてはならない(MUST NOT)。
[ネタバレ]のようなマーカーに置き換える、あるいはその文をインデックスから外すのはどちらも許容される。まったく対話性のない出力先(DOCX)では、脚注や展開可能なコメントに変換するのも妥当である。
参照 renderer のスタイルフックは .spoiler クラスである。最小限のルールセット:
.spoiler { background: currentColor; border-radius: 3px; cursor: pointer; outline: none; }
.spoiler:hover, .spoiler:focus { background: transparent; }(隠れている間はテキストの色が背景色と等しくなければならない——background: currentColor なら自動的にそうなる——そして開示時には両方をリセットする。)
@hex
メインカラーは @hex[#3366ff]、アクセントカラーは @hex[#f80] です。hex = "@hex" , "[" , hex-code , "]" ;
hex-code = "#" , ( 3 * hex-digit | 6 * hex-digit ) ;色見本と、その文字どおりのコードを並べて表示する——このノードの主題は色の値そのものである。
- 制限された内容。
@kbdのkeyと同様に、括弧の中には検証される値が入り、文章は入らない:@hex[@bold[#fff]]は太字の色コードではない。@hexの括弧の中では、文法はinline-nodeを経由しないからである。 - 受け付ける形式:
#RGBと#RRGGBB。8 桁の#RRGGBBAA形式はこの改訂では意図的に未決定とし、黙って受け入れるのではなく拒否する。これにより、あとでアルファ値の慣例を採用しても破壊的変更にならない。文法に合わない内容(名前付きカラー、4 桁や 5 桁のコード、#の欠落)は diagnostic となり、黙ってフォールバックすることは決してない。 - テーブルのセル。
@hexはテーブルのセルの許可リストに含まれる——色見本の表やデザイントークンの表が最も一般的な用途である。 - レンダリング(Web)。 参照 renderer は
<span class="hex-swatch"><span class="hex-swatch-color" style="background-color:#3366ff;"></span><code>#3366ff</code></span>を出力する。インラインなのは色見本の背景色だけで、サイズや余白はスタイルシートの役割(.hex-swatch、.hex-swatch-color)である。クリックしてコピーするといった操作は renderer に属し、文法には属さない。 - 色を描画できない出力先(プレーンテキストの terminal):コード
#3366ffを出力する。
@hex は @color ではない
この 2 つは互いに取り違えて使われやすいが、意味は正反対である:
| ノード | 意味 |
|---|---|
@color{#3366ff}[テキスト] | 「このテキストをこの色にする」——hex 値は無関係な内容を着色する |
@hex[#3366ff] | 「この色コードそのものを表示する」——コードが内容である |
色見本を並べるデザインシステムの文書には @hex を、たまたま青い文字が必要な段落には @color を使う。色見本を見せるために @color{#3366ff}[#3366ff] と書くと、描画結果は正しく見えるが、構造上は誤ったノードである:「この文書が色見本として提示しているすべての色」を探すツールは、すべての @hex を見つけられる一方で、この偶然の @color を普通の色付きの単語と区別できない。
@Doc