要約
RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行うツール群の基礎として作られています。RDoc::Markup 自身は何の出力も行いません。それらは 出力可能な形式 で後述するクラス群に委ねられています。
Markup
基本的には、rdoc/Markup と同じです。ただし、rdoc コマンドとは異なり、Ruby のソースコードのコメント部分ではなく、プレインテキストが変換対象になります。そのため、以下のみがフォーマットされます。
出力可能な形式
変換する形式として以下のいずれかを選択できます。
- HTML 形式: RDoc::Markup::ToHtml
- HTML 形式: RDoc::Markup::ToHtmlCrossref
クラス
| RDoc::Markup | RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。 |
サブライブラリ
| rdoc/markup/formatter | RDoc 形式のドキュメントを整形するためのサブライブラリです。 |
| rdoc/markup/to_ansi | RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライブラリです。 |
| rdoc/markup/to_bs | RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効果を持たせるように見せるサブライブラリです。 |
| rdoc/markup/to_html | RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。 |
| rdoc/markup/to_html_crossref | RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。 |
| rdoc/markup/to_rdoc | RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるためのサブライブラリです。 |