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,479 @@
1
+ = RD working draft
2
+ Japanese version is ((<here|URL:http://www.ruby-lang.org/~rubikitch/RDP.cgi?cmd=view&name=RD>)).
3
+
4
+ == What is RD?
5
+
6
+ RD is Ruby's POD, embeddable documentation format in script file.
7
+
8
+ RD is influenced mainly from plain2, a program to translate from plain text to
9
+ some mark-up language. So, RD looks like plain text, and its simpleness and
10
+ neatness make it easy to read and write.
11
+
12
+ == How does the interpreter work for RD?
13
+
14
+ Ruby's interpreter, (({ruby})), simply ignores text between a line beginning
15
+ with "(({=begin}))" and one beginning with "(({=end}))". So, RD is not only
16
+ embeddable. You can write anything between (({=begin})) and (({=end})). RD is
17
+ one of them, but RD will be a standard one.((- If you are interested in others,
18
+ see rubyapi2
19
+ ((<URL:http://www.ueda.info.waseda.ac.jp/~igarashi/ruby/xml.html#rubyapi2>))
20
+ for example. -))
21
+
22
+ == Concepts and Syntax
23
+ === Element, Block and Inline
24
+
25
+ We will use the term "Element" for features of RD which add information
26
+ of document structure to text. In addition, we use a term
27
+ "((<Block>))" for Elements for large and global structures, and a term
28
+ "((<Inline>))" for ones for small and local decorations.
29
+
30
+ Paragraph, headline or list is a kind of Block. RD uses indentation and
31
+ special characters to describe Blocks. You can also write complicated
32
+ structure to nested Blocks. And this style of Block looks naturally like
33
+ plain text format. See ((<Block>)) for details.
34
+
35
+ Emphasis, code or reference is a kind of Inline. Parentheses and special
36
+ characters, like (('((? ... ?))')), are used for Inline. Almost all
37
+ Inline may be nested inside each other. See ((<Inline>)) for more details.
38
+
39
+ === Block
40
+ ==== Basic Syntax
41
+
42
+ Block has line oriented syntax. i.e. each character on the same line belongs to the
43
+ same Block. And the indentation of the line represents nesting level and type of Block.
44
+ The first character of the line represents the type of Block.
45
+
46
+ + Concepts and Terms
47
+
48
+ :Baseline
49
+ Baseline is standard depth of indent. Relative depth between indent of one
50
+ line and Baseline affects its Block-type.
51
+
52
+ :Head Char
53
+ Head Char is the first character of line, except whitespace.
54
+
55
+ :STRINGLINE
56
+ STRINGLINE is line which consists of strings.
57
+ STRINGLINE doesn't have "(({*}))", "(({(((|num|)))}))", "(({:}))", "(({=}))"
58
+ nor "(({+}))" as Head Char. But if the line is indented, "(({=}))" and "(({+}))"
59
+ can be Head Char.
60
+
61
+ :WHITELINE
62
+ WHITELINE is a line which consists of whitespace, "(({\s}))", "(({\t}))" and
63
+ "(({\n}))".
64
+
65
+ :Comment
66
+ A line which is matched with (({/^#/})) is regarded as a comment.
67
+
68
+ + How Baseline is defined and how it works
69
+ At the top level, Baseline is at left end, i.e., indent is 0. In List,
70
+ Baseline is defined by first Block of ListItem. For example,
71
+
72
+ Example: "|" means Baseline
73
+ |Regard this line as one of TextBlock's in top level.
74
+ |<- So this Baseline is at the left-most position.
75
+ *|it is in List. (1)
76
+ |<- this Baseline is defined by the marked with a (1).
77
+ * |Different Item of List can have different Baseline inside.
78
+ |<- So this Baseline differs from one of this list's first item.
79
+
80
+ |Regard this line as one of TextBlock's in top level.
81
+ |<- So this Baseline is at the left-most position.
82
+ *|it is in List. (1)
83
+ |<- this Baseline is defined by the marked with a (1).
84
+ * |Different Items in Lists can have different Baselines inside.
85
+ |<- So this Baseline differs from the one of this list's first item.
86
+
87
+
88
+ If one Block is nested in another Block, the Baseline of the inside Blocks is deeper
89
+ than the Baseline of outside Blocks.
90
+
91
+ The relative position between Baseline and indent affects the type of Block.
92
+ If a ((<STRINGLINE>)) has same indent with Baseline, it belongs to
93
+ ((<TextBlock>)), otherwise, i.e. it has deeper indent than Baseline,
94
+ it belongs to ((<Verbatim>)).
95
+
96
+ ==== Types of Block
97
+ + Headline
98
+
99
+ Headline consists of a line which ((<Head Char>)) is "(({=}))" or
100
+ "(({+}))". And Headline can't include more than one line. Headline can
101
+ be on only top level.
102
+ Example:
103
+ |<- Regard this as top level Baseline.
104
+ = Headline 1.
105
+ === Headline 1.1.1.
106
+ + Headline 1.1.1.1.1.
107
+
108
+ = Headline 1.
109
+ === Headline 1.1.1.
110
+ + Headline 1.1.1.1.1.
111
+
112
+ Headline Mark represents level of Headline. See following figure. first
113
+ Mark is biggest one, and last Mark has two parts.
114
+ Fig: Headline Marks
115
+ =
116
+ ==
117
+ ===
118
+ ====
119
+ +
120
+ ++
121
+
122
+ Text which follows Mark is title of Headline. It is also used as Label of
123
+ ((<Reference>)).
124
+
125
+ Title of Headline can contain ((<Inline>))s except for ((<Reference>)) and
126
+ Footnote.
127
+
128
+ + Include
129
+
130
+ Include is a line that line head "(({<<<}))" and included file name.
131
+ You can input from other file text, both RD and target format, with Include.
132
+
133
+ When you include RD file, included file name have to have ".rd" or ".rb" as
134
+ suffix, like "foo.rd", and write full name (not full path) of file after
135
+ "(({<<<}))". For example,
136
+ <<< foo.rd
137
+
138
+ When you include target format file, include file name have to have suffix
139
+ of target format standard one, for example ".html" in the case of outputting
140
+ HTML, ".texi" in the case of outputting Texinfo, and write base name of file
141
+ after "(({<<<}))". For example,
142
+ <<< foo
143
+ RD formatter include "foo.html" to output HTML, and include "foo.texi" to
144
+ output Texinfo. If you want to use Include for target format, you should
145
+ prepare plural type of included file.
146
+
147
+ + TextBlock
148
+
149
+ TextBlock is composed of ((<STRINGLINE>))s, but the ((<STRINGLINE>))s
150
+ must have same indent with ((<Baseline>)). If its indent is deeper
151
+ than ((<Baseline>)), the ((<STRINGLINE>)) belongs to ((<Verbatim>)).
152
+
153
+ TextBlock can include ((<Inline>)) inside.
154
+
155
+ Example:
156
+ |
157
+ This is TextBlock.
158
+ Second line of same TextBlock.
159
+ This line is not TextBlock, but Verbatim.
160
+ * And this line is List. (But this line is exactly TextBlock in ListItem.)
161
+
162
+ And this example is formatted such like:
163
+
164
+ This is TextBlock.
165
+ Second line of same TextBlock.
166
+ This line is not TextBlock, but Verbatim.
167
+ * And this line is List. (But this line is exactly TextBlock in ListItem.)
168
+
169
+ + Verbatim
170
+
171
+ You can use Verbatim to cite Ruby script. Verbatim is composed of
172
+ ((<STRINGLINE>))s, and they must be indented deeper than
173
+ ((<Baseline>)). Verbatim can also include a line whose ((<Head Char>)) is
174
+ "(({*}))", "(({(1)}))" and "(({:}))", But it can't be first line of
175
+ Verbatim, it is regarded as ((<List>)). Verbatim can't include a line
176
+ which is indented shallower than first line. Verbatim can include
177
+ ((<WHITELINE>)).
178
+
179
+ You can't use ((<Inline>)) in Verbatim.
180
+
181
+ Example:
182
+ This is Verbatim.
183
+ Even if a line is indented deeper than first line, it is also in same
184
+ Verbatim.
185
+ * A line seems like list is also included in Verbatim.
186
+ But if the line is indented shallower, it is not in same Verbatim.
187
+ It is in other Verbatim.
188
+
189
+ And this example is formatted such like:
190
+
191
+ This is Verbatim.
192
+ Even if a line is indented deeper than first line, it is also in same
193
+ Verbatim.
194
+ * A line seems like list is also included in Verbatim.
195
+ But if the line is indented shallower, it is not in same Verbatim.
196
+ It is in other Verbatim.
197
+
198
+ + List
199
+
200
+ List is special ((<Block>)). List is composed of ListItems, and
201
+ ListItem is composed of Blocks. So List can include Blocks inside,
202
+ even also List itself.((- But List can't include ((<Headline>))
203
+ nor ((<Include>)). -))
204
+
205
+ ListItem can include ((<WHITELINE>)), and ((<TextBlock>)) can't
206
+ include WHITELINE, so when you want to write 2 TextBlock inside
207
+ ListItem, put a WHITELINE between TextBlocks.
208
+
209
+ There is 3 type of List, "((<ItemList>))", "((<EnumList>))",
210
+ "((<DescList>))" and "((<MethodList>)).
211
+
212
+ ++ ItemList
213
+
214
+ ItemList is simple and not numbered List. ItemListItem begins by a line
215
+ whose ((<Head Char>)) is "(({*}))", and first Block of ItemListItem must be
216
+ ((<TextBlock>)).
217
+
218
+ Example:
219
+ * first item of parent list
220
+ * first item of sub list
221
+ * second item of sub list
222
+ text block ( line of first item of parent list)
223
+
224
+ And this example is formatted such like:
225
+
226
+ * first item of parent list
227
+ * first item of sub list
228
+ * second item of sub list
229
+ text block ( line of first item of parent list)
230
+
231
+ ++ EnumList
232
+
233
+ EnumList is numbered List. EnumListItem starts with a line whose
234
+ ((<Head Char>)) is "(({(((|num|)))}))"(((|num|)) is integer). EnumList
235
+ is same as ((<ItemList>)) on other points.
236
+
237
+ Example:
238
+ (1) first line of parent list
239
+ * first line of sub list(ItemList)
240
+ (2) second list of parent list
241
+ (10) number is ignored...
242
+
243
+ And this example is formatted such like:
244
+
245
+ (1) first line of parent list
246
+ * first line of sub list(ItemList)
247
+ (2) second list of parent list
248
+ (10) number is ignored...
249
+
250
+ ++ DescList
251
+
252
+ DescList is List for descriptions. DescListItem has 2 part. One is Term part,
253
+ the other is Description part. Term of DescListItem is also used as Label
254
+ for ((<Reference>)).
255
+
256
+ Term part is composed of a line whose ((<Head Char>)) is "(({:}))",
257
+ and Term part is same as ((<Headline>)), except that a line of Term
258
+ part can be indented.
259
+
260
+ Description part is starts with next line of Term part. ((<Baseline>)) of
261
+ Description part must be same or deeper than term of Term part of its pair.
262
+ For example, following style is illegal.
263
+ Example:
264
+ : |Term
265
+ |Description.
266
+
267
+ Description part can include ((<Block>))s. ((<List>)) can be first
268
+ Block of Description part. Term part can contain ((<Inline>))s except
269
+ for ((<Reference>)) and ((<Footnote>)).
270
+
271
+ Example:
272
+ :Term
273
+ first line of Description
274
+ second line of Description
275
+ :Term2
276
+ * also include List
277
+ * ...
278
+
279
+ And this example is formatted such like:
280
+
281
+ :Term
282
+ first line of definition.
283
+ second line of definition
284
+ :Term2
285
+ * also include list
286
+ * ...
287
+
288
+ ++ MethodList
289
+
290
+ MethodList is the special type of ((<DescList>)) for explanation
291
+ methods of your classes. MethodList is similar with ((<DescList>)) in
292
+ almost all part, but it is labeled differently. RD formatters know it
293
+ is some kind of program code, e.g. method or constants of class in
294
+ Ruby or function prototype in C..., which is on Term part of
295
+ MethodList. So, MethodList is labeled without the part which seems to
296
+ be parameters of methods. See ((<Label and Reference>)) for more
297
+ detail.
298
+
299
+ Each item of MethodList has Term part and Description part like
300
+ ((<DescList>)). And its Term part start with its ((<Head Char>)),
301
+ "(({---}))". Its Description part can contain ((<TextBlock>)),
302
+ ((<Verbatim>)) and ((<List>)). But you shouldn't write MethodList
303
+ in any kind of ((<List>)). RD will come to deny it possibly in
304
+ future.
305
+
306
+ Example:
307
+ --- Array#each {|i| ... } # => labeled as "Array#each"
308
+ yield block for each item.
309
+ --- Array#index(val) # => labeled as "Array#index"
310
+ return index of first item which equals with ((|val|)). if it hasn't
311
+ same item, return (({nil})).
312
+
313
+ And this example is formatted such like:
314
+
315
+ --- Array#each {|i| ... }
316
+ yield block for each item.
317
+ --- Array#index(val)
318
+ return index of first item which equals with ((|val|)). if it hasn't
319
+ same item, return (({nil})).
320
+
321
+ Some formatter assumes it is Ruby's methods, constants or etc. which
322
+ is in Term part of MethodList. it can format term part of MethodList
323
+ intelligently, but you have to write according as specific formula
324
+ to make the best of its feature.
325
+
326
+ Standard Ruby class reference formula is suggested such like:
327
+ : instance method
328
+ instance method ((|method|)) of class ((|Class|))
329
+ Class#method(its params ...) { parameter block }
330
+ : class method (class singleton method)
331
+ class method ((|method|)) of class ((|Class|))
332
+ Class.method(its params ...) { parameter block }
333
+ : class constants
334
+ constant ((|Const|)) of class ((|Class|))
335
+ Class::Const
336
+ : functions (private methods on top level)
337
+ function ((|func|))
338
+ function#func(its params ...) { parameter block }
339
+
340
+ Ruby use some symbol characters (e.g. [], []=, +, - or <<) for the names
341
+ of methods. ruby, Ruby interpreter, parses them with different manner from
342
+ normal methods, but write them as same as others in this formula.
343
+
344
+ Example:
345
+ --- Array#[](key)
346
+ return value which in at index ((|key|)).
347
+ --- Array#[]=(key, value)
348
+ put ((|value|)) into cell of index ((|key|)).
349
+ --- Array#+(other)
350
+ return concatenated (({Array})).
351
+
352
+ === Inline
353
+
354
+ You can use Inline in ((<TextBlock>)), ((<Headline>)) and Term part of
355
+ ((<DescList>)). Common style of parentheses is used for Inline. Inline
356
+ can nest each other.
357
+
358
+ in following list of Inlines, preformatted text is on left hand side
359
+ and postformatted text is on right hand side.
360
+
361
+ :(('((*Em*))')) => ((*Em*))
362
+ Emphasis.
363
+
364
+ :(('(({while gets...}))')) => (({while gets...}))
365
+ Code.
366
+
367
+ :(('((|var|))')) => ((|var|))
368
+ Var.((- You can read very good explanation about Var in texinfo.info. -))
369
+
370
+ :(('((%ruby -v%))')) => ((%ruby -v%))
371
+ Keyboard.
372
+
373
+ :(('((:Term:))'))
374
+ => ((:Term:))
375
+
376
+ Term of Index.
377
+
378
+ :(('((<Identity or URL>))'))
379
+ => ((<Identity or URL>))
380
+
381
+ Link, Reference. See ((<RD/Label and Reference>)) for more detail.
382
+
383
+ :(('((-Footnote-))'))
384
+ => ((-Footnote-))
385
+
386
+ Footnote.
387
+
388
+ :(('(('verb\'))')) => (('verb'))
389
+ Inline Verbatim.
390
+
391
+ ==== Label and Reference
392
+
393
+ Reference needs Label. In RD, only title of ((<Headline>)) and Term of
394
+ ((<DescList>)) and ((<MethodList>)) is regarded as Label. So, you must
395
+ choose different titles for different ((<Headline>))s. This problem
396
+ has not resolved yet.
397
+
398
+ + How to RD generates Label from Headline, DescList or MethodList
399
+
400
+ Title of ((<Headline>)) and Term part of ((<DescList>)) and ((<MethodList>))
401
+ are regarded as Label. But they can contain ((<Inline>))s, so the situation
402
+ isn't so simple.
403
+
404
+ First, ((<MethodList>)) is special in the part of Labeling. Term part of
405
+ ((<MethodList>)) can't contain ((<Inline>))s, and RD assumes it is method
406
+ reference or such thing which is in Term part of ((<MethodList>)). So
407
+ it is Labeled under following rules.
408
+
409
+ (1) It is regarded as Label which is before a character of "(({(}))" or
410
+ "(({{}))".((- text inside "(({(...)}))" is regarded as parameters
411
+ of method, and text inside "(({{...}}))" is regarded as parameter
412
+ block of methods.-))
413
+
414
+ Following example will help you to understand how this rule works. the Label
415
+ which is generated from the term part of ((<MethodList>)) is after mark of
416
+ "(({# =>}))".
417
+
418
+ Example:
419
+ --- Array.new([size[, val]]) # => Array.new
420
+ --- Array#[]=(key, val) # => Array#[]=
421
+ --- Array#each { ... } # => Array#each
422
+ --- void rb_define_method(VALUE class, ...) # => void rb_define_method
423
+
424
+ Second, in the case of title of ((<Headline>)) or term part of ((<DescList>)),
425
+ there is not such a special rule. But you can use ((<Inline>))s for text on
426
+ them, so there are rules to strip ((<Inline>)) mark-ups from text.
427
+
428
+ (1) Any ((<Inline>)) mark-ups makes any difference to Label. So, both
429
+ = ((*Headline*))
430
+ and
431
+ = Headline
432
+ are Labeled as "Headline".
433
+ (2) But white spaces which is after open parenthesis and before close
434
+ parenthesis of ((<Inline>)) are striped when RD generates Label from
435
+ it. So, both
436
+ = ((* Headline *))
437
+ and
438
+ = ((*Headline*))
439
+ are Labeled as "Headline".
440
+
441
+ + Reference
442
+
443
+ You can refer Labeled element with Reference which is a kind of ((<Inline>))
444
+ marked up with (('((<...>))')).
445
+
446
+ Most simple use of Reference is to write Label inside parenthesis.
447
+ ((<Label>))
448
+ This works as reference to Label of "Label" and text "Label" is used
449
+ also for display such like: ((<Label>)).((- There is no element Labeled
450
+ "Label", so it doesn't seems to be Reference probably. -))
451
+
452
+ When you want to refer a resource pointed with URL, write such like:
453
+ ((<URL:http://www.ruby-lang.org/en/raa.html>))
454
+ RD formatter will format it as hyper-link to its URL if possible
455
+ such like:((<URL:http://www.ruby-lang.org/en/raa.html>)).
456
+
457
+ When you want to use other text than Label for display, write such like:
458
+ ((<Text for display|Label>))
459
+ "Text for display" is used for display and "Label" is used as Label to
460
+ refer such like: ((<Text for display|Label>))
461
+
462
+ Text for display can contain some ((<Inline>)), except for Footnotes and
463
+ Reference.
464
+
465
+ In Reference, "|" and "/" are syntax keywords. So if you will write them
466
+ inside Reference, you have to double-quote the part it's inside, such like:
467
+ ((<"Bar | inside display text"|Label>))
468
+ ((<"Bar | inside display text"|Label>))
469
+
470
+ The situations are same whether you will write them inside Substitution
471
+ part, Filename part and Label part.
472
+
473
+ Of course, you can use the text for the display for Reference to URL resource.
474
+ ((<Ruby Application Archive|URL:http://www.ruby-lang.org/en/raa.html>))
475
+ ((<Ruby Application Archive|URL:http://www.ruby-lang.org/en/raa.html>))
476
+
477
+ When the text for the display is omitted, you can use ((<Inline>)) for Label.
478
+ ((<((*Label*))>))
479
+ ((<((*Label*))>))