バージョン:3.3 > ライブラリ:rdoc > クエリ:markup

34件ヒット [1-34件を表示] （0.012秒）

トップページ >

:3.3

:rdoc

:markup

別のキーワード

種類

クラス

モジュール

RDoc::Text (2)

キーワード

Formatter (1)
LABEL_LIST_RE (1)
Markup (2)
RDoc (1)
SIMPLE_LIST_RE (1)
SPACE (1)
ToAnsi (1)
ToBs (1)
ToHtml (1)
ToHtmlCrossref (1)
ToRdoc (1)
add_html (1)
add_special (1)
add_tag (1)
add_word_pair (1)
attribute_manager (1)
content (1)
convert (2)
get_line_types (1)
markup= (1)
new (7)
parse (3)

検索結果

RDoc::Options#markup -> String (54355.0)

インスタンスメソッド

コマンドライン引数の --markup オプションで指定したフォーマットを返します。

...コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。

指定されていない場合は 'rdoc' を返します。...

RDoc::Text#markup(text) -> String (54307.0)

インスタンスメソッド

引数を整形します。

引数を整形します。

include したクラスに self#formatter メソッドが必要です。

@param text 文字列を指定します。

RDoc::Options#markup=(val) (18355.0)

インスタンスメソッド

コマンドライン引数の --markup オプションと同様の指定を行います。

コマンドライン引数の --markup オプションと同様の指定を行います。

@param val フォーマットを文字列で指定します。

RDoc::Markup (18130.0)

クラス

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

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

例:

require 'rdoc/markup/to_html'

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

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

例:

req...

...uire 'rdoc/markup'
require 'rdoc/markup/to_html'

class WikiHtml < RDoc::Markup::ToHtml
# WikiWord のフォントを赤く表示。
def handle_special_WIKIWORD(special)
"<font color=red>" + special.text + "</font>"
end
end

m = RDoc::Markup.new
# { 〜 } までを :STRIK...

...STRIKE のフォーマットを <strike> 〜 </strike> に指定。
wh.add_tag(:STRIKE, "<strike>", "</strike>")

puts "<body>#{wh.convert ARGF.read}</body>"

変換する形式を変更する場合、フォーマッタ(例. RDoc::Markup::ToHtml)
を変更、拡張する必要があります。...

RDoc::Generator::Markup (18004.0)

モジュール

ライブラリ内部で使用します。

絞り込み条件を変える

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

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

特異メソッド

自身を初期化します。

...自身を初期化します。

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

絞り込み条件を変える

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

特異メソッド

自身を初期化します。

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

特異メソッド

自身を初期化します。

...自身を初期化します。

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

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

@param show_hash true を指定した場合、メソッ...

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

インスタンスメソッド

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

...::ToHtml などのフォーマッタに識別させる時の名前を
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,...

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

インスタンスメソッド

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

...::ToHtml などのフォーマッタに識別させる時の名前を
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>" +...

RDoc::Markup#add_word_pair(start, stop, name) -> () (9076.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(:S...

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

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

例:

require 'rdoc/markup/to_html...

...'

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

RDoc::Markup::Formatter (9022.0)

クラス

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

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

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

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

インスタンスメソッド

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

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

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

インスタンスメソッド

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

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

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

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

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

インスタンスメソッド

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

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

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

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

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

絞り込み条件を変える

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

インスタンスメソッド

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

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

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

@see SM::SimpleMarkup#convert...

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

インスタンスメソッド

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

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

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

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

定数

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

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

定数

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

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

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

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

定数

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

絞り込み条件を変える

RDoc::Markup::ToAnsi (9004.0)

クラス

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

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

RDoc::Markup::ToBs (9004.0)

クラス

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

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

RDoc::Markup::ToHtml (9004.0)

クラス

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

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

RDoc::Markup::ToHtmlCrossref (9004.0)

クラス

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

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

RDoc::Markup::ToRdoc (9004.0)

クラス

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

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

絞り込み条件を変える

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (355.0)

インスタンスメソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

...引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。

@param markdown 解析の対象になるドキュメントを文字列で指定します。...

RDoc::Markdown.parse(markdown) -> RDoc::Markup::Document (355.0)

特異メソッド

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (307.0)

インスタンスメソッド

引数から RDoc::Text#normalize_comment でスペースや改行文字などを削除した後に解析を行います。

...引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。

@param text 文字列を指定します。

@see RDoc::Text#normalize_comment...

RDoc::RDoc (22.0)

クラス

rdoc ドキュメントの作成を行うクラスです。

...rdoc ドキュメントの作成を行うクラスです。

以下のようにして、rdoc コマンドを実行するのと同様に実行します。

require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)

args には rdoc コマンドに渡すのと同様の引数を文字列...

...の配列で指定します。

rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。...

別のキーワード

種類

クラス

モジュール

キーワード

検索結果

先頭5件

RDoc::Options#markup -> String (54355.0)

RDoc::Text#markup(text) -> String (54307.0)

RDoc::Options#markup=(val) (18355.0)

RDoc::Markup (18130.0)

RDoc::Generator::Markup (18004.0)

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

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

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

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

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

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

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

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

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

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

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

RDoc::Markup::Formatter (9022.0)

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

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

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

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

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

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

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

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

RDoc::Markup::ToAnsi (9004.0)

RDoc::Markup::ToBs (9004.0)

RDoc::Markup::ToHtml (9004.0)

RDoc::Markup::ToHtmlCrossref (9004.0)

RDoc::Markup::ToRdoc (9004.0)

RDoc::Markdown#parse(markdown) -> RDoc::Markup::Document (355.0)

RDoc::Markdown.parse(markdown) -> RDoc::Markup::Document (355.0)

RDoc::Text#parse(text) -> RDoc::Markup::Document | Array (307.0)

RDoc::RDoc (22.0)