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