HikiDocライブラリ - Ruby on Rails プラグイン まとめ wiki

プラグイン名

HikiDoc library

このライブラリでできること

1. Wikiファミリーの一員であるHikiのフォーマットを解析し、HTMLとして出力する事が出来る

対象バージョン

1.2系

インストール方法

• コマンドラインから

svn co http://hikidoc.rubyforge.org/svn/trunk/ hikidoc

してからこのディレクトリに移動し

$ ruby setup.rb config

して

$ ruby setup.rb setup

して

# ruby setup.rb install

すれば、このマシンにインストールされるはず。

ちょー簡単な使い方

irbとかscript/consoleで確認してみるのが早いかも。

require "hikidoc"
puts HikiDoc.to_html("[ [wiki_page_name] ]") ←実際には[と[の間は空かない

で

<p><a href="wiki_page_name">wiki_page_name</a></p>

となる気がします。
同様に
HikiDoc.to_html("[ [link|http://example.com/] ]")　←実際には[と[の間は空かない
は

<p><a href="http://example.com/">link</a></p>

となります。たぶん。

公式ページ

• HikiDoc

日本語解説ページ

• 本家で十分かも
• Hiki文法ならTextFormattingRules.ja

外国語解説ページ

• 必要ないかも。ちなみに、更新ページは同じ内容が英語でも用意されている。

検討事項

• 他のWikiパーサとしては、Pukipa(MITライセンス)もある。これはPukiWikiのフォーマットをパースする。
• Rubyist Magazine出張版にも添削後のPukipaが載っているのでちょと安心。

コメント