RSS 与 ATOM Feed 助推引擎

“条目强化因子”开放 API v.1.0

什么是“条目强化因子”？

您 Feed 的每个条目都可以扩展一个或多个附加功能。这每个功能都称作“条目强化因子”。例如，如果你想要向每个条目添加“DiggThis!”按钮，就可以使用“条目强化因子”（“DiggThis!”按钮）来办到。

在 Feed 设置里，您将找到多个已备好的“条目强化因子”，这些都可以在您的 Feed 中自由使用。这些“条目强化因子”包含了：Delicious、分享到 Facebook、Digg This!、Google 书签、Windows Live、MySpace、Stumble It!、Technorati 以及其他。

除了已经备好的“条目强化因子”，您可以利用 API 来自行增加 Feed 条目的潜在价值。

为什么使用“条目强化因子” API？

“条目强化因子” API 作为提升您 Feed 条目潜在价值的新功能定义而提供。每个新的“条目强化因子”都被定义在单独的 XML 文件中，如下所述。

“条目强化因子” XML 文件描述：

每个单独的“条目强化因子”都是独立的 XML 文件，由以下元素组成。

每个“强化因子”的根元素为 feedcat-itemenhancer。

元素	描述
feedcat-itemenhancer	元素，包含“条目强化因子”的固有定义

元素 feedcat-itemenhancer 包含它与下列元素固有“强化因子”的定义：

元素	描述
title	“条目强化因子”名称 (必需)
description	“条目强化因子”功能描述——建议填写，因为其可能会被显示在目录中
public	[yes/no] 显示在“条目强化因子”中的许可
author	“条目强化因子”的作者
alink	格式为 http://www.sample-web.com/ 的作者链接
enhancer	“条目强化因子”函数部分包含定义的元素 (必需)

元素 enhancer 包含决定“强化因子”外观和行为的函数部分的定义：

元素	描述
sample-caption	样式文字，仅用于设置“条目强化因子”时
caption	显示于 Feed 条目中的“条目强化因子”固有文本 (必需)
dynamic-caption	“条目强化因子”文本的动态版本，包含 HTTP GET 获取文本并显示在 Feed 条目的 URL 执行地址 (必需)
link	“条目强化因子”的 URL 地址，使用前被解析 (必需)
icon	“条目强化因子” 图标的 URL 地址，可以是 JPG, GIF 或 PNG 格式，大小 16 x 16 像素

元素 caption 或 dynamic-caption 之一必须强制出现于元素 enhancer 的定义中。

仅有元素 caption 可在定义中包含基本 HTML 标记 <b></b> a <i></i>。事实上如果设置在单个 Feed 的图标被显示或仅有一个图标使用于“条目强化因子”，这将全局地应用在所有使用的“条目强化因子”。

“条目强化因子” URL 地址修改

下列表格显示的函数中定义于元素 dynamic-caption 与 link 的 URL 地址很可能会被修改。所有函数均插入已编码的 URL 内容。

函数	描述
$[i:title]	Feed 条目标题
$[i:link]	Feed 条目 URL
$[i:des]	Feed 条目描述
$[i:linkcrc]	Feed 条目 CRC URL
$[i:date]	Feed 条目发布日期
$[i:author]	Feed 条目作者
$[f:title]	Feed 标题
$[f:feedurl]	已助推 Feed 的 URL
$[f:xmlurl]	XML 格式的已助推 Feed 的 URL
$[f:sourceurl]	Feed 原始 URL
$[f:link]	原始网站 URL
$[f:des]	Feed 描述
$[f:lang]	源 Feed 编码
$[f:copyright]	Feed 版权
$[f:lastget]	Feed 最后更新

修改地址 URL 的使用示例：

http://www.facebook.com/share.php?u=$[i:link]&t=$[i:title]

编码Encoding

“条目强化因子” API 鼓励使用 UTF-8 编码，但是 XML 文件也可以使用其他编码，但是必须标示以参数：

<feedcat-itemenhancer encoding="windows-1250"> 
    <title>...</title>
    .
    . 
</feedcat-itemenhancer>

“条目强化因子”示例：

在第一个示例中，我们会展示“条目强化因子”作为“Digg This”按钮的使用。按下 URL 之后，$[i:link] 及 $[i:title] 将被替代为真实的 Feed 条目数据。

<feedcat-itemenhancer> 
	<title>Sample 1</title> 
	<description> 
		Caption with link to any service / DiggThis in example.
	</description> 
	<public>Yes</public> 
	<author>FEEDCAT.NET</author> 
	<alink>http://www.feedcat.net/</alink> 
	<enhancer> 
		<caption>Sample 1</caption> 
        <link>http://digg.com/submit?url=$[i:link]&title=$[i:title]</link> 
        <icon>http://www.feedcat.net/ie/ico/digg.gif</icon> 
    </enhancer> 
</feedcat-itemenhancer>

在第二个示例中，我们将展示无链接元素的“条目强化因子”的使用。这个情况下元素 caption 将不含任何参考地显示在 Feed 条目。

<feedcat-itemenhancer> 
	<title>Sample 2</title> 
	<description> 
		Only caption without link.
	</description> 
	<public>Yes</public> 
	<author>FEEDCAT.NET</author> 
	<alink>http://www.feedcat.net/</alink> 
	<enhancer> 
		<caption>Sample <b>2</b></caption> 
    </enhancer> 
</feedcat-itemenhancer>

在第三个示例中，我们会展示带有 dynamic-caption 元素的“条目强化因子”的使用。这种情况下从展示在 dynamic-caption 元素的 URL 动态获取的文本会显示在 Feed 条目中。此时更应当填写被插入文本的 sample-caption 元素，这会在 feed 设置中取代动态获取的数值而显示。这甚至也可以设置于链接元素。

<feedcat-itemenhancer> 
	<title>Sample 3</title> 
	<description> 
		Dynamic caption example with caption sample / dynamic caption have to be any http service with ascii output up to 30 characters.
	</description> 
	<public>Yes</public> 
	<author>FEEDCAT.NET</author> 
	<alink>http://www.feedcat.net/</alink> 
	<enhancer> 
		<sample-caption>Timestamp</sample-caption> 
		<dynamic-caption>http://www.feedcat.net/timestamp/</dynamic-caption> 
    </enhancer> 
</feedcat-itemenhancer>