rabbit 1.0.8 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (141) hide show
  1. data/Gemfile +1 -19
  2. data/Rakefile +7 -31
  3. data/doc/_layouts/en.html +1 -1
  4. data/doc/_layouts/ja.html +1 -1
  5. data/doc/en/news.rd +31 -0
  6. data/doc/index.html.en +1 -1
  7. data/doc/index.html.ja +1 -1
  8. data/doc/ja/news.rd +31 -0
  9. data/lib/rabbit/middleware/controller.rb +1 -5
  10. data/lib/rabbit/parser/rd/ext/character-reference.rb +59 -0
  11. data/lib/rabbit/parser/rd/ext/inline-verbatim.rb +2 -2
  12. data/lib/rabbit/parser/rd.rb +1 -1
  13. data/lib/rabbit/parser/wiki/output.rb +4 -0
  14. data/lib/rabbit/rabbit.rb +1 -1
  15. data/lib/rabbit/twitter.rb +43 -56
  16. data/misc/emacs/rabbit-mode.el +3 -4
  17. data/po/en/rabbit.po~ +2567 -0
  18. data/po/fr/rabbit.po~ +2674 -0
  19. data/po/ja/rabbit.po~ +2695 -0
  20. data/test/run-test.rb +2 -1
  21. metadata +737 -822
  22. data/TODO +0 -25
  23. data/doc/_site/css/jquery-ui/themes/ui-lightness.css +0 -573
  24. data/doc/_site/css/rabbit.css +0 -288
  25. data/doc/_site/en/development.html +0 -140
  26. data/doc/_site/en/faq.html +0 -117
  27. data/doc/_site/en/hiki.html +0 -420
  28. data/doc/_site/en/how-to-make/hiki.html +0 -113
  29. data/doc/_site/en/how-to-make/index.html +0 -136
  30. data/doc/_site/en/how-to-make/markdown.html +0 -156
  31. data/doc/_site/en/how-to-make/pdf.html +0 -111
  32. data/doc/_site/en/how-to-make/rd.html +0 -151
  33. data/doc/_site/en/how-to-make/theme.html +0 -249
  34. data/doc/_site/en/index.html +0 -357
  35. data/doc/_site/en/install/homebrew.html +0 -273
  36. data/doc/_site/en/install/index.html +0 -146
  37. data/doc/_site/en/install/macports.html +0 -158
  38. data/doc/_site/en/install/windows.html +0 -200
  39. data/doc/_site/en/news.html +0 -1253
  40. data/doc/_site/en/rd.html +0 -555
  41. data/doc/_site/en/sample/hiki/rabbit.html +0 -556
  42. data/doc/_site/en/sample/index.html +0 -121
  43. data/doc/_site/en/sample/markdown/rabbit.html +0 -490
  44. data/doc/_site/en/sample/rd/rabbit.html +0 -572
  45. data/doc/_site/en/slides.html +0 -113
  46. data/doc/_site/en/usage.html +0 -445
  47. data/doc/_site/en/users.html +0 -129
  48. data/doc/_site/favicon.ico +0 -0
  49. data/doc/_site/favicon.png +0 -0
  50. data/doc/_site/images/background-sample.svg +0 -290
  51. data/doc/_site/images/background.png +0 -0
  52. data/doc/_site/images/background.svg +0 -131
  53. data/doc/_site/images/hare-and-tortoise.png +0 -0
  54. data/doc/_site/images/hare-and-tortoise.svg +0 -541
  55. data/doc/_site/images/jp.png +0 -0
  56. data/doc/_site/images/lavie-icon.png +0 -0
  57. data/doc/_site/images/lavie.png +0 -0
  58. data/doc/_site/images/screenshots/en/blue-circle-raw.png +0 -0
  59. data/doc/_site/images/screenshots/en/blue-circle.png +0 -0
  60. data/doc/_site/images/screenshots/en/clear-blue-raw.png +0 -0
  61. data/doc/_site/images/screenshots/en/clear-blue.png +0 -0
  62. data/doc/_site/images/screenshots/en/cozmixng-raw.png +0 -0
  63. data/doc/_site/images/screenshots/en/cozmixng.png +0 -0
  64. data/doc/_site/images/screenshots/en/dark-gradation-raw.png +0 -0
  65. data/doc/_site/images/screenshots/en/dark-gradation.png +0 -0
  66. data/doc/_site/images/screenshots/en/day-white-raw.png +0 -0
  67. data/doc/_site/images/screenshots/en/day-white.png +0 -0
  68. data/doc/_site/images/screenshots/en/debian-raw.png +0 -0
  69. data/doc/_site/images/screenshots/en/debian.png +0 -0
  70. data/doc/_site/images/screenshots/en/green-circle-raw.png +0 -0
  71. data/doc/_site/images/screenshots/en/green-circle.png +0 -0
  72. data/doc/_site/images/screenshots/en/night-black-raw.png +0 -0
  73. data/doc/_site/images/screenshots/en/night-black.png +0 -0
  74. data/doc/_site/images/screenshots/en/rabbit-raw.png +0 -0
  75. data/doc/_site/images/screenshots/en/rabbit.png +0 -0
  76. data/doc/_site/images/screenshots/en/ranguba-raw.png +0 -0
  77. data/doc/_site/images/screenshots/en/ranguba.png +0 -0
  78. data/doc/_site/images/screenshots/en/red-frame-raw.png +0 -0
  79. data/doc/_site/images/screenshots/en/red-frame.png +0 -0
  80. data/doc/_site/images/screenshots/en/ruby-gnome2-raw.png +0 -0
  81. data/doc/_site/images/screenshots/en/ruby-gnome2.png +0 -0
  82. data/doc/_site/images/screenshots/en/rubykaigi2011-raw.png +0 -0
  83. data/doc/_site/images/screenshots/en/rubykaigi2011.png +0 -0
  84. data/doc/_site/images/screenshots/ja/blue-circle-raw.png +0 -0
  85. data/doc/_site/images/screenshots/ja/blue-circle.png +0 -0
  86. data/doc/_site/images/screenshots/ja/clear-blue-raw.png +0 -0
  87. data/doc/_site/images/screenshots/ja/clear-blue.png +0 -0
  88. data/doc/_site/images/screenshots/ja/cozmixng-raw.png +0 -0
  89. data/doc/_site/images/screenshots/ja/cozmixng.png +0 -0
  90. data/doc/_site/images/screenshots/ja/dark-gradation-raw.png +0 -0
  91. data/doc/_site/images/screenshots/ja/dark-gradation.png +0 -0
  92. data/doc/_site/images/screenshots/ja/day-white-raw.png +0 -0
  93. data/doc/_site/images/screenshots/ja/day-white.png +0 -0
  94. data/doc/_site/images/screenshots/ja/debian-raw.png +0 -0
  95. data/doc/_site/images/screenshots/ja/debian.png +0 -0
  96. data/doc/_site/images/screenshots/ja/green-circle-raw.png +0 -0
  97. data/doc/_site/images/screenshots/ja/green-circle.png +0 -0
  98. data/doc/_site/images/screenshots/ja/night-black-raw.png +0 -0
  99. data/doc/_site/images/screenshots/ja/night-black.png +0 -0
  100. data/doc/_site/images/screenshots/ja/rabbit-raw.png +0 -0
  101. data/doc/_site/images/screenshots/ja/rabbit.png +0 -0
  102. data/doc/_site/images/screenshots/ja/ranguba-raw.png +0 -0
  103. data/doc/_site/images/screenshots/ja/ranguba.png +0 -0
  104. data/doc/_site/images/screenshots/ja/red-frame-raw.png +0 -0
  105. data/doc/_site/images/screenshots/ja/red-frame.png +0 -0
  106. data/doc/_site/images/screenshots/ja/ruby-gnome2-raw.png +0 -0
  107. data/doc/_site/images/screenshots/ja/ruby-gnome2.png +0 -0
  108. data/doc/_site/images/screenshots/ja/rubykaigi2011-raw.png +0 -0
  109. data/doc/_site/images/screenshots/ja/rubykaigi2011.png +0 -0
  110. data/doc/_site/images/us.png +0 -0
  111. data/doc/_site/index.html.en +0 -132
  112. data/doc/_site/index.html.ja +0 -132
  113. data/doc/_site/ja/about.html +0 -120
  114. data/doc/_site/ja/development.html +0 -141
  115. data/doc/_site/ja/faq.html +0 -243
  116. data/doc/_site/ja/hiki.html +0 -416
  117. data/doc/_site/ja/how-to-make/hiki.html +0 -113
  118. data/doc/_site/ja/how-to-make/index.html +0 -136
  119. data/doc/_site/ja/how-to-make/markdown.html +0 -161
  120. data/doc/_site/ja/how-to-make/pdf.html +0 -112
  121. data/doc/_site/ja/how-to-make/rd.html +0 -161
  122. data/doc/_site/ja/how-to-make/theme.html +0 -254
  123. data/doc/_site/ja/index.html +0 -364
  124. data/doc/_site/ja/install/homebrew.html +0 -273
  125. data/doc/_site/ja/install/index.html +0 -148
  126. data/doc/_site/ja/install/macports.html +0 -174
  127. data/doc/_site/ja/install/windows.html +0 -200
  128. data/doc/_site/ja/news.html +0 -1243
  129. data/doc/_site/ja/rd.html +0 -565
  130. data/doc/_site/ja/sample/hiki/rabbit.html +0 -566
  131. data/doc/_site/ja/sample/index.html +0 -121
  132. data/doc/_site/ja/sample/markdown/rabbit.html +0 -485
  133. data/doc/_site/ja/sample/rd/rabbit.html +0 -580
  134. data/doc/_site/ja/slides.html +0 -142
  135. data/doc/_site/ja/usage.html +0 -449
  136. data/doc/_site/ja/users.html +0 -332
  137. data/doc/_site/javascripts/jquery-ui.js +0 -11544
  138. data/doc/_site/javascripts/jquery.js +0 -7179
  139. data/doc/_site/screenshot.en.rab +0 -10
  140. data/doc/_site/screenshot.ja.rab +0 -10
  141. data/lib/rabbit/parser/rd/ext/entity.rb +0 -38
