tdiary 3.2.2.20130507

Sign up to get free protection for your applications and to get access to all the features.
Files changed (509) hide show
  1. checksums.yaml +7 -0
  2. data/.coveralls.yml +1 -0
  3. data/.gitignore +16 -0
  4. data/.travis.yml +29 -0
  5. data/Capfile +2 -0
  6. data/ChangeLog +3173 -0
  7. data/Gemfile +58 -0
  8. data/Gemfile.lock +201 -0
  9. data/LICENSE +340 -0
  10. data/Procfile +1 -0
  11. data/README.md +33 -0
  12. data/Rakefile +26 -0
  13. data/bin/tdiary +7 -0
  14. data/config.ru +61 -0
  15. data/data/.htaccess +2 -0
  16. data/doc/HOWTO-authenticate-in-rack.md +89 -0
  17. data/doc/HOWTO-make-io.md +305 -0
  18. data/doc/HOWTO-make-plugin.md +279 -0
  19. data/doc/HOWTO-make-theme.md +67 -0
  20. data/doc/HOWTO-testing-tDiary.md +44 -0
  21. data/doc/HOWTO-use-plugin.md +148 -0
  22. data/doc/HOWTO-write-tDiary.en.md +131 -0
  23. data/doc/HOWTO-write-tDiary.md +136 -0
  24. data/doc/INSTALL-paas.md +202 -0
  25. data/doc/INSTALL.md +160 -0
  26. data/doc/README.en.md +174 -0
  27. data/doc/README.md +56 -0
  28. data/doc/UPGRADE.md +164 -0
  29. data/doc/doc.css +115 -0
  30. data/dot.htaccess +27 -0
  31. data/index.fcgi +45 -0
  32. data/index.rb +57 -0
  33. data/js/00default.js +60 -0
  34. data/js/01conf.js +62 -0
  35. data/js/02edit.coffee +5 -0
  36. data/js/02edit.js +15 -0
  37. data/js/amazon.js +43 -0
  38. data/js/calendar3.js +130 -0
  39. data/js/caretposition.js +170 -0
  40. data/js/category.js +29 -0
  41. data/js/category_autocomplete.js +96 -0
  42. data/js/comment_ajax.js +27 -0
  43. data/js/draft.js +149 -0
  44. data/js/highlight.js +36 -0
  45. data/js/image.js +181 -0
  46. data/misc/convert2.rb +123 -0
  47. data/misc/filter/antispamservice.rb +101 -0
  48. data/misc/filter/limitdays.rb +40 -0
  49. data/misc/filter/linkcheck.rb +81 -0
  50. data/misc/filter/plugin/antispamservice.rb +82 -0
  51. data/misc/filter/plugin/en/antispamservice.rb +21 -0
  52. data/misc/filter/plugin/ja/antispamservice.rb +20 -0
  53. data/misc/lib/README +4 -0
  54. data/misc/lib/compatible.rb +1 -0
  55. data/misc/lib/fcgi_patch.rb +90 -0
  56. data/misc/migrate.rb +157 -0
  57. data/misc/paas/cloudfoundry/Gemfile +26 -0
  58. data/misc/paas/cloudfoundry/Gemfile.lock +85 -0
  59. data/misc/paas/heroku/Gemfile +22 -0
  60. data/misc/paas/heroku/Gemfile.lock +85 -0
  61. data/misc/paas/sqale/Gemfile +19 -0
  62. data/misc/paas/sqale/Gemfile.lock +85 -0
  63. data/misc/paas/sqale/Procfile +1 -0
  64. data/misc/paas/sqale/dot.env +1 -0
  65. data/misc/plugin/ChangeLog.DO_NOT_UPDATE +2333 -0
  66. data/misc/plugin/a.rb +211 -0
  67. data/misc/plugin/amazon.rb +403 -0
  68. data/misc/plugin/amazon/README.en +17 -0
  69. data/misc/plugin/amazon/README.ja +29 -0
  70. data/misc/plugin/amazon/amazonimg.rb +113 -0
  71. data/misc/plugin/amazon/large.png +0 -0
  72. data/misc/plugin/amazon/medium.png +0 -0
  73. data/misc/plugin/amazon/small.png +0 -0
  74. data/misc/plugin/append-css.rb +51 -0
  75. data/misc/plugin/bq.rb +48 -0
  76. data/misc/plugin/calendar2.rb +184 -0
  77. data/misc/plugin/calendar3.rb +256 -0
  78. data/misc/plugin/category.rb +779 -0
  79. data/misc/plugin/category_autocomplete.rb +33 -0
  80. data/misc/plugin/comment_ajax.rb +11 -0
  81. data/misc/plugin/comment_mail-qmail.rb +57 -0
  82. data/misc/plugin/comment_mail-sendmail.rb +56 -0
  83. data/misc/plugin/comment_mail-smtp.rb +59 -0
  84. data/misc/plugin/comment_rank.rb +36 -0
  85. data/misc/plugin/counter.rb +631 -0
  86. data/misc/plugin/daily_theme.rb +55 -0
  87. data/misc/plugin/disp_referrer.rb +1486 -0
  88. data/misc/plugin/doctype-html401tr.rb +16 -0
  89. data/misc/plugin/draft.rb +20 -0
  90. data/misc/plugin/dropdown_calendar.rb +32 -0
  91. data/misc/plugin/edit_today.rb +50 -0
  92. data/misc/plugin/en/a.rb +10 -0
  93. data/misc/plugin/en/amazon.rb +71 -0
  94. data/misc/plugin/en/append-css.rb +17 -0
  95. data/misc/plugin/en/bq.rb +12 -0
  96. data/misc/plugin/en/calendar2.rb +12 -0
  97. data/misc/plugin/en/category.rb +204 -0
  98. data/misc/plugin/en/counter.rb +48 -0
  99. data/misc/plugin/en/daily_theme.rb +14 -0
  100. data/misc/plugin/en/disp_referrer.rb +387 -0
  101. data/misc/plugin/en/dropdown_calendar.rb +14 -0
  102. data/misc/plugin/en/edit_today.rb +22 -0
  103. data/misc/plugin/en/hide-mail-field.rb +19 -0
  104. data/misc/plugin/en/highlight.rb +29 -0
  105. data/misc/plugin/en/image.rb +54 -0
  106. data/misc/plugin/en/kw.rb +22 -0
  107. data/misc/plugin/en/makerss.rb +47 -0
  108. data/misc/plugin/en/pb-show.rb +21 -0
  109. data/misc/plugin/en/ping.rb +16 -0
  110. data/misc/plugin/en/recent_comment.rb +44 -0
  111. data/misc/plugin/en/recent_comment3.rb +56 -0
  112. data/misc/plugin/en/recent_rss.rb +33 -0
  113. data/misc/plugin/en/referer_scheme.rb +48 -0
  114. data/misc/plugin/en/search_control.rb +74 -0
  115. data/misc/plugin/en/search_form.rb +22 -0
  116. data/misc/plugin/en/speed_comment.rb +19 -0
  117. data/misc/plugin/en/tb-show.rb +37 -0
  118. data/misc/plugin/en/todo.rb +43 -0
  119. data/misc/plugin/en/weather.rb +185 -0
  120. data/misc/plugin/en/xmlrpc.rb +14 -0
  121. data/misc/plugin/footnote.rb +92 -0
  122. data/misc/plugin/gradation.rb +39 -0
  123. data/misc/plugin/gradient.rb +36 -0
  124. data/misc/plugin/hide-mail-field.rb +50 -0
  125. data/misc/plugin/highlight.rb +22 -0
  126. data/misc/plugin/html_anchor.rb +34 -0
  127. data/misc/plugin/image.rb +290 -0
  128. data/misc/plugin/ja/amazon.rb +89 -0
  129. data/misc/plugin/ja/bq.rb +13 -0
  130. data/misc/plugin/ja/calendar2.rb +12 -0
  131. data/misc/plugin/ja/category.rb +212 -0
  132. data/misc/plugin/ja/daily_theme.rb +15 -0
  133. data/misc/plugin/ja/disp_referrer.rb +644 -0
  134. data/misc/plugin/ja/edit_today.rb +23 -0
  135. data/misc/plugin/ja/hide-mail-field.rb +20 -0
  136. data/misc/plugin/ja/highlight.rb +30 -0
  137. data/misc/plugin/ja/makerss.rb +44 -0
  138. data/misc/plugin/ja/my-sequel.rb +52 -0
  139. data/misc/plugin/ja/pb-show.rb +23 -0
  140. data/misc/plugin/ja/ping.rb +17 -0
  141. data/misc/plugin/ja/recent_comment.rb +45 -0
  142. data/misc/plugin/ja/recent_comment3.rb +57 -0
  143. data/misc/plugin/ja/recent_rss.rb +34 -0
  144. data/misc/plugin/ja/referer_scheme.rb +86 -0
  145. data/misc/plugin/ja/search_control.rb +75 -0
  146. data/misc/plugin/ja/search_form.rb +32 -0
  147. data/misc/plugin/ja/tb-show.rb +38 -0
  148. data/misc/plugin/ja/todo.rb +46 -0
  149. data/misc/plugin/ja/weather.rb +402 -0
  150. data/misc/plugin/ja/xmlrpc.rb +15 -0
  151. data/misc/plugin/kw.rb +150 -0
  152. data/misc/plugin/list.rb +40 -0
  153. data/misc/plugin/makelirs.rb +89 -0
  154. data/misc/plugin/makerss.rb +744 -0
  155. data/misc/plugin/my-ex.rb +68 -0
  156. data/misc/plugin/my-sequel.rb +539 -0
  157. data/misc/plugin/navi_user.rb +19 -0
  158. data/misc/plugin/number_anchor.rb +47 -0
  159. data/misc/plugin/pb-show.rb +165 -0
  160. data/misc/plugin/ping.rb +99 -0
  161. data/misc/plugin/pre_wrap.rb +19 -0
  162. data/misc/plugin/random_google.rb +165 -0
  163. data/misc/plugin/recent_comment.rb +82 -0
  164. data/misc/plugin/recent_comment3.rb +192 -0
  165. data/misc/plugin/recent_list.rb +91 -0
  166. data/misc/plugin/recent_namazu.rb +50 -0
  167. data/misc/plugin/recent_rss.rb +305 -0
  168. data/misc/plugin/referer-antibot.rb +53 -0
  169. data/misc/plugin/referer-utf8.rb +12 -0
  170. data/misc/plugin/referer_scheme.rb +87 -0
  171. data/misc/plugin/search_control.rb +227 -0
  172. data/misc/plugin/search_form.rb +53 -0
  173. data/misc/plugin/sn.rb +107 -0
  174. data/misc/plugin/speed_comment.rb +68 -0
  175. data/misc/plugin/squeeze.rb +272 -0
  176. data/misc/plugin/src.rb +30 -0
  177. data/misc/plugin/tb-show.rb +212 -0
  178. data/misc/plugin/title_list.rb +41 -0
  179. data/misc/plugin/title_tag.rb +80 -0
  180. data/misc/plugin/tlink.rb +163 -0
  181. data/misc/plugin/todo.rb +182 -0
  182. data/misc/plugin/weather.rb +505 -0
  183. data/misc/plugin/whatsnew.rb +100 -0
  184. data/misc/plugin/xmlrpc.rb +80 -0
  185. data/misc/plugin/xmlrpc/README +20 -0
  186. data/misc/plugin/xmlrpc/xmlrpc.rb +575 -0
  187. data/misc/style/emptdiary/README.rd +83 -0
  188. data/misc/style/emptdiary/README.rd.en +78 -0
  189. data/misc/style/emptdiary/emptdiary_style.rb +199 -0
  190. data/misc/style/etdiary/README.rd +83 -0
  191. data/misc/style/etdiary/etdiary_style.rb +446 -0
  192. data/misc/style/gfm/gfm_style.rb +194 -0
  193. data/misc/style/rd/README.rd +71 -0
  194. data/misc/style/rd/rd_style.rb +366 -0
  195. data/misc/style/wiki/README +116 -0
  196. data/misc/style/wiki/README.en +101 -0
  197. data/misc/style/wiki/wiki_parser.rb +273 -0
  198. data/misc/style/wiki/wiki_style.rb +478 -0
  199. data/misc/theme_convert/Readme.rd +21 -0
  200. data/misc/theme_convert/append.rcss +150 -0
  201. data/misc/theme_convert/theme_convert.rb +453 -0
  202. data/plugin/00default.rb +1015 -0
  203. data/plugin/05referer.rb +298 -0
  204. data/plugin/10spamfilter.rb +183 -0
  205. data/plugin/50sp.rb +146 -0
  206. data/plugin/60sf.rb +152 -0
  207. data/plugin/90migrate.rb +109 -0
  208. data/plugin/en/00default.rb +390 -0
  209. data/plugin/en/05referer.rb +49 -0
  210. data/plugin/en/10spamfilter.rb +81 -0
  211. data/plugin/en/50sp.rb +56 -0
  212. data/plugin/en/60sf.rb +60 -0
  213. data/plugin/ja/00default.rb +401 -0
  214. data/plugin/ja/05referer.rb +47 -0
  215. data/plugin/ja/10spamfilter.rb +79 -0
  216. data/plugin/ja/50sp.rb +66 -0
  217. data/plugin/ja/60sf.rb +73 -0
  218. data/public/.gitkeep +0 -0
  219. data/public/images/.gitkeep +0 -0
  220. data/public/javascripts/.gitkeep +0 -0
  221. data/public/stylesheets/.gitkeep +0 -0
  222. data/skel/category.rhtml +9 -0
  223. data/skel/conf.rhtml +23 -0
  224. data/skel/day.rhtml +33 -0
  225. data/skel/diary.rhtml +83 -0
  226. data/skel/footer.rhtml +8 -0
  227. data/skel/header.rhtml +10 -0
  228. data/skel/i.category.rhtml +6 -0
  229. data/skel/i.conf.rhtml +14 -0
  230. data/skel/i.day.rhtml +28 -0
  231. data/skel/i.diary.rhtml +17 -0
  232. data/skel/i.footer.rhtml +2 -0
  233. data/skel/i.header.rhtml +3 -0
  234. data/skel/i.latest.rhtml +24 -0
  235. data/skel/i.month.rhtml +39 -0
  236. data/skel/i.search.rhtml +5 -0
  237. data/skel/i.update.rhtml +40 -0
  238. data/skel/i.update.rhtml.en +40 -0
  239. data/skel/latest.rhtml +27 -0
  240. data/skel/mail.rtxt +18 -0
  241. data/skel/mail.rtxt.en +18 -0
  242. data/skel/month.rhtml +27 -0
  243. data/skel/plugin_error.rhtml +27 -0
  244. data/skel/preview.rhtml +85 -0
  245. data/skel/preview.rhtml.en +72 -0
  246. data/skel/referer.rhtml +24 -0
  247. data/skel/search.rhtml +14 -0
  248. data/skel/tdiary.rconf +76 -0
  249. data/skel/update.rhtml +103 -0
  250. data/skel/update.rhtml.en +83 -0
  251. data/spec/acceptance/append_comment_spec.rb +94 -0
  252. data/spec/acceptance/append_diary_spec.rb +98 -0
  253. data/spec/acceptance/bugfix/encoding_error_spec.rb +27 -0
  254. data/spec/acceptance/save_conf_comment_spec.rb +87 -0
  255. data/spec/acceptance/save_conf_default_spec.rb +169 -0
  256. data/spec/acceptance/save_conf_dnsbl_spec.rb +152 -0
  257. data/spec/acceptance/save_conf_filter_spec.rb +50 -0
  258. data/spec/acceptance/save_conf_plugin_spec.rb +69 -0
  259. data/spec/acceptance/save_conf_referer_spec.rb +60 -0
  260. data/spec/acceptance/save_conf_security_spec.rb +280 -0
  261. data/spec/acceptance/support/helpers.rb +49 -0
  262. data/spec/acceptance/support/paths.rb +7 -0
  263. data/spec/acceptance/update_diary_spec.rb +113 -0
  264. data/spec/acceptance/view_category_spec.rb +38 -0
  265. data/spec/acceptance/view_comment_spec.rb +67 -0
  266. data/spec/acceptance/view_diary_spec.rb +126 -0
  267. data/spec/acceptance/view_referer_spec.rb +31 -0
  268. data/spec/acceptance_helper.rb +101 -0
  269. data/spec/core/compatible_spec.rb +54 -0
  270. data/spec/core/core_ext_spec.rb +59 -0
  271. data/spec/core/plugin_spec.rb +389 -0
  272. data/spec/core/rack/assets/precompile_spec.rb +76 -0
  273. data/spec/core/rack/html_anchor_spec.rb +57 -0
  274. data/spec/core/rack/valid_request_path_spec.rb +67 -0
  275. data/spec/core/style/emptdiary_style_spec.rb +165 -0
  276. data/spec/core/style/etdiary_style_spec.rb +512 -0
  277. data/spec/core/style/gfm_style_spec.rb +334 -0
  278. data/spec/core/style/rd_style_spec.rb +202 -0
  279. data/spec/core/style/tdiary_style_spec.rb +240 -0
  280. data/spec/core/style/wiki_style_spec.rb +441 -0
  281. data/spec/fixtures/ascii8bit-pstore.db +0 -0
  282. data/spec/fixtures/invalid-sequence-volatile.tdr +9 -0
  283. data/spec/fixtures/just_installed.conf +1 -0
  284. data/spec/fixtures/plugin/ja/sample.rb +4 -0
  285. data/spec/fixtures/plugin/sample.rb +6 -0
  286. data/spec/fixtures/sample.rb +12 -0
  287. data/spec/fixtures/tdiary.conf.gem +212 -0
  288. data/spec/fixtures/tdiary.conf.rack +212 -0
  289. data/spec/fixtures/tdiary.conf.rdb +227 -0
  290. data/spec/fixtures/tdiary.conf.secure +204 -0
  291. data/spec/fixtures/tdiary.conf.webrick +212 -0
  292. data/spec/javascripts/00default_spec.js +35 -0
  293. data/spec/javascripts/fixtures/00default.html +1 -0
  294. data/spec/javascripts/support/jasmine.yml +76 -0
  295. data/spec/plugin/bq_spec.rb +24 -0
  296. data/spec/plugin/plugin_helper.rb +203 -0
  297. data/spec/spec_helper.rb +32 -0
  298. data/tdiary.conf.beginner +244 -0
  299. data/tdiary.conf.sample +345 -0
  300. data/tdiary.conf.sample-en +333 -0
  301. data/tdiary.gemspec +26 -0
  302. data/tdiary.rb +151 -0
  303. data/tdiary/admin.rb +236 -0
  304. data/tdiary/application.rb +57 -0
  305. data/tdiary/author_only_base.rb +171 -0
  306. data/tdiary/base.rb +220 -0
  307. data/tdiary/cli.rb +116 -0
  308. data/tdiary/comment.rb +40 -0
  309. data/tdiary/comment_manager.rb +94 -0
  310. data/tdiary/compatible.rb +72 -0
  311. data/tdiary/config.rb +270 -0
  312. data/tdiary/core_ext.rb +122 -0
  313. data/tdiary/deploy.rb +50 -0
  314. data/tdiary/dispatcher.rb +77 -0
  315. data/tdiary/dispatcher/index_main.rb +122 -0
  316. data/tdiary/dispatcher/update_main.rb +101 -0
  317. data/tdiary/environment.rb +15 -0
  318. data/tdiary/filter.rb +48 -0
  319. data/tdiary/filter/default.rb +54 -0
  320. data/tdiary/filter/spam.rb +304 -0
  321. data/tdiary/io/base.rb +70 -0
  322. data/tdiary/io/cache/file.rb +123 -0
  323. data/tdiary/io/cache/memcached.rb +88 -0
  324. data/tdiary/io/cache/redis.rb +100 -0
  325. data/tdiary/io/default.rb +297 -0
  326. data/tdiary/io/pstore.rb +252 -0
  327. data/tdiary/io/rdb.rb +213 -0
  328. data/tdiary/lang/en.rb +79 -0
  329. data/tdiary/lang/ja.rb +72 -0
  330. data/tdiary/plugin.rb +375 -0
  331. data/tdiary/rack/assets/precompile.rb +37 -0
  332. data/tdiary/rack/auth/basic.rb +38 -0
  333. data/tdiary/rack/auth/omniauth.rb +51 -0
  334. data/tdiary/rack/html_anchor.rb +31 -0
  335. data/tdiary/rack/valid_request_path.rb +36 -0
  336. data/tdiary/referer_manager.rb +80 -0
  337. data/tdiary/request.rb +217 -0
  338. data/tdiary/response.rb +29 -0
  339. data/tdiary/server.rb +85 -0
  340. data/tdiary/style.rb +194 -0
  341. data/tdiary/style/tdiary_style.rb +198 -0
  342. data/tdiary/style/wiki_style.rb +213 -0
  343. data/tdiary/tasks.rb +1 -0
  344. data/tdiary/tasks/assets.rake +31 -0
  345. data/tdiary/tasks/auth.rake +28 -0
  346. data/tdiary/tasks/db.rake +110 -0
  347. data/tdiary/tasks/doc.rake +31 -0
  348. data/tdiary/tasks/heroku.rake +37 -0
  349. data/tdiary/tasks/jasmine.rake +16 -0
  350. data/tdiary/tasks/rdoc.rake +24 -0
  351. data/tdiary/tasks/release.rake +122 -0
  352. data/tdiary/tasks/rspec.rake +51 -0
  353. data/tdiary/tasks/server.rake +33 -0
  354. data/tdiary/tasks/test.rake +17 -0
  355. data/tdiary/version.rb +3 -0
  356. data/tdiary/view.rb +468 -0
  357. data/tdiary/view_helper.rb +15 -0
  358. data/test/disp_referrer_test.rb +93 -0
  359. data/test/my-sequel_test.rb +238 -0
  360. data/test/test_helper.rb +7 -0
  361. data/test/test_plugin_helper.rb +64 -0
  362. data/test/test_plugin_helper_test.rb +28 -0
  363. data/test/weather_test.rb +33 -0
  364. data/theme/base.css +268 -0
  365. data/theme/conf.block.png +0 -0
  366. data/theme/conf.css +254 -0
  367. data/theme/default/README +11 -0
  368. data/theme/default/body.png +0 -0
  369. data/theme/default/default.css +743 -0
  370. data/theme/help.png +0 -0
  371. data/theme/loading.gif +0 -0
  372. data/theme/tdiary1/README +7 -0
  373. data/theme/tdiary1/tdiary1.css +394 -0
  374. data/theme/tdiary2/README +19 -0
  375. data/theme/tdiary2/tdiary2.css +624 -0
  376. data/update.fcgi +45 -0
  377. data/update.rb +57 -0
  378. data/vendor/hikidoc-0.0.6/COPYING +28 -0
  379. data/vendor/hikidoc-0.0.6/NEWS +30 -0
  380. data/vendor/hikidoc-0.0.6/NEWS.ja +30 -0
  381. data/vendor/hikidoc-0.0.6/README +86 -0
  382. data/vendor/hikidoc-0.0.6/README.ja +83 -0
  383. data/vendor/hikidoc-0.0.6/Rakefile +68 -0
  384. data/vendor/hikidoc-0.0.6/TextFormattingRules +320 -0
  385. data/vendor/hikidoc-0.0.6/TextFormattingRules.ja +318 -0
  386. data/vendor/hikidoc-0.0.6/bin/hikidoc +66 -0
  387. data/vendor/hikidoc-0.0.6/lib/hikidoc.rb +914 -0
  388. data/vendor/hikidoc-0.0.6/setup.rb +1360 -0
  389. data/vendor/hikidoc-0.0.6/test/run-test.rb +13 -0
  390. data/vendor/hikidoc-0.0.6/test/test_hikidoc.rb +506 -0
  391. data/vendor/imagesize-0.1.1/Manifest.txt +19 -0
  392. data/vendor/imagesize-0.1.1/README.txt +49 -0
  393. data/vendor/imagesize-0.1.1/lib/image_size.rb +305 -0
  394. data/vendor/imagesize-0.1.1/lib/image_size/version.rb +9 -0
  395. data/vendor/imagesize-0.1.1/setup.rb +1585 -0
  396. data/vendor/imagesize-0.1.1/test/2-4-7.png +0 -0
  397. data/vendor/imagesize-0.1.1/test/4_1_2.gif +0 -0
  398. data/vendor/imagesize-0.1.1/test/bmp.bmp +0 -0
  399. data/vendor/imagesize-0.1.1/test/cursor.xbm +6 -0
  400. data/vendor/imagesize-0.1.1/test/detect.swf +0 -0
  401. data/vendor/imagesize-0.1.1/test/pbm.pbm +0 -0
  402. data/vendor/imagesize-0.1.1/test/pcx.pcx +0 -0
  403. data/vendor/imagesize-0.1.1/test/pgm.pgm +5 -0
  404. data/vendor/imagesize-0.1.1/test/test.xpm +38 -0
  405. data/vendor/imagesize-0.1.1/test/test_helper.rb +2 -0
  406. data/vendor/imagesize-0.1.1/test/test_image_size.rb +71 -0
  407. data/vendor/imagesize-0.1.1/test/tiff.tiff +0 -0
  408. data/vendor/imagesize-0.1.1/test/tokyo_tower.jpg +0 -0
  409. data/vendor/imagesize-0.1.1/test/tower_e.gif.psd +0 -0
  410. data/vendor/jasmine-jquery-1.4.2/jasmine-jquery.js +548 -0
  411. data/vendor/jquery-1.8/jquery.js +9227 -0
  412. data/vendor/rdtool-0.6.38/COPYING.txt +339 -0
  413. data/vendor/rdtool-0.6.38/Gemfile +3 -0
  414. data/vendor/rdtool-0.6.38/HISTORY +318 -0
  415. data/vendor/rdtool-0.6.38/LGPL-2.1 +502 -0
  416. data/vendor/rdtool-0.6.38/LICENSE.txt +58 -0
  417. data/vendor/rdtool-0.6.38/README.html +66 -0
  418. data/vendor/rdtool-0.6.38/README.ja.html +73 -0
  419. data/vendor/rdtool-0.6.38/README.rd +76 -0
  420. data/vendor/rdtool-0.6.38/README.rd.ja +85 -0
  421. data/vendor/rdtool-0.6.38/Rakefile +152 -0
  422. data/vendor/rdtool-0.6.38/TODO +22 -0
  423. data/vendor/rdtool-0.6.38/bin/rd2 +283 -0
  424. data/vendor/rdtool-0.6.38/bin/rdswap.rb +207 -0
  425. data/vendor/rdtool-0.6.38/doc/rd-draft.html +456 -0
  426. data/vendor/rdtool-0.6.38/doc/rd-draft.ja.html +466 -0
  427. data/vendor/rdtool-0.6.38/doc/rd-draft.rd +479 -0
  428. data/vendor/rdtool-0.6.38/doc/rd-draft.rd.ja +487 -0
  429. data/vendor/rdtool-0.6.38/lib/rd/block-element.rb +114 -0
  430. data/vendor/rdtool-0.6.38/lib/rd/complex-list-item.rb +65 -0
  431. data/vendor/rdtool-0.6.38/lib/rd/desclist.rb +55 -0
  432. data/vendor/rdtool-0.6.38/lib/rd/document-struct.rb +46 -0
  433. data/vendor/rdtool-0.6.38/lib/rd/dot.rd2rc +18 -0
  434. data/vendor/rdtool-0.6.38/lib/rd/element.rb +160 -0
  435. data/vendor/rdtool-0.6.38/lib/rd/filter.rb +255 -0
  436. data/vendor/rdtool-0.6.38/lib/rd/head-filter.rb +14 -0
  437. data/vendor/rdtool-0.6.38/lib/rd/inline-element.rb +233 -0
  438. data/vendor/rdtool-0.6.38/lib/rd/labeled-element.rb +14 -0
  439. data/vendor/rdtool-0.6.38/lib/rd/list.rb +57 -0
  440. data/vendor/rdtool-0.6.38/lib/rd/loose-struct.rb +11 -0
  441. data/vendor/rdtool-0.6.38/lib/rd/methodlist.rb +57 -0
  442. data/vendor/rdtool-0.6.38/lib/rd/output-format-visitor.rb +30 -0
  443. data/vendor/rdtool-0.6.38/lib/rd/package.rb +4 -0
  444. data/vendor/rdtool-0.6.38/lib/rd/parser-util.rb +14 -0
  445. data/vendor/rdtool-0.6.38/lib/rd/post-install +1 -0
  446. data/vendor/rdtool-0.6.38/lib/rd/pre-setup.rb +18 -0
  447. data/vendor/rdtool-0.6.38/lib/rd/rbl-file.rb +69 -0
  448. data/vendor/rdtool-0.6.38/lib/rd/rbl-suite.rb +37 -0
  449. data/vendor/rdtool-0.6.38/lib/rd/rd-struct.rb +86 -0
  450. data/vendor/rdtool-0.6.38/lib/rd/rd2html-ext-lib.rb +266 -0
  451. data/vendor/rdtool-0.6.38/lib/rd/rd2html-ext-opt.rb +34 -0
  452. data/vendor/rdtool-0.6.38/lib/rd/rd2html-lib.rb +490 -0
  453. data/vendor/rdtool-0.6.38/lib/rd/rd2html-opt.rb +67 -0
  454. data/vendor/rdtool-0.6.38/lib/rd/rd2man-lib.rb +251 -0
  455. data/vendor/rdtool-0.6.38/lib/rd/rd2rdo-lib.rb +19 -0
  456. data/vendor/rdtool-0.6.38/lib/rd/rd2rmi-lib.rb +32 -0
  457. data/vendor/rdtool-0.6.38/lib/rd/rdblockparser.ry +518 -0
  458. data/vendor/rdtool-0.6.38/lib/rd/rdblockparser.tab.rb +1061 -0
  459. data/vendor/rdtool-0.6.38/lib/rd/rdfmt.rb +15 -0
  460. data/vendor/rdtool-0.6.38/lib/rd/rdinlineparser.ry +503 -0
  461. data/vendor/rdtool-0.6.38/lib/rd/rdinlineparser.tab.rb +1243 -0
  462. data/vendor/rdtool-0.6.38/lib/rd/rdvisitor.rb +214 -0
  463. data/vendor/rdtool-0.6.38/lib/rd/reference-resolver.rb +114 -0
  464. data/vendor/rdtool-0.6.38/lib/rd/search-file.rb +14 -0
  465. data/vendor/rdtool-0.6.38/lib/rd/tree.rb +103 -0
  466. data/vendor/rdtool-0.6.38/lib/rd/version.rb +41 -0
  467. data/vendor/rdtool-0.6.38/lib/rd/visitor.rb +86 -0
  468. data/vendor/rdtool-0.6.38/rdtool.gemspec +125 -0
  469. data/vendor/rdtool-0.6.38/setup.rb +1596 -0
  470. data/vendor/rdtool-0.6.38/test/data/includee1.html +1 -0
  471. data/vendor/rdtool-0.6.38/test/data/includee2.html +1 -0
  472. data/vendor/rdtool-0.6.38/test/data/includee3.nothtml +1 -0
  473. data/vendor/rdtool-0.6.38/test/data/includee4.xhtml +0 -0
  474. data/vendor/rdtool-0.6.38/test/data/label.rbl +2 -0
  475. data/vendor/rdtool-0.6.38/test/data/label2.rbl +2 -0
  476. data/vendor/rdtool-0.6.38/test/data/sub/includee2.html +1 -0
  477. data/vendor/rdtool-0.6.38/test/data/sub/includee4.html +0 -0
  478. data/vendor/rdtool-0.6.38/test/dummy-observer.rb +6 -0
  479. data/vendor/rdtool-0.6.38/test/dummy.rb +33 -0
  480. data/vendor/rdtool-0.6.38/test/temp-dir.rb +19 -0
  481. data/vendor/rdtool-0.6.38/test/test-block-parser.rb +46 -0
  482. data/vendor/rdtool-0.6.38/test/test-desclist-item.rb +219 -0
  483. data/vendor/rdtool-0.6.38/test/test-document-element.rb +46 -0
  484. data/vendor/rdtool-0.6.38/test/test-document-struct.rb +66 -0
  485. data/vendor/rdtool-0.6.38/test/test-element.rb +46 -0
  486. data/vendor/rdtool-0.6.38/test/test-headline.rb +80 -0
  487. data/vendor/rdtool-0.6.38/test/test-inline-parser.rb +46 -0
  488. data/vendor/rdtool-0.6.38/test/test-list-item.rb +54 -0
  489. data/vendor/rdtool-0.6.38/test/test-list.rb +53 -0
  490. data/vendor/rdtool-0.6.38/test/test-methodlist-item.rb +73 -0
  491. data/vendor/rdtool-0.6.38/test/test-nonterminal-element.rb +170 -0
  492. data/vendor/rdtool-0.6.38/test/test-nonterminal-inline.rb +33 -0
  493. data/vendor/rdtool-0.6.38/test/test-output-format-visitor.rb +48 -0
  494. data/vendor/rdtool-0.6.38/test/test-parser-util.rb +41 -0
  495. data/vendor/rdtool-0.6.38/test/test-rbl-file.rb +156 -0
  496. data/vendor/rdtool-0.6.38/test/test-rbl-suite.rb +43 -0
  497. data/vendor/rdtool-0.6.38/test/test-rd2html-lib.rb +496 -0
  498. data/vendor/rdtool-0.6.38/test/test-rdtree.rb +17 -0
  499. data/vendor/rdtool-0.6.38/test/test-rdvisitor.rb +29 -0
  500. data/vendor/rdtool-0.6.38/test/test-reference-resolver.rb +202 -0
  501. data/vendor/rdtool-0.6.38/test/test-reference.rb +132 -0
  502. data/vendor/rdtool-0.6.38/test/test-search-file.rb +22 -0
  503. data/vendor/rdtool-0.6.38/test/test-terminal-inline.rb +41 -0
  504. data/vendor/rdtool-0.6.38/test/test-textblock.rb +44 -0
  505. data/vendor/rdtool-0.6.38/test/test-tree.rb +82 -0
  506. data/vendor/rdtool-0.6.38/test/test-version.rb +57 -0
  507. data/vendor/rdtool-0.6.38/test/test-visitor.rb +230 -0
  508. data/vendor/rdtool-0.6.38/utils/rd-mode.el +464 -0
  509. metadata +666 -0
@@ -0,0 +1,466 @@
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>