tdiary 3.2.2.20130518 → 3.2.2.20130527

Sign up to get free protection for your applications and to get access to all the features.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/Gemfile.lock +17 -11
  4. data/Rakefile +2 -0
  5. data/config.ru +2 -1
  6. data/tdiary.gemspec +7 -0
  7. data/tdiary.rb +6 -2
  8. data/tdiary/cli.rb +27 -1
  9. data/tdiary/environment.rb +0 -1
  10. data/tdiary/tasks/release.rake +7 -1
  11. data/tdiary/version.rb +1 -1
  12. metadata +87 -132
  13. data/vendor/hikidoc-0.0.6/COPYING +0 -28
  14. data/vendor/hikidoc-0.0.6/NEWS +0 -30
  15. data/vendor/hikidoc-0.0.6/NEWS.ja +0 -30
  16. data/vendor/hikidoc-0.0.6/README +0 -86
  17. data/vendor/hikidoc-0.0.6/README.ja +0 -83
  18. data/vendor/hikidoc-0.0.6/Rakefile +0 -68
  19. data/vendor/hikidoc-0.0.6/TextFormattingRules +0 -320
  20. data/vendor/hikidoc-0.0.6/TextFormattingRules.ja +0 -318
  21. data/vendor/hikidoc-0.0.6/bin/hikidoc +0 -66
  22. data/vendor/hikidoc-0.0.6/lib/hikidoc.rb +0 -914
  23. data/vendor/hikidoc-0.0.6/setup.rb +0 -1360
  24. data/vendor/hikidoc-0.0.6/test/run-test.rb +0 -13
  25. data/vendor/hikidoc-0.0.6/test/test_hikidoc.rb +0 -506
  26. data/vendor/imagesize-0.1.1/Manifest.txt +0 -19
  27. data/vendor/imagesize-0.1.1/README.txt +0 -49
  28. data/vendor/imagesize-0.1.1/lib/image_size.rb +0 -305
  29. data/vendor/imagesize-0.1.1/lib/image_size/version.rb +0 -9
  30. data/vendor/imagesize-0.1.1/setup.rb +0 -1585
  31. data/vendor/imagesize-0.1.1/test/2-4-7.png +0 -0
  32. data/vendor/imagesize-0.1.1/test/4_1_2.gif +0 -0
  33. data/vendor/imagesize-0.1.1/test/bmp.bmp +0 -0
  34. data/vendor/imagesize-0.1.1/test/cursor.xbm +0 -6
  35. data/vendor/imagesize-0.1.1/test/detect.swf +0 -0
  36. data/vendor/imagesize-0.1.1/test/pbm.pbm +0 -0
  37. data/vendor/imagesize-0.1.1/test/pcx.pcx +0 -0
  38. data/vendor/imagesize-0.1.1/test/pgm.pgm +0 -5
  39. data/vendor/imagesize-0.1.1/test/test.xpm +0 -38
  40. data/vendor/imagesize-0.1.1/test/test_helper.rb +0 -2
  41. data/vendor/imagesize-0.1.1/test/test_image_size.rb +0 -71
  42. data/vendor/imagesize-0.1.1/test/tiff.tiff +0 -0
  43. data/vendor/imagesize-0.1.1/test/tokyo_tower.jpg +0 -0
  44. data/vendor/imagesize-0.1.1/test/tower_e.gif.psd +0 -0
  45. data/vendor/rdtool-0.6.38/COPYING.txt +0 -339
  46. data/vendor/rdtool-0.6.38/Gemfile +0 -3
  47. data/vendor/rdtool-0.6.38/HISTORY +0 -318
  48. data/vendor/rdtool-0.6.38/LGPL-2.1 +0 -502
  49. data/vendor/rdtool-0.6.38/LICENSE.txt +0 -58
  50. data/vendor/rdtool-0.6.38/README.html +0 -66
  51. data/vendor/rdtool-0.6.38/README.ja.html +0 -73
  52. data/vendor/rdtool-0.6.38/README.rd +0 -76
  53. data/vendor/rdtool-0.6.38/README.rd.ja +0 -85
  54. data/vendor/rdtool-0.6.38/Rakefile +0 -152
  55. data/vendor/rdtool-0.6.38/TODO +0 -22
  56. data/vendor/rdtool-0.6.38/bin/rd2 +0 -283
  57. data/vendor/rdtool-0.6.38/bin/rdswap.rb +0 -207
  58. data/vendor/rdtool-0.6.38/doc/rd-draft.html +0 -456
  59. data/vendor/rdtool-0.6.38/doc/rd-draft.ja.html +0 -466
  60. data/vendor/rdtool-0.6.38/doc/rd-draft.rd +0 -479
  61. data/vendor/rdtool-0.6.38/doc/rd-draft.rd.ja +0 -487
  62. data/vendor/rdtool-0.6.38/lib/rd/block-element.rb +0 -114
  63. data/vendor/rdtool-0.6.38/lib/rd/complex-list-item.rb +0 -65
  64. data/vendor/rdtool-0.6.38/lib/rd/desclist.rb +0 -55
  65. data/vendor/rdtool-0.6.38/lib/rd/document-struct.rb +0 -46
  66. data/vendor/rdtool-0.6.38/lib/rd/dot.rd2rc +0 -18
  67. data/vendor/rdtool-0.6.38/lib/rd/element.rb +0 -160
  68. data/vendor/rdtool-0.6.38/lib/rd/filter.rb +0 -255
  69. data/vendor/rdtool-0.6.38/lib/rd/head-filter.rb +0 -14
  70. data/vendor/rdtool-0.6.38/lib/rd/inline-element.rb +0 -233
  71. data/vendor/rdtool-0.6.38/lib/rd/labeled-element.rb +0 -14
  72. data/vendor/rdtool-0.6.38/lib/rd/list.rb +0 -57
  73. data/vendor/rdtool-0.6.38/lib/rd/loose-struct.rb +0 -11
  74. data/vendor/rdtool-0.6.38/lib/rd/methodlist.rb +0 -57
  75. data/vendor/rdtool-0.6.38/lib/rd/output-format-visitor.rb +0 -30
  76. data/vendor/rdtool-0.6.38/lib/rd/package.rb +0 -4
  77. data/vendor/rdtool-0.6.38/lib/rd/parser-util.rb +0 -14
  78. data/vendor/rdtool-0.6.38/lib/rd/post-install +0 -1
  79. data/vendor/rdtool-0.6.38/lib/rd/pre-setup.rb +0 -18
  80. data/vendor/rdtool-0.6.38/lib/rd/rbl-file.rb +0 -69
  81. data/vendor/rdtool-0.6.38/lib/rd/rbl-suite.rb +0 -37
  82. data/vendor/rdtool-0.6.38/lib/rd/rd-struct.rb +0 -86
  83. data/vendor/rdtool-0.6.38/lib/rd/rd2html-ext-lib.rb +0 -266
  84. data/vendor/rdtool-0.6.38/lib/rd/rd2html-ext-opt.rb +0 -34
  85. data/vendor/rdtool-0.6.38/lib/rd/rd2html-lib.rb +0 -490
  86. data/vendor/rdtool-0.6.38/lib/rd/rd2html-opt.rb +0 -67
  87. data/vendor/rdtool-0.6.38/lib/rd/rd2man-lib.rb +0 -251
  88. data/vendor/rdtool-0.6.38/lib/rd/rd2rdo-lib.rb +0 -19
  89. data/vendor/rdtool-0.6.38/lib/rd/rd2rmi-lib.rb +0 -32
  90. data/vendor/rdtool-0.6.38/lib/rd/rdblockparser.ry +0 -518
  91. data/vendor/rdtool-0.6.38/lib/rd/rdblockparser.tab.rb +0 -1061
  92. data/vendor/rdtool-0.6.38/lib/rd/rdfmt.rb +0 -15
  93. data/vendor/rdtool-0.6.38/lib/rd/rdinlineparser.ry +0 -503
  94. data/vendor/rdtool-0.6.38/lib/rd/rdinlineparser.tab.rb +0 -1243
  95. data/vendor/rdtool-0.6.38/lib/rd/rdvisitor.rb +0 -214
  96. data/vendor/rdtool-0.6.38/lib/rd/reference-resolver.rb +0 -114
  97. data/vendor/rdtool-0.6.38/lib/rd/search-file.rb +0 -14
  98. data/vendor/rdtool-0.6.38/lib/rd/tree.rb +0 -103
  99. data/vendor/rdtool-0.6.38/lib/rd/version.rb +0 -41
  100. data/vendor/rdtool-0.6.38/lib/rd/visitor.rb +0 -86
  101. data/vendor/rdtool-0.6.38/rdtool.gemspec +0 -125
  102. data/vendor/rdtool-0.6.38/setup.rb +0 -1596
  103. data/vendor/rdtool-0.6.38/test/data/includee1.html +0 -1
  104. data/vendor/rdtool-0.6.38/test/data/includee2.html +0 -1
  105. data/vendor/rdtool-0.6.38/test/data/includee3.nothtml +0 -1
  106. data/vendor/rdtool-0.6.38/test/data/includee4.xhtml +0 -0
  107. data/vendor/rdtool-0.6.38/test/data/label.rbl +0 -2
  108. data/vendor/rdtool-0.6.38/test/data/label2.rbl +0 -2
  109. data/vendor/rdtool-0.6.38/test/data/sub/includee2.html +0 -1
  110. data/vendor/rdtool-0.6.38/test/data/sub/includee4.html +0 -0
  111. data/vendor/rdtool-0.6.38/test/dummy-observer.rb +0 -6
  112. data/vendor/rdtool-0.6.38/test/dummy.rb +0 -33
  113. data/vendor/rdtool-0.6.38/test/temp-dir.rb +0 -19
  114. data/vendor/rdtool-0.6.38/test/test-block-parser.rb +0 -46
  115. data/vendor/rdtool-0.6.38/test/test-desclist-item.rb +0 -219
  116. data/vendor/rdtool-0.6.38/test/test-document-element.rb +0 -46
  117. data/vendor/rdtool-0.6.38/test/test-document-struct.rb +0 -66
  118. data/vendor/rdtool-0.6.38/test/test-element.rb +0 -46
  119. data/vendor/rdtool-0.6.38/test/test-headline.rb +0 -80
  120. data/vendor/rdtool-0.6.38/test/test-inline-parser.rb +0 -46
  121. data/vendor/rdtool-0.6.38/test/test-list-item.rb +0 -54
  122. data/vendor/rdtool-0.6.38/test/test-list.rb +0 -53
  123. data/vendor/rdtool-0.6.38/test/test-methodlist-item.rb +0 -73
  124. data/vendor/rdtool-0.6.38/test/test-nonterminal-element.rb +0 -170
  125. data/vendor/rdtool-0.6.38/test/test-nonterminal-inline.rb +0 -33
  126. data/vendor/rdtool-0.6.38/test/test-output-format-visitor.rb +0 -48
  127. data/vendor/rdtool-0.6.38/test/test-parser-util.rb +0 -41
  128. data/vendor/rdtool-0.6.38/test/test-rbl-file.rb +0 -156
  129. data/vendor/rdtool-0.6.38/test/test-rbl-suite.rb +0 -43
  130. data/vendor/rdtool-0.6.38/test/test-rd2html-lib.rb +0 -496
  131. data/vendor/rdtool-0.6.38/test/test-rdtree.rb +0 -17
  132. data/vendor/rdtool-0.6.38/test/test-rdvisitor.rb +0 -29
  133. data/vendor/rdtool-0.6.38/test/test-reference-resolver.rb +0 -202
  134. data/vendor/rdtool-0.6.38/test/test-reference.rb +0 -132
  135. data/vendor/rdtool-0.6.38/test/test-search-file.rb +0 -22
  136. data/vendor/rdtool-0.6.38/test/test-terminal-inline.rb +0 -41
  137. data/vendor/rdtool-0.6.38/test/test-textblock.rb +0 -44
  138. data/vendor/rdtool-0.6.38/test/test-tree.rb +0 -82
  139. data/vendor/rdtool-0.6.38/test/test-version.rb +0 -57
  140. data/vendor/rdtool-0.6.38/test/test-visitor.rb +0 -230
  141. data/vendor/rdtool-0.6.38/utils/rd-mode.el +0 -464
