noteプラグインについて

Last-modified: Mon, 19 Aug 2019 11:31:45 JST (32d)
Top > noteプラグインについて

概要

同一内容の注釈に対して統一したリンク先を生成するプラグインです。


noteプラグイン

Wiki構文の注釈(wiki構文で (( と )) で挟む)では、同一の注釈内容であっても注釈構文が使用された数だけフッター部に注釈内容が生成されてしまいます。
noteプラグインを利用することで同一内容の注釈のリンク先を一つにまとめる事が可能となります。

書式

&note(keyword:comment);
  • keyword:
    同一の注釈として識別するためのキーワードです。
    keywordは省略可能で、省略時はcommentが同一のものを自動的にまとめます。
  • comment:
    フッター部に注釈として表示する内容で、wiki構文の注釈 (( )) の中に記載していたものに相当します。

使用例

  • keywordを省略した例で、特に問題がなければこの使い方が最も簡単です。
    日本とアメリカの2つの注釈が生成されます。
    日本&note{:にほんこく、にっぽんこく、英=Japan};
    Japan&note{:にほんこく、にっぽんこく、英=Japan};
    アメリカ&note{:アメリカがっしゅうこく、英=United States of America, USA};
    America&note{:アメリカがっしゅうこく、英=United States of America, USA};

日本*1、Japan*1、アメリカ*2、America*2


  • 以下二つの例ではkeywordが同じですが、注釈が分かれています。
    ドイツとイタリアで2つの注釈にまとまりますが、この場合は最初に出現した注釈が採用されます。
    ドイツ&note{germany:ドイツれんぽうきょうわこく};
    Germany&note{germany:Bundesrepublik Deutschland};
    イタリア&note{italy:イタリアきょうわこく};
    Italy&note{italy:Repubblica Italiana};

ドイツ*3、Germany*3、イタリア*4、Italy*4


  • 同じ注釈内容でも、keywordの省略有無が混在する場合は別の注釈としてまとめられなくなるので注意してください。
    フランス&note{france:フランスきょうわこく};
    France&note{:フランスきょうわこく};

フランス*5、France*6

注意

通常の注釈構文「(( ))」と、noteプラグインで生成される注釈は個別に附番されます。混在すると*1などが複数存在することとなるため、ページ内ではどちらかのみをご利用下さい。

プラグインについて

このプラグインは にぶんのに様 のnote.inc.phpを使用しています。




*1 にほんこく、にっぽんこく、英=Japan
*2 アメリカがっしゅうこく、英=United States of America, USA
*3 ドイツれんぽうきょうわこく
*4 イタリアきょうわこく
*5 フランスきょうわこく
*6 フランスきょうわこく