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,466 +0,0 @@
1
- <?xml version="1.0" ?>
2
- <!DOCTYPE html
3
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
- <html xmlns="http://www.w3.org/1999/xhtml">
6
- <head>
7
- <title>doc/rd-draft.rd.ja</title>
8
- </head>
9
- <body>
10
- <h1><a name="label-0" id="label-0">RD working draft 日本語版</a></h1><!-- RDLabel: "RD working draft 日本語版" -->
11
- <p>英語版は<a href="http://www.ruby-lang.org/~rubikitch/RDP-en.cgi?cmd=view&amp;name=RD">ここ</a>にあります。</p>
12
- <h2><a name="label-1" id="label-1">RDとは何か</a></h2><!-- RDLabel: "RDとは何か" -->
13
- <p>RDとはRuby版のPODです。つまりRubyスクリプトファイルの中に埋め込む事を意図して
14
- 定義されたドキュメントフォーマットです。</p>
15
- <p>RDは主にplain textをさまざまなフォーマットに変換するplain2というプログラム
16
- の影響を受けています。そのため、RDはplain textに似ており、シンプルですっきり
17
- した文法なので読みやすく書きやすいでしょう。</p>
18
- <h2><a name="label-2" id="label-2">RubyインタプリタはRDをどのように扱うか</a></h2><!-- RDLabel: "RubyインタプリタはRDをどのように扱うか" -->
19
- <p>Rubyのインタプリタは単純に"<code>=begin</code>"で始まる行から"<code>=end</code>"で始まる
20
- 行までを無視します。ですから、スクリプトファイル中に埋め込む事ができるのは
21
- RDだけではありません。何でも<code>=begin</code>と<code>=end</code>の間に書く事ができるの
22
- です。RDは選択肢の一つにすぎませんが、Ruby標準のドキュメントフォーマットと
23
- されています。<a name="footmark-1" id="footmark-1" href="#foottext-1"><sup><small>*1</small></sup></a></p>
24
- <h2><a name="label-3" id="label-3">RDの基本的な概念と文法</a></h2><!-- RDLabel: "RDの基本的な概念と文法" -->
25
- <h3><a name="label-4" id="label-4">Element, Block, Inline</a></h3><!-- RDLabel: "Element, Block, Inline" -->
26
- <p>これからの説明では"Element"という用語<a name="footmark-2" id="footmark-2" href="#foottext-2"><sup><small>*2</small></sup></a>をテキストに文章構造を与えるための
27
- 構成要素という意味で用います。さらに、"<a href="#label-5">Block</a>"という用語を比較的
28
- 大きくグローバルな構造を表すElementに、"<a href="#label-35">Inline</a>"という用語を比較的小さ
29
- くローカルな、テキストに付加的な修飾を与えるElementに対して用います。</p>
30
- <p>段落や見出し、リストなどがBlockです。RDではBlockを表すのに
31
- インデントや特殊文字を用います。Blockを入れ子にすることで複雑な
32
- 構造も表現できます。そして、Blockの表現は自然とplain textに見え
33
- ます。詳しくは<a href="#label-5">Block</a>を見てください。</p>
34
- <p>強調やコードや参照などがInlineです。((? ... ?))のようなカッコと
35
- 特殊文字の組合せがInlineの表現に使われます。ほとんどのInlineが互いに
36
- 入れ子にできます。詳しくは<a href="#label-35">Inline</a>を見てください。</p>
37
- <h3><a name="label-5" id="label-5">Block</a></h3><!-- RDLabel: "Block" -->
38
- <h4><a name="label-6" id="label-6">基本文法</a></h4><!-- RDLabel: "基本文法" -->
39
- <p>Blockは行指向の文法にしたがいます。つまり、同じ行にある文字はすべて同じ
40
- Blockに属しています。インデントはBlockの入れ子レベルとタイプを表して
41
- います。行の先頭の文字はBlockのタイプに関係します。</p>
42
- <h5><a name="label-7" id="label-7">概念と用語</a></h5><!-- RDLabel: "概念と用語" -->
43
- <dl>
44
- <dt><a name="label-8" id="label-8">Baseline</a></dt><!-- RDLabel: "Baseline" -->
45
- <dd>
46
- Baselineはインデントの基準です。ある行のインデントととBaselineの相対的
47
- な深さはその行の属するBlockのタイプに影響します。
48
- </dd>
49
- <dt><a name="label-9" id="label-9">Head Char</a></dt><!-- RDLabel: "Head Char" -->
50
- <dd>
51
- Head Charは空白文字を除いた行の先頭の文字です。
52
- </dd>
53
- <dt><a name="label-10" id="label-10">STRINGLINE</a></dt><!-- RDLabel: "STRINGLINE" -->
54
- <dd>
55
- STRINGLINEは普通の文字で構成された行です。STRINGLINEは"<code>*</code>",
56
- "<code>(<var>num</var>)</code>", "<code>:</code>", "<code>=</code>", "<code>+</code>"といった文字を
57
- Head Charとしては含みません。しかし、インデントされた行なら"<code>=</code>"
58
- や"<code>+</code>"をHead Charとすることができます。
59
- </dd>
60
- <dt><a name="label-11" id="label-11">WHITELINE</a></dt><!-- RDLabel: "WHITELINE" -->
61
- <dd>
62
- WHITELINEは空白文字だけの行です。
63
- </dd>
64
- <dt><a name="label-12" id="label-12">Comment</a></dt><!-- RDLabel: "Comment" -->
65
- <dd>
66
- <code>/^#/</code>にマッチする行はコメントとみなされます。
67
- </dd>
68
- </dl>
69
- <h5><a name="label-13" id="label-13">Baselineの決定と影響</a></h5><!-- RDLabel: "Baselineの決定と影響" -->
70
- <p>トップレベルでは<a href="#label-8">Baseline</a>は行の左端です。リスト内ではBaselineはListItem
71
- の最初の<a href="#label-5">Block</a>によって決定します。例えば、</p>
72
- <pre>Example: "|" はBaselineを表しています。
73
- |この行はトップレベルのTextBlockの行だとします。
74
- |&lt;- したがって、Baselineは左端です。
75
- *|List内では (1)
76
- |&lt;- このようにBaselineは(1)の行で決定されます。
77
- * |同じListでもListItem毎にBaselineが決定されます。
78
- |&lt;- したがって、1番目のListItemとは違うここにBaselineがあります。</pre>
79
- <p>|この行はトップレベルのTextBlockの行だとします。
80
- |&lt;- したがって、Baselineは左端です。</p>
81
- <ul>
82
- <li>|List内では (1)
83
- |&lt;- このようにBaselineは(1)の行で決定されます。</li>
84
- <li>|同じListでもListItem毎にBaselineが決定されます。
85
- |&lt;- したがって、1番目のListItemとは違うここにBaselineがあります。</li>
86
- </ul>
87
- <p>Blockが別のBlockに入れ子になっている時には内部のBlockのBaselineは外側の
88
- BlockのBaselineよりも深くなります。</p>
89
- <p>Baselineとインデントの相対的な位置関係がBlockのタイプに影響します。
90
- Baselineと同じ深さにインデントされた<a href="#label-10">STRINGLINE</a>は<a href="#label-20">TextBlock</a>
91
- に属す行となります。一方Baselineより深くインデントされた<a href="#label-10">STRINGLINE</a>
92
- は<a href="#label-21">Verbatim</a>の行です。</p>
93
- <h4><a name="label-14" id="label-14">Blockのタイプ</a></h4><!-- RDLabel: "Blockのタイプ" -->
94
- <h5><a name="label-15" id="label-15">Headline</a></h5><!-- RDLabel: "Headline" -->
95
- <p>Headlineは"<code>=</code>"か"<code>+</code>"を<a href="#label-9">Head Char</a>とする行で構成されます。
96
- Headlineは1行以上にはなりません。Headlineはトップレベルだけに置く事が
97
- できます。</p>
98
- <pre>Example:
99
- |&lt;- トップレベルのBaseline
100
- = Headline 1.
101
- === Headline 1.1.1.
102
- + Headline 1.1.1.1.1.</pre>
103
- <h1><a name="label-16" id="label-16">Headline 1.</a></h1><!-- RDLabel: "Headline 1." -->
104
- <h3><a name="label-17" id="label-17">Headline 1.1.1.</a></h3><!-- RDLabel: "Headline 1.1.1." -->
105
- <h5><a name="label-18" id="label-18">Headline 1.1.1.1.1.</a></h5><!-- RDLabel: "Headline 1.1.1.1.1." -->
106
- <p>Headlineの先頭の特殊文字はHeadlineのレベルを表しています。次の図で
107
- 最初のマークは最も大きなレベルのもので、最後のマークがもっとも小さな
108
- レベルのものです。</p>
109
- <pre>Fig: Headline Marks
110
- =
111
- ==
112
- ===
113
- ====
114
- +
115
- ++</pre>
116
- <p>マークに続くテキストはHeadlineのタイトルです。これは同時に
117
- <a href="#label-46">Reference</a>のラベルとして使われます。</p>
118
- <p>Headlineのタイトルには<a href="#label-46">Reference</a>とFootnoteを除く<a href="#label-35">Inline</a>を使う事が
119
- できます。</p>
120
- <h5><a name="label-19" id="label-19">Include</a></h5><!-- RDLabel: "Include" -->
121
- <p>Includeは"<code>&lt;&lt;&lt;</code>"を<a href="#label-9">Head Char</a>とし、その後ろにインクルードする
122
- ファイルの名前が続く行からなります。RD形式のファイルと出力するフォーマッ
123
- トで書かれたファイルのどちらでもIncludeによってインクルードできます。</p>
124
- <p>RD形式のファイルをインクルードする時にはインクルードされるファイルの名
125
- 前は"foo.rd"の様に".rd"もしくは".rb"というサフィックスでなくてはなりま
126
- せん。そして、"<code>&lt;&lt;&lt;</code>"の後にはサフィックスを含めたファイルの完全な
127
- 名前を書きます。例えば、次の様にです。</p>
128
- <pre>&lt;&lt;&lt; foo.rd</pre>
129
- <p>出力するフォーマットのファイルをインクルードするには、インクルードされる
130
- ファイルはその出力フォーマットに固有のサフィックスを持たないといけません。
131
- 例えば、HTMLのファイルをインクルードするには".html"というサフィックスを、
132
- Texinfo形式のファイルをインクルードするには".texi"というサフィックスを
133
- つけます。そして、"<code>&lt;&lt;&lt;</code>"の後ろにはサフィックスを除いたファイルの
134
- 名前を書きます。例えば、</p>
135
- <pre>&lt;&lt;&lt; foo</pre>
136
- <p>と書くわけです。</p>
137
- <p>この場合、RDフォーマッタはHTMLを出力する時には"foo.html"をインクルード
138
- し、Texinfo形式で出力する時には"foo.texi"をインクルードします。出力フォー
139
- マットのIncludeを用いる時には複数の(しかもなるべく多くの)形式のインク
140
- ルードファイルを用意すべきです。</p>
141
- <h5><a name="label-20" id="label-20">TextBlock</a></h5><!-- RDLabel: "TextBlock" -->
142
- <p>TextBlockは複数の<a href="#label-10">STRINGLINE</a>から構成されます。それらの行は<a href="#label-8">Baseline</a>
143
- と同じインデントでないといけません。<a href="#label-8">Baseline</a>より深い<a href="#label-10">STRINGLINE</a>は
144
- <a href="#label-21">Verbatim</a>の行とみなされます。</p>
145
- <p>TextBlockは<a href="#label-35">Inline</a>を内部に含む事ができます。</p>
146
- <pre>Example:
147
- |
148
- これはTextBlockです。
149
- TextBlockの2行目の行です。
150
- この行はTextBlockでなくVerbatimです。
151
- * そしてこの行はListの行です。(正確にはListItemの中のTextBlockの行でも
152
- あるのですが)</pre>
153
- <p>この例は次のようにフォーマットされます。</p>
154
- <p>これはTextBlockです。
155
- TextBlockの2行目の行です。</p>
156
- <pre>この行はTextBlockでなくVerbatimです。</pre>
157
- <ul>
158
- <li>そしてこの行はListの行です。(正確にはListItemの中のTextBlockの行でも
159
- あるのですが)</li>
160
- </ul>
161
- <h5><a name="label-21" id="label-21">Verbatim</a></h5><!-- RDLabel: "Verbatim" -->
162
- <p>Rubyスクリプトを引用するのにVerbatimを用いる事ができます。Verbatimは
163
- <a href="#label-8">Baseline</a>より深いインデントを持つ<a href="#label-10">STRINGLINE</a>で構成されます。
164
- Verbatimは"<code>*</code>"や"<code>(1)</code>"や"<code>:</code>"といった特殊文字を<!-- Reference, RDLabel "Head
165
- Char" doesn't exist --><em class="label-not-found">Head
166
- Char</em><!-- Reference end -->として持つ行も含む事ができますが、それらは最初の行には置く事
167
- ができません。最初の行にあるときには<a href="#label-22">List</a>と見なされます。Verbatim
168
- は最初の行より浅いインデントの行も含みません。Verbatimは<a href="#label-11">WHITELINE</a>
169
- を含める事ができます。</p>
170
- <p><a href="#label-35">Inline</a>はVerbatim内では使えません。</p>
171
- <pre>Example:
172
- これはVerbatimです。
173
- 最初の行より深いインデントを持っても、同じVerbatimの行になります。
174
- * この行はListに見えますが、Verbatimです。
175
- しかしこの行は最初の行よりも浅くインデントされているので、別のVerbatim
176
- の行になります。</pre>
177
- <p>この例が次のようにフォーマットされます。</p>
178
- <pre>これはVerbatimです。
179
- 最初の行より深いインデントを持っても、同じVerbatimの行になります。
180
- * この行はListに見えますが、Verbatimです。</pre>
181
- <pre>しかしこの行は最初の行よりも浅くインデントされているので、別のVerbatim
182
- の行になります。</pre>
183
- <h5><a name="label-22" id="label-22">List</a></h5><!-- RDLabel: "List" -->
184
- <p>Listは特殊な<a href="#label-5">Block</a>です。Listは複数のListItemから構成され、ListItem
185
- は複数のBlockから構成されます。したがって、ListはBlockを内部に含む事が
186
- できます。含む事のできるBlockにはList自身も含みます。<a name="footmark-3" id="footmark-3" href="#foottext-3"><sup><small>*3</small></sup></a></p>
187
- <p>ListItemは<a href="#label-11">WHITELINE</a>を含む事ができますが、<a href="#label-20">TextBlock</a>は
188
- 持てません。そのため、WHITELINEを間にはさむ事によって複数のTextBlock
189
- をListItem内部に置く事ができます。</p>
190
- <p>Listには"<a href="#label-23">ItemList</a>"、"<a href="#label-24">EnumList</a>"、"<a href="#label-25">DescList</a>",
191
- "<a href="#label-28">MethodList</a>の4種類があります。</p>
192
- <h6><a name="label-23" id="label-23">ItemList</a></h6><!-- RDLabel: "ItemList" -->
193
- <p>ItemListは単純な番号付されないListです。ItemListItemは"<code>*</code>"という
194
- <a href="#label-9">Head Char</a>の行で始まります。ItemListItemの最初のBlockは必ず
195
- <a href="#label-20">TextBlock</a>になります。</p>
196
- <pre>Example:
197
- * 親Listの最初のItem
198
- * 子Listの最初のItem
199
- * 子Listの2番目のItem
200
- 親ListのItemに含まれるTextBlock</pre>
201
- <p>下のようにフォーマットされます。</p>
202
- <ul>
203
- <li><p>親Listの最初のItem</p>
204
- <ul>
205
- <li>子Listの最初のItem</li>
206
- <li>子Listの2番目のItem</li>
207
- </ul>
208
- <p>親ListのItemに含まれるTextBlock</p></li>
209
- </ul>
210
- <h6><a name="label-24" id="label-24">EnumList</a></h6><!-- RDLabel: "EnumList" -->
211
- <p>EnumListは番号付されたListです。EnumListItemは"<code><var>num</var></code>"(<var>num</var>
212
- は整数)という<a href="#label-9">Head Char</a>の行ではじまります。他の点ではEnumListは
213
- <a href="#label-23">ItemList</a>と同じです。</p>
214
- <pre>Example:
215
- (1) 親Listの最初のItem
216
- * 子ListとなるItemList
217
- (2) 親Listの2番目のItem
218
- (10) 番号は無視されます。</pre>
219
- <p>次のようにフォーマットされます。</p>
220
- <ol>
221
- <li>親Listの最初のItem
222
- <ul>
223
- <li>子ListとなるItemList</li>
224
- </ul></li>
225
- <li>親Listの2番目のItem</li>
226
- <li>番号は無視されます。</li>
227
- </ol>
228
- <h6><a name="label-25" id="label-25">DescList</a></h6><!-- RDLabel: "DescList" -->
229
- <p>DescListは用語説明のためのListです。DescListItemは2つの部分からなります。
230
- 1つはTermパートでもう1つはDescriptionパートです。Termパートは<a href="#label-46">Reference</a>
231
- のLabelとして使われます。</p>
232
- <p>Termパートは"<code>:</code>"という<a href="#label-9">Head Char</a>の行からなります。Termパートの
233
- 行はインデントできることを除くとTermパートは<a href="#label-15">Headline</a>と同様です。</p>
234
- <p>DescriptionパートはTermパートの次の行からはじまります。Descriptionパート
235
- の<a href="#label-8">Baseline</a>はTermパートの(<a href="#label-9">Head Char</a>を除いた)テキスト部分と
236
- 同じかより深くないといけません。例えば次の例は間違っています。</p>
237
- <pre>Example:
238
- : |Term
239
- |Description.</pre>
240
- <p>Descriptionぱーとは複数の<a href="#label-5">Block</a>を含む事ができます。<a href="#label-22">List</a>を
241
- 最初のBlockとすることもできます。Termパートは<a href="#label-35">Inline</a>を含む事が
242
- できますが、<a href="#label-46">Reference</a>とFootnoteは例外です。</p>
243
- <pre>Example:
244
- :Term
245
- Descriptionの最初の行
246
- 2番目の行
247
- :Term2
248
- * Listも含む事ができます
249
- * ...</pre>
250
- <p>次のようにフォーマットされます。</p>
251
- <dl>
252
- <dt><a name="label-26" id="label-26">Term</a></dt><!-- RDLabel: "Term" -->
253
- <dd>
254
- Descriptionの最初の行
255
- 2番目の行
256
- </dd>
257
- <dt><a name="label-27" id="label-27">Term2</a></dt><!-- RDLabel: "Term2" -->
258
- <dd>
259
- <ul>
260
- <li>Listも含む事ができます</li>
261
- <li>...</li>
262
- </ul>
263
- </dd>
264
- </dl>
265
- <h6><a name="label-28" id="label-28">MethodList</a></h6><!-- RDLabel: "MethodList" -->
266
- <p>MethodListはメソッドの説明のための特殊なタイプの<a href="#label-25">DescList</a>です。
267
- ほとんどの点でMethodListは<a href="#label-25">DescList</a>と同様ですが、Labelの規則
268
- は違っています。RDフォーマッタはMethodListのTermパートがなんらかの
269
- Rubyのあるクラスのメソッドや定数やCの関数プロトタイプといったような
270
- プログラムのコードであると知っています。そのため、MethodListは
271
- メソッドの引数のように見える部分を除いた上でLabelとなります。詳細は
272
- <a href="#label-44">LabelとReference</a>を見てください。</p>
273
- <p>MethodListItemは<a href="#label-25">DescList</a>と同様にTermパートとDescription
274
- パートを持ちます。Termパートは"<code>---</code>"という<a href="#label-9">Head Char</a>
275
- の行でなり、Descriptionパートは<a href="#label-20">TextBlock</a>や<a href="#label-21">Verbatim</a>
276
- 、<a href="#label-22">List</a>を含む事ができます。しかし、逆にMethodListを<a href="#label-22">List</a>
277
- の中に置くべきではありません。RDは将来的にはこれを禁止するかも
278
- しれません。</p>
279
- <pre>Example:
280
- --- Array#each {|i| ... } # =&gt; Labelは"Array#each"
281
- 各項目に対してブロックを評価する。
282
- --- Array#index(val) # =&gt; Labelは"Array#index"
283
- ((|val|))と同じ値である最初の項目を返す。同じ項目が無いときには
284
- (({nil}))を返す。</pre>
285
- <p>この例が次のようにフォーマットされます。</p>
286
- <dl>
287
- <dt><a name="label-29" id="label-29"><code>Array#each {|<var>i</var>| ... }</code></a></dt><!-- RDLabel: "Array#each" -->
288
- <dd>
289
- 各項目に対してブロックを評価する。</dd>
290
- <dt><a name="label-30" id="label-30"><code>Array#index(<var>val</var>)</code></a></dt><!-- RDLabel: "Array#index" -->
291
- <dd>
292
- <var>val</var>と同じ値である最初の項目を返す。同じ項目が無いときには
293
- <code>nil</code>を返す。</dd>
294
- </dl>
295
- <p>フォーマッタのいくつかはMethodListのTermパートに書かれているのはRuby
296
- のメソッドや定数などであると仮定しています。そういったフォーマッタでは
297
- MethodListのTermパートをインテリジェントに扱う事ができますが、そのため
298
- には特定の慣習にしたがってRDを書く必要があります。</p>
299
- <p>標準的なRubyクラスリファレンスのための慣習として次のようなものが提案さ
300
- れています。</p>
301
- <dl>
302
- <dt><a name="label-31" id="label-31">インスタンスメソッド</a></dt><!-- RDLabel: "インスタンスメソッド" -->
303
- <dd>
304
- <p>クラス<var>Class</var>のインスタンスメソッド<var>method</var></p>
305
- <pre>Class#method(its params ...) { parameter block }</pre>
306
- </dd>
307
- <dt><a name="label-32" id="label-32">クラスメソッド(クラスの特異メソッド)</a></dt><!-- RDLabel: "クラスメソッド(クラスの特異メソッド)" -->
308
- <dd>
309
- <p>クラス<var>Class</var>のクラスメソッド<var>method</var></p>
310
- <pre>Class.method(its params ...) { parameter block }</pre>
311
- </dd>
312
- <dt><a name="label-33" id="label-33">クラス定数</a></dt><!-- RDLabel: "クラス定数" -->
313
- <dd>
314
- <p>クラス<var>Class</var>の定数<var>Const</var></p>
315
- <pre>Class::Const</pre>
316
- </dd>
317
- <dt><a name="label-34" id="label-34">関数メソッド</a></dt><!-- RDLabel: "関数メソッド" -->
318
- <dd>
319
- <p>関数<var>func</var></p>
320
- <pre>function#func(its params ...) { parameter block }</pre>
321
- </dd>
322
- </dl>
323
- <p>Rubyはいくつかの特殊な文字(e.g. [], []=, +, -, &lt;&lt;, ...)はメソッドの名前
324
- (識別子)として使います。この時、Rubyインタプリタはこれらのメソッドの
325
- パースを普通のメソッドとは違ったやりかた(演算子メソッド)で行います。
326
- しかし、この慣習ではこれらの演算子メソッドも同じように書きます。</p>
327
- <pre>Example:
328
- --- Array#[](key)
329
- ((|key|))に対応する値を返す。
330
- --- Array#[]=(key, value)
331
- ((|key|))の場所に((|value|))を格納する。
332
- --- Array#+(other)
333
- 2つの(({Array}))を結合してそれを返します。</pre>
334
- <h3><a name="label-35" id="label-35">Inline</a></h3><!-- RDLabel: "Inline" -->
335
- <p>Inlineは<a href="#label-20">TextBlock</a>や<a href="#label-15">Headline</a>、<a href="#label-25">DescList</a>のTermパートの
336
- 中で使う事ができます。カッコを使ったマークアップがInlineに使われます。
337
- Inline同士は互いに入れ子にできます。</p>
338
- <p>次のInlineの一覧では左側に書式を、右側にフォーマット後の様子を表示
339
- しています。</p>
340
- <dl>
341
- <dt><a name="label-36" id="label-36">((*Em*)) =&gt; <em>Em</em></a></dt><!-- RDLabel: "((*Em*)) => Em" -->
342
- <dd>
343
- 強調
344
- </dd>
345
- <dt><a name="label-37" id="label-37">(({while gets...})) =&gt; <code>while gets...</code></a></dt><!-- RDLabel: "(({while gets...})) => while gets..." -->
346
- <dd>
347
- プログラムのコード
348
- </dd>
349
- <dt><a name="label-38" id="label-38">((|var|)) =&gt; <var>var</var></a></dt><!-- RDLabel: "((|var|)) => var" -->
350
- <dd>
351
- メタ変数<a name="footmark-4" id="footmark-4" href="#foottext-4"><sup><small>*4</small></sup></a>
352
- </dd>
353
- <dt><a name="label-39" id="label-39">((%ruby -v%)) =&gt; <kbd>ruby -v</kbd></a></dt><!-- RDLabel: "((%ruby -v%)) => ruby -v" -->
354
- <dd>
355
- キーボード
356
- </dd>
357
- <dt><a name="label-40" id="label-40">((:Term:))</a></dt><!-- RDLabel: "((:Term:))" -->
358
- <dd>
359
- <p>=&gt; <a name="index-0" id="index-0">Term</a></p>
360
- <p>インデクスやキーワードとなる用語の指定</p>
361
- </dd>
362
- <dt><a name="label-41" id="label-41">((&lt;Identity or URL&gt;))</a></dt><!-- RDLabel: "((<Identity or URL>))" -->
363
- <dd>
364
- <p>=&gt; <!-- Reference, RDLabel "Indentity or URL" doesn't exist --><em class="label-not-found">Indentity or URL</em><!-- Reference end --></p>
365
- <p>参照。詳しくは<a href="#label-44">LabelとReference</a>を見てください。</p>
366
- </dd>
367
- <dt><a name="label-42" id="label-42">((-Footnote-))</a></dt><!-- RDLabel: "((-Footnote-))" -->
368
- <dd>
369
- <p>=&gt; <a name="footmark-5" id="footmark-5" href="#foottext-5"><sup><small>*5</small></sup></a></p>
370
- <p>脚注</p>
371
- </dd>
372
- <dt><a name="label-43" id="label-43">(('verb')) =&gt; verb</a></dt><!-- RDLabel: "(('verb')) => verb" -->
373
- <dd>
374
- Inlineのvarbatim(フォーマット抑制)
375
- </dd>
376
- </dl>
377
- <h4><a name="label-44" id="label-44">LabelとReference</a></h4><!-- RDLabel: "LabelとReference" -->
378
- <p>ReferenceにはLabelが必要です。RDでは<a href="#label-15">Headline</a>のタイトルと<a href="#label-25">DescList</a>
379
- や<a href="#label-28">MethodList</a>のTermパートだけがLabelとなります。したがって、各々の
380
- <a href="#label-15">Headline</a>には違うタイトルをつけてあげなくてはなりません。この問題の
381
- きちんとした解決策はまだ見付かっていません。</p>
382
- <h5><a name="label-45" id="label-45">どのようにLabelがつけられるか</a></h5><!-- RDLabel: "どのようにLabelがつけられるか" -->
383
- <p><a href="#label-15">Headline</a>のタイトルと<a href="#label-25">DescList</a>や<a href="#label-28">MethodList</a>のTermパートが
384
- Labelとして使われます。しかし、<a href="#label-35">Inline</a>が含まれるために、それらが
385
- そのままLabelとして使われる、というほど単純ではありません。</p>
386
- <p>第一に、<a href="#label-28">MethodList</a>はLabel付けにおいてはやや特殊です。<a href="#label-28">MethodList</a>
387
- のTermパートは<a href="#label-35">Inline</a>を含みませんが、その代わりRDでは<a href="#label-28">MethodList</a>
388
- のTermパートはメソッドリファレンスやそれに類似の物とみなされますので、次の
389
- ようなルールでラベルが付けられます。</p>
390
- <ol>
391
- <li>"<code>(</code>"や"<code>{</code>"の前にあるテキストだけがラベルと見なされる。<a name="footmark-6" id="footmark-6" href="#foottext-6"><sup><small>*6</small></sup></a></li>
392
- </ol>
393
- <p>次の例を見れば、どのようにルールが適用されているかわかるでしょう。
394
- "<code># =&gt;</code>"より右にあるのが<a href="#label-28">MethodList</a>のTermパートから抽出された
395
- Labelです。</p>
396
- <pre>Example:
397
- --- Array.new([size[, val]]) # =&gt; Array.new
398
- --- Array#[]=(key, val) # =&gt; Array#[]=
399
- --- Array#each { ... } # =&gt; Array#each
400
- --- void rb_define_method(VALUE class, ...) # =&gt; void rb_define_method</pre>
401
- <p>次に、<a href="#label-15">Headline</a>のタイトルや<a href="#label-25">DescList</a>のTermパートの場合には、この
402
- ような特別なルールはありませんが、<a href="#label-35">Inline</a>を含む事があるので、<a href="#label-35">Inline</a>
403
- に用いるカッコを取り除くためのルールがあります。</p>
404
- <ol>
405
- <li><p>どんな<a href="#label-35">Inline</a>修飾もLabelには影響しません。したがって、</p>
406
- <pre>= ((*Headline*))</pre>
407
- <pre>と
408
- = Headline
409
- は共に"Headline"とLabelが決まります。</pre></li>
410
- <li><p>しかし、Labelを抽出する際には<a href="#label-35">Inline</a>の開始カッコの後ろと終端カッコ
411
- の前にある空白文字は取り除かれます。したがって、</p>
412
- <pre>= ((* Headline *))</pre>
413
- <p>も</p>
414
- <pre>= ((*Headline*))</pre>
415
- <p>も"Headline"とLabelがつけられます。</p></li>
416
- </ol>
417
- <h5><a name="label-46" id="label-46">Reference</a></h5><!-- RDLabel: "Reference" -->
418
- <p>LabelのつけられたElementはReferenceによって参照できます。Referenceは
419
- ((&lt;...&gt;))というカッコで修飾される<a href="#label-35">Inline</a>です。</p>
420
- <p>最も簡単なReferenceの使用法は、単にLabelをそのカッコの中に書けばよいのです。</p>
421
- <pre>((&lt;Label&gt;))</pre>
422
- <p>これは"Label"というLabelに対する参照となります。また、フォーマッタによる
423
- 出力では"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>
424
- <p>URLによって示されたリソースを参照するには次のように書きます。</p>
425
- <pre>((&lt;URL:http://www.ruby-lang.org/en/raa.html&gt;))</pre>
426
- <p>可能ならRDフォーマッタはURLを次のようにハイパーリンクします。例:
427
- <a href="http://www.ruby-lang.org/en/raa.html">&lt;URL:http://www.ruby-lang.org/en/raa.html&gt;</a>.</p>
428
- <p>Labelとは違うテキストを表示に使いたい時には次のように書きます。</p>
429
- <pre>((&lt;Text for display|Label&gt;))</pre>
430
- <p>"Text for display"が表示用のテキストとして使われ、"Label"がLabelとして
431
- 使われます。例: <!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found">Text for display</em><!-- Reference end --></p>
432
- <p>表示用のテキストは<a href="#label-35">Inline</a>を含む事ができます。しかし、Footnoteと
433
- Reference自身を含む事はできません。</p>
434
- <p>Reference内では"|"や"/"は特殊文字なのでこれらを使いたい時には、それを含む
435
- 部分ごとダブルクオートで囲ってやらないといけません。これはReference内のどの
436
- 部分でも同じです。</p>
437
- <pre>((&lt;"Bar | inside display text"|Label&gt;))</pre>
438
- <p><!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found">Bar | inside display text</em><!-- Reference end --></p>
439
- <p>表示用のテキストはURLへのReferenceにも使う事ができます。</p>
440
- <pre>((&lt;Ruby Application Archive|URL:http://www.ruby-lang.org/en/raa.html&gt;))</pre>
441
- <p><a href="http://www.ruby-lang.org/en/raa.html">Ruby Application Archive</a></p>
442
- <p>表示用のテキストが無い場合には代わりにLabelに<a href="#label-35">Inline</a>を使えます。</p>
443
- <pre>((&lt;((*Label*))&gt;))</pre>
444
- <p><!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found"><em>Label</em></em><!-- Reference end --></p>
445
- <hr />
446
- <p class="foottext">
447
- <a name="foottext-1" id="foottext-1" href="#footmark-1"><sup><small>*1</small></sup></a><small>もし他のドキュメントフォーマットに興味があるなら、例えば
448
- rubyapi2
449
- <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>
450
- などを見るといいでしょう。これはRuby/Gtkのような大規模ライブラリのドキュメン
451
- ト向けに作られています。</small><br />
452
- <a name="foottext-2" id="foottext-2" href="#footmark-2"><sup><small>*2</small></sup></a><small>訳注: RDの文法用語についてはあ
453
- えて日本語訳をあてませんでした。</small><br />
454
- <a name="foottext-3" id="foottext-3" href="#footmark-3"><sup><small>*3</small></sup></a><small><a href="#label-15">Headline</a>
455
- や<a href="#label-19">Include</a>はList内部に持てません。</small><br />
456
- <a name="foottext-4" id="foottext-4" href="#footmark-4"><sup><small>*4</small></sup></a><small> Varについての詳しい説明はtexinfo.texiの該当部分にあります。</small><br />
457
- <a name="foottext-5" id="foottext-5" href="#footmark-5"><sup><small>*5</small></sup></a><small>Footnote</small><br />
458
- <a name="foottext-6" id="foottext-6" href="#footmark-6"><sup><small>*6</small></sup></a><small>
459
- "<code>(...)</code>"の内部のテキストはメソッドの引数だと見なされ、
460
- "<code>{...}</code>"の内部のテキストはメソッドのブロックと見なされるのです。</small><br />
461
- <a name="foottext-7" id="foottext-7" href="#footmark-7"><sup><small>*7</small></sup></a><small>
462
- "Label"というLabelのついたElementが無いのでおそらくReferenceの様には
463
- 見えないでしょう。</small><br />
464
- </p>
465
- </body>
466
- </html>