Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > rdoc/markup/simple_markup/to_flowライブラリ

library rdoc/markup/simple_markup/to_flow

要約

RDoc 形式のドキュメントを表示する一段階前の構造化された状態にするための サブライブラリです。

SM::SimpleMarkup#convert の引数に SM::ToFlow のインスタンス を渡して使用します。 

require 'rdoc/ri/ri_formatter'
require 'rdoc/ri/ri_options'
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_flow'

m = SM::SimpleMarkup.new
h = SM::ToFlow.new
flow = m.convert(input_string, h)
options = RI::Options.instance
formatter = options.formatter.new(options, "")
formatter.display_flow(flow)

変換した結果は構造体の配列で取得できます。SM::ToHtml などとは異な り SM::SimpleMarkup#convert が文字列を返さないため、上記のように フォーマッタに変換した結果を渡す必要があります。

クラス

class SM::ToFlow

RDoc 形式のドキュメントを表示する一段階前の構造化された状態にするための クラスです。

同時にrequireされるライブラリ

cgi

CGI プログラムの支援ライブラリです。

library rdoc/markup/simple_markup/to_flow