rabbit 0.9.2 → 0.9.3

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 (345) hide show
  1. data/Gemfile +16 -0
  2. data/README +1 -0
  3. data/Rakefile +161 -53
  4. data/TODO +2 -0
  5. data/bin/rabbit +78 -34
  6. data/bin/rabbit-command +16 -3
  7. data/bin/rabbiter +74 -73
  8. data/bin/rabrick +17 -4
  9. data/bin/rabwii +77 -0
  10. data/data/rabbit/image/dark-gradation-images/background-gradation.png +0 -0
  11. data/data/rabbit/image/dark-gradation-images/dark-gradation-images.rb +2 -0
  12. data/data/rabbit/image/dark-gradation-images/property.rb +4 -0
  13. data/doc/_config.yml +2 -0
  14. data/doc/_layouts/en.html +37 -0
  15. data/doc/_layouts/ja.html +37 -0
  16. data/doc/_layouts/skeleton.html +91 -0
  17. data/doc/_plugins/converters/hiki.rb +27 -0
  18. data/doc/_plugins/converters/rd.rb +73 -0
  19. data/doc/_site/css/jquery-ui/themes/ui-lightness.css +573 -0
  20. data/doc/_site/css/rabbit.css +247 -0
  21. data/doc/_site/en/development.html +140 -0
  22. data/doc/_site/en/faq.html +117 -0
  23. data/doc/_site/en/hiki.html +420 -0
  24. data/doc/_site/en/how-to-make/hiki.html +113 -0
  25. data/doc/_site/en/how-to-make/index.html +135 -0
  26. data/doc/_site/en/how-to-make/pdf.html +111 -0
  27. data/doc/_site/en/how-to-make/rd.html +151 -0
  28. data/doc/_site/en/how-to-make/theme.html +249 -0
  29. data/doc/_site/en/index.html +343 -0
  30. data/doc/_site/en/install/homebrew.html +279 -0
  31. data/doc/_site/en/install/index.html +144 -0
  32. data/doc/_site/en/install/macports.html +158 -0
  33. data/doc/_site/en/install/windows.html +200 -0
  34. data/doc/_site/en/news.html +928 -0
  35. data/doc/_site/en/rd.html +555 -0
  36. data/doc/_site/en/sample/hiki/rabbit.html +380 -0
  37. data/doc/_site/en/sample/index.html +117 -0
  38. data/doc/_site/en/sample/rd/rabbit.html +572 -0
  39. data/doc/_site/en/slides.html +113 -0
  40. data/doc/_site/en/usage.html +445 -0
  41. data/doc/_site/en/users.html +127 -0
  42. data/doc/_site/favicon.ico +0 -0
  43. data/doc/_site/favicon.png +0 -0
  44. data/doc/_site/images/background-sample.svg +290 -0
  45. data/doc/_site/images/background.png +0 -0
  46. data/doc/_site/images/background.svg +131 -0
  47. data/doc/_site/images/hare-and-tortoise.png +0 -0
  48. data/doc/_site/images/hare-and-tortoise.svg +541 -0
  49. data/doc/_site/images/jp.png +0 -0
  50. data/{sample/momo/usako/usako_psd_100.png → doc/_site/images/lavie-icon.png} +0 -0
  51. data/doc/_site/images/lavie.png +0 -0
  52. data/doc/_site/images/screenshots/en/blue-circle-raw.png +0 -0
  53. data/doc/_site/images/screenshots/en/blue-circle.png +0 -0
  54. data/doc/_site/images/screenshots/en/clear-blue-raw.png +0 -0
  55. data/doc/_site/images/screenshots/en/clear-blue.png +0 -0
  56. data/doc/_site/images/screenshots/en/cozmixng-raw.png +0 -0
  57. data/doc/_site/images/screenshots/en/cozmixng.png +0 -0
  58. data/doc/_site/images/screenshots/en/dark-gradation-raw.png +0 -0
  59. data/doc/_site/images/screenshots/en/dark-gradation.png +0 -0
  60. data/doc/_site/images/screenshots/en/day-white-raw.png +0 -0
  61. data/doc/_site/images/screenshots/en/day-white.png +0 -0
  62. data/doc/_site/images/screenshots/en/debian-raw.png +0 -0
  63. data/doc/_site/images/screenshots/en/debian.png +0 -0
  64. data/doc/_site/images/screenshots/en/green-circle-raw.png +0 -0
  65. data/doc/_site/images/screenshots/en/green-circle.png +0 -0
  66. data/doc/_site/images/screenshots/en/night-black-raw.png +0 -0
  67. data/doc/_site/images/screenshots/en/night-black.png +0 -0
  68. data/doc/_site/images/screenshots/en/rabbit-raw.png +0 -0
  69. data/doc/_site/images/screenshots/en/rabbit.png +0 -0
  70. data/doc/_site/images/screenshots/en/ranguba-raw.png +0 -0
  71. data/doc/_site/images/screenshots/en/ranguba.png +0 -0
  72. data/doc/_site/images/screenshots/en/red-frame-raw.png +0 -0
  73. data/doc/_site/images/screenshots/en/red-frame.png +0 -0
  74. data/doc/_site/images/screenshots/en/ruby-gnome2-raw.png +0 -0
  75. data/doc/_site/images/screenshots/en/ruby-gnome2.png +0 -0
  76. data/doc/_site/images/screenshots/ja/blue-circle-raw.png +0 -0
  77. data/doc/_site/images/screenshots/ja/blue-circle.png +0 -0
  78. data/doc/_site/images/screenshots/ja/clear-blue-raw.png +0 -0
  79. data/doc/_site/images/screenshots/ja/clear-blue.png +0 -0
  80. data/doc/_site/images/screenshots/ja/cozmixng-raw.png +0 -0
  81. data/doc/_site/images/screenshots/ja/cozmixng.png +0 -0
  82. data/doc/_site/images/screenshots/ja/dark-gradation-raw.png +0 -0
  83. data/doc/_site/images/screenshots/ja/dark-gradation.png +0 -0
  84. data/doc/_site/images/screenshots/ja/day-white-raw.png +0 -0
  85. data/doc/_site/images/screenshots/ja/day-white.png +0 -0
  86. data/doc/_site/images/screenshots/ja/debian-raw.png +0 -0
  87. data/doc/_site/images/screenshots/ja/debian.png +0 -0
  88. data/doc/_site/images/screenshots/ja/green-circle-raw.png +0 -0
  89. data/doc/_site/images/screenshots/ja/green-circle.png +0 -0
  90. data/doc/_site/images/screenshots/ja/night-black-raw.png +0 -0
  91. data/doc/_site/images/screenshots/ja/night-black.png +0 -0
  92. data/doc/_site/images/screenshots/ja/rabbit-raw.png +0 -0
  93. data/doc/_site/images/screenshots/ja/rabbit.png +0 -0
  94. data/doc/_site/images/screenshots/ja/ranguba-raw.png +0 -0
  95. data/doc/_site/images/screenshots/ja/ranguba.png +0 -0
  96. data/doc/_site/images/screenshots/ja/red-frame-raw.png +0 -0
  97. data/doc/_site/images/screenshots/ja/red-frame.png +0 -0
  98. data/doc/_site/images/screenshots/ja/ruby-gnome2-raw.png +0 -0
  99. data/doc/_site/images/screenshots/ja/ruby-gnome2.png +0 -0
  100. data/doc/_site/images/us.png +0 -0
  101. data/doc/_site/index.html.en +122 -0
  102. data/doc/_site/index.html.ja +122 -0
  103. data/doc/_site/ja/about.html +120 -0
  104. data/doc/_site/ja/development.html +141 -0
  105. data/doc/_site/ja/faq.html +232 -0
  106. data/doc/_site/ja/hiki.html +416 -0
  107. data/doc/_site/ja/how-to-make/hiki.html +113 -0
  108. data/doc/_site/ja/how-to-make/index.html +135 -0
  109. data/doc/_site/ja/how-to-make/pdf.html +112 -0
  110. data/doc/_site/ja/how-to-make/rd.html +161 -0
  111. data/doc/_site/ja/how-to-make/theme.html +254 -0
  112. data/doc/_site/ja/index.html +351 -0
  113. data/doc/_site/ja/install/homebrew.html +279 -0
  114. data/doc/_site/ja/install/index.html +146 -0
  115. data/doc/_site/ja/install/macports.html +177 -0
  116. data/doc/_site/ja/install/windows.html +200 -0
  117. data/doc/_site/ja/news.html +926 -0
  118. data/doc/_site/ja/rd.html +565 -0
  119. data/doc/_site/ja/sample/hiki/rabbit.html +390 -0
  120. data/doc/_site/ja/sample/index.html +117 -0
  121. data/doc/_site/ja/sample/rd/rabbit.html +580 -0
  122. data/doc/_site/ja/slides.html +142 -0
  123. data/doc/_site/ja/usage.html +458 -0
  124. data/doc/_site/ja/users.html +331 -0
  125. data/doc/_site/javascripts/jquery-ui.js +11544 -0
  126. data/doc/_site/javascripts/jquery.js +7179 -0
  127. data/doc/_site/screenshot.en.rab +10 -0
  128. data/doc/_site/screenshot.ja.rab +10 -0
  129. data/doc/css/jquery-ui/themes/ui-lightness.css +573 -0
  130. data/doc/css/rabbit.css +247 -0
  131. data/doc/en/development.rd +50 -0
  132. data/doc/en/faq.rd +18 -0
  133. data/doc/en/hiki.hiki +325 -0
  134. data/doc/en/how-to-make/hiki.hiki +9 -0
  135. data/doc/en/how-to-make/index.rd +25 -0
  136. data/doc/en/how-to-make/pdf.rd +7 -0
  137. data/doc/en/how-to-make/rd.rd +66 -0
  138. data/doc/en/how-to-make/theme.rd +135 -0
  139. data/doc/en/index.rd +276 -0
  140. data/doc/en/install/homebrew.rd +196 -0
  141. data/doc/en/install/index.rd +63 -0
  142. data/doc/en/install/macports.rd +77 -0
  143. data/doc/en/install/windows.rd +103 -0
  144. data/{NEWS.en → doc/en/news.rd} +78 -3
  145. data/doc/en/rd.rd +481 -0
  146. data/doc/en/sample/hiki/rabbit.hiki +389 -0
  147. data/doc/en/sample/index.rd +11 -0
  148. data/doc/en/sample/rd/rabbit.rd +467 -0
  149. data/doc/en/slides.rd +7 -0
  150. data/doc/en/usage.rd +365 -0
  151. data/doc/en/users.rd +29 -0
  152. data/doc/favicon.ico +0 -0
  153. data/doc/favicon.png +0 -0
  154. data/doc/images/background-sample.svg +290 -0
  155. data/doc/images/background.png +0 -0
  156. data/doc/images/background.svg +131 -0
  157. data/doc/images/hare-and-tortoise.png +0 -0
  158. data/doc/images/hare-and-tortoise.svg +541 -0
  159. data/doc/images/jp.png +0 -0
  160. data/doc/images/lavie-icon.png +0 -0
  161. data/doc/images/lavie.png +0 -0
  162. data/doc/images/screenshots/en/blue-circle-raw.png +0 -0
  163. data/doc/images/screenshots/en/blue-circle.png +0 -0
  164. data/doc/images/screenshots/en/clear-blue-raw.png +0 -0
  165. data/doc/images/screenshots/en/clear-blue.png +0 -0
  166. data/doc/images/screenshots/en/cozmixng-raw.png +0 -0
  167. data/doc/images/screenshots/en/cozmixng.png +0 -0
  168. data/doc/images/screenshots/en/dark-gradation-raw.png +0 -0
  169. data/doc/images/screenshots/en/dark-gradation.png +0 -0
  170. data/doc/images/screenshots/en/day-white-raw.png +0 -0
  171. data/doc/images/screenshots/en/day-white.png +0 -0
  172. data/doc/images/screenshots/en/debian-raw.png +0 -0
  173. data/doc/images/screenshots/en/debian.png +0 -0
  174. data/doc/images/screenshots/en/green-circle-raw.png +0 -0
  175. data/doc/images/screenshots/en/green-circle.png +0 -0
  176. data/doc/images/screenshots/en/night-black-raw.png +0 -0
  177. data/doc/images/screenshots/en/night-black.png +0 -0
  178. data/doc/images/screenshots/en/rabbit-raw.png +0 -0
  179. data/doc/images/screenshots/en/rabbit.png +0 -0
  180. data/doc/images/screenshots/en/ranguba-raw.png +0 -0
  181. data/doc/images/screenshots/en/ranguba.png +0 -0
  182. data/doc/images/screenshots/en/red-frame-raw.png +0 -0
  183. data/doc/images/screenshots/en/red-frame.png +0 -0
  184. data/doc/images/screenshots/en/ruby-gnome2-raw.png +0 -0
  185. data/doc/images/screenshots/en/ruby-gnome2.png +0 -0
  186. data/doc/images/screenshots/ja/blue-circle-raw.png +0 -0
  187. data/doc/images/screenshots/ja/blue-circle.png +0 -0
  188. data/doc/images/screenshots/ja/clear-blue-raw.png +0 -0
  189. data/doc/images/screenshots/ja/clear-blue.png +0 -0
  190. data/doc/images/screenshots/ja/cozmixng-raw.png +0 -0
  191. data/doc/images/screenshots/ja/cozmixng.png +0 -0
  192. data/doc/images/screenshots/ja/dark-gradation-raw.png +0 -0
  193. data/doc/images/screenshots/ja/dark-gradation.png +0 -0
  194. data/doc/images/screenshots/ja/day-white-raw.png +0 -0
  195. data/doc/images/screenshots/ja/day-white.png +0 -0
  196. data/doc/images/screenshots/ja/debian-raw.png +0 -0
  197. data/doc/images/screenshots/ja/debian.png +0 -0
  198. data/doc/images/screenshots/ja/green-circle-raw.png +0 -0
  199. data/doc/images/screenshots/ja/green-circle.png +0 -0
  200. data/doc/images/screenshots/ja/night-black-raw.png +0 -0
  201. data/doc/images/screenshots/ja/night-black.png +0 -0
  202. data/doc/images/screenshots/ja/rabbit-raw.png +0 -0
  203. data/doc/images/screenshots/ja/rabbit.png +0 -0
  204. data/doc/images/screenshots/ja/ranguba-raw.png +0 -0
  205. data/doc/images/screenshots/ja/ranguba.png +0 -0
  206. data/doc/images/screenshots/ja/red-frame-raw.png +0 -0
  207. data/doc/images/screenshots/ja/red-frame.png +0 -0
  208. data/doc/images/screenshots/ja/ruby-gnome2-raw.png +0 -0
  209. data/doc/images/screenshots/ja/ruby-gnome2.png +0 -0
  210. data/doc/images/us.png +0 -0
  211. data/doc/index.html.en +48 -0
  212. data/doc/index.html.ja +48 -0
  213. data/doc/ja/about.rd +21 -0
  214. data/doc/ja/development.rd +49 -0
  215. data/doc/ja/faq.rd +177 -0
  216. data/doc/ja/hiki.hiki +319 -0
  217. data/doc/ja/how-to-make/hiki.hiki +9 -0
  218. data/doc/ja/how-to-make/index.rd +25 -0
  219. data/doc/ja/how-to-make/pdf.rd +8 -0
  220. data/doc/ja/how-to-make/rd.rd +83 -0
  221. data/doc/ja/how-to-make/theme.rd +142 -0
  222. data/doc/ja/index.rd +283 -0
  223. data/doc/ja/install/homebrew.rd +196 -0
  224. data/doc/ja/install/index.rd +65 -0
  225. data/doc/ja/install/macports.rd +105 -0
  226. data/doc/ja/install/windows.rd +100 -0
  227. data/{NEWS.ja → doc/ja/news.rd} +84 -3
  228. data/doc/ja/rd.rd +489 -0
  229. data/doc/ja/sample/hiki/rabbit.hiki +405 -0
  230. data/doc/ja/sample/index.rd +11 -0
  231. data/doc/ja/sample/rd/rabbit.rd +475 -0
  232. data/doc/ja/slides.rd +29 -0
  233. data/doc/ja/usage.rd +380 -0
  234. data/doc/ja/users.rd +173 -0
  235. data/doc/javascripts/jquery-ui.js +11544 -0
  236. data/doc/javascripts/jquery.js +7179 -0
  237. data/doc/screenshot.en.rab +10 -0
  238. data/doc/screenshot.ja.rab +10 -0
  239. data/lib/rabbit/action/toggle.rb +0 -14
  240. data/lib/rabbit/canvas.rb +42 -46
  241. data/lib/rabbit/console.rb +9 -1
  242. data/lib/rabbit/front.rb +1 -1
  243. data/lib/rabbit/keys.rb +0 -8
  244. data/lib/rabbit/logger/gui.rb +3 -5
  245. data/lib/rabbit/parser/pdf.rb +1 -1
  246. data/lib/rabbit/parser/wiki/output.rb +17 -1
  247. data/lib/rabbit/rabbit.rb +12 -1
  248. data/lib/rabbit/renderer/base.rb +0 -25
  249. data/lib/rabbit/renderer/display/clutter-embed.rb +5 -69
  250. data/lib/rabbit/renderer/display/drawing-area.rb +0 -2
  251. data/lib/rabbit/renderer/display/key-handler.rb +0 -8
  252. data/lib/rabbit/source/base.rb +4 -0
  253. data/lib/rabbit/theme/background-image-toolkit/background-image-toolkit.rb +4 -8
  254. data/lib/rabbit/theme/clutter-comment/clutter-comment.rb +76 -0
  255. data/lib/rabbit/theme/clutter-comment/property.rb +3 -0
  256. data/lib/rabbit/theme/color-circle/color-circle.rb +3 -0
  257. data/lib/rabbit/theme/dark-gradation/dark-gradation.rb +187 -0
  258. data/lib/rabbit/theme/dark-gradation/property.rb +3 -0
  259. data/lib/rabbit/theme/debian/debian.rb +125 -145
  260. data/lib/rabbit/theme/default/default.rb +6 -0
  261. data/lib/rabbit/theme/footer-comment/footer-comment.rb +46 -0
  262. data/lib/rabbit/theme/footer-comment/property.rb +3 -0
  263. data/lib/rabbit/theme/image/image.rb +3 -2
  264. data/lib/rabbit/theme/per-slide-background-color/property.rb +1 -1
  265. data/lib/rabbit/theme/slide-number/slide-number.rb +9 -3
  266. data/lib/rabbit/theme/stream-comment/property.rb +3 -0
  267. data/lib/rabbit/theme/stream-comment/stream-comment.rb +66 -0
  268. data/lib/rabbit/theme/tag/property.rb +1 -1
  269. data/lib/rabbit/theme/title-background-image/title-background-image.rb +6 -5
  270. data/lib/rabbit/theme/twitter-comment/property.rb +4 -0
  271. data/lib/rabbit/theme/twitter-comment/twitter-comment.rb +15 -0
  272. data/lib/rabbit/twitter.rb +216 -0
  273. data/lib/rabbit/utils.rb +26 -0
  274. data/misc/emacs/README.ja +1 -1
  275. data/misc/emacs/rabbit-mode.el +1 -1
  276. data/po/en/rabbit.po +429 -267
  277. data/po/fr/rabbit.po +440 -268
  278. data/po/ja/rabbit.po +455 -270
  279. data/po/rabbit.pot +2567 -0
  280. data/sample/rabbit-en.hiki +384 -0
  281. data/sample/rabbit-en.rd +1 -1
  282. data/sample/rabbit-implementation.rd +1 -1
  283. data/sample/rabbit.hiki +85 -13
  284. data/sample/rabbit.rd +1 -1
  285. data/sample/theme-bench-en.hiki +100 -0
  286. data/sample/theme-bench.hiki +101 -0
  287. metadata +413 -118
  288. data/README.en +0 -850
  289. data/README.ja +0 -885
  290. data/bin/rabbit.bat +0 -8
  291. data/data/locale/en/LC_MESSAGES/rabbit.mo +0 -0
  292. data/data/locale/fr/LC_MESSAGES/rabbit.mo +0 -0
  293. data/data/locale/ja/LC_MESSAGES/rabbit.mo +0 -0
  294. data/lib/rabbit/comment-canvas.rb +0 -21
  295. data/lib/rabbit/comment/log.rb +0 -74
  296. data/lib/rabbit/renderer/display/comment-drawing-area.rb +0 -175
  297. data/lib/rabbit/renderer/display/comment.rb +0 -194
  298. data/lib/rabbit/theme/comment/comment.rb +0 -5
  299. data/lib/rabbit/theme/comment/property.rb +0 -3
  300. data/lib/rt/rt2html-lib.rb +0 -157
  301. data/lib/rt/rtparser.rb +0 -226
  302. data/lib/rt/rtvisitor.rb +0 -68
  303. data/lib/rwiki/soap/common.rb +0 -5
  304. data/lib/rwiki/soap/driver.rb +0 -43
  305. data/lib/rwiki/soap/servant.rb +0 -78
  306. data/sample/asahina/alice.png +0 -0
  307. data/sample/asahina/yukiusa.png +0 -0
  308. data/sample/momo/banner/bn1.png +0 -0
  309. data/sample/momo/banner/bn2.png +0 -0
  310. data/sample/momo/banner/bn_psd.psd +0 -0
  311. data/sample/momo/banner/bn_psd2.psd +0 -0
  312. data/sample/momo/tailavi/tailavi-ruby.png +0 -0
  313. data/sample/momo/tailavi/tailavi-ruby.psd +0 -0
  314. data/sample/momo/tailavi/tailavi-taiyaki.png +0 -0
  315. data/sample/momo/tailavi/tailavi-taiyaki.psd +0 -0
  316. data/sample/momo/tailavi/tailavi-yokubari.png +0 -0
  317. data/sample/momo/tailavi/tailavi-yokubari.psd +0 -0
  318. data/sample/momo/tailavi/taiyaki.png +0 -0
  319. data/sample/momo/tailavi/taiyaki.psd +0 -0
  320. data/sample/momo/usako/blue_dot.png +0 -0
  321. data/sample/momo/usako/green_dot.png +0 -0
  322. data/sample/momo/usako/rabbit.png +0 -0
  323. data/sample/momo/usako/rabbit_mimi.png +0 -0
  324. data/sample/momo/usako/rabbit_mimi2.png +0 -0
  325. data/sample/momo/usako/red_dot.png +0 -0
  326. data/sample/momo/usako/ruby.png +0 -0
  327. data/sample/momo/usako/ruby_new.png +0 -0
  328. data/sample/momo/usako/usa1.png +0 -0
  329. data/sample/momo/usako/usa2.png +0 -0
  330. data/sample/momo/usako/usa3.png +0 -0
  331. data/sample/momo/usako/usako_psd.psd +0 -0
  332. data/sample/momo/usako/usako_psd_200.png +0 -0
  333. data/sample/rabbit-balloon.eps +0 -233
  334. data/sample/sode/kame-color.riff +0 -0
  335. data/sample/sode/kame.riff +0 -0
  336. data/sample/usatti/kame-taro.png +0 -0
  337. data/sample/usatti/rabbit-pink-logo.png +0 -0
  338. data/sample/usatti/rabbit-pink-logo2.png +0 -0
  339. data/sample/usatti/ruby-pink-circle-logo.png +0 -0
  340. data/sample/usatti/ruby-pink-circle.png +0 -0
  341. data/sample/usatti/ruby-pink-polygon-logo.png +0 -0
  342. data/sample/usatti/ruby-pink-polygon.png +0 -0
  343. data/sample/usatti/tanu-kitaro.png +0 -0
  344. data/sample/usatti/usa-taro.png +0 -0
  345. data/sample/usatti/yukidaru-taro.png +0 -0
