SuikaWiki/0.9 文書マーク付け書式 : 構文仕様書

- 順序なし A
- 順序なし B
-= 順序付き B.1
-= 順序付き B.2
-- 順序なし B.A
=- 順序なし B.B
- 順序なし C

> 段落1
段落1の続きの文
> 段落2
段落2の続きの文

  [INS[
    整形済み
    ブロック
  ]INS]

  [INS[
  [PRE[
    整形済み
    ブロック
  ]PRE]
  ]INS]

符号化文字集合

[5] SuikaWiki/0.9 文書の表現に使用する符号化文字集合は特に規定しません。 ただし、最低限 ISO/IEC 646 の国際基準版の文字集合を含んでいないと非実用的でしょう。

転送プロトコル等ではそのプロトコルによって使用している符号化方式を識別します。

書式識別子

技術訂正

修正履歴

[10] 2003-12-12 14:24:32 +00:00 わかば: 今更ですが、構文を ABNF でちゃんと書いてみました。新しい実装がほぼできたので、それを元に整理しました。

[11] 拡張可能部分のうち、頭部の引数と、要素型の種類については確定で、今後追加しません。要素型の引数の解釈 (外部参照リンク始点とかに意味を持たせるか) や参照方式や特定フォームの種類はまだ検討の余地があります。

[13] >>10-11 頭部引数 interactive が抜けていたので追加しました。 新たに外部参照リンク始点の参照方式に URI を追加しました。

[14] 2004年1月1日: こまの定義に誤りが見つかったので訂正しました。

引用文字列ではないこまには二重引用符 (<">) を含められないように定義していましたが、 従来の実装や文書ではこれを認めていました。

そこで、二重引用符を認めないのは最初の1文字だけとしました。

[17] 2004年1月1日: 注記 >>16 を追加。

なお、廃止整形済み文の閉じられる場所の実装は SuikaWiki 1 以来安定していません。 一文字目に非空白文字がくる行の直前で終わることにしていたときもありました。

>>16 の規定は、 (たぶん) SuikaWiki 2 の最新の実装と一致します。 SuikaWiki 3 の最新版もそう実装しています。

[25] 2004年1月30日: >>20-26 を追加・修正しました。

• >>20 汎用フォームの定義で、 フォーム名指定が抜けていました。
• >>21,>>24 生成規則フォーム名, フォーム名指定を追加しました。
• >>22 フォーム名についての規定を追加しました。
• 予約の特定フォーム名 form を表に加えました。 >>23 それに関する規定を追加しました。
• >>26 強調の式が SuikaWiki/0.9 的に解釈されてしまうので、表現を変更しました。

[31] 2004年6月13日: 技術訂正 >>28。 この修正は、 #?SuikaWiki/0.9 の魔法行を必須ではないことにします。

SuikaWiki2 以来、旧来の文書との互換性のために、 魔法行がなくても SuikaWiki/0.9 形式と認めてきました。 また、 SuikaWiki3 の新しい実装では媒体型を魔法行ではなく外部情報で判断するので、 魔法行を含める必然性がなくなりました。 これらの理由から、 #?SuikaWiki/0.9 は省略してよいこととします。

[32] 2004年8月8日: >>16 の例示の一部が SuikaWiki/0.9 のタグと認識されてしまうので修正しました。

[70] 2006年5月5日: >>34-69 を削除とマーク付けまたは追加しました。

変更点は:

• ほぼ任意の文字が認められる部分で例外的に禁止される文字を追加
• 実体参照など使われなくなったものを非推奨扱いに変更
• 魔法行より version 属性が優先することを明記
• version 属性を無視してよいことを明記
• 改行の扱いを、現実の実装に合わせて変更

[38] 令和7年4月9日: 実体参照の生成規則 (>>23) が SWML の実体参照として解釈されてしまうので修正しました。

[48] なお、当記事は SuikaWiki/0.9 当時のものであり、その後の変更を反映していません。 その後の改訂や現在の版に関しては SWML をご参照ください。

License

[42] この記事は、次の注意書きと共に公表されました。

[39] ただし、その場合はできれば仕様名に SuikaWiki を使わないでください。

[43] この記事は寄稿文のライセンスに従って他の記事同様に利用できます。 この注記は「できれば」とある通り、寄稿文のライセンスの条件の一部または全部を制限あるいは変更することを意図するものではありません。

[46] この注記はいかなる意味でも当記事の利用に関する法的要件を構成するものではなく、 単に筆者の希望を表明するものであり、そのことを明確にするため、 >>42 >>43 >>46 は令和7年4月9日に追記されました。

メモ

[3] >>2 もはや非互換だけど、構文解析の基本方針は概ね同じ。大体上位互換だから、 SuikaWiki から YukiWiki にもってけば (ごみは出るけど) それなりにつかいもんになる程度には互換性はあるはず。

[12] 2003-12-12 14:35:39 +00:00 >>3: なんて書いていましたけど、 SuikaWiki 3 の新しい実装では完全に書き直してしまいました。とはいっても以前とほとんど互換性があります。誤り処理の仕方は違います。 SuikaWiki/0.9 と YukiWiki の書式の互換性は、確かに >>3 の通りですけど、情報劣化を考えると非現実的です。 YukiWiki→SuikaWiki/0.9 はそのままでほとんどの場合 OK でしょうが、最新の YukiWiki で導入された plugin の仕組みは互換性がありませんから駄目です。

[15] 古い文書では頭部が存在しませんから、実装は存在しない文書も扱えるとよいかもしれません。また、内部処理形式等としては本体部だけを処理することとしてもいいでしょう。頭部が SuikaWiki/0.9 だけ (先頭に #? がない。) の形式が一時期使われていましたが、実装はこの形式に対応する必要はありません。 (SuikaWiki 2 も、かなり昔に切り捨てています。 SuikaWiki 3 はそもそも未対応。最初の段落とみなします。)

[18] 編集ブロック内に見出しが入ると、実装によってはうまく扱えないことがあります。

たとえば、

* 第2章
** 2.1
あいうえお。
[INS[
** 2.2
かきくけこ。
]INS]
]PRE]
は、 SuikaWiki 2 では思った通りの結果が得られますが、 SuikaWiki 3 では

* 第2章
** 2.1
あいうえお。
[INS[
]INS]
*** 2.2
かきくけこ。

となってしまいます。

これは、 SuikaWiki 3 で内部的に行っている節の処理との相性が悪いために起こります。 SuikaWiki 3 は内部的に

[section[
[heading[
第2章
]heading]
[section[
[heading[
2.1
]heading]
あいうえお。
[INS[
]INS]
[section[
[heading[
2.2
]heading]
かきくけこ。
]section]
]section]
]section]

と扱うからです。 [INS[ の直前で節を閉じることが出来れば思った通りの結果が得られるはずですが、 SuikaWiki/0.9 では陽に閉じる方法がありません。

SuikaWiki/0.9 仕様の立場としては、 この例のような文書の書き方は望ましくなく、 (SuikaWiki/0.9 で表現できる範囲を超えており、) どう処理されるかは実装依存としておきます。

[33] 仕様書の構文にいくつか間違いが見つかっているので修正を検討中です。。。 (名無しさん 2005-02-03 22:46:34 +00:00)