footnote-extra: Octopress用footnoteのプラグイン

OctopressにKramdownを導入して¹ PHP Markdown Extraの footnote書式が使える様になったので、 ついでにそれを使ったプラグインを作りました。

• footnote-extra
• まとめ

footnote-extra

インストールは基本的にplugins/footnote_extra.rbを 自分のpluginsに入れるだけです。

やりたかったのはLatexの様に

• 番号を気にせずに書いていって自動的に番号を振らせること。
• Latexのfootnoteの様に、footnoteを埋め込む場所に noteを書き込んで理解させること。

書き込んだタグをPHP Markdown Extraのfootnote書式に変更します。 ([^1]、[^1]-等。)

元々 footnote-octopress を使っていたので、これと競合しないよう、 以前のポストはそのままで置いておける様にしてあります。

ただし、1つの記事の中ではfootnote-octopressかfootnote-extra のどちらかしか使えません。

最終的なhtmlは似たような形になるので、基本的に footnote-octopressのcssを使えます。

footnote-extraの中にもscssが入ってますが、現在自分で使ってる 物を入れてあります。

また、footnote-octopressの方から footnote.js というfootnoteをポップアップするためのJavaScriptも拝借しています。 全く同じものなので、footnote-octopressですでに インストールしてある場合は新たにインストールする必要はありません。 ちなみにこのJavaScriptは出力後のfootnoteのhtmlに適用されるわけなので、 通常のPHP Markdown Extraのsyntaxでfootnoteを書いても 適用されます。

使い方は{% fnex %}または{% footnote_extra %}と言うブロックを使って footnoteを書き、

ポストの最後にfootnoteを出力させるために

{% footnotes_extra %}

または

{% footnotes_list_extra %}

を加えてください。

 footnoteをここへ{% fnex %}footnote{% endfnex %}埋め込む。

のようにすると。

---

footnoteをここへ²埋め込む。

---

こんな感じに。 さらに、コードもインデントやインラインブロックを使えば書けて (codeblockはブロックの中のブロックになってしまうので駄目。)

コードを含むfootntoe
{% fnex %}
footnoteにコードを書く

    this is a code line.

通常の文字。

`インラインコード`
{% endfnex %}。

とすると、

---

コードを含むfootntoe ³。

---

こんな感じに出来ます。

ポストの最後に

{% footnotes_extra %}

を忘れないように。

まとめ

今まで特に後からfootnoteを足す際にreference番号を変えたりするのが面倒で、 さらに下にまとめて書くとどれとどれが対応してるかわかりづらかったりしたんですが、 これで大分分かりやすくなりました。

この書き方自体はPHP Markdown Extra無くても footnote-octopressを変更すれば出来るわけですが。

KramdwonにしなくてもRDiscountもv2.0.7(最近のOctopressのデフォルト)では PHP Markdown Extraの書式が使えるのでこのプラグインが使えますが、 改行が余り上手く行かない様なので⁴ もしRDiscountと使う場合はその辺を注意してください。 (ちょっと今のバージョンで試してみたところ大丈夫そうでしたが。)