[Hiki] update - How to write this site (ruby-gnome2-doc-cvs) - Ruby-GNOME2

-------------------------
REMOTE_ADDR = 211.7.202.74
REMOTE_HOST = 
-------------------------
= How to write this site
This site is written with RD+. 
RD+ means RD with some additional rules.

{{toc}}

== About RD
See the documents below.
* ((<RD working draft|URL:http://helium.ruby-lang.org/~rubikitch/RDP-en.cgi?cmd=view&name=RD>))
* ((<Embedded Documentation in Programming Ruby|URL:http://www.pragmaticprogrammer.com/ruby/articles/rdtool.html>))

== About Additional Rules
=== ModuleNames
ModuleNames page is a module list for the link extension. 
The modules entried in ModuleNames create the links properly.
So it isn't required to surround Classes/Modules with (('((< >))')).

* For href links  
  * Hoge::Foo - Class name
  * Hoge::FOO - Constant
  * Hoge::Foo#bar - Instance method
  * Hoge::Foo.bar - Class method
  * Hoge.bar - Module method

* For linked names
  * Class method - "--- Hoge::Foo.new" 
  * Instance method - "--- bar" #Method only.

And before you use this, write the module name to the ModuleNames page what you need.

=== Auto-generated anchor
==== RD style

 ((<URL:url>))
 ((<name|URL:url>))

* name - Displayed words.
* url - URL

 e.g.
 ((<URL:http://www.hoge.com/>))
 ((<hoge|http://www.hoge.com/>))

 result
 <a href="http://www.hoge.com/">http://www.hoge.com/</a>
 <a href="http://www.hoge.com/">hoge</a>

Image URLs(suffix = png, jpg, jpeg, gif) extend as image.

==== InterWiki style
InterWiki is a mechanism to generate links automatically from dictionary(InterWikiName page). 

 ((<name|key:option>)) 

* name - Displayed words.
* key - keyword. Replace InterWikiName's URL if the key is existed.
* option - Add the URL(Omitable). 

 e.g.
 ((<Hiki>))
 ((<masao:20020329>))
 ((<Here|bibo:20020329>))

 result
 <a href="http://www.namaraii.com/hiki.cgi?">Hiki</a>
 <a href="http://ponx.s5.xrea.com/bibo/?date=20020329">masao</a>
 <a href="http://ponx.s5.xrea.com/bibo/?date=20020329">Here</a>

==== How to write InterWikiName page
InterWikiName page's format is (('[[keyword|url]]')) charset.

 *[[Hiki|http://www.namaraii.com/hiki/hiki.cgi?]] euc
 *[[masao|http://ponx.s5.xrea.com/bibo/?date=]] euc

== Plugins
=== status plugin
Create status table easily. 

 {{status "Title", "
 GLib::Type|GType|#|hoge
 GLib::TypePlugin|GTypePlugin|#|hoge
 "}}

=== toc plugin
Create table of contents.

  {{toc}}

=== image plugin
Show an image from attached file. You need to upload the attached file before using image plugin.

 {{image_left("foo.png")}}
 {{image_right("foo.png")}}

You want to force a line break after image, use br plugin.

 {{br}}

=== attach_anchor plugin
Show link to attached file.

 {{attach_anchor("foo.png")}}

== How to write API Reference
See other files. Please ask me if you need help.

== Misc
Try it ((<Practice Page>))!

- ((<Masao>))
-------------------------
= How to write this site
This site is written with RD+. 
RD+ means RD with some additional rules.