data/doc/_site/ja/rd.html DELETED
@@ -1,565 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="ja">
3
- <head>
4
- <meta charset="UTF-8" />
5
- <title>Rabbit - RD</title>
6
- <link rel="shortcut icon" href="/favicon.ico"
7
- type="image/vnd.microsfot.icon">
8
- <link rel="icon" href="/favicon.png" type="image/png">
9
- <link rel="stylesheet" href="/css/jquery-ui/themes/ui-lightness.css"
10
- type="text/css">
11
- <link rel="stylesheet" href="/css/rabbit.css" type="text/css">
12
- <meta property="fb:page_id" content="rabbit.shockers">
13
- <meta property="fb:admins" content="kouhei.sutou">
14
- <meta property="og:type" content="product">
15
- <meta property="og:image"
16
- content="http://rabbit-shockers.org/images/lavie.png">
17
- <meta property="og:site_name" content="Rabbit">
18
- <script type="text/javascript" src="/javascripts/jquery.js"></script>
19
- <script type="text/javascript" src="/javascripts/jquery-ui.js"></script>
20
- <!--[if lt IE 9]>
21
- <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
22
- <![endif]-->
23
- </head>
24
- <body>
25
- <header id="header">
26
- <h1 class="title">
27
- <a href="/">
28
- <span class="project">Rabbit</span>
29
- <span class="separator">-</span>
30
- <span class="description">RD</span>
31
- </a>
32
- </h1>
33
- <div class="facebook-buttons">
34
- <fb:like href="http://www.facebook.com/pages/Rabbit/202603309766491"
35
- layout="standard"></fb:like>
36
- </div>
37
- <pre id="install" class="command">gem install rabbit</pre>
38
- <div class="other-language-links">
39
- <ul>
40
-
41
-
42
- <li><a href="/en/rd.html" alt="English" title="English"><img src="/images/us.png"></a></li>
43
-
44
-
45
- </ul>
46
- </div>
47
- </header>
48
-
49
- <nav class="menu">
50
- <ul>
51
- <li><a href="/ja/">はじめに</a></li>
52
- <li><a href="/ja/install/">インストール</a></li>
53
- <li><a href="/ja/usage.html">使い方</a></li>
54
- <li><a href="/ja/how-to-make/">作り方</a></li>
55
- <li><a href="/ja/users.html">ショッカー</a></li>
56
- <li><a href="/ja/development.html">開発</a></li>
57
- </ul>
58
- </nav>
59
-
60
-
61
- <div id="body">
62
- <div id="main">
63
- <section class="contents">
64
- <h2><a name="label-0" id="label-0">RDとは何か</a></h2><!-- RDLabel: "RDとは何か" -->
65
- <p>RDとはRuby版のPODです。つまりRubyスクリプトファイルの中に埋め込む事を意図して
66
- 定義されたドキュメントフォーマットです。</p>
67
- <p>RDは主にplain textをさまざまなフォーマットに変換するplain2というプログラム
68
- の影響を受けています。そのため、RDはplain textに似ており、シンプルですっきり
69
- した文法なので読みやすく書きやすいでしょう。</p>
70
- <h2><a name="label-1" id="label-1">RubyインタプリタはRDをどのように扱うか</a></h2><!-- RDLabel: "RubyインタプリタはRDをどのように扱うか" -->
71
- <p>Rubyのインタプリタは単純に"<code>=begin</code>"で始まる行から"<code>=end</code>"で始まる
72
- 行までを無視します。ですから、スクリプトファイル中に埋め込む事ができるのは
73
- RDだけではありません。何でも<code>=begin</code>と<code>=end</code>の間に書く事ができるの
74
- です。RDは選択肢の一つにすぎませんが、Ruby標準のドキュメントフォーマットと
75
- されています。<a name="footmark-1" id="footmark-1" href="#foottext-1"><sup><small>*1</small></sup></a></p>
76
- <h2><a name="label-2" id="label-2">RDの基本的な概念と文法</a></h2><!-- RDLabel: "RDの基本的な概念と文法" -->
77
- <h3><a name="label-3" id="label-3">Element, Block, Inline</a></h3><!-- RDLabel: "Element, Block, Inline" -->
78
- <p>これからの説明では"Element"という用語<a name="footmark-2" id="footmark-2" href="#foottext-2"><sup><small>*2</small></sup></a>をテキストに文章構造を与えるための
79
- 構成要素という意味で用います。さらに、"<a href="#label-4">Block</a>"という用語を比較的
80
- 大きくグローバルな構造を表すElementに、"<a href="#label-34">Inline</a>"という用語を比較的小さ
81
- くローカルな、テキストに付加的な修飾を与えるElementに対して用います。</p>
82
- <p>段落や見出し、リストなどがBlockです。RDではBlockを表すのに
83
- インデントや特殊文字を用います。Blockを入れ子にすることで複雑な
84
- 構造も表現できます。そして、Blockの表現は自然とplain textに見え
85
- ます。詳しくは<a href="#label-4">Block</a>を見てください。</p>
86
- <p>強調やコードや参照などがInlineです。((? ... ?))のようなカッコと
87
- 特殊文字の組合せがInlineの表現に使われます。ほとんどのInlineが互いに
88
- 入れ子にできます。詳しくは<a href="#label-34">Inline</a>を見てください。</p>
89
- <h3><a name="label-4" id="label-4">Block</a></h3><!-- RDLabel: "Block" -->
90
- <h4><a name="label-5" id="label-5">基本文法</a></h4><!-- RDLabel: "基本文法" -->
91
- <p>Blockは行指向の文法にしたがいます。つまり、同じ行にある文字はすべて同じ
92
- Blockに属しています。インデントはBlockの入れ子レベルとタイプを表して
93
- います。行の先頭の文字はBlockのタイプに関係します。</p>
94
- <h5><a name="label-6" id="label-6">概念と用語</a></h5><!-- RDLabel: "概念と用語" -->
95
- <dl>
96
- <dt><a name="label-7" id="label-7">Baseline</a></dt><!-- RDLabel: "Baseline" -->
97
- <dd>
98
- Baselineはインデントの基準です。ある行のインデントととBaselineの相対的
99
- な深さはその行の属するBlockのタイプに影響します。
100
- </dd>
101
- <dt><a name="label-8" id="label-8">Head Char</a></dt><!-- RDLabel: "Head Char" -->
102
- <dd>
103
- Head Charは空白文字を除いた行の先頭の文字です。
104
- </dd>
105
- <dt><a name="label-9" id="label-9">STRINGLINE</a></dt><!-- RDLabel: "STRINGLINE" -->
106
- <dd>
107
- STRINGLINEは普通の文字で構成された行です。STRINGLINEは"<code>*</code>",
108
- "<code>(<var>num</var>)</code>", "<code>:</code>", "<code>=</code>", "<code>+</code>"といった文字を
109
- Head Charとしては含みません。しかし、インデントされた行なら"<code>=</code>"
110
- や"<code>+</code>"をHead Charとすることができます。
111
- </dd>
112
- <dt><a name="label-10" id="label-10">WHITELINE</a></dt><!-- RDLabel: "WHITELINE" -->
113
- <dd>
114
- WHITELINEは空白文字だけの行です。
115
- </dd>
116
- <dt><a name="label-11" id="label-11">Comment</a></dt><!-- RDLabel: "Comment" -->
117
- <dd>
118
- <code>/^#/</code>にマッチする行はコメントとみなされます。
119
- </dd>
120
- </dl>
121
- <h5><a name="label-12" id="label-12">Baselineの決定と影響</a></h5><!-- RDLabel: "Baselineの決定と影響" -->
122
- <p>トップレベルでは<a href="#label-7">Baseline</a>は行の左端です。リスト内ではBaselineはListItem
123
- の最初の<a href="#label-4">Block</a>によって決定します。例えば、</p>
124
- <pre>Example: "|" はBaselineを表しています。
125
- |この行はトップレベルのTextBlockの行だとします。
126
- |&lt;- したがって、Baselineは左端です。
127
- *|List内では (1)
128
- |&lt;- このようにBaselineは(1)の行で決定されます。
129
- * |同じListでもListItem毎にBaselineが決定されます。
130
- |&lt;- したがって、1番目のListItemとは違うここにBaselineがあります。</pre>
131
- <p>|この行はトップレベルのTextBlockの行だとします。
132
- |&lt;- したがって、Baselineは左端です。</p>
133
- <ul>
134
- <li>|List内では (1)
135
- |&lt;- このようにBaselineは(1)の行で決定されます。</li>
136
- <li>|同じListでもListItem毎にBaselineが決定されます。
137
- |&lt;- したがって、1番目のListItemとは違うここにBaselineがあります。</li>
138
- </ul>
139
- <p>Blockが別のBlockに入れ子になっている時には内部のBlockのBaselineは外側の
140
- BlockのBaselineよりも深くなります。</p>
141
- <p>Baselineとインデントの相対的な位置関係がBlockのタイプに影響します。
142
- Baselineと同じ深さにインデントされた<a href="#label-9">STRINGLINE</a>は<a href="#label-19">TextBlock</a>
143
- に属す行となります。一方Baselineより深くインデントされた<a href="#label-9">STRINGLINE</a>
144
- は<a href="#label-20">Verbatim</a>の行です。</p>
145
- <h4><a name="label-13" id="label-13">Blockのタイプ</a></h4><!-- RDLabel: "Blockのタイプ" -->
146
- <h5><a name="label-14" id="label-14">Headline</a></h5><!-- RDLabel: "Headline" -->
147
- <p>Headlineは"<code>=</code>"か"<code>+</code>"を<a href="#label-8">Head Char</a>とする行で構成されます。
148
- Headlineは1行以上にはなりません。Headlineはトップレベルだけに置く事が
149
- できます。</p>
150
- <pre>Example:
151
- |&lt;- トップレベルのBaseline
152
- = Headline 1.
153
- === Headline 1.1.1.
154
- + Headline 1.1.1.1.1.</pre>
155
- <h1><a name="label-15" id="label-15">Headline 1.</a></h1><!-- RDLabel: "Headline 1." -->
156
- <h3><a name="label-16" id="label-16">Headline 1.1.1.</a></h3><!-- RDLabel: "Headline 1.1.1." -->
157
- <h5><a name="label-17" id="label-17">Headline 1.1.1.1.1.</a></h5><!-- RDLabel: "Headline 1.1.1.1.1." -->
158
- <p>Headlineの先頭の特殊文字はHeadlineのレベルを表しています。次の図で
159
- 最初のマークは最も大きなレベルのもので、最後のマークがもっとも小さな
160
- レベルのものです。</p>
161
- <pre>Fig: Headline Marks
162
- =
163
- ==
164
- ===
165
- ====
166
- +
167
- ++</pre>
168
- <p>マークに続くテキストはHeadlineのタイトルです。これは同時に
169
- <a href="#label-45">Reference</a>のラベルとして使われます。</p>
170
- <p>Headlineのタイトルには<a href="#label-45">Reference</a>とFootnoteを除く<a href="#label-34">Inline</a>を使う事が
171
- できます。</p>
172
- <h5><a name="label-18" id="label-18">Include</a></h5><!-- RDLabel: "Include" -->
173
- <p>Includeは"<code>&lt;&lt;&lt;</code>"を<a href="#label-8">Head Char</a>とし、その後ろにインクルードする
174
- ファイルの名前が続く行からなります。RD形式のファイルと出力するフォーマッ
175
- トで書かれたファイルのどちらでもIncludeによってインクルードできます。</p>
176
- <p>RD形式のファイルをインクルードする時にはインクルードされるファイルの名
177
- 前は"foo.rd"の様に".rd"もしくは".rb"というサフィックスでなくてはなりま
178
- せん。そして、"<code>&lt;&lt;&lt;</code>"の後にはサフィックスを含めたファイルの完全な
179
- 名前を書きます。例えば、次の様にです。</p>
180
- <pre>&lt;&lt;&lt; foo.rd</pre>
181
- <p>出力するフォーマットのファイルをインクルードするには、インクルードされる
182
- ファイルはその出力フォーマットに固有のサフィックスを持たないといけません。
183
- 例えば、HTMLのファイルをインクルードするには".html"というサフィックスを、
184
- Texinfo形式のファイルをインクルードするには".texi"というサフィックスを
185
- つけます。そして、"<code>&lt;&lt;&lt;</code>"の後ろにはサフィックスを除いたファイルの
186
- 名前を書きます。例えば、</p>
187
- <pre>&lt;&lt;&lt; foo</pre>
188
- <p>と書くわけです。</p>
189
- <p>この場合、RDフォーマッタはHTMLを出力する時には"foo.html"をインクルード
190
- し、Texinfo形式で出力する時には"foo.texi"をインクルードします。出力フォー
191
- マットのIncludeを用いる時には複数の(しかもなるべく多くの)形式のインク
192
- ルードファイルを用意すべきです。</p>
193
- <h5><a name="label-19" id="label-19">TextBlock</a></h5><!-- RDLabel: "TextBlock" -->
194
- <p>TextBlockは複数の<a href="#label-9">STRINGLINE</a>から構成されます。それらの行は<a href="#label-7">Baseline</a>
195
- と同じインデントでないといけません。<a href="#label-7">Baseline</a>より深い<a href="#label-9">STRINGLINE</a>は
196
- <a href="#label-20">Verbatim</a>の行とみなされます。</p>
197
- <p>TextBlockは<a href="#label-34">Inline</a>を内部に含む事ができます。</p>
198
- <pre>Example:
199
- |
200
- これはTextBlockです。
201
- TextBlockの2行目の行です。
202
- この行はTextBlockでなくVerbatimです。
203
- * そしてこの行はListの行です。(正確にはListItemの中のTextBlockの行でも
204
- あるのですが)</pre>
205
- <p>この例は次のようにフォーマットされます。</p>
206
- <p>これはTextBlockです。
207
- TextBlockの2行目の行です。</p>
208
- <pre>この行はTextBlockでなくVerbatimです。</pre>
209
- <ul>
210
- <li>そしてこの行はListの行です。(正確にはListItemの中のTextBlockの行でも
211
- あるのですが)</li>
212
- </ul>
213
- <h5><a name="label-20" id="label-20">Verbatim</a></h5><!-- RDLabel: "Verbatim" -->
214
- <p>Rubyスクリプトを引用するのにVerbatimを用いる事ができます。Verbatimは
215
- <a href="#label-7">Baseline</a>より深いインデントを持つ<a href="#label-9">STRINGLINE</a>で構成されます。
216
- Verbatimは"<code>*</code>"や"<code>(1)</code>"や"<code>:</code>"といった特殊文字を<!-- Reference, RDLabel "Head
217
- Char" doesn't exist --><em class="label-not-found">Head
218
- Char</em><!-- Reference end -->として持つ行も含む事ができますが、それらは最初の行には置く事
219
- ができません。最初の行にあるときには<a href="#label-21">List</a>と見なされます。Verbatim
220
- は最初の行より浅いインデントの行も含みません。Verbatimは<a href="#label-10">WHITELINE</a>
221
- を含める事ができます。</p>
222
- <p><a href="#label-34">Inline</a>はVerbatim内では使えません。</p>
223
- <pre>Example:
224
- これはVerbatimです。
225
- 最初の行より深いインデントを持っても、同じVerbatimの行になります。
226
- * この行はListに見えますが、Verbatimです。
227
- しかしこの行は最初の行よりも浅くインデントされているので、別のVerbatim
228
- の行になります。</pre>
229
- <p>この例が次のようにフォーマットされます。</p>
230
- <pre>これはVerbatimです。
231
- 最初の行より深いインデントを持っても、同じVerbatimの行になります。
232
- * この行はListに見えますが、Verbatimです。</pre>
233
- <pre>しかしこの行は最初の行よりも浅くインデントされているので、別のVerbatim
234
- の行になります。</pre>
235
- <h5><a name="label-21" id="label-21">List</a></h5><!-- RDLabel: "List" -->
236
- <p>Listは特殊な<a href="#label-4">Block</a>です。Listは複数のListItemから構成され、ListItem
237
- は複数のBlockから構成されます。したがって、ListはBlockを内部に含む事が
238
- できます。含む事のできるBlockにはList自身も含みます。<a name="footmark-3" id="footmark-3" href="#foottext-3"><sup><small>*3</small></sup></a></p>
239
- <p>ListItemは<a href="#label-10">WHITELINE</a>を含む事ができますが、<a href="#label-19">TextBlock</a>は
240
- 持てません。そのため、WHITELINEを間にはさむ事によって複数のTextBlock
241
- をListItem内部に置く事ができます。</p>
242
- <p>Listには"<a href="#label-22">ItemList</a>"、"<a href="#label-23">EnumList</a>"、"<a href="#label-24">DescList</a>",
243
- "<a href="#label-27">MethodList</a>の4種類があります。</p>
244
- <h6><a name="label-22" id="label-22">ItemList</a></h6><!-- RDLabel: "ItemList" -->
245
- <p>ItemListは単純な番号付されないListです。ItemListItemは"<code>*</code>"という
246
- <a href="#label-8">Head Char</a>の行で始まります。ItemListItemの最初のBlockは必ず
247
- <a href="#label-19">TextBlock</a>になります。</p>
248
- <pre>Example:
249
- * 親Listの最初のItem
250
- * 子Listの最初のItem
251
- * 子Listの2番目のItem
252
- 親ListのItemに含まれるTextBlock</pre>
253
- <p>下のようにフォーマットされます。</p>
254
- <ul>
255
- <li><p>親Listの最初のItem</p>
256
- <ul>
257
- <li>子Listの最初のItem</li>
258
- <li>子Listの2番目のItem</li>
259
- </ul>
260
- <p>親ListのItemに含まれるTextBlock</p></li>
261
- </ul>
262
- <h6><a name="label-23" id="label-23">EnumList</a></h6><!-- RDLabel: "EnumList" -->
263
- <p>EnumListは番号付されたListです。EnumListItemは"<code><var>num</var></code>"(<var>num</var>
264
- は整数)という<a href="#label-8">Head Char</a>の行ではじまります。他の点ではEnumListは
265
- <a href="#label-22">ItemList</a>と同じです。</p>
266
- <pre>Example:
267
- (1) 親Listの最初のItem
268
- * 子ListとなるItemList
269
- (2) 親Listの2番目のItem
270
- (10) 番号は無視されます。</pre>
271
- <p>次のようにフォーマットされます。</p>
272
- <ol>
273
- <li>親Listの最初のItem
274
- <ul>
275
- <li>子ListとなるItemList</li>
276
- </ul></li>
277
- <li>親Listの2番目のItem</li>
278
- <li>番号は無視されます。</li>
279
- </ol>
280
- <h6><a name="label-24" id="label-24">DescList</a></h6><!-- RDLabel: "DescList" -->
281
- <p>DescListは用語説明のためのListです。DescListItemは2つの部分からなります。
282
- 1つはTermパートでもう1つはDescriptionパートです。Termパートは<a href="#label-45">Reference</a>
283
- のLabelとして使われます。</p>
284
- <p>Termパートは"<code>:</code>"という<a href="#label-8">Head Char</a>の行からなります。Termパートの
285
- 行はインデントできることを除くとTermパートは<a href="#label-14">Headline</a>と同様です。</p>
286
- <p>DescriptionパートはTermパートの次の行からはじまります。Descriptionパート
287
- の<a href="#label-7">Baseline</a>はTermパートの(<a href="#label-8">Head Char</a>を除いた)テキスト部分と
288
- 同じかより深くないといけません。例えば次の例は間違っています。</p>
289
- <pre>Example:
290
- : |Term
291
- |Description.</pre>
292
- <p>Descriptionぱーとは複数の<a href="#label-4">Block</a>を含む事ができます。<a href="#label-21">List</a>を
293
- 最初のBlockとすることもできます。Termパートは<a href="#label-34">Inline</a>を含む事が
294
- できますが、<a href="#label-45">Reference</a>とFootnoteは例外です。</p>
295
- <pre>Example:
296
- :Term
297
- Descriptionの最初の行
298
- 2番目の行
299
- :Term2
300
- * Listも含む事ができます
301
- * ...</pre>
302
- <p>次のようにフォーマットされます。</p>
303
- <dl>
304
- <dt><a name="label-25" id="label-25">Term</a></dt><!-- RDLabel: "Term" -->
305
- <dd>
306
- Descriptionの最初の行
307
- 2番目の行
308
- </dd>
309
- <dt><a name="label-26" id="label-26">Term2</a></dt><!-- RDLabel: "Term2" -->
310
- <dd>
311
- <ul>
312
- <li>Listも含む事ができます</li>
313
- <li>...</li>
314
- </ul>
315
- </dd>
316
- </dl>
317
- <h6><a name="label-27" id="label-27">MethodList</a></h6><!-- RDLabel: "MethodList" -->
318
- <p>MethodListはメソッドの説明のための特殊なタイプの<a href="#label-24">DescList</a>です。
319
- ほとんどの点でMethodListは<a href="#label-24">DescList</a>と同様ですが、Labelの規則
320
- は違っています。RDフォーマッタはMethodListのTermパートがなんらかの
321
- Rubyのあるクラスのメソッドや定数やCの関数プロトタイプといったような
322
- プログラムのコードであると知っています。そのため、MethodListは
323
- メソッドの引数のように見える部分を除いた上でLabelとなります。詳細は
324
- <a href="#label-43">LabelとReference</a>を見てください。</p>
325
- <p>MethodListItemは<a href="#label-24">DescList</a>と同様にTermパートとDescription
326
- パートを持ちます。Termパートは"<code>---</code>"という<a href="#label-8">Head Char</a>
327
- の行でなり、Descriptionパートは<a href="#label-19">TextBlock</a>や<a href="#label-20">Verbatim</a>
328
- 、<a href="#label-21">List</a>を含む事ができます。しかし、逆にMethodListを<a href="#label-21">List</a>
329
- の中に置くべきではありません。RDは将来的にはこれを禁止するかも
330
- しれません。</p>
331
- <pre>Example:
332
- --- Array#each {|i| ... } # =&gt; Labelは"Array#each"
333
- 各項目に対してブロックを評価する。
334
- --- Array#index(val) # =&gt; Labelは"Array#index"
335
- ((|val|))と同じ値である最初の項目を返す。同じ項目が無いときには
336
- (({nil}))を返す。</pre>
337
- <p>この例が次のようにフォーマットされます。</p>
338
- <dl>
339
- <dt><a name="label-28" id="label-28"><code>Array#each {|<var>i</var>| ... }</code></a></dt><!-- RDLabel: "Array#each" -->
340
- <dd>
341
- 各項目に対してブロックを評価する。</dd>
342
- <dt><a name="label-29" id="label-29"><code>Array#index(<var>val</var>)</code></a></dt><!-- RDLabel: "Array#index" -->
343
- <dd>
344
- <var>val</var>と同じ値である最初の項目を返す。同じ項目が無いときには
345
- <code>nil</code>を返す。</dd>
346
- </dl>
347
- <p>フォーマッタのいくつかはMethodListのTermパートに書かれているのはRuby
348
- のメソッドや定数などであると仮定しています。そういったフォーマッタでは
349
- MethodListのTermパートをインテリジェントに扱う事ができますが、そのため
350
- には特定の慣習にしたがってRDを書く必要があります。</p>
351
- <p>標準的なRubyクラスリファレンスのための慣習として次のようなものが提案さ
352
- れています。</p>
353
- <dl>
354
- <dt><a name="label-30" id="label-30">インスタンスメソッド</a></dt><!-- RDLabel: "インスタンスメソッド" -->
355
- <dd>
356
- <p>クラス<var>Class</var>のインスタンスメソッド<var>method</var></p>
357
- <pre>Class#method(its params ...) { parameter block }</pre>
358
- </dd>
359
- <dt><a name="label-31" id="label-31">クラスメソッド(クラスの特異メソッド)</a></dt><!-- RDLabel: "クラスメソッド(クラスの特異メソッド)" -->
360
- <dd>
361
- <p>クラス<var>Class</var>のクラスメソッド<var>method</var></p>
362
- <pre>Class.method(its params ...) { parameter block }</pre>
363
- </dd>
364
- <dt><a name="label-32" id="label-32">クラス定数</a></dt><!-- RDLabel: "クラス定数" -->
365
- <dd>
366
- <p>クラス<var>Class</var>の定数<var>Const</var></p>
367
- <pre>Class::Const</pre>
368
- </dd>
369
- <dt><a name="label-33" id="label-33">関数メソッド</a></dt><!-- RDLabel: "関数メソッド" -->
370
- <dd>
371
- <p>関数<var>func</var></p>
372
- <pre>function#func(its params ...) { parameter block }</pre>
373
- </dd>
374
- </dl>
375
- <p>Rubyはいくつかの特殊な文字(e.g. [], []=, +, -, &lt;&lt;, ...)はメソッドの名前
376
- (識別子)として使います。この時、Rubyインタプリタはこれらのメソッドの
377
- パースを普通のメソッドとは違ったやりかた(演算子メソッド)で行います。
378
- しかし、この慣習ではこれらの演算子メソッドも同じように書きます。</p>
379
- <pre>Example:
380
- --- Array#[](key)
381
- ((|key|))に対応する値を返す。
382
- --- Array#[]=(key, value)
383
- ((|key|))の場所に((|value|))を格納する。
384
- --- Array#+(other)
385
- 2つの(({Array}))を結合してそれを返します。</pre>
386
- <h3><a name="label-34" id="label-34">Inline</a></h3><!-- RDLabel: "Inline" -->
387
- <p>Inlineは<a href="#label-19">TextBlock</a>や<a href="#label-14">Headline</a>、<a href="#label-24">DescList</a>のTermパートの
388
- 中で使う事ができます。カッコを使ったマークアップがInlineに使われます。
389
- Inline同士は互いに入れ子にできます。</p>
390
- <p>次のInlineの一覧では左側に書式を、右側にフォーマット後の様子を表示
391
- しています。</p>
392
- <dl>
393
- <dt><a name="label-35" id="label-35">((*Em*)) =&gt; <em>Em</em></a></dt><!-- RDLabel: "((*Em*)) => Em" -->
394
- <dd>
395
- 強調
396
- </dd>
397
- <dt><a name="label-36" id="label-36">(({while gets...})) =&gt; <code>while gets...</code></a></dt><!-- RDLabel: "(({while gets...})) => while gets..." -->
398
- <dd>
399
- プログラムのコード
400
- </dd>
401
- <dt><a name="label-37" id="label-37">((|var|)) =&gt; <var>var</var></a></dt><!-- RDLabel: "((|var|)) => var" -->
402
- <dd>
403
- メタ変数<a name="footmark-4" id="footmark-4" href="#foottext-4"><sup><small>*4</small></sup></a>
404
- </dd>
405
- <dt><a name="label-38" id="label-38">((%ruby -v%)) =&gt; <kbd>ruby -v</kbd></a></dt><!-- RDLabel: "((%ruby -v%)) => ruby -v" -->
406
- <dd>
407
- キーボード
408
- </dd>
409
- <dt><a name="label-39" id="label-39">((:Term:))</a></dt><!-- RDLabel: "((:Term:))" -->
410
- <dd>
411
- <p>=&gt; <a name="index-0" id="index-0">Term</a></p>
412
- <p>インデクスやキーワードとなる用語の指定</p>
413
- </dd>
414
- <dt><a name="label-40" id="label-40">((&lt;Identity or URL&gt;))</a></dt><!-- RDLabel: "((<Identity or URL>))" -->
415
- <dd>
416
- <p>=&gt; <!-- Reference, RDLabel "Indentity or URL" doesn't exist --><em class="label-not-found">Indentity or URL</em><!-- Reference end --></p>
417
- <p>参照。詳しくは<a href="#label-43">LabelとReference</a>を見てください。</p>
418
- </dd>
419
- <dt><a name="label-41" id="label-41">((-Footnote-))</a></dt><!-- RDLabel: "((-Footnote-))" -->
420
- <dd>
421
- <p>=&gt; <a name="footmark-5" id="footmark-5" href="#foottext-5"><sup><small>*5</small></sup></a></p>
422
- <p>脚注</p>
423
- </dd>
424
- <dt><a name="label-42" id="label-42">(('verb')) =&gt; verb</a></dt><!-- RDLabel: "(('verb')) => verb" -->
425
- <dd>
426
- Inlineのvarbatim(フォーマット抑制)
427
- </dd>
428
- </dl>
429
- <h4><a name="label-43" id="label-43">LabelとReference</a></h4><!-- RDLabel: "LabelとReference" -->
430
- <p>ReferenceにはLabelが必要です。RDでは<a href="#label-14">Headline</a>のタイトルと<a href="#label-24">DescList</a>
431
- や<a href="#label-27">MethodList</a>のTermパートだけがLabelとなります。したがって、各々の
432
- <a href="#label-14">Headline</a>には違うタイトルをつけてあげなくてはなりません。この問題の
433
- きちんとした解決策はまだ見付かっていません。</p>
434
- <h5><a name="label-44" id="label-44">どのようにLabelがつけられるか</a></h5><!-- RDLabel: "どのようにLabelがつけられるか" -->
435
- <p><a href="#label-14">Headline</a>のタイトルと<a href="#label-24">DescList</a>や<a href="#label-27">MethodList</a>のTermパートが
436
- Labelとして使われます。しかし、<a href="#label-34">Inline</a>が含まれるために、それらが
437
- そのままLabelとして使われる、というほど単純ではありません。</p>
438
- <p>第一に、<a href="#label-27">MethodList</a>はLabel付けにおいてはやや特殊です。<a href="#label-27">MethodList</a>
439
- のTermパートは<a href="#label-34">Inline</a>を含みませんが、その代わりRDでは<a href="#label-27">MethodList</a>
440
- のTermパートはメソッドリファレンスやそれに類似の物とみなされますので、次の
441
- ようなルールでラベルが付けられます。</p>
442
- <ol>
443
- <li>"<code>(</code>"や"<code>{</code>"の前にあるテキストだけがラベルと見なされる。<a name="footmark-6" id="footmark-6" href="#foottext-6"><sup><small>*6</small></sup></a></li>
444
- </ol>
445
- <p>次の例を見れば、どのようにルールが適用されているかわかるでしょう。
446
- "<code># =&gt;</code>"より右にあるのが<a href="#label-27">MethodList</a>のTermパートから抽出された
447
- Labelです。</p>
448
- <pre>Example:
449
- --- Array.new([size[, val]]) # =&gt; Array.new
450
- --- Array#[]=(key, val) # =&gt; Array#[]=
451
- --- Array#each { ... } # =&gt; Array#each
452
- --- void rb_define_method(VALUE class, ...) # =&gt; void rb_define_method</pre>
453
- <p>次に、<a href="#label-14">Headline</a>のタイトルや<a href="#label-24">DescList</a>のTermパートの場合には、この
454
- ような特別なルールはありませんが、<a href="#label-34">Inline</a>を含む事があるので、<a href="#label-34">Inline</a>
455
- に用いるカッコを取り除くためのルールがあります。</p>
456
- <ol>
457
- <li><p>どんな<a href="#label-34">Inline</a>修飾もLabelには影響しません。したがって、</p>
458
- <pre>= ((*Headline*))</pre>
459
- <pre>と
460
- = Headline
461
- は共に"Headline"とLabelが決まります。</pre></li>
462
- <li><p>しかし、Labelを抽出する際には<a href="#label-34">Inline</a>の開始カッコの後ろと終端カッコ
463
- の前にある空白文字は取り除かれます。したがって、</p>
464
- <pre>= ((* Headline *))</pre>
465
- <p>も</p>
466
- <pre>= ((*Headline*))</pre>
467
- <p>も"Headline"とLabelがつけられます。</p></li>
468
- </ol>
469
- <h5><a name="label-45" id="label-45">Reference</a></h5><!-- RDLabel: "Reference" -->
470
- <p>LabelのつけられたElementはReferenceによって参照できます。Referenceは
471
- ((&lt;...&gt;))というカッコで修飾される<a href="#label-34">Inline</a>です。</p>
472
- <p>最も簡単なReferenceの使用法は、単にLabelをそのカッコの中に書けばよいのです。</p>
473
- <pre>((&lt;Label&gt;))</pre>
474
- <p>これは"Label"というLabelに対する参照となります。また、フォーマッタによる
475
- 出力では"Label"というテキストが表示にも使われます。例: <!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found">Label</em><!-- Reference end --><a name="footmark-7" id="footmark-7" href="#foottext-7"><sup><small>*7</small></sup></a></p>
476
- <p>URLによって示されたリソースを参照するには次のように書きます。</p>
477
- <pre>((&lt;URL:http://www.ruby-lang.org/en/raa.html&gt;))</pre>
478
- <p>可能ならRDフォーマッタはURLを次のようにハイパーリンクします。例:
479
- <a href="http://www.ruby-lang.org/en/raa.html">&lt;URL:http://www.ruby-lang.org/en/raa.html&gt;</a>.</p>
480
- <p>Labelとは違うテキストを表示に使いたい時には次のように書きます。</p>
481
- <pre>((&lt;Text for display|Label&gt;))</pre>
482
- <p>"Text for display"が表示用のテキストとして使われ、"Label"がLabelとして
483
- 使われます。例: <!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found">Text for display</em><!-- Reference end --></p>
484
- <p>表示用のテキストは<a href="#label-34">Inline</a>を含む事ができます。しかし、Footnoteと
485
- Reference自身を含む事はできません。</p>
486
- <p>Reference内では"|"や"/"は特殊文字なのでこれらを使いたい時には、それを含む
487
- 部分ごとダブルクオートで囲ってやらないといけません。これはReference内のどの
488
- 部分でも同じです。</p>
489
- <pre>((&lt;"Bar | inside display text"|Label&gt;))</pre>
490
- <p><!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found">Bar | inside display text</em><!-- Reference end --></p>
491
- <p>表示用のテキストはURLへのReferenceにも使う事ができます。</p>
492
- <pre>((&lt;Ruby Application Archive|URL:http://www.ruby-lang.org/en/raa.html&gt;))</pre>
493
- <p><a href="http://www.ruby-lang.org/en/raa.html">Ruby Application Archive</a></p>
494
- <p>表示用のテキストが無い場合には代わりにLabelに<a href="#label-34">Inline</a>を使えます。</p>
495
- <pre>((&lt;((*Label*))&gt;))</pre>
496
- <p><!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found"><em>Label</em></em><!-- Reference end --></p>
497
- </section>
498
- <section class="footnotes">
499
- <h2>Footnotes</h2>
500
-
501
- <p class="foottext">
502
- <a name="foottext-1" id="foottext-1" href="#footmark-1"><sup><small>*1</small></sup></a><small>もし他のドキュメントフォーマットに興味があるなら、例えば
503
- rubyapi2
504
- <a href="http://www.ueda.info.waseda.ac.jp/~igarashi/ruby/xml.html#rubyapi2">&lt;URL:http://www.ueda.info.waseda.ac.jp/~igarashi/ruby/xml.html#rubyapi2&gt;</a>
505
- などを見るといいでしょう。これはRuby/Gtkのような大規模ライブラリのドキュメン
506
- ト向けに作られています。</small><br />
507
- <a name="foottext-2" id="foottext-2" href="#footmark-2"><sup><small>*2</small></sup></a><small>訳注: RDの文法用語についてはあ
508
- えて日本語訳をあてませんでした。</small><br />
509
- <a name="foottext-3" id="foottext-3" href="#footmark-3"><sup><small>*3</small></sup></a><small><a href="#label-14">Headline</a>
510
- や<a href="#label-18">Include</a>はList内部に持てません。</small><br />
511
- <a name="foottext-4" id="foottext-4" href="#footmark-4"><sup><small>*4</small></sup></a><small> Varについての詳しい説明はtexinfo.texiの該当部分にあります。</small><br />
512
- <a name="foottext-5" id="foottext-5" href="#footmark-5"><sup><small>*5</small></sup></a><small>Footnote</small><br />
513
- <a name="foottext-6" id="foottext-6" href="#footmark-6"><sup><small>*6</small></sup></a><small>
514
- "<code>(...)</code>"の内部のテキストはメソッドの引数だと見なされ、
515
- "<code>{...}</code>"の内部のテキストはメソッドのブロックと見なされるのです。</small><br />
516
- <a name="foottext-7" id="foottext-7" href="#footmark-7"><sup><small>*7</small></sup></a><small>
517
- "Label"というLabelのついたElementが無いのでおそらくReferenceの様には
518
- 見えないでしょう。</small><br />
519
- </p>
520
- </section>
521
- </div>
522
- <nav id="sidebar">
523
- <h3>最新リリース</h3>
524
- <p>2012-05-29にリリースされた<a href="/ja/news.html">1.0.7</a>が最新リリースです。</p>
525
- <h3>リンク</h3>
526
- <ul>
527
- <li><a href="/ja/">はじめに</a></li>
528
- <li><a href="/ja/install/">インストール</a></li>
529
- <li><a href="/ja/usage.html">使い方</a></li>
530
- <li><a href="/ja/how-to-make/">作り方</a></li>
531
- <li><a href="/ja/users.html">ショッカー</a></li>
532
- <li><a href="/ja/development.html">開発</a></li>
533
- </ul>
534
- </nav>
535
- </div>
536
-
537
-
538
- <footer>
539
- <p class="copyright">&copy; 2004-2012 Kouhei Sutou.</p>
540
- </footer>
541
- <script src="http://connect.facebook.net/ja_JP/all.js"></script>
542
- <script>
543
- FB.init({
544
- appId : null,
545
- status : true, // check login status
546
- cookie : true, // enable cookies to allow the server to access the session
547
- xfbml : true // parse XFBML
548
- });
549
- </script>
550
- <script type="text/javascript">
551
- if (document.location.protocol != "file:" &&
552
- document.location.host != "localhost") {
553
- var _gaq = _gaq || [];
554
- _gaq.push(['_setAccount', 'UA-12143252-4']);
555
- _gaq.push(['_trackPageview']);
556
-
557
- (function() {
558
- var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
559
- ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
560
- var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
561
- })();
562
- }
563
- </script>
564
- </body>
565
- </html>