Skip to content

Commit f42dba9

Browse files
authored
Merge pull request #3032 from rurema/normalize/rss-tutorial-period
rss/Tutorial: 全角の「.,」を和文句読点「。、」に統一
2 parents 65f2fb3 + 7fde30d commit f42dba9

1 file changed

Lines changed: 66 additions & 66 deletions

File tree

refm/api/src/rss/Tutorial

Lines changed: 66 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
=== 注意
44

5-
RSS ParserはRSS 0.9x/1.0/2.0, Atom 1.0 をサポートしていますがRSS 0.90
6-
はサポートしてませんごめんなさい
5+
RSS ParserはRSS 0.9x/1.0/2.0, Atom 1.0 をサポートしていますがRSS 0.90
6+
はサポートしてませんごめんなさい
77

88
RSS のモジュールはそれぞれ、
99
* Dublin Core モジュール [[url:http://web.resource.org/rss/1.0/modules/dc/]]
@@ -12,7 +12,7 @@ RSS のモジュールはそれぞれ、
1212
* Trackback モジュール [[url:http://madskills.com/public/xml/rss/module/trackback/]]
1313
* Image モジュール [[url:http://web.resource.org/rss/1.0/modules/image/]]
1414
をサポートしています。
15-
ただしContent モジュールは content:encoded しかサポートしていません
15+
ただしContent モジュールは content:encoded しかサポートしていません
1616

1717
=== パース
1818

@@ -23,10 +23,10 @@ RSS::Parser.parse は String の RSSを パースします(使用するXMLパー
2323
* RSS 0.9x/2.0をパースした場合は [[c:RSS::Rss]] オブジェクト
2424
* Atom をパースした場合は [[c:RSS::Atom::Feed]] オブジェクト
2525
をそれぞれ返します。パースした
26-
String が well formed な XML で無い場合は
26+
String が well formed な XML で無い場合は
2727
例外 [[c:RSS::NotWellFormedError]] が発生します。well formed な
28-
XML だがRSS 0.9x/1.0/2.0, Atom のいずれでもない場合はnil が
29-
返ります
28+
XML だがRSS 0.9x/1.0/2.0, Atom のいずれでもない場合はnil が
29+
返ります
3030

3131
例えば、RSS 1.0 をバリデーション付きでパースするには以下のよ
3232
うにします。ここで、変数 rss_source には RSS 1.0 形式の文
@@ -41,7 +41,7 @@ RSS::Parser.parse の第二引数は省略すると true が指定されたも
4141
require 'rss'
4242
rss = RSS::Parser.parse(rss_source)
4343

44-
最初はバリデーション付きでパースしてvalid ではない RSS だった
44+
最初はバリデーション付きでパースしてvalid ではない RSS だった
4545
場合はバリデーション無しでパースするには以下のように書きます。
4646

4747
require 'rss'
@@ -61,25 +61,25 @@ RSS::Parser.parse の第二引数は省略すると true が指定されたも
6161

6262
パーサはデフォルトでは知らない要素(仕様書に規定されていない
6363
要素)を無視します。もし、知らない要素に遭遇した時に例外を発
64-
生させたければRSS::Parser.parse の第三引数に false を指定して
64+
生させたければRSS::Parser.parse の第三引数に false を指定して
6565
ください。こうすると、パース中に知らない要素に遭遇した時に
6666
[[c:RSS::UnknownTagError]] 例外が発生します。RSS::UnknownTagError
6767
クラスは [[c:RSS::InvalidError]] クラスのサブクラスです。
6868

69-
以下のようにするとより厳密にパースできます。
69+
以下のようにするとより厳密にパースできます。
7070

7171
RSS::Parser.parse(rss_source, true, false)
7272

7373
=== パースされたフィード
7474

7575
フィードをパースすると [[c:RSS::RDF]], [[c:RSS::RDF::Channel]],
7676
[[c:RSS::Rss]], [[c:RSS::Atom::Feed]] 等のオブジェクトになります。
77-
各オブジェクトで子要素オブジェクトにアクセスするために要素名と
77+
各オブジェクトで子要素オブジェクトにアクセスするために要素名と
7878
同じ名前のアクセサがあります。
7979

8080
==== リーダ(reader)
8181

82-
rdf:RDF 要素の子要素である channel 要素を参照するには以下のよう
82+
rdf:RDF 要素の子要素である channel 要素を参照するには以下のよう
8383
にします。
8484

8585
rss = RSS::Parser.parse(rss_source)
@@ -133,28 +133,28 @@ rdf:RDF要素の子要素であるchannel要素を設定するには以下のよ
133133
rss = RSS::Parser.parse(rss_source)
134134
rss.channel.about = "http://cozmixng.www.cozmixng.org/"
135135

136-
同名の複数の子要素が存在する場合は少し異なります要素名の複
137-
数形でのメソッドで要素の配列を取得してその配列に対して
138-
Array#<<やArray#[]=などを用いて要素を設定します
136+
同名の複数の子要素が存在する場合は少し異なります要素名の複
137+
数形でのメソッドで要素の配列を取得してその配列に対して
138+
Array#<<やArray#[]=などを用いて要素を設定します
139139

140140
rss = RSS::Parser.parse(rss_source)
141141
item = RSS::RDF::Item.new(rdf_about_value)
142142
rss.items << item
143143
rss.items.last == item # => true
144144

145145
注意: item=/set_itemなどはRubyっぽくないので使わないでくださ
146-
146+
147147

148148
=== 出力
149149

150-
RSS Parserといっているので誤解されがちですがRSS/Atomを出力する
151-
こともできます
150+
RSS Parserといっているので誤解されがちですがRSS/Atomを出力する
151+
こともできます
152152

153153
==== 基本
154154

155-
to_sするとRSSまたはAtom形式の文字列を返します
155+
to_sするとRSSまたはAtom形式の文字列を返します
156156

157-
RSS/Atomを出力する流れは以下のようになります
157+
RSS/Atomを出力する流れは以下のようになります
158158

159159
* RSS/Atomオブジェクト(RSS::RDFとかRSS::Rssクラスとか
160160
RSS::Atom::Feedのオブジェクト)を作成する
@@ -165,20 +165,20 @@ RSS/Atomを出力する流れは以下のようになります.
165165

166166
==== xml-stylesheet
167167

168-
xml-stylesheetも出力できます
168+
xml-stylesheetも出力できます
169169

170170
RSSのルート要素(RSS::RDFまたはRSS::Rss)オブジェ
171171
クトおよびAtomのルート要素(RSS::Atom::Feedまたは
172172
RSS::Atom::Entry)オブジェクトはxml_stylesheetsという
173-
名前の配列を持っていますこの配列にRSS::XMLStyleSheet
173+
名前の配列を持っていますこの配列にRSS::XMLStyleSheet
174174
オブジェクトを挿入することでRSS/Atomにxml-stylesheetを
175-
関連づけることができます
175+
関連づけることができます
176176

177177
rss.xml_stylesheets << RSS::XMLStyleSheet.new(...)
178178

179179
RSS::XMLStyleSheet.newには以下のようなHashまたは
180-
連想配列を渡します作成されるRSS::XMLStyleSheetオブジェ
181-
クトは与えられた引数によって初期化されます
180+
連想配列を渡します作成されるRSS::XMLStyleSheetオブジェ
181+
クトは与えられた引数によって初期化されます
182182

183183
Hash:
184184

@@ -202,24 +202,24 @@ Hash:
202202
[:alternate, "..."],
203203
]
204204

205-
全てのキーは省略可能です
205+
全てのキーは省略可能です
206206

207-
例えばxml-stylesheetとしてsample.xslを指定する場合は以下の
208-
ようにします
207+
例えばxml-stylesheetとしてsample.xslを指定する場合は以下の
208+
ようにします
209209

210210
rss.xml_stylesheets << RSS::XMLStyleSheet.new({:href => "sample.xsl"})
211211

212212
本当は{:type => "text/xsl"}も指定しないといけないとこ
213-
ろですが拡張子が.xslまたは.cssの場合は適当に推測してくれ
214-
るので省略可能です
213+
ろですが拡張子が.xslまたは.cssの場合は適当に推測してくれ
214+
るので省略可能です
215215

216216
==== RSS/Atomオブジェクトを作る
217217

218-
既存のRSS/Atomをパースせずに一から新しくRSS/Atomを作成するには
219-
RSS Makerが便利です
218+
既存のRSS/Atomをパースせずに一から新しくRSS/Atomを作成するには
219+
RSS Makerが便利です
220220

221221

222-
以下のように使います
222+
以下のように使います
223223

224224
require "rss"
225225

@@ -230,14 +230,14 @@ RSS Makerが便利です.
230230

231231
===== シンプルなRSS
232232

233-
例えば
233+
例えば
234234

235235
* http://example.com/にある
236236
* Example Siteという説明文を持つ
237237
* Exampleというサイトを
238238
* http://example.com/index.rdfという名前のRSS 1.0
239239

240-
を生成するには以下のようにします
240+
を生成するには以下のようにします
241241

242242
require "rss"
243243

@@ -248,12 +248,12 @@ RSS Makerが便利です.
248248
maker.channel.link = "http://example.com/"
249249
end
250250

251-
もし
251+
もし
252252

253253
* http://example.com/article.htmlにある
254254
* Sample Articleというタイトルの
255255

256-
エントリを含めたければ以下のようにします
256+
エントリを含めたければ以下のようにします
257257

258258
require "rss"
259259

@@ -270,11 +270,11 @@ RSS Makerが便利です.
270270

271271
===== 更新時刻を追加
272272

273-
もし先のエントリが
273+
もし先のエントリが
274274

275275
* 2004/11/1 10:10
276276

277-
のものならこうします
277+
のものならこうします
278278

279279
require "rss"
280280

@@ -299,18 +299,18 @@ RSS Makerが便利です.
299299

300300
item.dc_date = ...
301301

302-
でも構いません#dc_date=は#date=の単なる別名で
303-
302+
でも構いません#dc_date=は#date=の単なる別名で
303+
304304

305305
===== さらにエントリを追加
306306

307-
さらに
307+
さらに
308308

309309
* http://example.com/article2.htmlにある
310310
* Sample Article2という
311311
* 2004/11/2 10:10に作成された
312312

313-
エントリを持つなら以下のようにします
313+
エントリを持つなら以下のようにします
314314

315315
require "rss"
316316

@@ -335,11 +335,11 @@ RSS Makerが便利です.
335335

336336
===== エントリを並び替える
337337

338-
もし更新日が新しい順に並び替えたければ
338+
もし更新日が新しい順に並び替えたければ
339339

340340
maker.items.do_sort = true
341341

342-
を追加し以下のようにします
342+
を追加し以下のようにします
343343

344344
require "rss"
345345

@@ -366,12 +366,12 @@ RSS Makerが便利です.
366366

367367
===== ロゴの指定
368368

369-
もしサイトに
369+
もしサイトに
370370

371371
* Example Siteという名前の
372372
* http://example.com/logo.pngというロゴ
373373

374-
がある場合は以下のようにします
374+
がある場合は以下のようにします
375375

376376
require "rss"
377377

@@ -401,14 +401,14 @@ RSS Makerが便利です.
401401

402402
===== 検索ページの指定
403403

404-
もし
404+
もし
405405

406406
* http://example.com/search.cgiに
407407
* keywordというパラメタ名で検索できる
408408
* Search Example Siteという名前で
409409
* Search Example Site's all textという説明付きの
410410

411-
検索用ページがあったら以下のようにします
411+
検索用ページがあったら以下のようにします
412412

413413
require "rss"
414414

@@ -443,11 +443,11 @@ RSS Makerが便利です.
443443

444444
===== XMLスタイルシートの指定
445445

446-
もし
446+
もし
447447

448448
* http://example.com/index.xslにある
449449

450-
xml-stylesheetを追加したい場合は以下のようにします
450+
xml-stylesheetを追加したい場合は以下のようにします
451451

452452
require "rss"
453453

@@ -485,8 +485,8 @@ xml-stylesheetを追加したい場合は以下のようにします.
485485

486486
===== RSS 2.0の生成
487487

488-
もしRSS 2.0を生成したい場合は以下のように
489-
RSS::Maker.makeの第一引数を変更します
488+
もしRSS 2.0を生成したい場合は以下のように
489+
RSS::Maker.makeの第一引数を変更します
490490

491491
require "rss"
492492

@@ -524,8 +524,8 @@ RSS::Maker.makeの第一引数を変更します.
524524

525525
===== RSS 0.91の生成
526526

527-
もしRSS 0.91を生成したい場合はRSS 2.0の場合と同様に
528-
RSS::Maker.make の第一引数を"0.91"に変更します
527+
もしRSS 0.91を生成したい場合はRSS 2.0の場合と同様に
528+
RSS::Maker.make の第一引数を"0.91"に変更します
529529

530530
ただし、RSS 0.91では言語指定が必須なので、言語を指定する必要
531531
があります。ここでは日本語であると指定します。
@@ -548,8 +548,8 @@ RSS 1.0など、/rdf:RDF/channel/language要素がないフィードの場
548548

549549
===== Atom 1.0の生成
550550

551-
もしAtom 1.0を生成したい場合はRSS 0.91や2.0の場合と同様に
552-
RSS::Maker.makeの第一引数を"atom"に変更します
551+
もしAtom 1.0を生成したい場合はRSS 0.91や2.0の場合と同様に
552+
RSS::Maker.makeの第一引数を"atom"に変更します
553553

554554
rss = RSS::Maker.make("atom") do |maker|
555555
...
@@ -719,8 +719,8 @@ to_feed().to_sではなく、to_xmlを使うことには一長一短がありま
719719

720720
=== サンプル
721721

722-
RSS Parser のサンプルスクリプトをいくつか紹介しますこれらの
723-
スクリプトは sample/ 以下に入っています
722+
RSS Parser のサンプルスクリプトをいくつか紹介しますこれらの
723+
スクリプトは sample/ 以下に入っています
724724

725725
==== サンプル1 - 項目一覧
726726

@@ -823,15 +823,15 @@ RSS::UnknownConversionMethodError例外が発生します。
823823
最初に現れたDublin Coreモジュールの要素にアクセスするには
824824
「dc_要素名」というアクセサが用意されています。全ての要素の
825825
配列にアクセスするには「dc_要素の複数形」(dc_rightsは
826-
dc_rights_listになります)とします
826+
dc_rights_listになります)とします
827827

828-
複数形でアクセスした場合は「要素の内容を表す文字列」ではなく
829-
「要素を表すオブジェクト」の配列が返ります「要素を表すオブ
828+
複数形でアクセスした場合は「要素の内容を表す文字列」ではなく
829+
「要素を表すオブジェクト」の配列が返ります「要素を表すオブ
830830
ジェクト」から「要素の内容を表す文字列」を取得するには
831831
contentメソッドやその別名であるvalueメソッドを利
832-
用します「要素の内容を表す文字列」を設定するには
832+
用します「要素の内容を表す文字列」を設定するには
833833
content=メソッドやその別名であるvalue=メソッドを
834-
利用します
834+
利用します
835835

836836
rss.channel.dc_title # => 「要素の内容を表す文字列」
837837
# ("My site"など)
@@ -852,7 +852,7 @@ content=メソッドやその別名であるvalue=メソッドを
852852
# => true
853853

854854
ちなみにSyndicationモジュールの要素にアクセスするには「sy_要
855-
素名」というアクセサがContentモジュールの要素にアクセスす
855+
素名」というアクセサがContentモジュールの要素にアクセスす
856856
るには「content_要素名」というアクセサが用意されています。
857857

858858
サンプル1と同じようにパースするRSSはファイルに保存されていて
@@ -902,8 +902,8 @@ itemsにはdc_dateがnilではないものしか含まれていないは
902902

903903
#@# ==== サンプル3 - 複数のRSSをブレンド
904904
#@#
905-
#@# TODO: sample/blend.rbを元にしたサンプルを書く
905+
#@# TODO: sample/blend.rbを元にしたサンプルを書く
906906

907907
#@# ==== サンプル4 - フィードを変換する
908908
#@#
909-
#@# TODO: sample/convert.rbを元にしたサンプルを書く
909+
#@# TODO: sample/convert.rbを元にしたサンプルを書く

0 commit comments

Comments
 (0)