Ruby 1.8.7 リファレンスマニュアル > ライブラリ一覧 > rdoc/markup/simple_markupライブラリ
RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
SM::SimpleMarkup は RDoc 形式のドキュメント、Wiki エントリ、Web 上の FAQ などを想定したプレインテキストから様々なフォーマットへの変換を 行うツール群の基礎として作られています。SM::SimpleMarkup 自身は何 の出力も行いません。 それらは 出力可能な形式 で後述するクラス群に委ねられています。
基本的には、rdoc/Markup と同じです。ただし、rdoc コマンドと は異なり、Ruby のソースコードのコメント部分ではなく、プレインテキストが 変換対象になります。そのため、以下のみがフォーマットされます。
変換する形式として以下のいずれかを選択できます。
また、それ以外にコマンドライン表示などで特別なフォーマットにしたい場合 に、SM::ToFlow を使用できます。(ri コマンドで使われています)
| SM::SimpleMarkup | RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。 |
| rdoc/markup/simple_markup/to_flow | RDoc 形式のドキュメントを表示する一段階前の構造化された状態にするための サブライブラリです。 |
| rdoc/markup/simple_markup/to_html | RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。 |
| rdoc/markup/simple_markup/to_latex | RDoc 形式のドキュメントを LaTeX に整形するためのサブライブラリです。 |