type=class
superclass=Object
included=
extended=
dynamically_included=
dynamically_extended=
library=rdoc.markup
aliases=
aliasof=

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

例:

  require 'rdoc/markup/to_html'

  h = RDoc::Markup::ToHtml.new
  puts h.convert(input_string)

独自のフォーマットを行うようにパーサを拡張する事もできます。


例:

  require 'rdoc/markup'
  require 'rdoc/markup/to_html'

  class WikiHtml < RDoc::Markup::ToHtml
    # WikiWord のフォントを赤く表示。
    def handle_special_WIKIWORD(special)
      "<font color=red>" + special.text + "</font>"
    end
  end

  m = RDoc::Markup.new
  # { 〜 } までを :STRIKE でフォーマットする。
  m.add_word_pair("{", "}", :STRIKE)
  # <no> 〜 </no> までを :STRIKE でフォーマットする。
  m.add_html("no", :STRIKE)

  # WikiWord を追加。
  m.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)

  wh = WikiHtml.new(m)
  # :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
  wh.add_tag(:STRIKE, "<strike>", "</strike>")

  puts "<body>#{wh.convert ARGF.read}</body>"

変換する形式を変更する場合、フォーマッタ(例. [[c:RDoc::Markup::ToHtml]])
を変更、拡張する必要があります。