@@ -1,487 +0,0 @@
1
- = RD working draft 日本語版
2
- 英語版は((<ここ|URL:http://www.ruby-lang.org/~rubikitch/RDP-en.cgi?cmd=view&name=RD>))にあります。
3
-
4
- == RDとは何か
5
-
6
- RDとはRuby版のPODです。つまりRubyスクリプトファイルの中に埋め込む事を意図して
7
- 定義されたドキュメントフォーマットです。
8
-
9
- RDは主にplain textをさまざまなフォーマットに変換するplain2というプログラム
10
- の影響を受けています。そのため、RDはplain textに似ており、シンプルですっきり
11
- した文法なので読みやすく書きやすいでしょう。
12
-
13
- == RubyインタプリタはRDをどのように扱うか
14
-
15
- Rubyのインタプリタは単純に"(({=begin}))"で始まる行から"(({=end}))"で始まる
16
- 行までを無視します。ですから、スクリプトファイル中に埋め込む事ができるのは
17
- RDだけではありません。何でも(({=begin}))と(({=end}))の間に書く事ができるの
18
- です。RDは選択肢の一つにすぎませんが、Ruby標準のドキュメントフォーマットと
19
- されています。((-もし他のドキュメントフォーマットに興味があるなら、例えば
20
- rubyapi2
21
- ((<URL:http://www.ueda.info.waseda.ac.jp/~igarashi/ruby/xml.html#rubyapi2>))
22
- などを見るといいでしょう。これはRuby/Gtkのような大規模ライブラリのドキュメン
23
- ト向けに作られています。-))
24
-
25
- == RDの基本的な概念と文法
26
- === Element, Block, Inline
27
-
28
- これからの説明では"Element"という用語((-訳注: RDの文法用語についてはあ
29
- えて日本語訳をあてませんでした。-))をテキストに文章構造を与えるための
30
- 構成要素という意味で用います。さらに、"((<Block>))"という用語を比較的
31
- 大きくグローバルな構造を表すElementに、"((<Inline>))"という用語を比較的小さ
32
- くローカルな、テキストに付加的な修飾を与えるElementに対して用います。
33
-
34
- 段落や見出し、リストなどがBlockです。RDではBlockを表すのに
35
- インデントや特殊文字を用います。Blockを入れ子にすることで複雑な
36
- 構造も表現できます。そして、Blockの表現は自然とplain textに見え
37
- ます。詳しくは((<Block>))を見てください。
38
-
39
- 強調やコードや参照などがInlineです。(('((? ... ?))'))のようなカッコと
40
- 特殊文字の組合せがInlineの表現に使われます。ほとんどのInlineが互いに
41
- 入れ子にできます。詳しくは((<Inline>))を見てください。
42
-
43
- === Block
44
- ==== 基本文法
45
-
46
- Blockは行指向の文法にしたがいます。つまり、同じ行にある文字はすべて同じ
47
- Blockに属しています。インデントはBlockの入れ子レベルとタイプを表して
48
- います。行の先頭の文字はBlockのタイプに関係します。
49
-
50
- + 概念と用語
51
-
52
- :Baseline
53
- Baselineはインデントの基準です。ある行のインデントととBaselineの相対的
54
- な深さはその行の属するBlockのタイプに影響します。
55
-
56
- :Head Char
57
- Head Charは空白文字を除いた行の先頭の文字です。
58
-
59
- :STRINGLINE
60
- STRINGLINEは普通の文字で構成された行です。STRINGLINEは"(({*}))",
61
- "(({(((|num|)))}))", "(({:}))", "(({=}))", "(({+}))"といった文字を
62
- Head Charとしては含みません。しかし、インデントされた行なら"(({=}))"
63
- や"(({+}))"をHead Charとすることができます。
64
-
65
- :WHITELINE
66
- WHITELINEは空白文字だけの行です。
67
-
68
- :Comment
69
- (({/^#/}))にマッチする行はコメントとみなされます。
70
-
71
- + Baselineの決定と影響
72
- トップレベルでは((<Baseline>))は行の左端です。リスト内ではBaselineはListItem
73
- の最初の((<Block>))によって決定します。例えば、
74
-
75
- Example: "|" はBaselineを表しています。
76
- |この行はトップレベルのTextBlockの行だとします。
77
- |<- したがって、Baselineは左端です。
78
- *|List内では (1)
79
- |<- このようにBaselineは(1)の行で決定されます。
80
- * |同じListでもListItem毎にBaselineが決定されます。
81
- |<- したがって、1番目のListItemとは違うここにBaselineがあります。
82
- |この行はトップレベルのTextBlockの行だとします。
83
- |<- したがって、Baselineは左端です。
84
- *|List内では (1)
85
- |<- このようにBaselineは(1)の行で決定されます。
86
- * |同じListでもListItem毎にBaselineが決定されます。
87
- |<- したがって、1番目のListItemとは違うここにBaselineがあります。
88
-
89
- Blockが別のBlockに入れ子になっている時には内部のBlockのBaselineは外側の
90
- BlockのBaselineよりも深くなります。
91
-
92
- Baselineとインデントの相対的な位置関係がBlockのタイプに影響します。
93
- Baselineと同じ深さにインデントされた((<STRINGLINE>))は((<TextBlock>))
94
- に属す行となります。一方Baselineより深くインデントされた((<STRINGLINE>))
95
- は((<Verbatim>))の行です。
96
-
97
- ==== Blockのタイプ
98
- + Headline
99
-
100
- Headlineは"(({=}))"か"(({+}))"を((<Head Char>))とする行で構成されます。
101
- Headlineは1行以上にはなりません。Headlineはトップレベルだけに置く事が
102
- できます。
103
-
104
- Example:
105
- |<- トップレベルのBaseline
106
- = Headline 1.
107
- === Headline 1.1.1.
108
- + Headline 1.1.1.1.1.
109
-
110
- = Headline 1.
111
- === Headline 1.1.1.
112
- + Headline 1.1.1.1.1.
113
-
114
- Headlineの先頭の特殊文字はHeadlineのレベルを表しています。次の図で
115
- 最初のマークは最も大きなレベルのもので、最後のマークがもっとも小さな
116
- レベルのものです。
117
-
118
- Fig: Headline Marks
119
- =
120
- ==
121
- ===
122
- ====
123
- +
124
- ++
125
-
126
- マークに続くテキストはHeadlineのタイトルです。これは同時に
127
- ((<Reference>))のラベルとして使われます。
128
-
129
- Headlineのタイトルには((<Reference>))とFootnoteを除く((<Inline>))を使う事が
130
- できます。
131
-
132
- + Include
133
-
134
- Includeは"(({<<<}))"を((<Head Char>))とし、その後ろにインクルードする
135
- ファイルの名前が続く行からなります。RD形式のファイルと出力するフォーマッ
136
- トで書かれたファイルのどちらでもIncludeによってインクルードできます。
137
-
138
- RD形式のファイルをインクルードする時にはインクルードされるファイルの名
139
- 前は"foo.rd"の様に".rd"もしくは".rb"というサフィックスでなくてはなりま
140
- せん。そして、"(({<<<}))"の後にはサフィックスを含めたファイルの完全な
141
- 名前を書きます。例えば、次の様にです。
142
- <<< foo.rd
143
-
144
- 出力するフォーマットのファイルをインクルードするには、インクルードされる
145
- ファイルはその出力フォーマットに固有のサフィックスを持たないといけません。
146
- 例えば、HTMLのファイルをインクルードするには".html"というサフィックスを、
147
- Texinfo形式のファイルをインクルードするには".texi"というサフィックスを
148
- つけます。そして、"(({<<<}))"の後ろにはサフィックスを除いたファイルの
149
- 名前を書きます。例えば、
150
- <<< foo
151
- と書くわけです。
152
-
153
- この場合、RDフォーマッタはHTMLを出力する時には"foo.html"をインクルード
154
- し、Texinfo形式で出力する時には"foo.texi"をインクルードします。出力フォー
155
- マットのIncludeを用いる時には複数の(しかもなるべく多くの)形式のインク
156
- ルードファイルを用意すべきです。
157
-
158
- + TextBlock
159
-
160
- TextBlockは複数の((<STRINGLINE>))から構成されます。それらの行は((<Baseline>))
161
- と同じインデントでないといけません。((<Baseline>))より深い((<STRINGLINE>))は
162
- ((<Verbatim>))の行とみなされます。
163
-
164
- TextBlockは((<Inline>))を内部に含む事ができます。
165
-
166
- Example:
167
- |
168
- これはTextBlockです。
169
- TextBlockの2行目の行です。
170
- この行はTextBlockでなくVerbatimです。
171
- * そしてこの行はListの行です。(正確にはListItemの中のTextBlockの行でも
172
- あるのですが)
173
-
174
- この例は次のようにフォーマットされます。
175
-
176
- これはTextBlockです。
177
- TextBlockの2行目の行です。
178
- この行はTextBlockでなくVerbatimです。
179
- * そしてこの行はListの行です。(正確にはListItemの中のTextBlockの行でも
180
- あるのですが)
181
-
182
- + Verbatim
183
-
184
- Rubyスクリプトを引用するのにVerbatimを用いる事ができます。Verbatimは
185
- ((<Baseline>))より深いインデントを持つ((<STRINGLINE>))で構成されます。
186
- Verbatimは"(({*}))"や"(({(1)}))"や"(({:}))"といった特殊文字を((<Head
187
- Char>))として持つ行も含む事ができますが、それらは最初の行には置く事
188
- ができません。最初の行にあるときには((<List>))と見なされます。Verbatim
189
- は最初の行より浅いインデントの行も含みません。Verbatimは((<WHITELINE>))
190
- を含める事ができます。
191
-
192
- ((<Inline>))はVerbatim内では使えません。
193
-
194
- Example:
195
- これはVerbatimです。
196
- 最初の行より深いインデントを持っても、同じVerbatimの行になります。
197
- * この行はListに見えますが、Verbatimです。
198
- しかしこの行は最初の行よりも浅くインデントされているので、別のVerbatim
199
- の行になります。
200
-
201
- この例が次のようにフォーマットされます。
202
-
203
- これはVerbatimです。
204
- 最初の行より深いインデントを持っても、同じVerbatimの行になります。
205
- * この行はListに見えますが、Verbatimです。
206
- しかしこの行は最初の行よりも浅くインデントされているので、別のVerbatim
207
- の行になります。
208
-
209
- + List
210
-
211
- Listは特殊な((<Block>))です。Listは複数のListItemから構成され、ListItem
212
- は複数のBlockから構成されます。したがって、ListはBlockを内部に含む事が
213
- できます。含む事のできるBlockにはList自身も含みます。((-((<Headline>))
214
- や((<Include>))はList内部に持てません。-))
215
-
216
- ListItemは((<WHITELINE>))を含む事ができますが、((<TextBlock>))は
217
- 持てません。そのため、WHITELINEを間にはさむ事によって複数のTextBlock
218
- をListItem内部に置く事ができます。
219
-
220
- Listには"((<ItemList>))"、"((<EnumList>))"、"((<DescList>))",
221
- "((<MethodList>))の4種類があります。
222
-
223
- ++ ItemList
224
-
225
- ItemListは単純な番号付されないListです。ItemListItemは"(({*}))"という
226
- ((<Head Char>))の行で始まります。ItemListItemの最初のBlockは必ず
227
- ((<TextBlock>))になります。
228
-
229
- Example:
230
- * 親Listの最初のItem
231
- * 子Listの最初のItem
232
- * 子Listの2番目のItem
233
- 親ListのItemに含まれるTextBlock
234
-
235
- 下のようにフォーマットされます。
236
-
237
- * 親Listの最初のItem
238
- * 子Listの最初のItem
239
- * 子Listの2番目のItem
240
- 親ListのItemに含まれるTextBlock
241
-
242
- ++ EnumList
243
-
244
- EnumListは番号付されたListです。EnumListItemは"(({((|num|))}))"(((|num|))
245
- は整数)という((<Head Char>))の行ではじまります。他の点ではEnumListは
246
- ((<ItemList>))と同じです。
247
-
248
- Example:
249
- (1) 親Listの最初のItem
250
- * 子ListとなるItemList
251
- (2) 親Listの2番目のItem
252
- (10) 番号は無視されます。
253
-
254
- 次のようにフォーマットされます。
255
-
256
- (1) 親Listの最初のItem
257
- * 子ListとなるItemList
258
- (2) 親Listの2番目のItem
259
- (10) 番号は無視されます。
260
-
261
- ++ DescList
262
-
263
- DescListは用語説明のためのListです。DescListItemは2つの部分からなります。
264
- 1つはTermパートでもう1つはDescriptionパートです。Termパートは((<Reference>))
265
- のLabelとして使われます。
266
-
267
- Termパートは"(({:}))"という((<Head Char>))の行からなります。Termパートの
268
- 行はインデントできることを除くとTermパートは((<Headline>))と同様です。
269
-
270
- DescriptionパートはTermパートの次の行からはじまります。Descriptionパート
271
- の((<Baseline>))はTermパートの(((<Head Char>))を除いた)テキスト部分と
272
- 同じかより深くないといけません。例えば次の例は間違っています。
273
-
274
- Example:
275
- : |Term
276
- |Description.
277
-
278
- Descriptionぱーとは複数の((<Block>))を含む事ができます。((<List>))を
279
- 最初のBlockとすることもできます。Termパートは((<Inline>))を含む事が
280
- できますが、((<Reference>))とFootnoteは例外です。
281
-
282
- Example:
283
- :Term
284
- Descriptionの最初の行
285
- 2番目の行
286
- :Term2
287
- * Listも含む事ができます
288
- * ...
289
-
290
- 次のようにフォーマットされます。
291
-
292
- :Term
293
- Descriptionの最初の行
294
- 2番目の行
295
- :Term2
296
- * Listも含む事ができます
297
- * ...
298
-
299
- ++ MethodList
300
-
301
- MethodListはメソッドの説明のための特殊なタイプの((<DescList>))です。
302
- ほとんどの点でMethodListは((<DescList>))と同様ですが、Labelの規則
303
- は違っています。RDフォーマッタはMethodListのTermパートがなんらかの
304
- Rubyのあるクラスのメソッドや定数やCの関数プロトタイプといったような
305
- プログラムのコードであると知っています。そのため、MethodListは
306
- メソッドの引数のように見える部分を除いた上でLabelとなります。詳細は
307
- ((<LabelとReference>))を見てください。
308
-
309
- MethodListItemは((<DescList>))と同様にTermパートとDescription
310
- パートを持ちます。Termパートは"(({---}))"という((<Head Char>))
311
- の行でなり、Descriptionパートは((<TextBlock>))や((<Verbatim>))
312
- 、((<List>))を含む事ができます。しかし、逆にMethodListを((<List>))
313
- の中に置くべきではありません。RDは将来的にはこれを禁止するかも
314
- しれません。
315
-
316
- Example:
317
- --- Array#each {|i| ... } # => Labelは"Array#each"
318
- 各項目に対してブロックを評価する。
319
- --- Array#index(val) # => Labelは"Array#index"
320
- ((|val|))と同じ値である最初の項目を返す。同じ項目が無いときには
321
- (({nil}))を返す。
322
-
323
- この例が次のようにフォーマットされます。
324
-
325
- --- Array#each {|i| ... }
326
- 各項目に対してブロックを評価する。
327
- --- Array#index(val)
328
- ((|val|))と同じ値である最初の項目を返す。同じ項目が無いときには
329
- (({nil}))を返す。
330
-
331
- フォーマッタのいくつかはMethodListのTermパートに書かれているのはRuby
332
- のメソッドや定数などであると仮定しています。そういったフォーマッタでは
333
- MethodListのTermパートをインテリジェントに扱う事ができますが、そのため
334
- には特定の慣習にしたがってRDを書く必要があります。
335
-
336
- 標準的なRubyクラスリファレンスのための慣習として次のようなものが提案さ
337
- れています。
338
- : インスタンスメソッド
339
- クラス((|Class|))のインスタンスメソッド((|method|))
340
- Class#method(its params ...) { parameter block }
341
- : クラスメソッド(クラスの特異メソッド)
342
- クラス((|Class|))のクラスメソッド((|method|))
343
- Class.method(its params ...) { parameter block }
344
- : クラス定数
345
- クラス((|Class|))の定数((|Const|))
346
- Class::Const
347
- : 関数メソッド
348
- 関数((|func|))
349
- function#func(its params ...) { parameter block }
350
-
351
- Rubyはいくつかの特殊な文字(e.g. [], []=, +, -, <<, ...)はメソッドの名前
352
- (識別子)として使います。この時、Rubyインタプリタはこれらのメソッドの
353
- パースを普通のメソッドとは違ったやりかた(演算子メソッド)で行います。
354
- しかし、この慣習ではこれらの演算子メソッドも同じように書きます。
355
-
356
- Example:
357
- --- Array#[](key)
358
- ((|key|))に対応する値を返す。
359
- --- Array#[]=(key, value)
360
- ((|key|))の場所に((|value|))を格納する。
361
- --- Array#+(other)
362
- 2つの(({Array}))を結合してそれを返します。
363
-
364
- === Inline
365
- Inlineは((<TextBlock>))や((<Headline>))、((<DescList>))のTermパートの
366
- 中で使う事ができます。カッコを使ったマークアップがInlineに使われます。
367
- Inline同士は互いに入れ子にできます。
368
-
369
- 次のInlineの一覧では左側に書式を、右側にフォーマット後の様子を表示
370
- しています。
371
-
372
- :(('((*Em*))')) => ((*Em*))
373
- 強調
374
-
375
- :(('(({while gets...}))')) => (({while gets...}))
376
- プログラムのコード
377
-
378
- :(('((|var|))')) => ((|var|))
379
- メタ変数((- Varについての詳しい説明はtexinfo.texiの該当部分にあります。-))
380
-
381
- :(('((%ruby -v%))')) => ((%ruby -v%))
382
- キーボード
383
-
384
- :(('((:Term:))'))
385
- => ((:Term:))
386
-
387
- インデクスやキーワードとなる用語の指定
388
-
389
- :(('((<Identity or URL>))'))
390
- => ((<Indentity or URL>))
391
-
392
- 参照。詳しくは((<LabelとReference>))を見てください。
393
-
394
- :(('((-Footnote-))'))
395
- => ((-Footnote-))
396
-
397
- 脚注
398
-
399
- :(('(('verb\'))')) => (('verb'))
400
- Inlineのvarbatim(フォーマット抑制)
401
-
402
- ==== LabelとReference
403
-
404
- ReferenceにはLabelが必要です。RDでは((<Headline>))のタイトルと((<DescList>))
405
- や((<MethodList>))のTermパートだけがLabelとなります。したがって、各々の
406
- ((<Headline>))には違うタイトルをつけてあげなくてはなりません。この問題の
407
- きちんとした解決策はまだ見付かっていません。
408
-
409
- + どのようにLabelがつけられるか
410
-
411
- ((<Headline>))のタイトルと((<DescList>))や((<MethodList>))のTermパートが
412
- Labelとして使われます。しかし、((<Inline>))が含まれるために、それらが
413
- そのままLabelとして使われる、というほど単純ではありません。
414
-
415
- 第一に、((<MethodList>))はLabel付けにおいてはやや特殊です。((<MethodList>))
416
- のTermパートは((<Inline>))を含みませんが、その代わりRDでは((<MethodList>))
417
- のTermパートはメソッドリファレンスやそれに類似の物とみなされますので、次の
418
- ようなルールでラベルが付けられます。
419
-
420
- (1) "(({(}))"や"(({{}))"の前にあるテキストだけがラベルと見なされる。((-
421
- "(({(...)}))"の内部のテキストはメソッドの引数だと見なされ、
422
- "(({{...}}))"の内部のテキストはメソッドのブロックと見なされるのです。-))
423
-
424
- 次の例を見れば、どのようにルールが適用されているかわかるでしょう。
425
- "(({# =>}))"より右にあるのが((<MethodList>))のTermパートから抽出された
426
- Labelです。
427
-
428
- Example:
429
- --- Array.new([size[, val]]) # => Array.new
430
- --- Array#[]=(key, val) # => Array#[]=
431
- --- Array#each { ... } # => Array#each
432
- --- void rb_define_method(VALUE class, ...) # => void rb_define_method
433
-
434
- 次に、((<Headline>))のタイトルや((<DescList>))のTermパートの場合には、この
435
- ような特別なルールはありませんが、((<Inline>))を含む事があるので、((<Inline>))
436
- に用いるカッコを取り除くためのルールがあります。
437
-
438
- (1)どんな((<Inline>))修飾もLabelには影響しません。したがって、
439
- = ((*Headline*))
440
-
441
- = Headline
442
- は共に"Headline"とLabelが決まります。
443
- (2)しかし、Labelを抽出する際には((<Inline>))の開始カッコの後ろと終端カッコ
444
- の前にある空白文字は取り除かれます。したがって、
445
- = ((* Headline *))
446
-
447
- = ((*Headline*))
448
- も"Headline"とLabelがつけられます。
449
-
450
- + Reference
451
-
452
- LabelのつけられたElementはReferenceによって参照できます。Referenceは
453
- (('((<...>))'))というカッコで修飾される((<Inline>))です。
454
-
455
- 最も簡単なReferenceの使用法は、単にLabelをそのカッコの中に書けばよいのです。
456
- ((<Label>))
457
- これは"Label"というLabelに対する参照となります。また、フォーマッタによる
458
- 出力では"Label"というテキストが表示にも使われます。例: ((<Label>))((-
459
- "Label"というLabelのついたElementが無いのでおそらくReferenceの様には
460
- 見えないでしょう。-))
461
-
462
- URLによって示されたリソースを参照するには次のように書きます。
463
- ((<URL:http://www.ruby-lang.org/en/raa.html>))
464
- 可能ならRDフォーマッタはURLを次のようにハイパーリンクします。例:
465
- ((<URL:http://www.ruby-lang.org/en/raa.html>)).
466
-
467
- Labelとは違うテキストを表示に使いたい時には次のように書きます。
468
- ((<Text for display|Label>))
469
- "Text for display"が表示用のテキストとして使われ、"Label"がLabelとして
470
- 使われます。例: ((<Text for display|Label>))
471
-
472
- 表示用のテキストは((<Inline>))を含む事ができます。しかし、Footnoteと
473
- Reference自身を含む事はできません。
474
-
475
- Reference内では"|"や"/"は特殊文字なのでこれらを使いたい時には、それを含む
476
- 部分ごとダブルクオートで囲ってやらないといけません。これはReference内のどの
477
- 部分でも同じです。
478
- ((<"Bar | inside display text"|Label>))
479
- ((<"Bar | inside display text"|Label>))
480
-
481
- 表示用のテキストはURLへのReferenceにも使う事ができます。
482
- ((<Ruby Application Archive|URL:http://www.ruby-lang.org/en/raa.html>))
483
- ((<Ruby Application Archive|URL:http://www.ruby-lang.org/en/raa.html>))
484
-
485
- 表示用のテキストが無い場合には代わりにLabelに((<Inline>))を使えます。
486
- ((<((*Label*))>))
487
- ((<((*Label*))>))