[ruby-gnome2-doc-cvs] [Hiki] update - Hiki/RD+について

Back to archive index

ruby-****@lists***** ruby-****@lists*****
2003年 3月 30日 (日) 03:24:13 JST


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

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

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

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

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

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

== Changelog
:2003-03-21
  * hiki/rd2html.rb: Support InterWikiName+.

:2003-03-17
  * hiki/rd2html.rb: Revised.
:2003-03-04 
  * First test release
-------------------------
= Hiki/RD+について
Hiki/RD+は((<Hiki>))をベースに記述方式にRDを使うよう改造を加えたものです。

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

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

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

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

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





ruby-gnome2-cvs メーリングリストの案内
Back to archive index