instance method RDoc::Markup#add_regexp_handling

pattern で指定した正規表現にマッチする文字列をフォーマットの対象にします。

例えば WikiWord のような、単純な開始・終了の記号ではさめない文字列に対して使用します。

[PARAM] pattern:

正規表現を指定します。

[PARAM] name:

RDoc::Markup::ToHtml などのフォーマッタに識別させる時の名前を Symbol で指定します。

フォーマッタ(例. RDoc::Markup::ToHtml)は自身が持つ RDoc::Markup オブジェクトに登録された正規表現を使うため、独自のフォーマットを追加するには、フォーマッタのサブクラスで登録を行います。

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

class WikiHtml < RDoc::Markup::ToHtml
  def initialize(...)
    super
    @markup.add_regexp_handling(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
  end

  def handle_regexp_WIKIWORD(text)
    "<font color=red>" + text + "</font>"
  end
end

p WikiHtml.new.convert("see WikiWord here")
# => "\n<p>see <font color=red>WikiWord</font> here</p>\n"

変換時に実際にフォーマットを行うには、フォーマッタ側で handle_regexp_<name で指定した名前>(text) を定義します。 text にはマッチした文字列(正規表現にグループがある場合は最初のグループ)が渡されます。