Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > rdoc/markup/simple_markup/to_htmlライブラリ > SM::ToHtmlクラス

class SM::ToHtml

クラスの継承リスト: SM::ToHtml < Object < Kernel

要約

RDoc 形式のドキュメントを HTML に整形するクラスです。

[注意] 1.9 系では、require 先やクラス名が以下のように変更になりました。

• require 先: rdoc/markup/to_html
• クラス名: RDoc::Markup::ToHtml

目次

特異メソッド

new

インスタンスメソッド

add_tag

特異メソッド

new -> SM::ToHtml[permalink][rdoc]

自身を初期化します。

実際に文字列を変換する際には、SM::SimpleMarkup#convert の引数に自 身を渡します。

[SEE_ALSO] SM::SimpleMarkup#convert

インスタンスメソッド

add_tag(name, start, stop) -> ()[permalink][rdoc]

name で登録された規則で取得された文字列を start と stop で囲むように指 定します。

[PARAM] name:

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

[PARAM] start:

開始の記号を文字列で指定します。

[PARAM] stop:

終了の記号を文字列で指定します。

例:

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

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