tdiary 3.2.2.20130507
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.coveralls.yml +1 -0
- data/.gitignore +16 -0
- data/.travis.yml +29 -0
- data/Capfile +2 -0
- data/ChangeLog +3173 -0
- data/Gemfile +58 -0
- data/Gemfile.lock +201 -0
- data/LICENSE +340 -0
- data/Procfile +1 -0
- data/README.md +33 -0
- data/Rakefile +26 -0
- data/bin/tdiary +7 -0
- data/config.ru +61 -0
- data/data/.htaccess +2 -0
- data/doc/HOWTO-authenticate-in-rack.md +89 -0
- data/doc/HOWTO-make-io.md +305 -0
- data/doc/HOWTO-make-plugin.md +279 -0
- data/doc/HOWTO-make-theme.md +67 -0
- data/doc/HOWTO-testing-tDiary.md +44 -0
- data/doc/HOWTO-use-plugin.md +148 -0
- data/doc/HOWTO-write-tDiary.en.md +131 -0
- data/doc/HOWTO-write-tDiary.md +136 -0
- data/doc/INSTALL-paas.md +202 -0
- data/doc/INSTALL.md +160 -0
- data/doc/README.en.md +174 -0
- data/doc/README.md +56 -0
- data/doc/UPGRADE.md +164 -0
- data/doc/doc.css +115 -0
- data/dot.htaccess +27 -0
- data/index.fcgi +45 -0
- data/index.rb +57 -0
- data/js/00default.js +60 -0
- data/js/01conf.js +62 -0
- data/js/02edit.coffee +5 -0
- data/js/02edit.js +15 -0
- data/js/amazon.js +43 -0
- data/js/calendar3.js +130 -0
- data/js/caretposition.js +170 -0
- data/js/category.js +29 -0
- data/js/category_autocomplete.js +96 -0
- data/js/comment_ajax.js +27 -0
- data/js/draft.js +149 -0
- data/js/highlight.js +36 -0
- data/js/image.js +181 -0
- data/misc/convert2.rb +123 -0
- data/misc/filter/antispamservice.rb +101 -0
- data/misc/filter/limitdays.rb +40 -0
- data/misc/filter/linkcheck.rb +81 -0
- data/misc/filter/plugin/antispamservice.rb +82 -0
- data/misc/filter/plugin/en/antispamservice.rb +21 -0
- data/misc/filter/plugin/ja/antispamservice.rb +20 -0
- data/misc/lib/README +4 -0
- data/misc/lib/compatible.rb +1 -0
- data/misc/lib/fcgi_patch.rb +90 -0
- data/misc/migrate.rb +157 -0
- data/misc/paas/cloudfoundry/Gemfile +26 -0
- data/misc/paas/cloudfoundry/Gemfile.lock +85 -0
- data/misc/paas/heroku/Gemfile +22 -0
- data/misc/paas/heroku/Gemfile.lock +85 -0
- data/misc/paas/sqale/Gemfile +19 -0
- data/misc/paas/sqale/Gemfile.lock +85 -0
- data/misc/paas/sqale/Procfile +1 -0
- data/misc/paas/sqale/dot.env +1 -0
- data/misc/plugin/ChangeLog.DO_NOT_UPDATE +2333 -0
- data/misc/plugin/a.rb +211 -0
- data/misc/plugin/amazon.rb +403 -0
- data/misc/plugin/amazon/README.en +17 -0
- data/misc/plugin/amazon/README.ja +29 -0
- data/misc/plugin/amazon/amazonimg.rb +113 -0
- data/misc/plugin/amazon/large.png +0 -0
- data/misc/plugin/amazon/medium.png +0 -0
- data/misc/plugin/amazon/small.png +0 -0
- data/misc/plugin/append-css.rb +51 -0
- data/misc/plugin/bq.rb +48 -0
- data/misc/plugin/calendar2.rb +184 -0
- data/misc/plugin/calendar3.rb +256 -0
- data/misc/plugin/category.rb +779 -0
- data/misc/plugin/category_autocomplete.rb +33 -0
- data/misc/plugin/comment_ajax.rb +11 -0
- data/misc/plugin/comment_mail-qmail.rb +57 -0
- data/misc/plugin/comment_mail-sendmail.rb +56 -0
- data/misc/plugin/comment_mail-smtp.rb +59 -0
- data/misc/plugin/comment_rank.rb +36 -0
- data/misc/plugin/counter.rb +631 -0
- data/misc/plugin/daily_theme.rb +55 -0
- data/misc/plugin/disp_referrer.rb +1486 -0
- data/misc/plugin/doctype-html401tr.rb +16 -0
- data/misc/plugin/draft.rb +20 -0
- data/misc/plugin/dropdown_calendar.rb +32 -0
- data/misc/plugin/edit_today.rb +50 -0
- data/misc/plugin/en/a.rb +10 -0
- data/misc/plugin/en/amazon.rb +71 -0
- data/misc/plugin/en/append-css.rb +17 -0
- data/misc/plugin/en/bq.rb +12 -0
- data/misc/plugin/en/calendar2.rb +12 -0
- data/misc/plugin/en/category.rb +204 -0
- data/misc/plugin/en/counter.rb +48 -0
- data/misc/plugin/en/daily_theme.rb +14 -0
- data/misc/plugin/en/disp_referrer.rb +387 -0
- data/misc/plugin/en/dropdown_calendar.rb +14 -0
- data/misc/plugin/en/edit_today.rb +22 -0
- data/misc/plugin/en/hide-mail-field.rb +19 -0
- data/misc/plugin/en/highlight.rb +29 -0
- data/misc/plugin/en/image.rb +54 -0
- data/misc/plugin/en/kw.rb +22 -0
- data/misc/plugin/en/makerss.rb +47 -0
- data/misc/plugin/en/pb-show.rb +21 -0
- data/misc/plugin/en/ping.rb +16 -0
- data/misc/plugin/en/recent_comment.rb +44 -0
- data/misc/plugin/en/recent_comment3.rb +56 -0
- data/misc/plugin/en/recent_rss.rb +33 -0
- data/misc/plugin/en/referer_scheme.rb +48 -0
- data/misc/plugin/en/search_control.rb +74 -0
- data/misc/plugin/en/search_form.rb +22 -0
- data/misc/plugin/en/speed_comment.rb +19 -0
- data/misc/plugin/en/tb-show.rb +37 -0
- data/misc/plugin/en/todo.rb +43 -0
- data/misc/plugin/en/weather.rb +185 -0
- data/misc/plugin/en/xmlrpc.rb +14 -0
- data/misc/plugin/footnote.rb +92 -0
- data/misc/plugin/gradation.rb +39 -0
- data/misc/plugin/gradient.rb +36 -0
- data/misc/plugin/hide-mail-field.rb +50 -0
- data/misc/plugin/highlight.rb +22 -0
- data/misc/plugin/html_anchor.rb +34 -0
- data/misc/plugin/image.rb +290 -0
- data/misc/plugin/ja/amazon.rb +89 -0
- data/misc/plugin/ja/bq.rb +13 -0
- data/misc/plugin/ja/calendar2.rb +12 -0
- data/misc/plugin/ja/category.rb +212 -0
- data/misc/plugin/ja/daily_theme.rb +15 -0
- data/misc/plugin/ja/disp_referrer.rb +644 -0
- data/misc/plugin/ja/edit_today.rb +23 -0
- data/misc/plugin/ja/hide-mail-field.rb +20 -0
- data/misc/plugin/ja/highlight.rb +30 -0
- data/misc/plugin/ja/makerss.rb +44 -0
- data/misc/plugin/ja/my-sequel.rb +52 -0
- data/misc/plugin/ja/pb-show.rb +23 -0
- data/misc/plugin/ja/ping.rb +17 -0
- data/misc/plugin/ja/recent_comment.rb +45 -0
- data/misc/plugin/ja/recent_comment3.rb +57 -0
- data/misc/plugin/ja/recent_rss.rb +34 -0
- data/misc/plugin/ja/referer_scheme.rb +86 -0
- data/misc/plugin/ja/search_control.rb +75 -0
- data/misc/plugin/ja/search_form.rb +32 -0
- data/misc/plugin/ja/tb-show.rb +38 -0
- data/misc/plugin/ja/todo.rb +46 -0
- data/misc/plugin/ja/weather.rb +402 -0
- data/misc/plugin/ja/xmlrpc.rb +15 -0
- data/misc/plugin/kw.rb +150 -0
- data/misc/plugin/list.rb +40 -0
- data/misc/plugin/makelirs.rb +89 -0
- data/misc/plugin/makerss.rb +744 -0
- data/misc/plugin/my-ex.rb +68 -0
- data/misc/plugin/my-sequel.rb +539 -0
- data/misc/plugin/navi_user.rb +19 -0
- data/misc/plugin/number_anchor.rb +47 -0
- data/misc/plugin/pb-show.rb +165 -0
- data/misc/plugin/ping.rb +99 -0
- data/misc/plugin/pre_wrap.rb +19 -0
- data/misc/plugin/random_google.rb +165 -0
- data/misc/plugin/recent_comment.rb +82 -0
- data/misc/plugin/recent_comment3.rb +192 -0
- data/misc/plugin/recent_list.rb +91 -0
- data/misc/plugin/recent_namazu.rb +50 -0
- data/misc/plugin/recent_rss.rb +305 -0
- data/misc/plugin/referer-antibot.rb +53 -0
- data/misc/plugin/referer-utf8.rb +12 -0
- data/misc/plugin/referer_scheme.rb +87 -0
- data/misc/plugin/search_control.rb +227 -0
- data/misc/plugin/search_form.rb +53 -0
- data/misc/plugin/sn.rb +107 -0
- data/misc/plugin/speed_comment.rb +68 -0
- data/misc/plugin/squeeze.rb +272 -0
- data/misc/plugin/src.rb +30 -0
- data/misc/plugin/tb-show.rb +212 -0
- data/misc/plugin/title_list.rb +41 -0
- data/misc/plugin/title_tag.rb +80 -0
- data/misc/plugin/tlink.rb +163 -0
- data/misc/plugin/todo.rb +182 -0
- data/misc/plugin/weather.rb +505 -0
- data/misc/plugin/whatsnew.rb +100 -0
- data/misc/plugin/xmlrpc.rb +80 -0
- data/misc/plugin/xmlrpc/README +20 -0
- data/misc/plugin/xmlrpc/xmlrpc.rb +575 -0
- data/misc/style/emptdiary/README.rd +83 -0
- data/misc/style/emptdiary/README.rd.en +78 -0
- data/misc/style/emptdiary/emptdiary_style.rb +199 -0
- data/misc/style/etdiary/README.rd +83 -0
- data/misc/style/etdiary/etdiary_style.rb +446 -0
- data/misc/style/gfm/gfm_style.rb +194 -0
- data/misc/style/rd/README.rd +71 -0
- data/misc/style/rd/rd_style.rb +366 -0
- data/misc/style/wiki/README +116 -0
- data/misc/style/wiki/README.en +101 -0
- data/misc/style/wiki/wiki_parser.rb +273 -0
- data/misc/style/wiki/wiki_style.rb +478 -0
- data/misc/theme_convert/Readme.rd +21 -0
- data/misc/theme_convert/append.rcss +150 -0
- data/misc/theme_convert/theme_convert.rb +453 -0
- data/plugin/00default.rb +1015 -0
- data/plugin/05referer.rb +298 -0
- data/plugin/10spamfilter.rb +183 -0
- data/plugin/50sp.rb +146 -0
- data/plugin/60sf.rb +152 -0
- data/plugin/90migrate.rb +109 -0
- data/plugin/en/00default.rb +390 -0
- data/plugin/en/05referer.rb +49 -0
- data/plugin/en/10spamfilter.rb +81 -0
- data/plugin/en/50sp.rb +56 -0
- data/plugin/en/60sf.rb +60 -0
- data/plugin/ja/00default.rb +401 -0
- data/plugin/ja/05referer.rb +47 -0
- data/plugin/ja/10spamfilter.rb +79 -0
- data/plugin/ja/50sp.rb +66 -0
- data/plugin/ja/60sf.rb +73 -0
- data/public/.gitkeep +0 -0
- data/public/images/.gitkeep +0 -0
- data/public/javascripts/.gitkeep +0 -0
- data/public/stylesheets/.gitkeep +0 -0
- data/skel/category.rhtml +9 -0
- data/skel/conf.rhtml +23 -0
- data/skel/day.rhtml +33 -0
- data/skel/diary.rhtml +83 -0
- data/skel/footer.rhtml +8 -0
- data/skel/header.rhtml +10 -0
- data/skel/i.category.rhtml +6 -0
- data/skel/i.conf.rhtml +14 -0
- data/skel/i.day.rhtml +28 -0
- data/skel/i.diary.rhtml +17 -0
- data/skel/i.footer.rhtml +2 -0
- data/skel/i.header.rhtml +3 -0
- data/skel/i.latest.rhtml +24 -0
- data/skel/i.month.rhtml +39 -0
- data/skel/i.search.rhtml +5 -0
- data/skel/i.update.rhtml +40 -0
- data/skel/i.update.rhtml.en +40 -0
- data/skel/latest.rhtml +27 -0
- data/skel/mail.rtxt +18 -0
- data/skel/mail.rtxt.en +18 -0
- data/skel/month.rhtml +27 -0
- data/skel/plugin_error.rhtml +27 -0
- data/skel/preview.rhtml +85 -0
- data/skel/preview.rhtml.en +72 -0
- data/skel/referer.rhtml +24 -0
- data/skel/search.rhtml +14 -0
- data/skel/tdiary.rconf +76 -0
- data/skel/update.rhtml +103 -0
- data/skel/update.rhtml.en +83 -0
- data/spec/acceptance/append_comment_spec.rb +94 -0
- data/spec/acceptance/append_diary_spec.rb +98 -0
- data/spec/acceptance/bugfix/encoding_error_spec.rb +27 -0
- data/spec/acceptance/save_conf_comment_spec.rb +87 -0
- data/spec/acceptance/save_conf_default_spec.rb +169 -0
- data/spec/acceptance/save_conf_dnsbl_spec.rb +152 -0
- data/spec/acceptance/save_conf_filter_spec.rb +50 -0
- data/spec/acceptance/save_conf_plugin_spec.rb +69 -0
- data/spec/acceptance/save_conf_referer_spec.rb +60 -0
- data/spec/acceptance/save_conf_security_spec.rb +280 -0
- data/spec/acceptance/support/helpers.rb +49 -0
- data/spec/acceptance/support/paths.rb +7 -0
- data/spec/acceptance/update_diary_spec.rb +113 -0
- data/spec/acceptance/view_category_spec.rb +38 -0
- data/spec/acceptance/view_comment_spec.rb +67 -0
- data/spec/acceptance/view_diary_spec.rb +126 -0
- data/spec/acceptance/view_referer_spec.rb +31 -0
- data/spec/acceptance_helper.rb +101 -0
- data/spec/core/compatible_spec.rb +54 -0
- data/spec/core/core_ext_spec.rb +59 -0
- data/spec/core/plugin_spec.rb +389 -0
- data/spec/core/rack/assets/precompile_spec.rb +76 -0
- data/spec/core/rack/html_anchor_spec.rb +57 -0
- data/spec/core/rack/valid_request_path_spec.rb +67 -0
- data/spec/core/style/emptdiary_style_spec.rb +165 -0
- data/spec/core/style/etdiary_style_spec.rb +512 -0
- data/spec/core/style/gfm_style_spec.rb +334 -0
- data/spec/core/style/rd_style_spec.rb +202 -0
- data/spec/core/style/tdiary_style_spec.rb +240 -0
- data/spec/core/style/wiki_style_spec.rb +441 -0
- data/spec/fixtures/ascii8bit-pstore.db +0 -0
- data/spec/fixtures/invalid-sequence-volatile.tdr +9 -0
- data/spec/fixtures/just_installed.conf +1 -0
- data/spec/fixtures/plugin/ja/sample.rb +4 -0
- data/spec/fixtures/plugin/sample.rb +6 -0
- data/spec/fixtures/sample.rb +12 -0
- data/spec/fixtures/tdiary.conf.gem +212 -0
- data/spec/fixtures/tdiary.conf.rack +212 -0
- data/spec/fixtures/tdiary.conf.rdb +227 -0
- data/spec/fixtures/tdiary.conf.secure +204 -0
- data/spec/fixtures/tdiary.conf.webrick +212 -0
- data/spec/javascripts/00default_spec.js +35 -0
- data/spec/javascripts/fixtures/00default.html +1 -0
- data/spec/javascripts/support/jasmine.yml +76 -0
- data/spec/plugin/bq_spec.rb +24 -0
- data/spec/plugin/plugin_helper.rb +203 -0
- data/spec/spec_helper.rb +32 -0
- data/tdiary.conf.beginner +244 -0
- data/tdiary.conf.sample +345 -0
- data/tdiary.conf.sample-en +333 -0
- data/tdiary.gemspec +26 -0
- data/tdiary.rb +151 -0
- data/tdiary/admin.rb +236 -0
- data/tdiary/application.rb +57 -0
- data/tdiary/author_only_base.rb +171 -0
- data/tdiary/base.rb +220 -0
- data/tdiary/cli.rb +116 -0
- data/tdiary/comment.rb +40 -0
- data/tdiary/comment_manager.rb +94 -0
- data/tdiary/compatible.rb +72 -0
- data/tdiary/config.rb +270 -0
- data/tdiary/core_ext.rb +122 -0
- data/tdiary/deploy.rb +50 -0
- data/tdiary/dispatcher.rb +77 -0
- data/tdiary/dispatcher/index_main.rb +122 -0
- data/tdiary/dispatcher/update_main.rb +101 -0
- data/tdiary/environment.rb +15 -0
- data/tdiary/filter.rb +48 -0
- data/tdiary/filter/default.rb +54 -0
- data/tdiary/filter/spam.rb +304 -0
- data/tdiary/io/base.rb +70 -0
- data/tdiary/io/cache/file.rb +123 -0
- data/tdiary/io/cache/memcached.rb +88 -0
- data/tdiary/io/cache/redis.rb +100 -0
- data/tdiary/io/default.rb +297 -0
- data/tdiary/io/pstore.rb +252 -0
- data/tdiary/io/rdb.rb +213 -0
- data/tdiary/lang/en.rb +79 -0
- data/tdiary/lang/ja.rb +72 -0
- data/tdiary/plugin.rb +375 -0
- data/tdiary/rack/assets/precompile.rb +37 -0
- data/tdiary/rack/auth/basic.rb +38 -0
- data/tdiary/rack/auth/omniauth.rb +51 -0
- data/tdiary/rack/html_anchor.rb +31 -0
- data/tdiary/rack/valid_request_path.rb +36 -0
- data/tdiary/referer_manager.rb +80 -0
- data/tdiary/request.rb +217 -0
- data/tdiary/response.rb +29 -0
- data/tdiary/server.rb +85 -0
- data/tdiary/style.rb +194 -0
- data/tdiary/style/tdiary_style.rb +198 -0
- data/tdiary/style/wiki_style.rb +213 -0
- data/tdiary/tasks.rb +1 -0
- data/tdiary/tasks/assets.rake +31 -0
- data/tdiary/tasks/auth.rake +28 -0
- data/tdiary/tasks/db.rake +110 -0
- data/tdiary/tasks/doc.rake +31 -0
- data/tdiary/tasks/heroku.rake +37 -0
- data/tdiary/tasks/jasmine.rake +16 -0
- data/tdiary/tasks/rdoc.rake +24 -0
- data/tdiary/tasks/release.rake +122 -0
- data/tdiary/tasks/rspec.rake +51 -0
- data/tdiary/tasks/server.rake +33 -0
- data/tdiary/tasks/test.rake +17 -0
- data/tdiary/version.rb +3 -0
- data/tdiary/view.rb +468 -0
- data/tdiary/view_helper.rb +15 -0
- data/test/disp_referrer_test.rb +93 -0
- data/test/my-sequel_test.rb +238 -0
- data/test/test_helper.rb +7 -0
- data/test/test_plugin_helper.rb +64 -0
- data/test/test_plugin_helper_test.rb +28 -0
- data/test/weather_test.rb +33 -0
- data/theme/base.css +268 -0
- data/theme/conf.block.png +0 -0
- data/theme/conf.css +254 -0
- data/theme/default/README +11 -0
- data/theme/default/body.png +0 -0
- data/theme/default/default.css +743 -0
- data/theme/help.png +0 -0
- data/theme/loading.gif +0 -0
- data/theme/tdiary1/README +7 -0
- data/theme/tdiary1/tdiary1.css +394 -0
- data/theme/tdiary2/README +19 -0
- data/theme/tdiary2/tdiary2.css +624 -0
- data/update.fcgi +45 -0
- data/update.rb +57 -0
- data/vendor/hikidoc-0.0.6/COPYING +28 -0
- data/vendor/hikidoc-0.0.6/NEWS +30 -0
- data/vendor/hikidoc-0.0.6/NEWS.ja +30 -0
- data/vendor/hikidoc-0.0.6/README +86 -0
- data/vendor/hikidoc-0.0.6/README.ja +83 -0
- data/vendor/hikidoc-0.0.6/Rakefile +68 -0
- data/vendor/hikidoc-0.0.6/TextFormattingRules +320 -0
- data/vendor/hikidoc-0.0.6/TextFormattingRules.ja +318 -0
- data/vendor/hikidoc-0.0.6/bin/hikidoc +66 -0
- data/vendor/hikidoc-0.0.6/lib/hikidoc.rb +914 -0
- data/vendor/hikidoc-0.0.6/setup.rb +1360 -0
- data/vendor/hikidoc-0.0.6/test/run-test.rb +13 -0
- data/vendor/hikidoc-0.0.6/test/test_hikidoc.rb +506 -0
- data/vendor/imagesize-0.1.1/Manifest.txt +19 -0
- data/vendor/imagesize-0.1.1/README.txt +49 -0
- data/vendor/imagesize-0.1.1/lib/image_size.rb +305 -0
- data/vendor/imagesize-0.1.1/lib/image_size/version.rb +9 -0
- data/vendor/imagesize-0.1.1/setup.rb +1585 -0
- data/vendor/imagesize-0.1.1/test/2-4-7.png +0 -0
- data/vendor/imagesize-0.1.1/test/4_1_2.gif +0 -0
- data/vendor/imagesize-0.1.1/test/bmp.bmp +0 -0
- data/vendor/imagesize-0.1.1/test/cursor.xbm +6 -0
- data/vendor/imagesize-0.1.1/test/detect.swf +0 -0
- data/vendor/imagesize-0.1.1/test/pbm.pbm +0 -0
- data/vendor/imagesize-0.1.1/test/pcx.pcx +0 -0
- data/vendor/imagesize-0.1.1/test/pgm.pgm +5 -0
- data/vendor/imagesize-0.1.1/test/test.xpm +38 -0
- data/vendor/imagesize-0.1.1/test/test_helper.rb +2 -0
- data/vendor/imagesize-0.1.1/test/test_image_size.rb +71 -0
- data/vendor/imagesize-0.1.1/test/tiff.tiff +0 -0
- data/vendor/imagesize-0.1.1/test/tokyo_tower.jpg +0 -0
- data/vendor/imagesize-0.1.1/test/tower_e.gif.psd +0 -0
- data/vendor/jasmine-jquery-1.4.2/jasmine-jquery.js +548 -0
- data/vendor/jquery-1.8/jquery.js +9227 -0
- data/vendor/rdtool-0.6.38/COPYING.txt +339 -0
- data/vendor/rdtool-0.6.38/Gemfile +3 -0
- data/vendor/rdtool-0.6.38/HISTORY +318 -0
- data/vendor/rdtool-0.6.38/LGPL-2.1 +502 -0
- data/vendor/rdtool-0.6.38/LICENSE.txt +58 -0
- data/vendor/rdtool-0.6.38/README.html +66 -0
- data/vendor/rdtool-0.6.38/README.ja.html +73 -0
- data/vendor/rdtool-0.6.38/README.rd +76 -0
- data/vendor/rdtool-0.6.38/README.rd.ja +85 -0
- data/vendor/rdtool-0.6.38/Rakefile +152 -0
- data/vendor/rdtool-0.6.38/TODO +22 -0
- data/vendor/rdtool-0.6.38/bin/rd2 +283 -0
- data/vendor/rdtool-0.6.38/bin/rdswap.rb +207 -0
- data/vendor/rdtool-0.6.38/doc/rd-draft.html +456 -0
- data/vendor/rdtool-0.6.38/doc/rd-draft.ja.html +466 -0
- data/vendor/rdtool-0.6.38/doc/rd-draft.rd +479 -0
- data/vendor/rdtool-0.6.38/doc/rd-draft.rd.ja +487 -0
- data/vendor/rdtool-0.6.38/lib/rd/block-element.rb +114 -0
- data/vendor/rdtool-0.6.38/lib/rd/complex-list-item.rb +65 -0
- data/vendor/rdtool-0.6.38/lib/rd/desclist.rb +55 -0
- data/vendor/rdtool-0.6.38/lib/rd/document-struct.rb +46 -0
- data/vendor/rdtool-0.6.38/lib/rd/dot.rd2rc +18 -0
- data/vendor/rdtool-0.6.38/lib/rd/element.rb +160 -0
- data/vendor/rdtool-0.6.38/lib/rd/filter.rb +255 -0
- data/vendor/rdtool-0.6.38/lib/rd/head-filter.rb +14 -0
- data/vendor/rdtool-0.6.38/lib/rd/inline-element.rb +233 -0
- data/vendor/rdtool-0.6.38/lib/rd/labeled-element.rb +14 -0
- data/vendor/rdtool-0.6.38/lib/rd/list.rb +57 -0
- data/vendor/rdtool-0.6.38/lib/rd/loose-struct.rb +11 -0
- data/vendor/rdtool-0.6.38/lib/rd/methodlist.rb +57 -0
- data/vendor/rdtool-0.6.38/lib/rd/output-format-visitor.rb +30 -0
- data/vendor/rdtool-0.6.38/lib/rd/package.rb +4 -0
- data/vendor/rdtool-0.6.38/lib/rd/parser-util.rb +14 -0
- data/vendor/rdtool-0.6.38/lib/rd/post-install +1 -0
- data/vendor/rdtool-0.6.38/lib/rd/pre-setup.rb +18 -0
- data/vendor/rdtool-0.6.38/lib/rd/rbl-file.rb +69 -0
- data/vendor/rdtool-0.6.38/lib/rd/rbl-suite.rb +37 -0
- data/vendor/rdtool-0.6.38/lib/rd/rd-struct.rb +86 -0
- data/vendor/rdtool-0.6.38/lib/rd/rd2html-ext-lib.rb +266 -0
- data/vendor/rdtool-0.6.38/lib/rd/rd2html-ext-opt.rb +34 -0
- data/vendor/rdtool-0.6.38/lib/rd/rd2html-lib.rb +490 -0
- data/vendor/rdtool-0.6.38/lib/rd/rd2html-opt.rb +67 -0
- data/vendor/rdtool-0.6.38/lib/rd/rd2man-lib.rb +251 -0
- data/vendor/rdtool-0.6.38/lib/rd/rd2rdo-lib.rb +19 -0
- data/vendor/rdtool-0.6.38/lib/rd/rd2rmi-lib.rb +32 -0
- data/vendor/rdtool-0.6.38/lib/rd/rdblockparser.ry +518 -0
- data/vendor/rdtool-0.6.38/lib/rd/rdblockparser.tab.rb +1061 -0
- data/vendor/rdtool-0.6.38/lib/rd/rdfmt.rb +15 -0
- data/vendor/rdtool-0.6.38/lib/rd/rdinlineparser.ry +503 -0
- data/vendor/rdtool-0.6.38/lib/rd/rdinlineparser.tab.rb +1243 -0
- data/vendor/rdtool-0.6.38/lib/rd/rdvisitor.rb +214 -0
- data/vendor/rdtool-0.6.38/lib/rd/reference-resolver.rb +114 -0
- data/vendor/rdtool-0.6.38/lib/rd/search-file.rb +14 -0
- data/vendor/rdtool-0.6.38/lib/rd/tree.rb +103 -0
- data/vendor/rdtool-0.6.38/lib/rd/version.rb +41 -0
- data/vendor/rdtool-0.6.38/lib/rd/visitor.rb +86 -0
- data/vendor/rdtool-0.6.38/rdtool.gemspec +125 -0
- data/vendor/rdtool-0.6.38/setup.rb +1596 -0
- data/vendor/rdtool-0.6.38/test/data/includee1.html +1 -0
- data/vendor/rdtool-0.6.38/test/data/includee2.html +1 -0
- data/vendor/rdtool-0.6.38/test/data/includee3.nothtml +1 -0
- data/vendor/rdtool-0.6.38/test/data/includee4.xhtml +0 -0
- data/vendor/rdtool-0.6.38/test/data/label.rbl +2 -0
- data/vendor/rdtool-0.6.38/test/data/label2.rbl +2 -0
- data/vendor/rdtool-0.6.38/test/data/sub/includee2.html +1 -0
- data/vendor/rdtool-0.6.38/test/data/sub/includee4.html +0 -0
- data/vendor/rdtool-0.6.38/test/dummy-observer.rb +6 -0
- data/vendor/rdtool-0.6.38/test/dummy.rb +33 -0
- data/vendor/rdtool-0.6.38/test/temp-dir.rb +19 -0
- data/vendor/rdtool-0.6.38/test/test-block-parser.rb +46 -0
- data/vendor/rdtool-0.6.38/test/test-desclist-item.rb +219 -0
- data/vendor/rdtool-0.6.38/test/test-document-element.rb +46 -0
- data/vendor/rdtool-0.6.38/test/test-document-struct.rb +66 -0
- data/vendor/rdtool-0.6.38/test/test-element.rb +46 -0
- data/vendor/rdtool-0.6.38/test/test-headline.rb +80 -0
- data/vendor/rdtool-0.6.38/test/test-inline-parser.rb +46 -0
- data/vendor/rdtool-0.6.38/test/test-list-item.rb +54 -0
- data/vendor/rdtool-0.6.38/test/test-list.rb +53 -0
- data/vendor/rdtool-0.6.38/test/test-methodlist-item.rb +73 -0
- data/vendor/rdtool-0.6.38/test/test-nonterminal-element.rb +170 -0
- data/vendor/rdtool-0.6.38/test/test-nonterminal-inline.rb +33 -0
- data/vendor/rdtool-0.6.38/test/test-output-format-visitor.rb +48 -0
- data/vendor/rdtool-0.6.38/test/test-parser-util.rb +41 -0
- data/vendor/rdtool-0.6.38/test/test-rbl-file.rb +156 -0
- data/vendor/rdtool-0.6.38/test/test-rbl-suite.rb +43 -0
- data/vendor/rdtool-0.6.38/test/test-rd2html-lib.rb +496 -0
- data/vendor/rdtool-0.6.38/test/test-rdtree.rb +17 -0
- data/vendor/rdtool-0.6.38/test/test-rdvisitor.rb +29 -0
- data/vendor/rdtool-0.6.38/test/test-reference-resolver.rb +202 -0
- data/vendor/rdtool-0.6.38/test/test-reference.rb +132 -0
- data/vendor/rdtool-0.6.38/test/test-search-file.rb +22 -0
- data/vendor/rdtool-0.6.38/test/test-terminal-inline.rb +41 -0
- data/vendor/rdtool-0.6.38/test/test-textblock.rb +44 -0
- data/vendor/rdtool-0.6.38/test/test-tree.rb +82 -0
- data/vendor/rdtool-0.6.38/test/test-version.rb +57 -0
- data/vendor/rdtool-0.6.38/test/test-visitor.rb +230 -0
- data/vendor/rdtool-0.6.38/utils/rd-mode.el +464 -0
- metadata +666 -0
@@ -0,0 +1,456 @@
|
|
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</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>Japanese version is <a href="http://www.ruby-lang.org/~rubikitch/RDP.cgi?cmd=view&name=RD">here</a>.</p>
|
12
|
+
<h2><a name="label-1" id="label-1">What is RD?</a></h2><!-- RDLabel: "What is RD?" -->
|
13
|
+
<p>RD is Ruby's POD, embeddable documentation format in script file. </p>
|
14
|
+
<p>RD is influenced mainly from plain2, a program to translate from plain text to
|
15
|
+
some mark-up language. So, RD looks like plain text, and its simpleness and
|
16
|
+
neatness make it easy to read and write.</p>
|
17
|
+
<h2><a name="label-2" id="label-2">How does the interpreter work for RD?</a></h2><!-- RDLabel: "How does the interpreter work for RD?" -->
|
18
|
+
<p>Ruby's interpreter, <code>ruby</code>, simply ignores text between a line beginning
|
19
|
+
with "<code>=begin</code>" and one beginning with "<code>=end</code>". So, RD is not only
|
20
|
+
embeddable. You can write anything between <code>=begin</code> and <code>=end</code>. RD is
|
21
|
+
one of them, but RD will be a standard one.<a name="footmark-1" id="footmark-1" href="#foottext-1"><sup><small>*1</small></sup></a></p>
|
22
|
+
<h2><a name="label-3" id="label-3">Concepts and Syntax</a></h2><!-- RDLabel: "Concepts and Syntax" -->
|
23
|
+
<h3><a name="label-4" id="label-4">Element, Block and Inline</a></h3><!-- RDLabel: "Element, Block and Inline" -->
|
24
|
+
<p>We will use the term "Element" for features of RD which add information
|
25
|
+
of document structure to text. In addition, we use a term
|
26
|
+
"<a href="#label-5">Block</a>" for Elements for large and global structures, and a term
|
27
|
+
"<a href="#label-35">Inline</a>" for ones for small and local decorations.</p>
|
28
|
+
<p>Paragraph, headline or list is a kind of Block. RD uses indentation and
|
29
|
+
special characters to describe Blocks. You can also write complicated
|
30
|
+
structure to nested Blocks. And this style of Block looks naturally like
|
31
|
+
plain text format. See <a href="#label-5">Block</a> for details.</p>
|
32
|
+
<p>Emphasis, code or reference is a kind of Inline. Parentheses and special
|
33
|
+
characters, like ((? ... ?)), are used for Inline. Almost all
|
34
|
+
Inline may be nested inside each other. See <a href="#label-35">Inline</a> for more details.</p>
|
35
|
+
<h3><a name="label-5" id="label-5">Block</a></h3><!-- RDLabel: "Block" -->
|
36
|
+
<h4><a name="label-6" id="label-6">Basic Syntax</a></h4><!-- RDLabel: "Basic Syntax" -->
|
37
|
+
<p>Block has line oriented syntax. i.e. each character on the same line belongs to the
|
38
|
+
same Block. And the indentation of the line represents nesting level and type of Block.
|
39
|
+
The first character of the line represents the type of Block.</p>
|
40
|
+
<h5><a name="label-7" id="label-7">Concepts and Terms</a></h5><!-- RDLabel: "Concepts and Terms" -->
|
41
|
+
<dl>
|
42
|
+
<dt><a name="label-8" id="label-8">Baseline</a></dt><!-- RDLabel: "Baseline" -->
|
43
|
+
<dd>
|
44
|
+
Baseline is standard depth of indent. Relative depth between indent of one
|
45
|
+
line and Baseline affects its Block-type.
|
46
|
+
</dd>
|
47
|
+
<dt><a name="label-9" id="label-9">Head Char</a></dt><!-- RDLabel: "Head Char" -->
|
48
|
+
<dd>
|
49
|
+
Head Char is the first character of line, except whitespace.
|
50
|
+
</dd>
|
51
|
+
<dt><a name="label-10" id="label-10">STRINGLINE</a></dt><!-- RDLabel: "STRINGLINE" -->
|
52
|
+
<dd>
|
53
|
+
STRINGLINE is line which consists of strings.
|
54
|
+
STRINGLINE doesn't have "<code>*</code>", "<code>(<var>num</var>)</code>", "<code>:</code>", "<code>=</code>"
|
55
|
+
nor "<code>+</code>" as Head Char. But if the line is indented, "<code>=</code>" and "<code>+</code>"
|
56
|
+
can be Head Char.
|
57
|
+
</dd>
|
58
|
+
<dt><a name="label-11" id="label-11">WHITELINE</a></dt><!-- RDLabel: "WHITELINE" -->
|
59
|
+
<dd>
|
60
|
+
WHITELINE is a line which consists of whitespace, "<code>\s</code>", "<code>\t</code>" and
|
61
|
+
"<code>\n</code>".
|
62
|
+
</dd>
|
63
|
+
<dt><a name="label-12" id="label-12">Comment</a></dt><!-- RDLabel: "Comment" -->
|
64
|
+
<dd>
|
65
|
+
A line which is matched with <code>/^#/</code> is regarded as a comment.
|
66
|
+
</dd>
|
67
|
+
</dl>
|
68
|
+
<h5><a name="label-13" id="label-13">How Baseline is defined and how it works</a></h5><!-- RDLabel: "How Baseline is defined and how it works" -->
|
69
|
+
<p>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,</p>
|
71
|
+
<pre>Example: "|" means Baseline
|
72
|
+
|Regard this line as one of TextBlock's in top level.
|
73
|
+
|<- So this Baseline is at the left-most position.
|
74
|
+
*|it is in List. (1)
|
75
|
+
|<- this Baseline is defined by the marked with a (1).
|
76
|
+
* |Different Item of List can have different Baseline inside.
|
77
|
+
|<- So this Baseline differs from one of this list's first item.</pre>
|
78
|
+
<p>|Regard this line as one of TextBlock's in top level.
|
79
|
+
|<- So this Baseline is at the left-most position.</p>
|
80
|
+
<ul>
|
81
|
+
<li>|it is in List. (1)
|
82
|
+
|<- this Baseline is defined by the marked with a (1).</li>
|
83
|
+
<li>|Different Items in Lists can have different Baselines inside.
|
84
|
+
|<- So this Baseline differs from the one of this list's first item.</li>
|
85
|
+
</ul>
|
86
|
+
<p>If one Block is nested in another Block, the Baseline of the inside Blocks is deeper
|
87
|
+
than the Baseline of outside Blocks.</p>
|
88
|
+
<p>The relative position between Baseline and indent affects the type of Block.
|
89
|
+
If a <a href="#label-10">STRINGLINE</a> has same indent with Baseline, it belongs to
|
90
|
+
<a href="#label-20">TextBlock</a>, otherwise, i.e. it has deeper indent than Baseline,
|
91
|
+
it belongs to <a href="#label-21">Verbatim</a>.</p>
|
92
|
+
<h4><a name="label-14" id="label-14">Types of Block</a></h4><!-- RDLabel: "Types of Block" -->
|
93
|
+
<h5><a name="label-15" id="label-15">Headline</a></h5><!-- RDLabel: "Headline" -->
|
94
|
+
<p>Headline consists of a line which <a href="#label-9">Head Char</a> is "<code>=</code>" or
|
95
|
+
"<code>+</code>". And Headline can't include more than one line. Headline can
|
96
|
+
be on only top level.</p>
|
97
|
+
<pre>Example:
|
98
|
+
|<- Regard this as top level Baseline.
|
99
|
+
= Headline 1.
|
100
|
+
=== Headline 1.1.1.
|
101
|
+
+ Headline 1.1.1.1.1.</pre>
|
102
|
+
<h1><a name="label-16" id="label-16">Headline 1.</a></h1><!-- RDLabel: "Headline 1." -->
|
103
|
+
<h3><a name="label-17" id="label-17">Headline 1.1.1.</a></h3><!-- RDLabel: "Headline 1.1.1." -->
|
104
|
+
<h5><a name="label-18" id="label-18">Headline 1.1.1.1.1.</a></h5><!-- RDLabel: "Headline 1.1.1.1.1." -->
|
105
|
+
<p>Headline Mark represents level of Headline. See following figure. first
|
106
|
+
Mark is biggest one, and last Mark has two parts.</p>
|
107
|
+
<pre>Fig: Headline Marks
|
108
|
+
=
|
109
|
+
==
|
110
|
+
===
|
111
|
+
====
|
112
|
+
+
|
113
|
+
++</pre>
|
114
|
+
<p>Text which follows Mark is title of Headline. It is also used as Label of
|
115
|
+
<a href="#label-46">Reference</a>.</p>
|
116
|
+
<p>Title of Headline can contain <a href="#label-35">Inline</a>s except for <a href="#label-46">Reference</a> and
|
117
|
+
Footnote.</p>
|
118
|
+
<h5><a name="label-19" id="label-19">Include</a></h5><!-- RDLabel: "Include" -->
|
119
|
+
<p>Include is a line that line head "<code><<<</code>" and included file name.
|
120
|
+
You can input from other file text, both RD and target format, with Include.</p>
|
121
|
+
<p>When you include RD file, included file name have to have ".rd" or ".rb" as
|
122
|
+
suffix, like "foo.rd", and write full name (not full path) of file after
|
123
|
+
"<code><<<</code>". For example,</p>
|
124
|
+
<pre><<< foo.rd</pre>
|
125
|
+
<p>When you include target format file, include file name have to have suffix
|
126
|
+
of target format standard one, for example ".html" in the case of outputting
|
127
|
+
HTML, ".texi" in the case of outputting Texinfo, and write base name of file
|
128
|
+
after "<code><<<</code>". For example,</p>
|
129
|
+
<pre><<< foo</pre>
|
130
|
+
<p>RD formatter include "foo.html" to output HTML, and include "foo.texi" to
|
131
|
+
output Texinfo. If you want to use Include for target format, you should
|
132
|
+
prepare plural type of included file. </p>
|
133
|
+
<h5><a name="label-20" id="label-20">TextBlock</a></h5><!-- RDLabel: "TextBlock" -->
|
134
|
+
<p>TextBlock is composed of <a href="#label-10">STRINGLINE</a>s, but the <a href="#label-10">STRINGLINE</a>s
|
135
|
+
must have same indent with <a href="#label-8">Baseline</a>. If its indent is deeper
|
136
|
+
than <a href="#label-8">Baseline</a>, the <a href="#label-10">STRINGLINE</a> belongs to <a href="#label-21">Verbatim</a>.</p>
|
137
|
+
<p>TextBlock can include <a href="#label-35">Inline</a> inside.</p>
|
138
|
+
<pre>Example:
|
139
|
+
|
|
140
|
+
This is TextBlock.
|
141
|
+
Second line of same TextBlock.
|
142
|
+
This line is not TextBlock, but Verbatim.
|
143
|
+
* And this line is List. (But this line is exactly TextBlock in ListItem.)</pre>
|
144
|
+
<p>And this example is formatted such like:</p>
|
145
|
+
<p>This is TextBlock.
|
146
|
+
Second line of same TextBlock.</p>
|
147
|
+
<pre>This line is not TextBlock, but Verbatim.</pre>
|
148
|
+
<ul>
|
149
|
+
<li>And this line is List. (But this line is exactly TextBlock in ListItem.)</li>
|
150
|
+
</ul>
|
151
|
+
<h5><a name="label-21" id="label-21">Verbatim</a></h5><!-- RDLabel: "Verbatim" -->
|
152
|
+
<p>You can use Verbatim to cite Ruby script. Verbatim is composed of
|
153
|
+
<a href="#label-10">STRINGLINE</a>s, and they must be indented deeper than
|
154
|
+
<a href="#label-8">Baseline</a>. Verbatim can also include a line whose <a href="#label-9">Head Char</a> is
|
155
|
+
"<code>*</code>", "<code>(1)</code>" and "<code>:</code>", But it can't be first line of
|
156
|
+
Verbatim, it is regarded as <a href="#label-22">List</a>. Verbatim can't include a line
|
157
|
+
which is indented shallower than first line. Verbatim can include
|
158
|
+
<a href="#label-11">WHITELINE</a>.</p>
|
159
|
+
<p>You can't use <a href="#label-35">Inline</a> in Verbatim.</p>
|
160
|
+
<pre>Example:
|
161
|
+
This is Verbatim.
|
162
|
+
Even if a line is indented deeper than first line, it is also in same
|
163
|
+
Verbatim.
|
164
|
+
* A line seems like list is also included in Verbatim.
|
165
|
+
But if the line is indented shallower, it is not in same Verbatim.
|
166
|
+
It is in other Verbatim.</pre>
|
167
|
+
<p>And this example is formatted such like:</p>
|
168
|
+
<pre>This is Verbatim.
|
169
|
+
Even if a line is indented deeper than first line, it is also in same
|
170
|
+
Verbatim.
|
171
|
+
* A line seems like list is also included in Verbatim.</pre>
|
172
|
+
<pre>But if the line is indented shallower, it is not in same Verbatim.
|
173
|
+
It is in other Verbatim.</pre>
|
174
|
+
<h5><a name="label-22" id="label-22">List</a></h5><!-- RDLabel: "List" -->
|
175
|
+
<p>List is special <a href="#label-5">Block</a>. List is composed of ListItems, and
|
176
|
+
ListItem is composed of Blocks. So List can include Blocks inside,
|
177
|
+
even also List itself.<a name="footmark-2" id="footmark-2" href="#foottext-2"><sup><small>*2</small></sup></a></p>
|
178
|
+
<p>ListItem can include <a href="#label-11">WHITELINE</a>, and <a href="#label-20">TextBlock</a> can't
|
179
|
+
include WHITELINE, so when you want to write 2 TextBlock inside
|
180
|
+
ListItem, put a WHITELINE between TextBlocks.</p>
|
181
|
+
<p>There is 3 type of List, "<a href="#label-23">ItemList</a>", "<a href="#label-24">EnumList</a>",
|
182
|
+
"<a href="#label-25">DescList</a>" and "<a href="#label-28">MethodList</a>.</p>
|
183
|
+
<h6><a name="label-23" id="label-23">ItemList</a></h6><!-- RDLabel: "ItemList" -->
|
184
|
+
<p>ItemList is simple and not numbered List. ItemListItem begins by a line
|
185
|
+
whose <a href="#label-9">Head Char</a> is "<code>*</code>", and first Block of ItemListItem must be
|
186
|
+
<a href="#label-20">TextBlock</a>.</p>
|
187
|
+
<pre>Example:
|
188
|
+
* first item of parent list
|
189
|
+
* first item of sub list
|
190
|
+
* second item of sub list
|
191
|
+
text block ( line of first item of parent list)</pre>
|
192
|
+
<p>And this example is formatted such like:</p>
|
193
|
+
<ul>
|
194
|
+
<li><p>first item of parent list</p>
|
195
|
+
<ul>
|
196
|
+
<li>first item of sub list</li>
|
197
|
+
<li>second item of sub list</li>
|
198
|
+
</ul>
|
199
|
+
<p>text block ( line of first item of parent list)</p></li>
|
200
|
+
</ul>
|
201
|
+
<h6><a name="label-24" id="label-24">EnumList</a></h6><!-- RDLabel: "EnumList" -->
|
202
|
+
<p>EnumList is numbered List. EnumListItem starts with a line whose
|
203
|
+
<a href="#label-9">Head Char</a> is "<code>(<var>num</var>)</code>"(<var>num</var> is integer). EnumList
|
204
|
+
is same as <a href="#label-23">ItemList</a> on other points.</p>
|
205
|
+
<pre>Example:
|
206
|
+
(1) first line of parent list
|
207
|
+
* first line of sub list(ItemList)
|
208
|
+
(2) second list of parent list
|
209
|
+
(10) number is ignored...</pre>
|
210
|
+
<p>And this example is formatted such like:</p>
|
211
|
+
<ol>
|
212
|
+
<li>first line of parent list
|
213
|
+
<ul>
|
214
|
+
<li>first line of sub list(ItemList)</li>
|
215
|
+
</ul></li>
|
216
|
+
<li>second list of parent list</li>
|
217
|
+
<li>number is ignored...</li>
|
218
|
+
</ol>
|
219
|
+
<h6><a name="label-25" id="label-25">DescList</a></h6><!-- RDLabel: "DescList" -->
|
220
|
+
<p>DescList is List for descriptions. DescListItem has 2 part. One is Term part,
|
221
|
+
the other is Description part. Term of DescListItem is also used as Label
|
222
|
+
for <a href="#label-46">Reference</a>.</p>
|
223
|
+
<p>Term part is composed of a line whose <a href="#label-9">Head Char</a> is "<code>:</code>",
|
224
|
+
and Term part is same as <a href="#label-15">Headline</a>, except that a line of Term
|
225
|
+
part can be indented.</p>
|
226
|
+
<p>Description part is starts with next line of Term part. <a href="#label-8">Baseline</a> of
|
227
|
+
Description part must be same or deeper than term of Term part of its pair.
|
228
|
+
For example, following style is illegal.</p>
|
229
|
+
<pre>Example:
|
230
|
+
: |Term
|
231
|
+
|Description.</pre>
|
232
|
+
<p>Description part can include <a href="#label-5">Block</a>s. <a href="#label-22">List</a> can be first
|
233
|
+
Block of Description part. Term part can contain <a href="#label-35">Inline</a>s except
|
234
|
+
for <a href="#label-46">Reference</a> and <!-- Reference, RDLabel "Footnote" doesn't exist --><em class="label-not-found">Footnote</em><!-- Reference end -->.</p>
|
235
|
+
<pre>Example:
|
236
|
+
:Term
|
237
|
+
first line of Description
|
238
|
+
second line of Description
|
239
|
+
:Term2
|
240
|
+
* also include List
|
241
|
+
* ...</pre>
|
242
|
+
<p>And this example is formatted such like:</p>
|
243
|
+
<dl>
|
244
|
+
<dt><a name="label-26" id="label-26">Term</a></dt><!-- RDLabel: "Term" -->
|
245
|
+
<dd>
|
246
|
+
first line of definition.
|
247
|
+
second line of definition
|
248
|
+
</dd>
|
249
|
+
<dt><a name="label-27" id="label-27">Term2</a></dt><!-- RDLabel: "Term2" -->
|
250
|
+
<dd>
|
251
|
+
<ul>
|
252
|
+
<li>also include list</li>
|
253
|
+
<li>...</li>
|
254
|
+
</ul>
|
255
|
+
</dd>
|
256
|
+
</dl>
|
257
|
+
<h6><a name="label-28" id="label-28">MethodList</a></h6><!-- RDLabel: "MethodList" -->
|
258
|
+
<p>MethodList is the special type of <a href="#label-25">DescList</a> for explanation
|
259
|
+
methods of your classes. MethodList is similar with <a href="#label-25">DescList</a> in
|
260
|
+
almost all part, but it is labeled differently. RD formatters know it
|
261
|
+
is some kind of program code, e.g. method or constants of class in
|
262
|
+
Ruby or function prototype in C..., which is on Term part of
|
263
|
+
MethodList. So, MethodList is labeled without the part which seems to
|
264
|
+
be parameters of methods. See <a href="#label-44">Label and Reference</a> for more
|
265
|
+
detail.</p>
|
266
|
+
<p>Each item of MethodList has Term part and Description part like
|
267
|
+
<a href="#label-25">DescList</a>. And its Term part start with its <a href="#label-9">Head Char</a>,
|
268
|
+
"<code>---</code>". Its Description part can contain <a href="#label-20">TextBlock</a>,
|
269
|
+
<a href="#label-21">Verbatim</a> and <a href="#label-22">List</a>. But you shouldn't write MethodList
|
270
|
+
in any kind of <a href="#label-22">List</a>. RD will come to deny it possibly in
|
271
|
+
future.</p>
|
272
|
+
<pre>Example:
|
273
|
+
--- Array#each {|i| ... } # => labeled as "Array#each"
|
274
|
+
yield block for each item.
|
275
|
+
--- Array#index(val) # => labeled as "Array#index"
|
276
|
+
return index of first item which equals with ((|val|)). if it hasn't
|
277
|
+
same item, return (({nil})).</pre>
|
278
|
+
<p>And this example is formatted such like:</p>
|
279
|
+
<dl>
|
280
|
+
<dt><a name="label-29" id="label-29"><code>Array#each {|<var>i</var>| ... }</code></a></dt><!-- RDLabel: "Array#each" -->
|
281
|
+
<dd>
|
282
|
+
yield block for each item.</dd>
|
283
|
+
<dt><a name="label-30" id="label-30"><code>Array#index(<var>val</var>)</code></a></dt><!-- RDLabel: "Array#index" -->
|
284
|
+
<dd>
|
285
|
+
return index of first item which equals with <var>val</var>. if it hasn't
|
286
|
+
same item, return <code>nil</code>.</dd>
|
287
|
+
</dl>
|
288
|
+
<p>Some formatter assumes it is Ruby's methods, constants or etc. which
|
289
|
+
is in Term part of MethodList. it can format term part of MethodList
|
290
|
+
intelligently, but you have to write according as specific formula
|
291
|
+
to make the best of its feature. </p>
|
292
|
+
<p>Standard Ruby class reference formula is suggested such like: </p>
|
293
|
+
<dl>
|
294
|
+
<dt><a name="label-31" id="label-31">instance method</a></dt><!-- RDLabel: "instance method" -->
|
295
|
+
<dd>
|
296
|
+
<p>instance method <var>method</var> of class <var>Class</var></p>
|
297
|
+
<pre>Class#method(its params ...) { parameter block }</pre>
|
298
|
+
</dd>
|
299
|
+
<dt><a name="label-32" id="label-32">class method (class singleton method)</a></dt><!-- RDLabel: "class method (class singleton method)" -->
|
300
|
+
<dd>
|
301
|
+
<p>class method <var>method</var> of class <var>Class</var></p>
|
302
|
+
<pre>Class.method(its params ...) { parameter block }</pre>
|
303
|
+
</dd>
|
304
|
+
<dt><a name="label-33" id="label-33">class constants</a></dt><!-- RDLabel: "class constants" -->
|
305
|
+
<dd>
|
306
|
+
<p>constant <var>Const</var> of class <var>Class</var></p>
|
307
|
+
<pre>Class::Const</pre>
|
308
|
+
</dd>
|
309
|
+
<dt><a name="label-34" id="label-34">functions (private methods on top level)</a></dt><!-- RDLabel: "functions (private methods on top level)" -->
|
310
|
+
<dd>
|
311
|
+
<p>function <var>func</var></p>
|
312
|
+
<pre>function#func(its params ...) { parameter block }</pre>
|
313
|
+
</dd>
|
314
|
+
</dl>
|
315
|
+
<p>Ruby use some symbol characters (e.g. [], []=, +, - or <<) for the names
|
316
|
+
of methods. ruby, Ruby interpreter, parses them with different manner from
|
317
|
+
normal methods, but write them as same as others in this formula.</p>
|
318
|
+
<pre>Example:
|
319
|
+
--- Array#[](key)
|
320
|
+
return value which in at index ((|key|)).
|
321
|
+
--- Array#[]=(key, value)
|
322
|
+
put ((|value|)) into cell of index ((|key|)).
|
323
|
+
--- Array#+(other)
|
324
|
+
return concatenated (({Array})).</pre>
|
325
|
+
<h3><a name="label-35" id="label-35">Inline</a></h3><!-- RDLabel: "Inline" -->
|
326
|
+
<p>You can use Inline in <a href="#label-20">TextBlock</a>, <a href="#label-15">Headline</a> and Term part of
|
327
|
+
<a href="#label-25">DescList</a>. Common style of parentheses is used for Inline. Inline
|
328
|
+
can nest each other.</p>
|
329
|
+
<p>in following list of Inlines, preformatted text is on left hand side
|
330
|
+
and postformatted text is on right hand side.</p>
|
331
|
+
<dl>
|
332
|
+
<dt><a name="label-36" id="label-36">((*Em*)) => <em>Em</em></a></dt><!-- RDLabel: "((*Em*)) => Em" -->
|
333
|
+
<dd>
|
334
|
+
Emphasis.
|
335
|
+
</dd>
|
336
|
+
<dt><a name="label-37" id="label-37">(({while gets...})) => <code>while gets...</code></a></dt><!-- RDLabel: "(({while gets...})) => while gets..." -->
|
337
|
+
<dd>
|
338
|
+
Code.
|
339
|
+
</dd>
|
340
|
+
<dt><a name="label-38" id="label-38">((|var|)) => <var>var</var></a></dt><!-- RDLabel: "((|var|)) => var" -->
|
341
|
+
<dd>
|
342
|
+
Var.<a name="footmark-3" id="footmark-3" href="#foottext-3"><sup><small>*3</small></sup></a>
|
343
|
+
</dd>
|
344
|
+
<dt><a name="label-39" id="label-39">((%ruby -v%)) => <kbd>ruby -v</kbd></a></dt><!-- RDLabel: "((%ruby -v%)) => ruby -v" -->
|
345
|
+
<dd>
|
346
|
+
Keyboard.
|
347
|
+
</dd>
|
348
|
+
<dt><a name="label-40" id="label-40">((:Term:))</a></dt><!-- RDLabel: "((:Term:))" -->
|
349
|
+
<dd>
|
350
|
+
<p>=> <a name="index-0" id="index-0">Term</a></p>
|
351
|
+
<p>Term of Index.</p>
|
352
|
+
</dd>
|
353
|
+
<dt><a name="label-41" id="label-41">((<Identity or URL>))</a></dt><!-- RDLabel: "((<Identity or URL>))" -->
|
354
|
+
<dd>
|
355
|
+
<p>=> <!-- Reference, RDLabel "Identity or URL" doesn't exist --><em class="label-not-found">Identity or URL</em><!-- Reference end --></p>
|
356
|
+
<p>Link, Reference. See <a href="RD">Label and Reference</a> for more detail.</p>
|
357
|
+
</dd>
|
358
|
+
<dt><a name="label-42" id="label-42">((-Footnote-))</a></dt><!-- RDLabel: "((-Footnote-))" -->
|
359
|
+
<dd>
|
360
|
+
<p>=> <a name="footmark-4" id="footmark-4" href="#foottext-4"><sup><small>*4</small></sup></a></p>
|
361
|
+
<p>Footnote.</p>
|
362
|
+
</dd>
|
363
|
+
<dt><a name="label-43" id="label-43">(('verb')) => verb</a></dt><!-- RDLabel: "(('verb')) => verb" -->
|
364
|
+
<dd>
|
365
|
+
Inline Verbatim.
|
366
|
+
</dd>
|
367
|
+
</dl>
|
368
|
+
<h4><a name="label-44" id="label-44">Label and Reference</a></h4><!-- RDLabel: "Label and Reference" -->
|
369
|
+
<p>Reference needs Label. In RD, only title of <a href="#label-15">Headline</a> and Term of
|
370
|
+
<a href="#label-25">DescList</a> and <a href="#label-28">MethodList</a> is regarded as Label. So, you must
|
371
|
+
choose different titles for different <a href="#label-15">Headline</a>s. This problem
|
372
|
+
has not resolved yet.</p>
|
373
|
+
<h5><a name="label-45" id="label-45">How to RD generates Label from Headline, DescList or MethodList</a></h5><!-- RDLabel: "How to RD generates Label from Headline, DescList or MethodList" -->
|
374
|
+
<p>Title of <a href="#label-15">Headline</a> and Term part of <a href="#label-25">DescList</a> and <a href="#label-28">MethodList</a>
|
375
|
+
are regarded as Label. But they can contain <a href="#label-35">Inline</a>s, so the situation
|
376
|
+
isn't so simple.</p>
|
377
|
+
<p>First, <a href="#label-28">MethodList</a> is special in the part of Labeling. Term part of
|
378
|
+
<a href="#label-28">MethodList</a> can't contain <a href="#label-35">Inline</a>s, and RD assumes it is method
|
379
|
+
reference or such thing which is in Term part of <a href="#label-28">MethodList</a>. So
|
380
|
+
it is Labeled under following rules.</p>
|
381
|
+
<ol>
|
382
|
+
<li>It is regarded as Label which is before a character of "<code>(</code>" or
|
383
|
+
"<code>{</code>".<a name="footmark-5" id="footmark-5" href="#foottext-5"><sup><small>*5</small></sup></a></li>
|
384
|
+
</ol>
|
385
|
+
<p>Following example will help you to understand how this rule works. the Label
|
386
|
+
which is generated from the term part of <a href="#label-28">MethodList</a> is after mark of
|
387
|
+
"<code># =></code>".</p>
|
388
|
+
<pre>Example:
|
389
|
+
--- Array.new([size[, val]]) # => Array.new
|
390
|
+
--- Array#[]=(key, val) # => Array#[]=
|
391
|
+
--- Array#each { ... } # => Array#each
|
392
|
+
--- void rb_define_method(VALUE class, ...) # => void rb_define_method</pre>
|
393
|
+
<p>Second, in the case of title of <a href="#label-15">Headline</a> or term part of <a href="#label-25">DescList</a>,
|
394
|
+
there is not such a special rule. But you can use <a href="#label-35">Inline</a>s for text on
|
395
|
+
them, so there are rules to strip <a href="#label-35">Inline</a> mark-ups from text.</p>
|
396
|
+
<ol>
|
397
|
+
<li><p>Any <a href="#label-35">Inline</a> mark-ups makes any difference to Label. So, both</p>
|
398
|
+
<pre>= ((*Headline*))</pre>
|
399
|
+
<p>and</p>
|
400
|
+
<pre>= Headline</pre>
|
401
|
+
<p>are Labeled as "Headline".</p></li>
|
402
|
+
<li><p>But white spaces which is after open parenthesis and before close
|
403
|
+
parenthesis of <a href="#label-35">Inline</a> are striped when RD generates Label from
|
404
|
+
it. So, both</p>
|
405
|
+
<pre>= ((* Headline *))</pre>
|
406
|
+
<p>and</p>
|
407
|
+
<pre>= ((*Headline*))</pre>
|
408
|
+
<p>are Labeled as "Headline".</p></li>
|
409
|
+
</ol>
|
410
|
+
<h5><a name="label-46" id="label-46">Reference</a></h5><!-- RDLabel: "Reference" -->
|
411
|
+
<p>You can refer Labeled element with Reference which is a kind of <a href="#label-35">Inline</a>
|
412
|
+
marked up with ((<...>)).</p>
|
413
|
+
<p>Most simple use of Reference is to write Label inside parenthesis.</p>
|
414
|
+
<pre>((<Label>))</pre>
|
415
|
+
<p>This works as reference to Label of "Label" and text "Label" is used
|
416
|
+
also for display such like: <!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found">Label</em><!-- Reference end -->.<a name="footmark-6" id="footmark-6" href="#foottext-6"><sup><small>*6</small></sup></a></p>
|
417
|
+
<p>When you want to refer a resource pointed with URL, write such like:</p>
|
418
|
+
<pre>((<URL:http://www.ruby-lang.org/en/raa.html>))</pre>
|
419
|
+
<p>RD formatter will format it as hyper-link to its URL if possible
|
420
|
+
such like:<a href="http://www.ruby-lang.org/en/raa.html"><URL:http://www.ruby-lang.org/en/raa.html></a>.</p>
|
421
|
+
<p>When you want to use other text than Label for display, write such like:</p>
|
422
|
+
<pre>((<Text for display|Label>))</pre>
|
423
|
+
<p>"Text for display" is used for display and "Label" is used as Label to
|
424
|
+
refer such like: <!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found">Text for display</em><!-- Reference end --></p>
|
425
|
+
<p>Text for display can contain some <a href="#label-35">Inline</a>, except for Footnotes and
|
426
|
+
Reference.</p>
|
427
|
+
<p>In Reference, "|" and "/" are syntax keywords. So if you will write them
|
428
|
+
inside Reference, you have to double-quote the part it's inside, such like:</p>
|
429
|
+
<pre>((<"Bar | inside display text"|Label>))</pre>
|
430
|
+
<p><!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found">Bar | inside display text</em><!-- Reference end --></p>
|
431
|
+
<p>The situations are same whether you will write them inside Substitution
|
432
|
+
part, Filename part and Label part.</p>
|
433
|
+
<p>Of course, you can use the text for the display for Reference to URL resource.</p>
|
434
|
+
<pre>((<Ruby Application Archive|URL:http://www.ruby-lang.org/en/raa.html>))</pre>
|
435
|
+
<p><a href="http://www.ruby-lang.org/en/raa.html">Ruby Application Archive</a></p>
|
436
|
+
<p>When the text for the display is omitted, you can use <a href="#label-35">Inline</a> for Label.</p>
|
437
|
+
<pre>((<((*Label*))>))</pre>
|
438
|
+
<p><!-- Reference, RDLabel "Label" doesn't exist --><em class="label-not-found"><em>Label</em></em><!-- Reference end --></p>
|
439
|
+
<hr />
|
440
|
+
<p class="foottext">
|
441
|
+
<a name="foottext-1" id="foottext-1" href="#footmark-1"><sup><small>*1</small></sup></a><small> If you are interested in others,
|
442
|
+
see rubyapi2
|
443
|
+
<a href="http://www.ueda.info.waseda.ac.jp/~igarashi/ruby/xml.html#rubyapi2"><URL:http://www.ueda.info.waseda.ac.jp/~igarashi/ruby/xml.html#rubyapi2></a>
|
444
|
+
for example. </small><br />
|
445
|
+
<a name="foottext-2" id="foottext-2" href="#footmark-2"><sup><small>*2</small></sup></a><small> But List can't include <a href="#label-15">Headline</a>
|
446
|
+
nor <a href="#label-19">Include</a>. </small><br />
|
447
|
+
<a name="foottext-3" id="foottext-3" href="#footmark-3"><sup><small>*3</small></sup></a><small> You can read very good explanation about Var in texinfo.info. </small><br />
|
448
|
+
<a name="foottext-4" id="foottext-4" href="#footmark-4"><sup><small>*4</small></sup></a><small>Footnote</small><br />
|
449
|
+
<a name="foottext-5" id="foottext-5" href="#footmark-5"><sup><small>*5</small></sup></a><small> text inside "<code>(...)</code>" is regarded as parameters
|
450
|
+
of method, and text inside "<code>{...}</code>" is regarded as parameter
|
451
|
+
block of methods.</small><br />
|
452
|
+
<a name="foottext-6" id="foottext-6" href="#footmark-6"><sup><small>*6</small></sup></a><small> There is no element Labeled
|
453
|
+
"Label", so it doesn't seems to be Reference probably. </small><br />
|
454
|
+
</p>
|
455
|
+
</body>
|
456
|
+
</html>
|