ライブラリ
-
rdoc
/ generator / markup (1) -
rdoc
/ markdown (2) -
rdoc
/ markup (12) -
rdoc
/ markup / formatter (4) -
rdoc
/ markup / to _ ansi (2) -
rdoc
/ markup / to _ bs (2) -
rdoc
/ markup / to _ html (2) -
rdoc
/ markup / to _ html _ crossref (2) -
rdoc
/ markup / to _ rdoc (2) -
rdoc
/ rdoc (1) -
rdoc
/ text (2) - yaml (1)
クラス
-
RDoc
:: Markdown (2) -
RDoc
:: Markup (11) -
RDoc
:: Markup :: Formatter (3) -
RDoc
:: Markup :: ToAnsi (1) -
RDoc
:: Markup :: ToBs (1) -
RDoc
:: Markup :: ToHtml (1) -
RDoc
:: Markup :: ToHtmlCrossref (1) -
RDoc
:: Markup :: ToRdoc (1) -
RDoc
:: Options (2)
モジュール
-
RDoc
:: Text (2)
キーワード
-
1
. 6 . 8から1 . 8 . 0への変更点(まとめ) (1) - 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)
- YAML (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)
-
net
/ http (1) - new (7)
- parse (3)
- rdoc (1)
-
rdoc
/ generator / markup (1) -
rdoc
/ markup (1) -
rdoc
/ markup / formatter (1) -
rdoc
/ markup / to _ ansi (1) -
rdoc
/ markup / to _ bs (1) -
rdoc
/ markup / to _ html (1) -
rdoc
/ markup / to _ html _ crossref (1) -
rdoc
/ markup / to _ rdoc (1) -
rdoc
/ parser / changelog (1) -
ruby 1
. 8 . 4 feature (1) - yaml (1)
検索結果
先頭5件
-
RDoc
:: Options # markup -> String (54352.0) -
コマンドライン引数の --markup オプションで指定したフォーマットを返しま す。
コマンドライン引数の --markup オプションで指定したフォーマットを返しま
す。
指定されていない場合は 'rdoc' を返します。 -
RDoc
:: Text # markup(text) -> String (54304.0) -
引数を整形します。
引数を整形します。
include したクラスに self#formatter メソッドが必要です。
@param text 文字列を指定します。 -
RDoc
:: Options # markup=(val) (18352.0) -
コマンドライン引数の --markup オプションと同様の指定を行います。
コマンドライン引数の --markup オプションと同様の指定を行います。
@param val フォーマットを文字列で指定します。 -
RDoc
:: Markup (18127.0) -
RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。
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
# WikiWord のフォントを赤く表示。
... -
rdoc
/ markup (18109.0) -
RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。
RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の
FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う
ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も
行いません。
それらは output_format で後述するクラス群に委ねられています。
=== Markup
基本的には、lib:rdoc#markup と同じです。ただし、rdoc コマンドと
は異なり、Ruby のソースコードのコメント部分ではなく、プレイン... -
rdoc
/ markup / to _ ansi (18037.0) -
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ ブラリです。
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ
ブラリです。
require 'rdoc/markup/to_ansi'
h = RDoc::Markup::ToAnsi.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。 -
rdoc
/ markup / to _ bs (18037.0) -
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるサブライブラリです。
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるサブライブラリです。
require 'rdoc/markup/to_bs'
h = RDoc::Markup::ToBs.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。実際に効果を確認するためにはページャ
などで出力を確認します。
テキスト中の以下のマークアップ記法をエスケープシーケンスの \b と組み合
わせる事によって見た目を変更します。
* イタリック体(_word_): word にアンダーラインを付けて... -
rdoc
/ markup / to _ html (18037.0) -
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
require 'rdoc/markup/to_html'
h = RDoc::Markup::ToHtml.new
puts h.convert(input_string)
変換した結果は文字列で取得できます。 -
rdoc
/ markup / to _ html _ crossref (18019.0) -
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。
RDoc::Markup::ToHtml を拡張して、ドキュメント内のメソッド名やクラ
ス名を自動的にリンクにします。 -
rdoc
/ markup / to _ rdoc (18019.0) -
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための サブライブラリです。
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
サブライブラリです。
サブクラス(RDoc::Markup::ToAnsi など)を作成して使います。 -
RDoc
:: Generator :: Markup (18001.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
rdoc
/ generator / markup (18001.0) -
ライブラリ内部で使用します。
ライブラリ内部で使用します。 -
rdoc
/ markup / formatter (18001.0) -
RDoc 形式のドキュメントを整形するためのサブライブラリです。
RDoc 形式のドキュメントを整形するためのサブライブラリです。 -
RDoc
:: Markup :: Formatter . new(markup = nil) -> RDoc :: Markup :: Formatter (9643.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup :: ToAnsi . new(markup = nil) -> RDoc :: Markup :: ToAnsi (9643.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup :: ToBs . new(markup = nil) -> RDoc :: Markup :: ToBs (9643.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup :: ToRdoc . new(markup = nil) -> RDoc :: Markup :: ToRdoc (9643.0) -
自身を初期化します。
自身を初期化します。
@param markup RDoc::Markup オブジェクトを指定します。省略した場合
は新しく作成します。 -
RDoc
:: Markup . new(attribute _ manager = nil) -> RDoc :: Markup (9304.0) -
自身を初期化します。
自身を初期化します。
@param attribute_manager Rdoc::AttributeManager オブジェクトを指
定します。 -
RDoc
:: Markup :: ToHtml . new -> RDoc :: Markup :: ToHtml (9304.0) -
自身を初期化します。
自身を初期化します。 -
RDoc
:: Markup :: ToHtmlCrossref . new(path , context , show _ hash) -> RDoc :: Markup :: ToHtmlCrossref (9304.0) -
自身を初期化します。
自身を初期化します。
@param path 生成するファイルのパスを文字列で指定します。
@param context RDoc::Context オブジェクトかそのサブクラスのオブジェ
クトを指定します。
@param show_hash true を指定した場合、メソッド名のリンクに # を表示しま
す。false の場合は表示しません。
@raise ArgumentError path に nil を指定した場合に発生します。 -
RDoc
:: Markup # add _ html(tag , name) -> () (9073.0) -
tag で指定したタグをフォーマットの対象にします。
tag で指定したタグをフォーマットの対象にします。
@param tag 追加するタグ名を文字列で指定します。大文字、小文字のど
ちらを指定しても同一のものとして扱われます。
@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
例:
require 'rdoc/markup/simple_markup'
require 'rdoc/markup/simple_markup/to_html'
m = SM::SimpleMarkup.new
m.add_ht... -
RDoc
:: Markup # add _ special(pattern , name) -> () (9073.0) -
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 # add _ word _ pair(start , stop , name) -> () (9073.0) -
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま す。
start と stop ではさまれる文字列(例. *bold*)をフォーマットの対象にしま
す。
@param start 開始となる文字列を指定します。
@param stop 終了となる文字列を指定します。start と同じ文字列にする事も
可能です。
@param name SM::ToHtml などのフォーマッタに識別させる時の名前を
Symbol で指定します。
@raise RuntimeError start に "<" で始まる文字列を指定した場合に発生します。
例:
require 'rdoc/markup/... -
RDoc
:: Markup :: Formatter # add _ tag(name , start , stop) -> () (9055.0) -
name で登録された規則で取得された文字列を start と stop で囲むように指 定します。
name で登録された規則で取得された文字列を start と stop で囲むように指
定します。
@param name RDoc::Markup::ToHtml などのフォーマッタに識別させる時
の名前を Symbol で指定します。
@param start 開始の記号を文字列で指定します。
@param stop 終了の記号を文字列で指定します。
例:
require 'rdoc/markup/to_html'
# :STRIKE のフォーマットを <strike> 〜 </strike> に指定。
h = RDoc::Markup:... -
RDoc
:: Markup :: Formatter (9019.0) -
RDoc 形式のドキュメントを整形するための基本クラスです。
RDoc 形式のドキュメントを整形するための基本クラスです。
実際にドキュメントを整形するには、RDoc::Markup::ToHtml のような、
継承したクラスで convert メソッドを実行してください。 -
RDoc
:: Markup # attribute _ manager -> RDoc :: AttributeManager (9001.0) -
自身の RDoc::AttributeManager オブジェクトを返します。
自身の RDoc::AttributeManager オブジェクトを返します。 -
RDoc
:: Markup # content -> String (9001.0) -
変換する文字列を返します。
変換する文字列を返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
変換のために加工したオブジェクトを改行で連結したものを返すため、変換前
の文字列と結果が異なる事があります。
@see SM::SimpleMarkup#convert -
RDoc
:: Markup # convert(str , formatter) -> object | "" (9001.0) -
str で指定された文字列を formatter に変換させます。
str で指定された文字列を formatter に変換させます。
@param str 変換する文字列を指定します。
@param formatter SM::ToHtml、SM::ToLaTeX などのインスタンス
を指定します。
変換結果は formatter によって文字列や配列を返します。 -
RDoc
:: Markup # get _ line _ types -> [Symbol] (9001.0) -
変換する文字列の各行のタイプを Symbol の配列で返します。
変換する文字列の各行のタイプを Symbol の配列で返します。
rdoc ライブラリのデバッグ用途に使用します。
SM::SimpleMarkup#convert の後に実行します。
@see SM::SimpleMarkup#convert -
RDoc
:: Markup :: Formatter # convert(content) -> () (9001.0) -
content で指定された文字列を変換します。
content で指定された文字列を変換します。
@param content 変換する文字列を指定します。 -
RDoc
:: Markup :: LABEL _ LIST _ RE -> Regexp (9001.0) -
ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。
ラベル付きリストにマッチする正規表現です。ライブラリの内部で使用します。 -
RDoc
:: Markup :: SIMPLE _ LIST _ RE -> Regexp (9001.0) -
リストにマッチする正規表現です。ライブラリの内部で使用します。
リストにマッチする正規表現です。ライブラリの内部で使用します。
ラベルの有無を問わずマッチします。 -
RDoc
:: Markup :: SPACE -> ?\s (9001.0) -
空白文字です。?\s を返します。ライブラリの内部で使用します。
空白文字です。?\s を返します。ライブラリの内部で使用します。 -
RDoc
:: Markup :: ToAnsi (9001.0) -
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするクラスで す。
RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするクラスで
す。 -
RDoc
:: Markup :: ToBs (9001.0) -
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるクラスです。
RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効
果を持たせるように見せるクラスです。 -
RDoc
:: Markup :: ToHtml (9001.0) -
RDoc 形式のドキュメントを HTML に整形するクラスです。
RDoc 形式のドキュメントを HTML に整形するクラスです。 -
RDoc
:: Markup :: ToHtmlCrossref (9001.0) -
RDoc 形式のドキュメントを HTML に整形するクラスです。
RDoc 形式のドキュメントを HTML に整形するクラスです。 -
RDoc
:: Markup :: ToRdoc (9001.0) -
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための クラスです。
RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための
クラスです。 -
RDoc
:: Markdown # parse(markdown) -> RDoc :: Markup :: Document (352.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。 -
RDoc
:: Markdown . parse(markdown) -> RDoc :: Markup :: Document (352.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。 -
RDoc
:: Text # parse(text) -> RDoc :: Markup :: Document | Array (304.0) -
引数から RDoc::Text#normalize_comment でスペースや改行文字などを削 除した後に解析を行います。
引数から RDoc::Text#normalize_comment でスペースや改行文字などを削
除した後に解析を行います。
@param text 文字列を指定します。
@see RDoc::Text#normalize_comment -
rdoc (271.0)
-
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という ドキュメント生成のためのコマンドも含んでいます。
RDoc は Ruby のドキュメント生成を行うためのライブラリです。rdoc という
ドキュメント生成のためのコマンドも含んでいます。
このパッケージは RDoc と Markup というふたつのコンポーネントを含
んでいます。 RDoc とは Ruby のソースファイルに対するドキュメントを生成
するアプリケーションです。 JavaDoc と同様に、ソースを解析し、クラス、モ
ジュール、メソッドの定義を抜き出してきます(include,require もです)。そ
してこれらの内容とその直前に書かれたコメントを併合し、ドキュメントを出
力します(現在は HTML しか出力できませんが、こ... -
YAML (49.0)
-
YAML (YAML Ain't Markup Language) を扱うモジュールです。
YAML (YAML Ain't Markup Language) を扱うモジュールです。
YAML オブジェクトは実際は Psych オブジェクトです。その他のオブジェ
クトも同様に実体は別のオブジェクトです。もし確認したいメソッドの記述が
見つからない場合は、psych ライブラリを確認してください。
//emlist[例][ruby]{
require "yaml"
p YAML # => Psych
p YAML::Stream # => Psych::Stream
//} -
yaml (49.0)
-
構造化されたデータを表現するフォーマットであるYAML (YAML Ain't Markup Language) を扱うためのライブラリです。
構造化されたデータを表現するフォーマットであるYAML (YAML Ain't Markup Language) を扱うためのライブラリです。
//emlist[例1: 構造化された配列][ruby]{
require 'yaml'
data = ["Taro san", "Jiro san", "Saburo san"]
str_r = YAML.dump(data)
str_l = <<~YAML_EOT
---
- Taro san
- Jiro san
- Saburo san
YAML_EOT
p str_r == str_l # => true
//}
... -
ruby 1
. 8 . 4 feature (37.0) -
ruby 1.8.4 feature ruby 1.8.4 での ruby 1.8.3 からの変更点です。
ruby 1.8.4 feature
ruby 1.8.4 での ruby 1.8.3 からの変更点です。
掲載方針
*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。
以下は各変更点に付けるべきタグです。
記号について(特に重要なものは大文字(主観))
# * カテゴリ
# * [ruby]: ruby インタプリタの変更
# * [api]: 拡張ライブラリ API
# * [lib]: ライブラリ
* レベル
* [bug]: バグ修正
* [new]: 追加され... -
1
. 6 . 8から1 . 8 . 0への変更点(まとめ) (19.0) -
1.6.8から1.8.0への変更点(まとめ) * ((<1.6.8から1.8.0への変更点(まとめ)/インタプリタの変更>)) * ((<1.6.8から1.8.0への変更点(まとめ)/追加されたクラス/モジュール>)) * ((<1.6.8から1.8.0への変更点(まとめ)/追加されたメソッド>)) * ((<1.6.8から1.8.0への変更点(まとめ)/追加された定数>)) * ((<1.6.8から1.8.0への変更点(まとめ)/拡張されたクラス/メソッド(互換性のある変更)>)) * ((<1.6.8から1.8.0への変更点(まとめ)/変更されたクラス/メソッド(互換性のない変更)>)) * ((<1.6.8から1.8.0への変更点(まとめ)/文法の変更>)) * ((<1.6.8から1.8.0への変更点(まとめ)/正規表現>)) * ((<1.6.8から1.8.0への変更点(まとめ)/Marshal>)) * ((<1.6.8から1.8.0への変更点(まとめ)/Windows 対応>)) * ((<1.6.8から1.8.0への変更点(まとめ)/廃止された(される予定の)機能>)) * ((<1.6.8から1.8.0への変更点(まとめ)/ライブラリ>)) * ((<1.6.8から1.8.0への変更点(まとめ)/拡張ライブラリAPI>)) * ((<1.6.8から1.8.0への変更点(まとめ)/バグ修正>)) * ((<1.6.8から1.8.0への変更点(まとめ)/サポートプラットフォームの追加>))
1.6.8から1.8.0への変更点(まとめ)
* ((<1.6.8から1.8.0への変更点(まとめ)/インタプリタの変更>))
* ((<1.6.8から1.8.0への変更点(まとめ)/追加されたクラス/モジュール>))
* ((<1.6.8から1.8.0への変更点(まとめ)/追加されたメソッド>))
* ((<1.6.8から1.8.0への変更点(まとめ)/追加された定数>))
* ((<1.6.8から1.8.0への変更点(まとめ)/拡張されたクラス/メソッド(互換性のある変更)>))
* ((<1.6.8から1.8.0への変更点(まとめ)/変更されたクラス/メソッド(互換性のない変更)>))... -
RDoc
:: RDoc (19.0) -
rdoc ドキュメントの作成を行うクラスです。
rdoc ドキュメントの作成を行うクラスです。
以下のようにして、rdoc コマンドを実行するのと同様に実行します。
require 'rdoc/rdoc'
rdoc = RDoc::RDoc.new
rdoc.document(args)
args には rdoc コマンドに渡すのと同様の引数を文字列の配列で指定します。
rdoc コマンドと同様に変換結果はファイルに出力されるため、テキストを
HTML に変換する部分をライブラリとして使用したい場合、
rdoc/markup を参照してください。 -
net
/ http (19.0) -
汎用データ転送プロトコル HTTP を扱うライブラリです。 実装は 2616 に基きます。
汎用データ転送プロトコル HTTP を扱うライブラリです。
実装は 2616 に基きます。
=== 使用例
==== ウェブサーバからドキュメントを得る (GET)
//emlist[例1: GET して 表示するだけ][ruby]{
require 'net/http'
print Net::HTTP.get('www.example.com', '/index.html')
//}
//emlist[例2: URI を使う][ruby]{
require 'net/http'
require 'uri'
print Net::HTTP.get(URI.parse('http://w... -
rdoc
/ parser / changelog (19.0) -
ChangeLog ファイルを解析するためのサブライブラリです。
ChangeLog ファイルを解析するためのサブライブラリです。
ChangeLog ファイルを解析して、RDoc::Markup::Document オブジェクト
に変換します。出力される HTML はサイドバーに日ごとに分けられます。
このサブライブラリは主に MRI の ChangeLog を解析するために使われますが、
GNU style の ChangeLog(http://www.gnu.org/prep/standards/html_node/Style-of-Change-Logs.html
参照)であれば解析できます。