検索結果

RDoc::Markup (7.0)

• 2.6.0

• クラス

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

...ラスです。

例:

require 'rdoc/markup/to_html'

h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)

独自のフォーマットを行うようにパーサを拡張する事もできます。


例:

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

class WikiHtml < RDoc::...

• RDoc::Markup::ToHtml

RDoc::Markup#add_html(tag, name) -> () (7.0)

• 2.6.0

• インスタンスメソッド

tag で指定したタグをフォーマットの対象にします。

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

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_html("no", :STRIKE)

h = SM::ToHtml.new
h.add_tag(:STRIKE, "<s...

• RDoc::Markup
• SM::ToHtml

RDoc::Markup#add_special(pattern, name) -> () (7.0)

• 2.6.0

• インスタンスメソッド

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

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

例:

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

class WikiHtml < SM::ToHtml
def handle_special_WIKIWORD(special)
"<font color=red>" + sp...

• RDoc::Markup
• SM::ToHtml

RDoc::Markup#add_word_pair(start, stop, name) -> () (7.0)

• 2.6.0

• インスタンスメソッド

start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。

...す。

@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。

例:

require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_word_pair("{", "}", :STRIKE)

h = SM::ToHtml.new
h.add_tag(:STRI...

• RDoc::Markup
• SM::ToHtml

RDoc::Markup#attribute_manager -> RDoc::AttributeManager (7.0)

• 2.6.0

• インスタンスメソッド

自身の RDoc::AttributeManager オブジェクトを返します。

自身の RDoc::AttributeManager オブジェクトを返します。

• RDoc::AttributeManager
• RDoc::Markup

絞り込み条件を変える

RDoc::Markup#content -> String (7.0)

• 2.6.0

• インスタンスメソッド

変換する文字列を返します。

変換する文字列を返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる事があります。

@see SM::SimpleMarkup#convert

• RDoc::Markup

RDoc::Markup#convert(str, formatter) -> object | "" (7.0)

• 2.6.0

• インスタンスメソッド

str で指定された文字列を formatter に変換させます。

str で指定された文字列を formatter に変換させます。

@param str 変換する文字列を指定します。

@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。

変換結果は formatter によって文字列や配列を返します。

• RDoc::Markup
• SM::ToHtml
• SM::ToLaTeX

RDoc::Markup#get_line_types -> [Symbol] (7.0)

• 2.6.0

• インスタンスメソッド

変換する文字列の各行のタイプを Symbol の配列で返します。

変換する文字列の各行のタイプを Symbol の配列で返します。

rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。

@see SM::SimpleMarkup#convert

• RDoc::Markup
• Symbol

RDoc::Markup.new(attribute_manager = nil) -> RDoc::Markup (7.0)

• 2.6.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。

• RDoc::Markup
• Rdoc::AttributeManager

RDoc::Markup::LABEL_LIST_RE -> Regexp (7.0)

• 2.6.0

• 定数

ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。

ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。

• RDoc::Markup

絞り込み条件を変える

RDoc::Markup::SIMPLE_LIST_RE -> Regexp (7.0)

• 2.6.0

• 定数

リストにマッチする正規表現です。ライブラリの内部で使用します。

リストにマッチする正規表現です。ライブラリの内部で使用します。

ラベルの有無を問わずマッチします。

• RDoc::Markup

RDoc::Markup::SPACE -> ?\s (7.0)

• 2.6.0

• 定数

空白文字です。?\s を返します。ライブラリの内部で使用します。

空白文字です。?\s を返します。ライブラリの内部で使用します。

• RDoc::Markup

RDoc::Markup::Formatter (4.0)

• 2.6.0

• クラス

RDoc 形式のドキュメントを整形するための基本クラスです。

RDoc 形式のドキュメントを整形するための基本クラスです。

実際にドキュメントを整形するには、RDoc::Markup::ToHtml のような、
継承したクラスで convert メソッドを実行してください。

• RDoc::Markup::ToHtml

RDoc::Markup::Formatter#add_tag(name, start, stop) -> () (4.0)

• 2.6.0

• インスタンスメソッド

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

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

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

例:

require 'rdoc/markup/to_html'

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

• RDoc::Markup::Formatter
• RDoc::Markup::ToHtml

RDoc::Markup::Formatter#convert(content) -> () (4.0)

• 2.6.0

• インスタンスメソッド

content で指定された文字列を変換します。

content で指定された文字列を変換します。

@param content 変換する文字列を指定します。

• RDoc::Markup::Formatter

絞り込み条件を変える

RDoc::Markup::Formatter.new(markup = nil) -> RDoc::Markup::Formatter (4.0)

• 2.6.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。

• RDoc::Markup
• RDoc::Markup::Formatter

RDoc::Markup::ToAnsi (4.0)

• 2.6.0

• クラス

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするクラスで す。

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするクラスで
す。

RDoc::Markup::ToAnsi.new(markup = nil) -> RDoc::Markup::ToAnsi (4.0)

• 2.6.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。

• RDoc::Markup
• RDoc::Markup::ToAnsi

RDoc::Markup::ToBs (4.0)

• 2.6.0

• クラス

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるクラスです。

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるクラスです。

RDoc::Markup::ToBs.new(markup = nil) -> RDoc::Markup::ToBs (4.0)

• 2.6.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。

• RDoc::Markup
• RDoc::Markup::ToBs

絞り込み条件を変える

RDoc::Markup::ToHtml (4.0)

• 2.6.0

• クラス

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

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

RDoc::Markup::ToHtml.new -> RDoc::Markup::ToHtml (4.0)

• 2.6.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

• RDoc::Markup::ToHtml

RDoc::Markup::ToHtmlCrossref (4.0)

• 2.6.0

• クラス

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

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

RDoc::Markup::ToHtmlCrossref.new(path, context, show_hash) -> RDoc::Markup::ToHtmlCrossref (4.0)

• 2.6.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param path 生成するファイルのパスを文字列で指定します。

@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。

@param show_hash true を指定した場合、メソッド名のリンクに # を表示しま
す。false の場合は表示しません。

@raise ArgumentError path に nil を指定した場合に発生します。

• RDoc::Context
• RDoc::Markup::ToHtmlCrossref

RDoc::Markup::ToRdoc (4.0)

• 2.6.0

• クラス

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための クラスです。

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。

絞り込み条件を変える

RDoc::Markup::ToRdoc.new(markup = nil) -> RDoc::Markup::ToRdoc (4.0)

• 2.6.0

• 特異メソッド

自身を初期化します。

自身を初期化します。

@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。

• RDoc::Markup
• RDoc::Markup::ToRdoc