@@ -0,0 +1,65 @@
1
+ ---
2
+ layout: ja
3
+ title: インストール
4
+ ---
5
+ == インストール方法について
6
+
7
+ Rabbitはgemまたはそれぞれのプラットフォームにあるパッケージ管
8
+ 理システムを使ってインストールすることができるため、導入が非
9
+ 常に簡単です。
10
+
11
+ == gemを使う方法
12
+
13
+ % gem install rabbit
14
+
15
+ == Debian GNU/Linuxでのインストール方法
16
+
17
+ % sudo aptitude install -y rabbit
18
+
19
+ == Ubuntuでのインストール方法
20
+
21
+ % sudo aptitude install -y rabbit
22
+
23
+ == Gentoo Linuxでのインストール方法
24
+
25
+ % sudo env ACCEPT_KEYWORDS=~x86 FEATURES="digest" emerge rabbit
26
+
27
+ == NetBSD(またはpkgsrcが使えるプラットフォーム)でのインストール方法
28
+
29
+ % sudo pkg_add ruby18-rabbit
30
+
31
+ または
32
+
33
+ % sudo pkg_add ruby19-rabbit
34
+
35
+ == FreeBSDでのインストール方法
36
+
37
+ % sudo portupgrade -NRr rabbit
38
+
39
+ == Mac OS XでMacPortsを使ったインストール方法
40
+
41
+ ((<macports.rd/MacPortsを使ったインストール方法>))を参照してく
42
+ ださい。
43
+
44
+ == Mac OS XでHomebrewを使ったインストール方法
45
+
46
+ ((<homebrew.rd/Homebrewを使ったインストール方法>))を参照してく
47
+ ださい。
48
+
49
+ == Windowsでのインストール方法
50
+
51
+ ((<windows.rd/Windowsでのインストール方法>))を参照してくださ
52
+ い。
53
+
54
+ == tar.gzからインストール
55
+
56
+ ((<URL:http://rabbit-shockers.org/download/rabbit.tar.gz>))
57
+ から最新のRabbitをダウンロードし、setup.rbを実行します。この
58
+ URLは常に最新のRabbitのアーカイブになります。
59
+
60
+ % mkdir tmp
61
+ % cd tmp
62
+ % wget http://rabbit-shockers.org/download/rabbit.tar.gz
63
+ % tar xvzf rabbit.tar.gz
64
+ % cd rabbit-*
65
+ % sudo ruby setup.rb
@@ -0,0 +1,105 @@
1
+ ---
2
+ layout: ja
3
+ title: MacPortsでインストール
4
+ ---
5
+ == Mac OS XでMacPortsを使ったインストール方法
6
+
7
+ Mac OS X のパッケージ管理システムのひとつである、MacPorts を利用して
8
+ Rabbit をインストール、利用する手順について説明します。
9
+
10
+ === 事前に準備するもの
11
+
12
+ 以下のソフトウェアが必要です。Mac OS X のシステムDVDなどからインストール
13
+ してください。
14
+
15
+ * Xcode Tools
16
+ * X11
17
+
18
+ Xcode Tools のインストール時には、X11 SDK を選択するのを忘れないでください。
19
+
20
+ === MacPorts のインストール
21
+
22
+ MacPorts の公式サイト ((<URL:http://www.macports.org/>)) からダウンロード、
23
+ インストールします。ディスクイメージ(.dmg)からインストールするのが簡単です。
24
+
25
+ とくに指定しなければ、/opt/local 以下に MacPorts 関連のファイル群がインストール
26
+ されます。MacPorts のコマンドを利用するために、環境変数 PATH に /opt/local/bin
27
+ を追加します。
28
+
29
+ === Rabbit のインストール
30
+
31
+ まず、以下のコマンドで、Rabbitに必要なソフトウェアの情報を更新し
32
+ ておくのも良いかもしれません。
33
+
34
+ ~% sudo port sync
35
+
36
+ 以下のコマンドで Rabbit と、それに必要なソフトウェアがインストールされます。
37
+
38
+ ~% sudo port install rb-rabbit
39
+
40
+ glib や Gtk2 がインストールされていないときは、これらのインストールのために
41
+ ある程度の時間がかかります。
42
+
43
+ 他にも以下の port をインストールするとよいでしょう。
44
+
45
+ * Ruby-GetText-Package (rb-gettext) - メッセージなどの国際化が有効になります
46
+ * net/irc (rb-net-irc) - rabbircが利用できるようになります
47
+
48
+ インストール方法は同様です。
49
+
50
+ ~% sudo port install rb-gettext
51
+ ~% sudo port install rb-net-irc
52
+
53
+ 注) Ruby-GetText-Package が、すでに RubyGems からインストールされているときは
54
+ rb-gettext のインストールは不要です。
55
+
56
+ ==== X11なしでRabbitを利用したい
57
+
58
+ もしRabbitをX11なしで利用したい場合は、rb-rabbitパッケージをインストールする
59
+ 前に、pango・cairoおよびgtk2をX11なしでインストールしてください。
60
+
61
+ ~% sudo port install pango +no_x11 +quartz
62
+ ~% sudo port install cairo +no_x11 +quartz
63
+ ~% sudo port install gtk2 +no_x11 +quartz
64
+
65
+ === X11 環境に関する Tips
66
+
67
+ 一般的な PC-UNIX 環境とは異なり、Mac OS X ではウィンドウシステムとして X を
68
+ 利用していません。そのため、いくつかの注意が必要になります。
69
+
70
+ ==== X11.app を起動する
71
+
72
+ X11.app が起動していなければ、rabbit は実行できません。X11.app は
73
+ /アプリケーション/ユーティリティ/X11.app にあります。
74
+
75
+ ==== DISPLAY 環境変数
76
+
77
+ X11 上で動作する Rabbit を利用するためには、DISPLAY 環境変数が設定されて
78
+ いなければなりません。X11.app 上の xterm では設定されていますが、標準の
79
+ ターミナルや iTerm、JTerminal を利用しているときは自分で設定する必要が
80
+ あることに注意してください。
81
+
82
+ === Rabbit をバージョンアップする
83
+
84
+ port sync コマンドで Portfile を最新のものに更新したうえで、
85
+ port upgrade コマンドにより、Rabbit を最新のバージョンに更新することが
86
+ できます。
87
+
88
+ ~% sudo port sync
89
+ ~% sudo port upgrade rb-rabbit
90
+
91
+ Rabbit だけをバージョンアップしたいときは、-n オプションを指定します。この
92
+ オプションの指定により、関連するソフトウェアは更新せずに Rabbit だけを更新
93
+ することができます。
94
+
95
+ ~% sudo port -n upgrade rb-rabbit
96
+
97
+ === 連絡先
98
+
99
+ お気づきの点やリクエストなどは、Rabbit::UsersGroup.ja
100
+ ((<URL:http://www.cozmixng.org/~rwiki/index.rb?cmd=view;name=Rabbit%3A%3AUsersGroup.ja>))
101
+ や Rabbit MacPorts 担当の木村 (kimuraw at i.nifty.jp) までどうぞ。
102
+
103
+
104
+ Rabbitはgemまたはそれぞれのプラットフォームにあるパッケージ管
105
+ 理システムを使ってインストールすることができます。
@@ -0,0 +1,100 @@
1
+ ---
2
+ layout: ja
3
+ title: Windowsへインストール
4
+ ---
5
+ == Windowsでのインストール方法
6
+
7
+ Windows上でRabbitをインストール、利用する手順について説明し
8
+ ます。
9
+
10
+ 必ずインストールしなければいけないソフトウェアと、なくても動
11
+ くけどあると便利なソフトウェアがあります。
12
+
13
+ === 必須のソフトウェアのインストール
14
+
15
+ 以下が必須のソフトウェアです。
16
+
17
+ * Ruby
18
+ * Rabbit
19
+
20
+ まずは必須のソフトウェアをインストールしましょう。
21
+
22
+ ==== Ruby 本体のインストール
23
+
24
+ ((<RubyInstall for Windowsのダウンロードページ(英語)
25
+ |URL:http://rubyinstaller.org/downloads/>))からRuby 1.8.7 の
26
+ インストーラをダウンロードします。Ruby 1.8.7-p334のインストー
27
+ ラは以下のURLからダウンロードできます。
28
+
29
+ : rubyinstaller-1.8.7-p334.exe
30
+ ((<URL:http://rubyforge.org/frs/download.php/74293/rubyinstaller-1.8.7-p334.exe>))
31
+
32
+ ==== Rabbitのインストール
33
+
34
+ RubyInstallerをインストールするとスタートメニューに「Start
35
+ Command Prompt with Ruby」というプログラムが追加されます。こ
36
+ のプログラムを実行するとruby.exeにパスが通ったコマンドプロン
37
+ プトが表示されます。ここで以下のコマンドを実行することで
38
+ Rabbitをインストールできます。Ruby/GTK2など関連するソフトウェ
39
+ アも一緒にインストールされます。
40
+
41
+ > gem install rabbit
42
+
43
+ === 必須ではないソフトウェアのインストール
44
+
45
+ 以下がなくても動くけどあると便利なソフトウェアです。
46
+
47
+ * RDtool
48
+ * Ghostscript
49
+ * Enscript
50
+ * div
51
+
52
+ それではあると便利なソフトウェアをインストールしましょう。
53
+
54
+ ==== RDTool のインストール
55
+
56
+ ((<RAA:rdtool>)) をインストールする。
57
+
58
+ アーカイブを展開して,setup.rb を実行してインストールする.
59
+
60
+ : rdtool-0.6.20.tar.gz
61
+ ((<URL:http://www.moonwolf.com/ruby/archive/rdtool-0.6.20.tar.gz>))
62
+
63
+ ==== EPS を表示する
64
+
65
+ (1) AFPL Ghostscript 8.53 for Win32 をインストールする。
66
+
67
+ : gs853w32.exe
68
+ ((<URL:http://www.cs.wisc.edu/~ghost/>))
69
+
70
+ (2) インストール後 <インストール先>/gs/gs8.53/bin に PATH を通す。
71
+
72
+ ==== ソースコードの色づけを行う
73
+
74
+ (1) Enscript をインストールする。
75
+
76
+ : enscript-1.6.3-9-bin.exe
77
+ ((<URL:http://sourceforge.net/project/showfiles.php?group_id=23617&package_id=16960>))
78
+
79
+ (2) <Enscript のインストール先>/bin に PATH を通す。
80
+
81
+ (3) ruby コードを色づけする場合は、以下のコマンドで ruby.st もインストールする。
82
+
83
+ > cd <Enscript のインストール先>\share\enscript\hl
84
+ > ruby -ropen-uri -e "puts open('http://viewvc.rubyforge.mmmultiworks.com/cgi/viewvc.cgi/trunk/support/ruby.st?root=support&view=co').read" > ruby.st
85
+
86
+ (4) ((<RAA:htree>)) をインストールする。
87
+
88
+ アーカイブを展開して,install.rb を実行してインストールする。
89
+
90
+ : htree.tar.gz
91
+ ((<URL:http://cvs.m17n.org/viewcvs/ruby/htree.tar.gz>))
92
+
93
+ ==== rabrick を使う
94
+
95
+ ((<RAA:div>)) をインストールする。
96
+
97
+ アーカイブを展開して,install.rb を実行してインストールする。
98
+
99
+ : div-1.3.2.tar.gz
100
+ ((<URL:http://www2a.biglobe.ne.jp/~seki/ruby/div-1.3.2.tar.gz>))
@@ -1,8 +1,89 @@
1
- # -*- rd -*-
1
+ ---
2
+ layout: ja
3
+ title: お知らせ
4
+ apply_data: false
5
+ ---
6
+ == 0.9.3: 2010-06-25
2
7
 
3
- = NEWS.ja
8
+ コメント・Twitterサポート強化リリース。
4
9
 
5
- $Id: NEWS.ja 1455 2010-12-31 09:13:21Z kou $
10
+ === 改良
11
+
12
+ ==== 本体
13
+
14
+ * PDFサポートのRuby 1.9対応。
15
+ [とみたさんが報告]
16
+ * [#199] "-I"オプションで指定されたパスの中の「~」を展開す
17
+ るようにした。
18
+ [kdmsnrさんが報告]
19
+ * TwitterのOAuthに対応。
20
+ * Bundlerに対応。
21
+ * rabbitコマンド終了時に実行する処理を登録できる
22
+ Rabbit.add_cleanup_procを追加。
23
+ * Wii RemoteでRabbitを操作するためのコマンドrabwii(らぶ
24
+ うぃー)を追加。
25
+ [おかべさんのコードをベースに改造]
26
+ * dRubyサーバはデフォルトでlocalhostにバインドするようにし
27
+ た。
28
+ * デフォルトでRabbit APIをすべて公開するようにした。
29
+ (--default-public-level=all)
30
+ * rabbitter: OAuthを使用するようにした。
31
+ * rabrick: --druby-uriオプションを--rabbit-uriに変更した。
32
+ * rabbit-command: --druby-uriオプションを--rabbit-uriに変更した。
33
+ * コメントビューの削除。
34
+ * rabbitter: --user-languageオプションを追加。
35
+ * Windowsではrubyw.exeで起動されていたらデフォルトでGUIロガー
36
+ を使うようにした。
37
+ [なかださんが手助け]
38
+ * コンソールなしの状態で引数を指定せずに起動した場合はファ
39
+ イル選択ダイアログを表示するランチャーモードを追加。
40
+ * Hiki記法でタグをサポート。({{tag('タグ名', '値')}})
41
+
42
+ ==== テーマ
43
+
44
+ * title-background-image: スライドプロパティでの画像ファイ
45
+ ル名指定に対応。
46
+ [kdmsnrさんが提案]
47
+ * background-image-toolkit: テーマでオプションが指定されて
48
+ いても常にスライドプロパティを使うようにした。
49
+ * image: 画像のキャプションのフォントサイズをカスタマイズ
50
+ できるようにした。
51
+ * color-circle: newline-in-slidesテーマとtagテーマを有効に
52
+ した。
53
+ * slide-number: スライド番号を表示する位置をカスタマイズで
54
+ きるようにした。
55
+ [佐々木さん]
56
+ * debian: アップデート。
57
+ [佐々木さん]
58
+ * dark-gradation: 追加。Keynote風の暗めのグラデーションの
59
+ テーマ。
60
+ [佐々木さん]
61
+ * twitter-comment: 追加。Twitterのtweetをコメントとして取
62
+ り込むテーマ。
63
+ [おかべさんのコードをベースに改造]
64
+ * comment: 削除。廃止されたコメントビュー用のテーマ。
65
+ * footer-comment: 追加。コメントをフッターに表示するテーマ。
66
+ [おかべさんのコードをベースに改造]
67
+ * clutter-comment: 追加。コメントをClutterのAPIを利用して
68
+ ぐりんぐりんさせながら表示するテーマ。
69
+ * stream-comment: 追加。コメントをスライド上に流すテーマ。
70
+
71
+ === 修正
72
+
73
+ ==== 本体
74
+
75
+ * Clutterバックエンドが動かない問題を修正。
76
+ [おばたさんが報告]
77
+ * GUIロガーが動かない問題を修正。
78
+
79
+ === 感謝
80
+
81
+ * とみたさん
82
+ * kdmsnrさん
83
+ * おばたさん
84
+ * 佐々木さん
85
+ * おかべさん
86
+ * なかださん
6
87
 
7
88
  == 0.9.2: 2010-12-31
8
89
 
data/doc/ja/rd.rd ADDED
@@ -0,0 +1,489 @@
1
+ ---
2
+ layout: ja
3
+ title: RD
4
+ apply_data: false
5
+ ---
6
+ == RDとは何か
7
+
8
+ RDとはRuby版のPODです。つまりRubyスクリプトファイルの中に埋め込む事を意図して
9
+ 定義されたドキュメントフォーマットです。
10
+
11
+ RDは主にplain textをさまざまなフォーマットに変換するplain2というプログラム
12
+ の影響を受けています。そのため、RDはplain textに似ており、シンプルですっきり
13
+ した文法なので読みやすく書きやすいでしょう。
14
+
15
+ == RubyインタプリタはRDをどのように扱うか
16
+
17
+ Rubyのインタプリタは単純に"(({=begin}))"で始まる行から"(({=end}))"で始まる
18
+ 行までを無視します。ですから、スクリプトファイル中に埋め込む事ができるのは
19
+ RDだけではありません。何でも(({=begin}))と(({=end}))の間に書く事ができるの
20
+ です。RDは選択肢の一つにすぎませんが、Ruby標準のドキュメントフォーマットと
21
+ されています。((-もし他のドキュメントフォーマットに興味があるなら、例えば
22
+ rubyapi2
23
+ ((<URL:http://www.ueda.info.waseda.ac.jp/~igarashi/ruby/xml.html#rubyapi2>))
24
+ などを見るといいでしょう。これはRuby/Gtkのような大規模ライブラリのドキュメン
25
+ ト向けに作られています。-))
26
+
27
+ == RDの基本的な概念と文法
28
+ === Element, Block, Inline
29
+
30
+ これからの説明では"Element"という用語((-訳注: RDの文法用語についてはあ
31
+ えて日本語訳をあてませんでした。-))をテキストに文章構造を与えるための
32
+ 構成要素という意味で用います。さらに、"((<Block>))"という用語を比較的
33
+ 大きくグローバルな構造を表すElementに、"((<Inline>))"という用語を比較的小さ
34
+ くローカルな、テキストに付加的な修飾を与えるElementに対して用います。
35
+
36
+ 段落や見出し、リストなどがBlockです。RDではBlockを表すのに
37
+ インデントや特殊文字を用います。Blockを入れ子にすることで複雑な
38
+ 構造も表現できます。そして、Blockの表現は自然とplain textに見え
39
+ ます。詳しくは((<Block>))を見てください。
40
+
41
+ 強調やコードや参照などがInlineです。(('((? ... ?))'))のようなカッコと
42
+ 特殊文字の組合せがInlineの表現に使われます。ほとんどのInlineが互いに
43
+ 入れ子にできます。詳しくは((<Inline>))を見てください。
44
+
45
+ === Block
46
+ ==== 基本文法
47
+
48
+ Blockは行指向の文法にしたがいます。つまり、同じ行にある文字はすべて同じ
49
+ Blockに属しています。インデントはBlockの入れ子レベルとタイプを表して
50
+ います。行の先頭の文字はBlockのタイプに関係します。
51
+
52
+ + 概念と用語
53
+
54
+ :Baseline
55
+ Baselineはインデントの基準です。ある行のインデントととBaselineの相対的
56
+ な深さはその行の属するBlockのタイプに影響します。
57
+
58
+ :Head Char
59
+ Head Charは空白文字を除いた行の先頭の文字です。
60
+
61
+ :STRINGLINE
62
+ STRINGLINEは普通の文字で構成された行です。STRINGLINEは"(({*}))",
63
+ "(({(((|num|)))}))", "(({:}))", "(({=}))", "(({+}))"といった文字を
64
+ Head Charとしては含みません。しかし、インデントされた行なら"(({=}))"
65
+ や"(({+}))"をHead Charとすることができます。
66
+
67
+ :WHITELINE
68
+ WHITELINEは空白文字だけの行です。
69
+
70
+ :Comment
71
+ (({/^#/}))にマッチする行はコメントとみなされます。
72
+
73
+ + Baselineの決定と影響
74
+ トップレベルでは((<Baseline>))は行の左端です。リスト内ではBaselineはListItem
75
+ の最初の((<Block>))によって決定します。例えば、
76
+
77
+ Example: "|" はBaselineを表しています。
78
+ |この行はトップレベルのTextBlockの行だとします。
79
+ |<- したがって、Baselineは左端です。
80
+ *|List内では (1)
81
+ |<- このようにBaselineは(1)の行で決定されます。
82
+ * |同じListでもListItem毎にBaselineが決定されます。
83
+ |<- したがって、1番目のListItemとは違うここにBaselineがあります。
84
+ |この行はトップレベルのTextBlockの行だとします。
85
+ |<- したがって、Baselineは左端です。
86
+ *|List内では (1)
87
+ |<- このようにBaselineは(1)の行で決定されます。
88
+ * |同じListでもListItem毎にBaselineが決定されます。
89
+ |<- したがって、1番目のListItemとは違うここにBaselineがあります。
90
+
91
+ Blockが別のBlockに入れ子になっている時には内部のBlockのBaselineは外側の
92
+ BlockのBaselineよりも深くなります。
93
+
94
+ Baselineとインデントの相対的な位置関係がBlockのタイプに影響します。
95
+ Baselineと同じ深さにインデントされた((<STRINGLINE>))は((<TextBlock>))
96
+ に属す行となります。一方Baselineより深くインデントされた((<STRINGLINE>))
97
+ は((<Verbatim>))の行です。
98
+
99
+ ==== Blockのタイプ
100
+ + Headline
101
+
102
+ Headlineは"(({=}))"か"(({+}))"を((<Head Char>))とする行で構成されます。
103
+ Headlineは1行以上にはなりません。Headlineはトップレベルだけに置く事が
104
+ できます。
105
+
106
+ Example:
107
+ |<- トップレベルのBaseline
108
+ = Headline 1.
109
+ === Headline 1.1.1.
110
+ + Headline 1.1.1.1.1.
111
+
112
+ = Headline 1.
113
+ === Headline 1.1.1.
114
+ + Headline 1.1.1.1.1.
115
+
116
+ Headlineの先頭の特殊文字はHeadlineのレベルを表しています。次の図で
117
+ 最初のマークは最も大きなレベルのもので、最後のマークがもっとも小さな
118
+ レベルのものです。
119
+
120
+ Fig: Headline Marks
121
+ =
122
+ ==
123
+ ===
124
+ ====
125
+ +
126
+ ++
127
+
128
+ マークに続くテキストはHeadlineのタイトルです。これは同時に
129
+ ((<Reference>))のラベルとして使われます。
130
+
131
+ Headlineのタイトルには((<Reference>))とFootnoteを除く((<Inline>))を使う事が
132
+ できます。
133
+
134
+ + Include
135
+
136
+ Includeは"(({<<<}))"を((<Head Char>))とし、その後ろにインクルードする
137
+ ファイルの名前が続く行からなります。RD形式のファイルと出力するフォーマッ
138
+ トで書かれたファイルのどちらでもIncludeによってインクルードできます。
139
+
140
+ RD形式のファイルをインクルードする時にはインクルードされるファイルの名
141
+ 前は"foo.rd"の様に".rd"もしくは".rb"というサフィックスでなくてはなりま
142
+ せん。そして、"(({<<<}))"の後にはサフィックスを含めたファイルの完全な
143
+ 名前を書きます。例えば、次の様にです。
144
+ <<< foo.rd
145
+
146
+ 出力するフォーマットのファイルをインクルードするには、インクルードされる
147
+ ファイルはその出力フォーマットに固有のサフィックスを持たないといけません。
148
+ 例えば、HTMLのファイルをインクルードするには".html"というサフィックスを、
149
+ Texinfo形式のファイルをインクルードするには".texi"というサフィックスを
150
+ つけます。そして、"(({<<<}))"の後ろにはサフィックスを除いたファイルの
151
+ 名前を書きます。例えば、
152
+ <<< foo
153
+ と書くわけです。
154
+
155
+ この場合、RDフォーマッタはHTMLを出力する時には"foo.html"をインクルード
156
+ し、Texinfo形式で出力する時には"foo.texi"をインクルードします。出力フォー
157
+ マットのIncludeを用いる時には複数の(しかもなるべく多くの)形式のインク
158
+ ルードファイルを用意すべきです。
159
+
160
+ + TextBlock
161
+
162
+ TextBlockは複数の((<STRINGLINE>))から構成されます。それらの行は((<Baseline>))
163
+ と同じインデントでないといけません。((<Baseline>))より深い((<STRINGLINE>))は
164
+ ((<Verbatim>))の行とみなされます。
165
+
166
+ TextBlockは((<Inline>))を内部に含む事ができます。
167
+
168
+ Example:
169
+ |
170
+ これはTextBlockです。
171
+ TextBlockの2行目の行です。
172
+ この行はTextBlockでなくVerbatimです。
173
+ * そしてこの行はListの行です。(正確にはListItemの中のTextBlockの行でも
174
+ あるのですが)
175
+
176
+ この例は次のようにフォーマットされます。
177
+
178
+ これはTextBlockです。
179
+ TextBlockの2行目の行です。
180
+ この行はTextBlockでなくVerbatimです。
181
+ * そしてこの行はListの行です。(正確にはListItemの中のTextBlockの行でも
182
+ あるのですが)
183
+
184
+ + Verbatim
185
+
186
+ Rubyスクリプトを引用するのにVerbatimを用いる事ができます。Verbatimは
187
+ ((<Baseline>))より深いインデントを持つ((<STRINGLINE>))で構成されます。
188
+ Verbatimは"(({*}))"や"(({(1)}))"や"(({:}))"といった特殊文字を((<Head
189
+ Char>))として持つ行も含む事ができますが、それらは最初の行には置く事
190
+ ができません。最初の行にあるときには((<List>))と見なされます。Verbatim
191
+ は最初の行より浅いインデントの行も含みません。Verbatimは((<WHITELINE>))
192
+ を含める事ができます。
193
+
194
+ ((<Inline>))はVerbatim内では使えません。
195
+
196
+ Example:
197
+ これはVerbatimです。
198
+ 最初の行より深いインデントを持っても、同じVerbatimの行になります。
199
+ * この行はListに見えますが、Verbatimです。
200
+ しかしこの行は最初の行よりも浅くインデントされているので、別のVerbatim
201
+ の行になります。
202
+
203
+ この例が次のようにフォーマットされます。
204
+
205
+ これはVerbatimです。
206
+ 最初の行より深いインデントを持っても、同じVerbatimの行になります。
207
+ * この行はListに見えますが、Verbatimです。
208
+ しかしこの行は最初の行よりも浅くインデントされているので、別のVerbatim
209
+ の行になります。
210
+
211
+ + List
212
+
213
+ Listは特殊な((<Block>))です。Listは複数のListItemから構成され、ListItem
214
+ は複数のBlockから構成されます。したがって、ListはBlockを内部に含む事が
215
+ できます。含む事のできるBlockにはList自身も含みます。((-((<Headline>))
216
+ や((<Include>))はList内部に持てません。-))
217
+
218
+ ListItemは((<WHITELINE>))を含む事ができますが、((<TextBlock>))は
219
+ 持てません。そのため、WHITELINEを間にはさむ事によって複数のTextBlock
220
+ をListItem内部に置く事ができます。
221
+
222
+ Listには"((<ItemList>))"、"((<EnumList>))"、"((<DescList>))",
223
+ "((<MethodList>))の4種類があります。
224
+
225
+ ++ ItemList
226
+
227
+ ItemListは単純な番号付されないListです。ItemListItemは"(({*}))"という
228
+ ((<Head Char>))の行で始まります。ItemListItemの最初のBlockは必ず
229
+ ((<TextBlock>))になります。
230
+
231
+ Example:
232
+ * 親Listの最初のItem
233
+ * 子Listの最初のItem
234
+ * 子Listの2番目のItem
235
+ 親ListのItemに含まれるTextBlock
236
+
237
+ 下のようにフォーマットされます。
238
+
239
+ * 親Listの最初のItem
240
+ * 子Listの最初のItem
241
+ * 子Listの2番目のItem
242
+ 親ListのItemに含まれるTextBlock
243
+
244
+ ++ EnumList
245
+
246
+ EnumListは番号付されたListです。EnumListItemは"(({((|num|))}))"(((|num|))
247
+ は整数)という((<Head Char>))の行ではじまります。他の点ではEnumListは
248
+ ((<ItemList>))と同じです。
249
+
250
+ Example:
251
+ (1) 親Listの最初のItem
252
+ * 子ListとなるItemList
253
+ (2) 親Listの2番目のItem
254
+ (10) 番号は無視されます。
255
+
256
+ 次のようにフォーマットされます。
257
+
258
+ (1) 親Listの最初のItem
259
+ * 子ListとなるItemList
260
+ (2) 親Listの2番目のItem
261
+ (10) 番号は無視されます。
262
+
263
+ ++ DescList
264
+
265
+ DescListは用語説明のためのListです。DescListItemは2つの部分からなります。
266
+ 1つはTermパートでもう1つはDescriptionパートです。Termパートは((<Reference>))
267
+ のLabelとして使われます。
268
+
269
+ Termパートは"(({:}))"という((<Head Char>))の行からなります。Termパートの
270
+ 行はインデントできることを除くとTermパートは((<Headline>))と同様です。
271
+
272
+ DescriptionパートはTermパートの次の行からはじまります。Descriptionパート
273
+ の((<Baseline>))はTermパートの(((<Head Char>))を除いた)テキスト部分と
274
+ 同じかより深くないといけません。例えば次の例は間違っています。
275
+
276
+ Example:
277
+ : |Term
278
+ |Description.
279
+
280
+ Descriptionぱーとは複数の((<Block>))を含む事ができます。((<List>))を
281
+ 最初のBlockとすることもできます。Termパートは((<Inline>))を含む事が
282
+ できますが、((<Reference>))とFootnoteは例外です。
283
+
284
+ Example:
285
+ :Term
286
+ Descriptionの最初の行
287
+ 2番目の行
288
+ :Term2
289
+ * Listも含む事ができます
290
+ * ...
291
+
292
+ 次のようにフォーマットされます。
293
+
294
+ :Term
295
+ Descriptionの最初の行
296
+ 2番目の行
297
+ :Term2
298
+ * Listも含む事ができます
299
+ * ...
300
+
301
+ ++ MethodList
302
+
303
+ MethodListはメソッドの説明のための特殊なタイプの((<DescList>))です。
304
+ ほとんどの点でMethodListは((<DescList>))と同様ですが、Labelの規則
305
+ は違っています。RDフォーマッタはMethodListのTermパートがなんらかの
306
+ Rubyのあるクラスのメソッドや定数やCの関数プロトタイプといったような
307
+ プログラムのコードであると知っています。そのため、MethodListは
308
+ メソッドの引数のように見える部分を除いた上でLabelとなります。詳細は
309
+ ((<LabelとReference>))を見てください。
310
+
311
+ MethodListItemは((<DescList>))と同様にTermパートとDescription
312
+ パートを持ちます。Termパートは"(({---}))"という((<Head Char>))
313
+ の行でなり、Descriptionパートは((<TextBlock>))や((<Verbatim>))
314
+ 、((<List>))を含む事ができます。しかし、逆にMethodListを((<List>))
315
+ の中に置くべきではありません。RDは将来的にはこれを禁止するかも
316
+ しれません。
317
+
318
+ Example:
319
+ --- Array#each {|i| ... } # => Labelは"Array#each"
320
+ 各項目に対してブロックを評価する。
321
+ --- Array#index(val) # => Labelは"Array#index"
322
+ ((|val|))と同じ値である最初の項目を返す。同じ項目が無いときには
323
+ (({nil}))を返す。
324
+
325
+ この例が次のようにフォーマットされます。
326
+
327
+ --- Array#each {|i| ... }
328
+ 各項目に対してブロックを評価する。
329
+ --- Array#index(val)
330
+ ((|val|))と同じ値である最初の項目を返す。同じ項目が無いときには
331
+ (({nil}))を返す。
332
+
333
+ フォーマッタのいくつかはMethodListのTermパートに書かれているのはRuby
334
+ のメソッドや定数などであると仮定しています。そういったフォーマッタでは
335
+ MethodListのTermパートをインテリジェントに扱う事ができますが、そのため
336
+ には特定の慣習にしたがってRDを書く必要があります。
337
+
338
+ 標準的なRubyクラスリファレンスのための慣習として次のようなものが提案さ
339
+ れています。
340
+ : インスタンスメソッド
341
+ クラス((|Class|))のインスタンスメソッド((|method|))
342
+ Class#method(its params ...) { parameter block }
343
+ : クラスメソッド(クラスの特異メソッド)
344
+ クラス((|Class|))のクラスメソッド((|method|))
345
+ Class.method(its params ...) { parameter block }
346
+ : クラス定数
347
+ クラス((|Class|))の定数((|Const|))
348
+ Class::Const
349
+ : 関数メソッド
350
+ 関数((|func|))
351
+ function#func(its params ...) { parameter block }
352
+
353
+ Rubyはいくつかの特殊な文字(e.g. [], []=, +, -, <<, ...)はメソッドの名前
354
+ (識別子)として使います。この時、Rubyインタプリタはこれらのメソッドの
355
+ パースを普通のメソッドとは違ったやりかた(演算子メソッド)で行います。
356
+ しかし、この慣習ではこれらの演算子メソッドも同じように書きます。
357
+
358
+ Example:
359
+ --- Array#[](key)
360
+ ((|key|))に対応する値を返す。
361
+ --- Array#[]=(key, value)
362
+ ((|key|))の場所に((|value|))を格納する。
363
+ --- Array#+(other)
364
+ 2つの(({Array}))を結合してそれを返します。
365
+
366
+ === Inline
367
+ Inlineは((<TextBlock>))や((<Headline>))、((<DescList>))のTermパートの
368
+ 中で使う事ができます。カッコを使ったマークアップがInlineに使われます。
369
+ Inline同士は互いに入れ子にできます。
370
+
371
+ 次のInlineの一覧では左側に書式を、右側にフォーマット後の様子を表示
372
+ しています。
373
+
374
+ :(('((*Em*))')) => ((*Em*))
375
+ 強調
376
+
377
+ :(('(({while gets...}))')) => (({while gets...}))
378
+ プログラムのコード
379
+
380
+ :(('((|var|))')) => ((|var|))
381
+ メタ変数((- Varについての詳しい説明はtexinfo.texiの該当部分にあります。-))
382
+
383
+ :(('((%ruby -v%))')) => ((%ruby -v%))
384
+ キーボード
385
+
386
+ :(('((:Term:))'))
387
+ => ((:Term:))
388
+
389
+ インデクスやキーワードとなる用語の指定
390
+
391
+ :(('((<Identity or URL>))'))
392
+ => ((<Indentity or URL>))
393
+
394
+ 参照。詳しくは((<LabelとReference>))を見てください。
395
+
396
+ :(('((-Footnote-))'))
397
+ => ((-Footnote-))
398
+
399
+ 脚注
400
+
401
+ :(('(('verb\'))')) => (('verb'))
402
+ Inlineのvarbatim(フォーマット抑制)
403
+
404
+ ==== LabelとReference
405
+
406
+ ReferenceにはLabelが必要です。RDでは((<Headline>))のタイトルと((<DescList>))
407
+ や((<MethodList>))のTermパートだけがLabelとなります。したがって、各々の
408
+ ((<Headline>))には違うタイトルをつけてあげなくてはなりません。この問題の
409
+ きちんとした解決策はまだ見付かっていません。
410
+
411
+ + どのようにLabelがつけられるか
412
+
413
+ ((<Headline>))のタイトルと((<DescList>))や((<MethodList>))のTermパートが
414
+ Labelとして使われます。しかし、((<Inline>))が含まれるために、それらが
415
+ そのままLabelとして使われる、というほど単純ではありません。
416
+
417
+ 第一に、((<MethodList>))はLabel付けにおいてはやや特殊です。((<MethodList>))
418
+ のTermパートは((<Inline>))を含みませんが、その代わりRDでは((<MethodList>))
419
+ のTermパートはメソッドリファレンスやそれに類似の物とみなされますので、次の
420
+ ようなルールでラベルが付けられます。
421
+
422
+ (1) "(({(}))"や"(({{}))"の前にあるテキストだけがラベルと見なされる。((-
423
+ "(({(...)}))"の内部のテキストはメソッドの引数だと見なされ、
424
+ "(({{...}}))"の内部のテキストはメソッドのブロックと見なされるのです。-))
425
+
426
+ 次の例を見れば、どのようにルールが適用されているかわかるでしょう。
427
+ "(({# =>}))"より右にあるのが((<MethodList>))のTermパートから抽出された
428
+ Labelです。
429
+
430
+ Example:
431
+ --- Array.new([size[, val]]) # => Array.new
432
+ --- Array#[]=(key, val) # => Array#[]=
433
+ --- Array#each { ... } # => Array#each
434
+ --- void rb_define_method(VALUE class, ...) # => void rb_define_method
435
+
436
+ 次に、((<Headline>))のタイトルや((<DescList>))のTermパートの場合には、この
437
+ ような特別なルールはありませんが、((<Inline>))を含む事があるので、((<Inline>))
438
+ に用いるカッコを取り除くためのルールがあります。
439
+
440
+ (1)どんな((<Inline>))修飾もLabelには影響しません。したがって、
441
+ = ((*Headline*))
442
+
443
+ = Headline
444
+ は共に"Headline"とLabelが決まります。
445
+ (2)しかし、Labelを抽出する際には((<Inline>))の開始カッコの後ろと終端カッコ
446
+ の前にある空白文字は取り除かれます。したがって、
447
+ = ((* Headline *))
448
+
449
+ = ((*Headline*))
450
+ も"Headline"とLabelがつけられます。
451
+
452
+ + Reference
453
+
454
+ LabelのつけられたElementはReferenceによって参照できます。Referenceは
455
+ (('((<...>))'))というカッコで修飾される((<Inline>))です。
456
+
457
+ 最も簡単なReferenceの使用法は、単にLabelをそのカッコの中に書けばよいのです。
458
+ ((<Label>))
459
+ これは"Label"というLabelに対する参照となります。また、フォーマッタによる
460
+ 出力では"Label"というテキストが表示にも使われます。例: ((<Label>))((-
461
+ "Label"というLabelのついたElementが無いのでおそらくReferenceの様には
462
+ 見えないでしょう。-))
463
+
464
+ URLによって示されたリソースを参照するには次のように書きます。
465
+ ((<URL:http://www.ruby-lang.org/en/raa.html>))
466
+ 可能ならRDフォーマッタはURLを次のようにハイパーリンクします。例:
467
+ ((<URL:http://www.ruby-lang.org/en/raa.html>)).
468
+
469
+ Labelとは違うテキストを表示に使いたい時には次のように書きます。
470
+ ((<Text for display|Label>))
471
+ "Text for display"が表示用のテキストとして使われ、"Label"がLabelとして
472
+ 使われます。例: ((<Text for display|Label>))
473
+
474
+ 表示用のテキストは((<Inline>))を含む事ができます。しかし、Footnoteと
475
+ Reference自身を含む事はできません。
476
+
477
+ Reference内では"|"や"/"は特殊文字なのでこれらを使いたい時には、それを含む
478
+ 部分ごとダブルクオートで囲ってやらないといけません。これはReference内のどの
479
+ 部分でも同じです。
480
+ ((<"Bar | inside display text"|Label>))
481
+ ((<"Bar | inside display text"|Label>))
482
+
483
+ 表示用のテキストはURLへのReferenceにも使う事ができます。
484
+ ((<Ruby Application Archive|URL:http://www.ruby-lang.org/en/raa.html>))
485
+ ((<Ruby Application Archive|URL:http://www.ruby-lang.org/en/raa.html>))
486
+
487
+ 表示用のテキストが無い場合には代わりにLabelに((<Inline>))を使えます。
488
+ ((<((*Label*))>))
489
+ ((<((*Label*))>))