すぎむし。

今週のWeRDSの訳はお休みです。みなさんおとなしかったので。

(元記事は
http://www.moonwolf.com/%7Earcml/cgi-bin/arcml/?rm=view;list_id=2;ml_count=182
 にあります。ってなぜだ。)

今日のおまけはruby-doc向けのネタに集めたまま
何もまとめてないものです。何か気がついた方に
補足・コメントいただければ幸いです。
(URLとか英文ドキュメントとかライセンスとか)
-- 
SugHimsi == SUGIHARA Hiroshi
maili31s / clio.ne.jp

/// Unfinished summary on efforts for plain(?) documentation /// Past and Present (2002-10) /// SugHimsi Those are included in chaos, and perhaps too Ruby-centric... a. formats and formatter b. textprocessor c. browser/pager d. document style suggestion /// Tosh (1) RD An documentation format. Ruby's POD. http://www.ruby-lang.org/%7Erubikitch/RDP.cgi?cmd=view&amp;name=RD (2) RDtool The formatter, handler of RD. http://www2.pos.to/%7Etosh/ruby/rdtool/en/ http://www.ruby-lang.org/en/raa-list.rhtml?name=RDtool (X) RD-related works * getRD, by Moonwolf Extract RD document from Ruby script. http://blade.nagaokaut.ac.jp/ruby/ruby-list/25524 * rd2texi, by Koji Arai html=>texinfo transformation script (limited to ruby's manual) * RT: An extention for table description, by rubikitch http://www.ruby-lang.org/en/raa-list.rhtml?name=RTtool * document.ja http://www.ruby-lang.org/%7Erubikitch/computer/rt/index.html * RDindex: RD in EmacsLisp, by rubikitch http://www.ruby-lang.org/en/raa-list.rhtml?name=RDindex * Online RD converter (ja), by rubikitch and ktokita http://www.ruby-lang.org/%7Erubikitch/makerd.html http://www.where-i.com/%7Ektokita/rdtool.html moriq (1) Pi Apollo's document is written in this syntax. Format (by its author): Simple, elegant, and practical. Plainer than RD. pi2html is available; auto.rb or pi.rb is in Apollo. http://www.users.yun.co.jp/%7Emoriq/ruby/spec.html http://www.users.yun.co.jp/%7Emoriq/ruby/opname.html (both are in Japanese) Keita Yamaguchi (1) BD http://www.ruby-lang.org/en/raa-list.rhtml?name=BD Abstracted, general-purpose RD, as an input format. (2) SD A sample of BD; is a kind of subset of RD. (2) KD Hiroshi IGARASHI (1) rubyapi http://www.ruby-lang.org/%7Eiga/files/ recent archives: http://www.ruby-lang.org/%7Eiga/files/rubyapi2-19991106.tar.gz http://blade.nagaokaut.ac.jp/ruby/ruby-list/17496 http://blade.nagaokaut.ac.jp/ruby/ruby-list/17995 http://blade.nagaokaut.ac.jp/ruby/ruby-list/18294 There was an idea (like Sean's work) in 1999 around Waseda Univ. He (and M. Fukushima) defined rubyapi.dtd and create transformation tool from rubyapi-featured docs to HTML, etc. He thought it suitable for extension library. Old API Document of Ruby/GTK was written in it. (2) rubydoc Yet another Iga's documentation format. Document of ruby-irc was written in it. http://blade.nagaokaut.ac.jp/ruby/ruby-list/23252 (in Japanese) Moonwolf (1) rd2xml http://www.moonwolf.com/ruby/ (2) xml2rb http://www.moonwolf.com/ruby/ (3) RubyDoc http://www.moonwolf.com/ruby/rubydoc/index.html http://blade.nagaokaut.ac.jp/ruby/ruby-list/24556 http://blade.nagaokaut.ac.jp/ruby/ruby-list/34033 A feature to maintain embedded documents in Ruby script. * can extract document from Ruby script to a file * can bring document file in Ruby script * can parallelly edit both script and document (in different editors) * can easily exchange document; can exchange English and Japanese docs * whole document pluggable in your favor RD, HTML, and plain text is scriptable between "=begin ..." line and "=end ..." line. (4) http://rwiki.moonwolf.com/rw-cgi.cgi?cmd=view;name=RDformat (5) ruby-doc mailing list archive http://www.moonwolf.com/%7Earcml/cgi-bin/arcml/?rm=threadlist&list_id=2 Masaki Fukushima (1) xmarshal.rb It can save any Ruby object in XML format. http://www.goto.info.waseda.ac.jp/%7Efukusima/ruby/ (2) rubyapi ...Described at "Hiroshi IGARASHI". Kazuhiro Fuchi (1) embruby--yet another eRuby http://www.ba.wakwak.com/%7Efuchi/rubyxml/2001/docs/emb/index.html Macro processing framework for general embedding document. For example: HTML, RD, XML, Ruby code itself, etc. Extremely stick on #{...} and completely rely on Ruby's parser. http://www.ba.wakwak.com/%7Efuchi/rubyxml/2001/docs/emb/eruby.html Comparison with eRuby: eRuby's embedding tag <% ... %> is (i) not in Ruby's syntax and (ii) forbidden in XML. Mr. T. M., a.k.a. Tomoya Akaishi (1) ruby.freak document format for Ruby ML Topics. The backstage of ruby.freak.ne.jp (^^; http://blade.nagaokaut.ac.jp/ruby/ruby-list/16480 http://blade.nagaokaut.ac.jp/ruby/ruby-list/16581 nyasu (1) tagiter.rb A class to yield a range of the text between a pair of tags. This yields an instance of the class itself. Very loose with the structure of the tags, for convenience. http://www.osk.3web.ne.jp/%7Enyasu/software/ruby.html UENO Katsuhiro, a.k.a. Unnie http://www.blue.sky.or.jp/atelier/ (1) xml2html.rb (2000/03/26) A Ruby script which transforms XHTML 1.0 Strict document to HTML 4.01 Strict one. (2) uink (2000/06/16) uink-0.0.2.tar.gz Command-separated type(?) preprocessor for documents in plain text. License = KaPuLi(??) Minero Aoki (1) ripper http://www.loveruby.net/archive/ripper/ http://blade.nagaokaut.ac.jp/ruby/ruby-list/31973 Extended-library'ed parser of Ruby (with bison) The biggest difference between ripper and Dave's RubyParser is the parser style. ripper is SAX-like. Dave's RubyParser is DOM-like. (NISHIO Mizuho, [ruby-doc:00143]) (2) embedding RD http://blade.nagaokaut.ac.jp/ruby/ruby-list/32119 Once planning to embedded RD project. kadu (1) Class browser with ReFe and ri http://blade.nagaokaut.ac.jp/ruby/ruby-list/29504 http://www.alpha-net.ne.jp/users2/kato2/kadu/ruby/rbbr_with_doc.txt http://www.bb.wakwak.com/%7Eakk/kadu/ruby/rbbr_with_doc.txt http://www.bb.wakwak.com/%7Eakk/kadu/ruby/ (in Japanese) Requires Ruby/Gtk. (2) rl http://www.bb.wakwak.com/%7Eakk/kadu/ruby/rl.txt display the document from =begin to =end (after '$:'). greentea (1) Textautomaton.rb is contains some automatons to process string. http://www02.so-net.ne.jp/%7Egreentea/ruby/textautomaton/ TAKAHASHI Masayoshi (1) Ruby Coding Convention http://rwiki.jin.gr.jp/cgi-bin/rw-cgi.rb?cmd=view;name=RubyCodingConvention RubyDoc-like... Once pickuped in Ruby Garden http://www.rubygarden.org/article.php?sid=134 Koji Arai (1) erd: RDP format suggestion RD's macro, or RD's wrapper http://blade.nagaokaut.ac.jp/ruby/ruby-list/24648 http://blade.nagaokaut.ac.jp/ruby/ruby-list/24685 HIDAKA Takahiro (1) Raise an question on localization http://blade.nagaokaut.ac.jp/ruby/ruby-list/34021 John Johnson (1) RubyDoc http://www.johnjohnsonsoftware.com/RubyDoc/index.html Ruby's answer to JavaDoc. An easy to use source code commenting system. See Dave's comment http://blade.nagaokaut.ac.jp/ruby/ruby-talk/17386 In fact, in the current implementation any comment immediately preceding a class, method, or attribute is associated with that entity. You don't actually need the '##'s. Sean Chittenden http://sean.chittenden.org/news/ (1) rubydoc intended to be Ruby's equiv of perldoc, but more powerful and tightly coupled to the language. (2) rubynet is the backend for a distributed module and documentation project for the Ruby programming language. (target is RAA.succ) Dan Brickley (1) RubyRDF http://www.w3.org/2001/12/rubyrdf/intro.html is a simple, experimental RDF system implemented in Ruby Brandt Kurowski (1) Liber http://liber.sourceforge.net/ Included is an RDF API for Ruby, a layer on top of that API for RDF-based portals, (yet another) web application framework for ruby, and a sample portal ASAMI Tomoharu (1) SmartDoc is an XML-based tool to create documents. http://www.xmlsmartdoc.org/ http://www.asahi-net.or.jp/%7Edp8t-asm/java/tools/SmartDoc/index.html It can convert SmartDoc format document to HTML4.0, HTML3.2, LaTeX2e , JavaHelp and plain text. sdoc2man, tex2sdoc, sdoc2fo, rd2sdoc, sdoc2mgp is also available. GPL license plain2 http://shika.aist-nara.ac.jp/products/plain2/plain2.html (in Japanese) Wiki's TextFormattingRules In WardsWiki, see: http://c2.com/cgi/wiki?TextFormattingRules See also Appendix A of "The Wiki Way". reStructuredText http://docutils.sourceforge.net/rst.html http://docutils.sourceforge.net/spec/rst/introduction.html SOX http://www.langdale.com.au/SOX/ xml2 http://www.ofb.net/%7Eegnor/xml2/ POD http://www.perldoc.com/perl5.8/pod/perlpod.html JavaDoc (What is Java doclet?) LaTeX http://www.latex-project.org/ /// End ///