• 名前
• 必須項目
• インストール
• 初期設定
• AGENTを使って自動更新
• テンプレート内でSYNDICATION DATAを使う
• 基本
• 複数フィード
• 最新フィード
• テンプレートタグ
• プロキシサーバーと一緒に使う
• サポート・その他
• これからの課題
• CAVEATS AND KNOWN BUGS
• ライセンス
• 作者 & COPYRIGHT

名前

Feeds.App - Movable Type のテンプレートにsyndicationフィードを導入する為のプラグイン.

Version 2.0

必須項目

Feeds.App　は Movable Type 3.0D 以上ならびに以下のモジュールが必要です:

• XML::Parser (version >= 2)
  
• Class::XPath (version >= 1.41)[1]
  
• XML::Elemental (version >= 1.01)
  
• XML::RAI (version >= 1.01)
  
• XML::Atom::Syndication (version >= 0.08)
  
• Storable (version >= 2)
  
• Date::Parse (version >= 2.6)
  
• Getopt::Long (version >= 2.33
  

すべてのモジュールはCPANより取得できます。

[1] 注:　まだCPANでは発表されていないバグがClass::XPath manpage にあるので、モジュールの横に記載されたバージョンを守ってください. 詳しくはCAVEATS AND KNOWN BUGS で。

インストール

1. 最新のFeeds.Appをダウンロード及び解凍
   
2. ファイルを任意の場所に移動
   
mtがMovable Typeのあるディレクトリとするとファイルを以下のディレクトリに移動

 lib -> mt/extlib 
 plugins -> mt/plugins
 contents ->mt/tmpl
 docs -> path/of/mt/docs

MTディレクトリ内にあるフォルダと置き換えないでください。これらのフォルダにはシステムや他のプラグインに必要なファイルが含まれています

3. パーミッションの設定
   
すべてのファイルの設置が終了したら、plugins/feedsディレクトリに入りすべてのCGIのパーミッション、及びagentのパーミッションを755にセットする

755とはすべてのユーザーに読み込み・実行権限があり、オーナーにのみ書き込み権限が与えられることを意味する。

Unixのshellでパーミッションを設定している場合、以下のコマンドで設定ができる。

$ chmod 755 *.cgi agent

4. キャッシュのディレクトリを作成
   syndication feedsのため、キャッシュディレクトリを作ります。このディレクトリにソースからsyndicationのデータが貯まっていきます。キャッシュによりページの再構築の速度が速くなり、帯域幅の使用が減ります。ブログの設定と同じようにMovableTypeをcgiwrap又はsuexec内で動かしていない場合キャッシュのディレクトリを777にセットしてください。(詳しくはMTインストールのドキュメントを参照）
   
   今作ったディレクトリのフルパスを後で使用するので覚えておいてください。

初期化

1. MTにサインイン
   
ウェブブラウザでMovable Typeにサインイン。 もし正常にインストールが終了していたらFeeds.Appが 「利用可能なプラグインの設定」のリスト内に表示されているでしょう。
2. Feeds.App設定
   
Feeds.Appのリンクをクリックし、設定アプリを起動。 デフォルトの設定をサイトに合った設定に変更してください。 以下の設定を変えられます：
• キャッシュのディレクトリ
  
syndication feedsをローカル上に保存する為に使うディレクトリのフルパス。 ファイル形式で保存する場合、パスはデフォルトでmt.cfgに書かれてるDataSourceになります。
• バックグラウンド処理
  
このプラグインはキャッシュの情報のみで再構築するよう設定でき、feed agentを他のプロセス（例、定期的に動くcron）としてバックグラウンドで処理できるようになってます。これによりsyndicationのデータによるテンプレートの再構築の遅れキャッシュを効率的に使い、軽減できます。たくさんのfeedを使っている場合にもっとも効果を発揮します。デフォルトではバックグラウンド処理を使います。

3. Save Configurationをクリック
   
プラグインの設定はこれで終了。

Agentによるバックグラウンド処理

もしサーバーにスクリプトの実行をスケジュールできる権限があるのであれば、Feeds.Appのagentを定期的に実行しキャッシュの情報を最新のものに更新することをオススメします。

例えば、もしcronに書き込む権限があるのであれば以下の処理をUnixのシェルで行います。

 $ crontab -e

これで今までに書かれたcronが開かれます。（最初の場合は白紙の状態です）mysubs.txtを30分ごとにagentを使って更新するには以下の行を書き足して保存します。

 */30 * * * * /path/to/mt/plugins/feed/agent --blog_id=2 --tmpl="Feeds" path/to/data/mysubs.txt

mysubs.txt はリスト（１つの行につき1つのsyndivation feed URL）として扱われます。feedをチェックしキャッシュを更新した後、agentはブログのidが２で名前がFeedsのインデックス･テンプレートを再構築します。

以下はテンプレートのIDとCSVフォーマットのリストを使ったagentスクリプトの例です

/path/to/mt/plugins/feed/agent --tmpl_id=40 -c path/to/data/mysubs.csv

agentは他にも以下のコマンドを指定してあげることができます

     --help     -?  ヘルプ
     --version      スクリプトのバージョン
 
     モード
     --silent   -s  ステータスメッセージを表示しない
     --quiet    -q  最小限のステータスメッセージ (デフォルト)
     --verbose  -v  詳細なステータスメッセージ、並びにトレースレポート
 
     タイプ
     --list     -l  リスト化されたコレクション
     --opml     -o  OPMLのコレクション
     --csv      -c  CSVのコレクション
     --type         A argument for stating type by key
 
     --tmpl_id      キャッシュ更新後に再構築するテンプレートID
     --tmpl         キャッシュ更新後に再構築するテンプレートの名前
     --blog_id      テンプレートが属するブログのID

ファイルを保存、終了してください。agentはバックグラウンドで30分おきに実行されます。

SYNDICATION DATAをテンプレート内に表示

基本

以下のMTタグがh3タグで囲まれたfeedのタイトル、そしてエントリーのタイトルとリンクが順不同で生成される。

<$MTFeedsInclude uri=``http://www.timaoutloud.org/xml/index.rdf'' lastn=``5''$>

そう、たったこれだけ。このタグ与えられたパラメーターと共に以下のタグを生成、再構築される。

     <MTFeeds uri="http://www.timaoutloud.org/xml/index.rdf">
     <h3><$MTFeedTitle$></h3>
     <ul><MTFeedEntries lastn="5">
     <li><a href="<$MTFeedEntryLink$>"><$MTFeedEntryTitle$></a></li>
     </MTFeedEntries></ul>
     <$MTFeedVersionSlug$>
     </MTFeeds>

複数のFeeds

ここでmysubs.txtというsyndication feed のURLのリストを含んだファイルを作ったとして話を進める。

http://www.timaoutloud.org/xml/atom.xml http://www.movabletype.org/index.xml http://www.sixapart.com/log/index.rdf http://sixapart.com/corner/index.rdf http://www.sixapart.com/pronet/index.rdf

これらのサイトから最新の記事五つを表示するには以下のタグを書き込む。

<$MTFeedsInclude collection=``mysubs.txt'' lastn=``5''$>

このタグが以下のレイアウトで再構築される。

 <MTFeeds collection="mysubs.txt" type="list">
 <h3><$MTFeedTitle$></h3>
 <ul><MTFeedEntries lastn="5">
 <li><a href="<$MTFeedEntryLink$>"><$MTFeedEntryTitle$></a></li>
 </MTFeedEntries></ul>
 <$MTFeedVersionSlug$>
 </MTFeeds>

注：type="list"はパラメータで設定されてなければデフォルトでつく。typeで使用可能なパラメーターは"opml"や"csv"である。詳しくはテンプレートタグのドキュメントを参照。

ここではfeedのタイトルをh3タグで囲み、mysubs.txtに含まれる各ｆｅｅｄのエントリーのタイトルとリンクが５つ順不同で生成される。

最新のFeeds

Syndication feedsの更新速度は各サイトによって違う。もし自分のサイトですべてのサイトにおいて最新記事を表示させたいのであれば先ほどの記述ではうまくいかない。以下のパラメーターを渡してやることでこれが可能となる。

<$MTFeedsIncludeLatest collection=``mysubs.txt'' lastn=``25'' title=``Latest Posts''$>

この記述が以下のテンプレートを生成する。

 <MTFeedsLatest collection="mysubs.txt" type="list">
 <h3>Latest Posts</h3>
 <ul><MTFeedEntries lastn="25">
 <li><a href="<$MTFeedEntryLink$>"><$MTFeedEntryTitle$></a> (<$MTFeedEntrySourceName$>)</li>
 </MTFeedEntries></ul>
 </MTFeedsLatest>

ここでは静的なタイトル”Latest Posts"を表示し、mysubs.txtに含まれるリストから２５の最新記事を一つの順不同のリストにして生成する。この時、ソースのfeedのタイトルがカッコに囲まれてエントリーのタイトルの横に表示される。

以上は基本的な使い方を記したもので、このプラグインでは更なるオプションが用意されている。プラグインタグのドキュメントを読んで他のオプションを参照してください。

テンプレートタグ

Feeds.Appで以下のテンプレートタグが使えます。

• MTFeeds uri=``''
  
• MTFeeds collection=``'' [type=``'']
  
コンテナタグで一つ又は複数のsyndication feedsをさす時に使用。

uri又はcollectionは指定されてなければならない。

一つのfeedを使うときuriでfeedの場所を指定する。サポートされているプロトコルはhttp://、https:// と file://である。

複数のfeedを使うときはcollectionでリストを含むファイルのパス（ブログのディレクトリがroot）を指定する。typeは指定しなくともよい。typeでcollectionのソースのタイプを指定できる。

list type readerは各行にURIを含むplain text fileを処理する。これがtypeが指定されなかった場合のデフォルトの動作である。

The opml type reader uses an XML parser to find all <outline> tags and extracts URIs from either the xmlUrl or xmlurl attributes. Outline tags with either of these are skipped.

The csv type reader will process a plain text file of comma seperated values extracting URIs.The first row in these files are assumed to be field names. Links are extracted from the 'link' or 'url' field in each row.

• MTFeedLatest collection=``'' [type=``'']
  
Creates a virtual feed of the latest entries from the specified collection. This tag is an alternate to the Feeds container.

The collection argument is the path of a file relative to the blogs root directory.

The type argument is optional and specifies the collection source type. The default is 'list'.

• MTFeedTitle
  
The title of the syndication feed.
• MTFeedLink [rel=``'' any=``0|1'']
  
The URI of the syndication feed. The optional rel attribute specifies a certain link relationship as found in Atom feeds. The default is ``alternate.'' This attribute has no real effect on RSS feeds. The optional any attribute takes a boolean value. If set to true (1) the tag will return the first link of any relationship. The default is (0) false.
• MTFeedCreatorName
  
The name of the syndication feed.
• MTFeedCreatorEmail
  
The email address of the syndication feed.
• MTFeedCreatorURL
  
The URL of the syndication feed.
• MTFeedDescription [type=``'']
  
An abstract or tagline of the syndication feed.

Using the optional argument of type will only return content if a description/abstract is available with the specified MIME type.

• MTFeedRights
  
The rights or license of the syndication feed's content.
• MTFeedLanguage
  
The language of the syndication feed's content.
• MTFeedIdentifier
  
A unique identifier for the feed.
• MTFeedContributors
  
A container tag that loops through each contributor to the syndication feed (if any) and creates the necessary context.
• MTFeedContributorName
  
The name of a contributor to the syndication feed. Must be used within a MTFeedContributors tag context.
• MTFeedContributorEmail
  
The email address of a contributor to a syndication feed. Must be used within a MTFeedContributors tag context.
• MTFeedContributorLink
  
The URL of a contributor to a syndication feed. Must be a used within a MTFeedContributors tag context.
• MTFeedModified [format=``'']
  
The last modified timestamp of the syndication feed.

The optional format argument can be used to format the timestamp using the same specifiers as other MT timestamp tags such as MTDate. The default is W3C Date Time Format (W3CDTF aka ISO 8601) using UTC (Coordinated Universal Time).

• MTFeedImageURL
  
The image URL associated to the syndication feed.
• MTFeedImageHeight
  
The height of the image associated to the syndication feed.
• MTFeedImageWidth
  
The width of the image associated to the syndication feed.
• MTFeedEntries [offset=``'' lastn=``'']
  
A container tag that will loop through the entries of the feed in context. Like MTEntries this tag supports optional arguments of limit and offset to control the number entries and starting point to be insert. Entries are sorted in reverse chronological order.
• MTFeedEntryCount
  
The total number of entries in the syndication feed.
• MTFeedEntryTitle
  
The title of the syndication feed entry in context.
• MTFeedEntryLink [rel=``'' any=``0|1'']
  
The hyperlink to the syndication feed entry in context. The optional rel attribute specifies a certain link relationship as found in Atom feeds. The default is ``alternate.'' This attribute has no real effect on RSS feeds. The optional any attribute takes a boolean value. If set to true (1) the tag will return the first link of any relationship. The default is (0) false.
• MTFeedEntryContributors
  
A container tag that loops through each contributor to the syndication feed entry (if any) and creates the necessary context.
• MTFeedEntryContributorName
  
The name of a contributor to the syndication feed entry. Must be used within a MTFeedEntryContributors tag context.
• MTFeedEntryContributorEmail
  
The email address of a contributor to a syndication feed entry. Must be used within a MTFeedEntryContributors tag context.
• MTFeedEntryContributorLink
  
The URL of a contributor to a syndication feed entry. Must be a used within a MTFeedEntryContributors tag context.
• MTFeedEntryDescription [type=``'']
  
An abstract or summary of the syndication feed entry.

Using the optional argument of type will only return content if a description/abstract is available with the specified MIME type.

Due to the varying nature of RSS format feeds this may not return what you expect. This tag will only return content if a description tag exists in the syndication feed along with a ``full content'' tag such as a XHTML body or content:encoded tagset.

• MTFeedEntryLanguage
  
The language of the syndication feed entry.
• MTFeedEntryIdentifier
  
A unique identifier to the syndication feed entry.
• MTFeedEntryPing
  
The Trackback URL to ping the syndication feed entry with.
• MTFeedEntryPinged
  
A container tag that loops through each Trackback URL pinged by the syndication feed entry.
• MTFeedEntryPingedURL
  
The URL of the resource that was pinged by this syndication feed entry. Must be used within a MTFeedEntryPinged tag context.
• MTFeedEntrySubjects
  
A container tag that loops through each subject the syndication feed entry is associated with.
• MTFeedEntrySubjectLabel
  
A subject label the syndication feed entry has been associated with. Must be used within the context of a MTFeedEntrySubjects tag context.
• MTFeedEntryContent [type=``'']
  
The content of the syndication feed entry.

Using the optional argument of type will only return content if it matches the specified MIME type.

• MTFeedEntryModified [format=``'']
  
The last modified timestamp of the syndication feed entry.

The optional format argument can be used to format the timestamp using the same specifiers as other MT timestamp tags such as MTDate. The default is W3C Date Time Format (W3CDTF aka ISO 8601) using UTC (Coordinated Universal Time).

• MTFeedEntryIssued [format=``'']
  
The issued timestamp of the syndication feed.

The optional format argument can be used to format the timestamp using the same specifiers as other MT timestamp tags such as MTDate. The default is W3C Date Time Format (W3CDTF aka ISO 8601) using UTC (Coordinated Universal Time).

• MTFeedEntryCreated [format=``'']
  
The created on timestamp of the syndication feed.

The optional format argument can be used to format the timestamp using the same specifiers as other MT timestamp tags such as MTDate. The default is W3C Date Time Format (W3CDTF aka ISO 8601) using UTC (Coordinated Universal Time).

• MTFeedEntrySourceName
  
The name (title) of the feed that the entry to pulled from. This tag on returns a value when you in a latest feed.
• MTFeedEntrySourceLink
  
The primary link of the feed that the entry to pulled from. This tag on returns a value when you in a latest feed.
• MTFeedIf name=``'' [type=``'']
  
A simple and generic container tag for inserting conditional logic into templates depending upon on the content of the syndication feed.

The required name argument is the plugin tag (sans the MTFeed prefix -- MTFeedLink is 'Link' and so on) whose content will be tested. If the associated tag has content the contents of MTFeedIf will be inserted. Otherwise it will be skipped unless the standard MTElse tagset is used to render a different result.

An optional argument of type can also be used to specify a specific MIME type for the condition. This is only useful when working with content tags such as MTFeedEntryContent and MTFeedEntryDescription.

• MTFeedsVersion
  
The version number of the Feeds.App plugin.
• MTFeedsVersionSlug
  
Returns ``Gathered by Feeds.App'' with the version number.
• MTFeedsInclude uri=``'' [lastn=``'' description=``none|tooltip|paragraph'']
  
• MTFeedsInclude collection=``'' [type=``'' lastn=``'' description=``none|tooltip|paragraph'']
  
A tag to insert syndication content with a generic unordered list layout.
• MTFeedsIncludeLatest collection=``'' [lastn=``'' description=``none|tooltip|paragraph'' title=``'']
  
A tag to insert a latest syndication content with a generic unordered list layout.

USAGE WITH A PROXY SERVER

The Feeds.App agent will use the standard MT configuration parameters of PingTimeout, PingProxy and PingNoProxy if they have been set.

If you are running mt in an environment that requires the use of a proxy server to connect outside of your network, these parameter must be set. Chances are you may have already set them if you are using outbound Trackbacks.

SUPPORT AND MORE

Users of Feeds.App are encouraged to join the Feeds.App-announce group at http://groups.yahoo.com/group/Feeds.App-announce/. This is a low-volume mailing list that will let you keep up with the latest news and releases of Feeds.App and related activites.

Technical support is not provided for the Beta Software. You may find the Feeds.App-discuss user-to-user mailing list and archive at http://groups.yahoo.com/group/Feeds.App-discuss/ helpful in addressing any issues.

TO DO

• API Clean-up. Agent should not be an instance. More.
  
• Handle Atom feeds with relative URLs. (xml:base support)
  
• Enhanced tracer reports and management.
  
• Configurable and additional CacheMgr drivers
  
• Integrate XML::Atom
  
• Add callback hooks.
  
• Make installation easier.
  

CAVEATS AND KNOWN BUGS

Class::XPath 1.4 chokes on feeds that use \ in their identifier string which is most a URI uses this character. A patch has been submitted to the author of the module, but it has not been posted for some time. In the meanwhile, I am including my patched version 1.41.

There is a known bug effecting MT 3.0D using SQLite. It was fixed by SixApart with the release of 3.1.

Atom feeds using relative links are not supported yet.

Error handling needs to be refined through out. For instance MT::CacheMgr-expire()> does not pass success or failure indicator back.

Using the optional argument of type will only return content if a description/abstract is available with the specified MIME type.

ライセンス

See FEEDS-APP-LICENSE included in the Feeds.App distribution.

作者& 著作権

This code cannot be redistributed without permission from the author. Except where otherwise noted, Feeds.App is Copyright 2002-2005, Timothy Appnel, Appnel Internet Solutions, tim@appnel.com. All rights reserved.
翻訳：春口陽寿