検索結果

rdoc/markup (44006.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• ライブラリ

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

...イブラリです。

RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も...

...行いません。
それらは output_format で後述するクラス群に委ねられています。

=== Markup

基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby のソースコードのコメント部分ではなく、プレインテキ...

...doc#labeled_list
* lib:rdoc#headline
* lib:rdoc#ruled_line
* lib:rdoc#italic_bold_typewriter
* lib:rdoc#escape


===[a:output_format] 出力可能な形式

変換する形式として以下のいずれかを選択できます。

* HTML 形式: RDoc::Markup::ToHtml
* HTML 形式: RDoc::Markup...

• RDoc::Markup
• rdoc/markup/formatter
• rdoc/markup/to_ansi
• rdoc/markup/to_bs
• rdoc/markup/to_html
• rdoc/markup/to_html_crossref
• rdoc/markup/to_rdoc

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

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

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

• RDoc::AttributeManager
• RDoc::Markup

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

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

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

例えば WikiWord のような、SM::SimpleMarkup#add_word_pair、
SM::SimpleMarkup#add_html でフォーマットできないものに対して使用
します。

@param pattern 正規...

...。

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

例:

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

class WikiHtml < SM::ToHtml
def handle_special_WIKIWORD(special)
"...

...ont color=red>" + special.text + "</font>"
end
end

m = SM::SimpleMarkup.new
m.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)

h = WikiHtml.new
puts m.convert(input_string, h)

変換時に実際にフォーマットを行うには SM::ToHtml#accept_special_<name で指定した名...

• RDoc::Markup
• SM::ToHtml

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

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

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

@param tag 追加するタグ名を文字列で指定します。大文字、小文字のど
ちらを指定しても同一のものとして扱われます。

@param name SM::ToHtml などのフォーマッタに...

...'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, "<strike>", "</strike>")
puts m.convert(input_string, h)

変換時に実際にフォーマットを行うには SM::ToHtml#ad...

...d_tag のように、
フォーマッタ側でも操作を行う必要があります。...

• RDoc::Markup
• SM::ToHtml

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• インスタンスメソッド

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

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

@param start 開始となる文字列を指定します。

@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。

@param name...

...。

@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(:STRIKE,...

..."<strike>", "</strike>")
puts m.convert(input_string, h)

変換時に実際にフォーマットを行うには SM::ToHtml#add_tag のように、
フォーマッタ側でも操作を行う必要があります。...

• RDoc::Markup
• SM::ToHtml

絞り込み条件を変える

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• 定数

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

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

• RDoc::Markup

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

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• 定数

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

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

• RDoc::Markup

RDoc::Markup (14036.0)

• 2.1.0
• 2.2.0
• 2.3.0
• 2.4.0
• 2.5.0
• 2.6.0
• 2.7.0
• 3.0
• 3.1
• 3.2
• 3.3
• 3.4

• クラス

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::Markup::ToHtml
#...

...ef handle_special_WIKIWORD(special)
"<font color=red>" + special.text + "</font>"
end
end

m = RDoc::Markup.new
# { 〜 } までを :STRIKE でフォーマットする。
m.add_word_pair("{", "}", :STRIKE)
# <no> 〜 </no> までを :STRIKE でフォーマットする。
m.add_...

...KE)

# WikiWord を追加。
m.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)

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

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

変換する形式を...

• RDoc::Markup::ToHtml

rdoc/markup/to_ansi (12006.0)

• 2.2.0
• 2.4.0
• 2.5.0
• 3.0

• ライブラリ

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

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

require 'rdoc/markup/to_ansi'

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

変換した結果は文字列で取得できます。...

• RDoc::Markup::ToAnsi