wikiwiki official

マルチライン書式に対応した新プラグインについて

0 コメント
views
1 フォロー

マルチライン書式に対応した新プラグインについて

これまで愛用されていた region 系プラグインと accordion 系プラグインですが、
その書式には複数の問題があるため、今後は非推奨とし、代替となるプラグインを提供
することとなりました。マルチライン書式に対応した新プラグインをご利用ください。

またこれに際して、PukiWiki plus のマルチライン書式の仕様に残っていた不具合を
解消しました。マルチライン書式の階層化に不安/不便を感じていた方でも、安心して
移行していただけると思います。

新プラグイン

  • fold
  • acoordion
#fold(もっと見る){{
隠されていたテキスト
複数行
}}
#accordion(見出し,*,close){{
隠されていたテキスト
複数行
}}

パラメーターの仕様は region と accordion_start と同じです。

既存の記事はどうなる?

すでに region と accordion_start を使って書かれた記事は、内部的に
fold と accordion に置き換えられます。

非推奨プラグインとなった region が今後使えなくなるということはありません。
ただし、fold を使う方が処理が軽くなるので、わざわざ遅い方を使うのはお勧めしません。

非推奨となったプラグイン

  • region
  • endregion
  • acoordion_start
  • acoordion_end

問題点だったこと

問題となるプラグインを使うと、開始と終了を正しく対応付けなければ HTML が壊れて
しまう現象がありました。

範囲外と範囲内とで構造が分割されないため、たとえば、箇条書きと組み合わせると、
ひとつの箇条書きの中におかしな構造が発生するなどの不具合が起きていました。

マルチライン書式を階層化すると、意図しない場所で閉じてしまい、閉じ中括弧の
ゴミがテキストとして表示されることがありました。

開始と終了の中括弧数が一致しないとき、ソースの末尾に書いたおぼえのない
内容が保存される現象が起きるなど、フェイルセーフがうまく機能していませんでした。

マルチライン書式の改善について

ソースが構造的に解釈されるようになりました。そのおかげで階層化する場合でも
開始/終了を {{ }} と、2つの中括弧だけで記述できるようになりました。

#plugin(){{{
#plugin(){{
内容
}}
}}}

#plugin(){{
#plugin(){{
内容
}}
}}

わかりやすさのためにわざと中括弧を多く書くことは可能です。

開始と終了の括弧数はぴったり一致していなくてもかまいません。が、閉じ中括弧はかならず、
開始中括弧の数以上にしなければなりません。

マルチライン書式でも、そうでない書式と同様に、パラメーターの文字列部分に
wiki シンタックスを使うことができるようになりました。

#plugin(&color(red){パラメーター};)

#plugin(&color(red){パラメーター};){{
内容
}}

つまり、fold にも region と同じ装飾のサマリ文言を書くことができます。

WIKIWIKI運営
作成: 2020/02/19 (水) 19:02:10
最終更新: 2020/02/20 (木) 14:46:50
通報 ...