新規作成  編集  Ruby-GNOME2 Project Website  ページ一覧  検索  更新履歴  編集履歴  RSS  Back  ログイン

Hiki/RD+について 差分 - Ruby-GNOME2 Project Website

  • 最後の更新で追加された部分はこのように表示します。
  • 最後の更新で削除された部分はこのように表示します。

= Hiki/RD+について
Hiki/RD+は((<Hiki>))をベースに記述方式にRDを使うよう改造を加えたものです。

APIリファレンスやチュートリアルなどを書きやすくすることを第一に考えた結果、
以下の点でデフォルトのRDと異なります(ので+をつけてる。-をつけるべき?(^^;))。

詳しくは((<本サイトのドキュメントの書き方|本サイトの書き方>))を参照してください。

なお、Hiki/RD+はHiki-0.5.0系列からHiki本体に取り込まれました。

--- ModuleNamesを採用
    ModuleNamesに登録されたモジュールであれば、自動的にリンクが作られます。WikiNameと同様の考えですが、文章の章単位(メソッド名)に対しリンクを張ることができます。
    APIリファレンス等で、著者が(('((<Hoge::Fuga>))'))を意識的に記述する必要はありません。
    なお、普通に(('((<hoge>))'))を使えば任意にリンクを指定できます。一部、リンクが生成されないパターン(定数値など)は明示的にリンクを指定してください。

--- リンクの拡張
    suffixが画像を示すURL(png, jpg, jpeg, gif)のURLは画像として展開されます。
    #今のところ画像のpostはできないのですがその辺も考えた方が良いかもしれませんね。

--- InterWiki+(InterWikiの拡張)
    標準の((<Hiki>))のリンク指定を拡張し、表示用文字列とキー項目は分離できるようになりました。

== バージョン情報
* ruby {{ruby_version_info}}
* Hiki {{hiki_version_info}}