Pugpig supports RSS feeds for importing content, both at an article level and at the edition level. For an introduction to our feed importing process and our article feed specification, see this article.
This article details the specification for RSS Edition Feeds, see below for the spec.
Default RSS elements
|
Name |
Description |
Example |
|
rss |
The main tag in RSS feed. RSS tag is a required global container. |
<rss version="2.0"> ... </rss> <rss xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http:/purl.org/dc/terms/" xmlns:app="http://www.w3.org/2007/app" version="2.0"> ... </rss> |
|
channel |
Channel is another required tag. This is a distribution channel, it has several descriptive tags and holds one or several items. |
<rss version="2.0"> <channel> ... </channel> </rss> |
Tags required by channel
|
Name |
Description |
Example |
|
title |
The title of the channel, should contain the name. |
<title>Channel title as plain text</title> |
|
link |
This tag should contain the URL of the website that provides this channel. |
<link>https://www.example.com</link> |
|
description |
Contains the summary of what the provider is. |
<description>Channel content description as plain text</description> |
|
item |
Item tag contains edition specific data. Each item is a single edition and at least one is required by the channel tag. |
<item>...</item> |
Updated date tag
|
Name |
Description |
Example |
|
atom:updated |
This tag represent the time and date when this feed was last updated. |
<atom:updated>2019-02-14T00:00:00Z</atom:updated> |
Tags required by a item tag
|
Name |
Description |
Example |
|
title |
Title of the edition. (Pugpig feed equivalent: title) |
<title>Edition title as plain text</title> |
|
description |
Contains summary of the edition. (Pugpig feed equivalent: summary) |
<description>Edition description as plain text</description> |
Other item tags
|
Name |
Description |
Example |
|
Name |
Description |
Example |
|
guid |
Unique ID used to identify the edition. (Pugpig feed equivalent: id) |
<guid isPermaLink="false">edition_1</guid> |
|
dcterms:issued |
Edition issued date. (The date should be in the form YYYY, YYYY-mm or YYYY-mm-dd; this is what the app will show) |
<dcterms:issued>2019-02</dcterms:issued> |
|
atom:updated |
Contains the datetime when this edition was last changed. |
<atom:updated>2019-02-14T00:00:00Z</atom:updated> |
|
dc:creator |
Name of the author of the edition. (Pugpig feed equivalent: author) |
<dc:creator>Bob Author</dc:creator> |
|
atom:link |
Contains main media of the edition. (Usually contains main cover image. 3:4 aspect ratio is recommended) |
<atom:link type="image/jpg" href="example_cover.jpg" rel="http://opds-spec.org/image"/> |
|
category |
Used to specify the state of the edition. (Example 1 is used for subtitle whereas example 2 is used to specify if edition is free or paid) |
<category domain="http://schema.pugpig.com/subtitle">Edition subtitle as plain text</category> <category domain="http://schema.pugpig.com/acquisition">free</category> |
|
pubDate |
Published date of the edition. (Pugpig feed equivalent: published; Date will be convert from RFC 822 to ISO 8601) |
<pubDate>Thu, 14 Feb 2019 00:00:00 +0000</pubDate> |
Draft/Published
|
Name |
Description |
Example |
|
app:control |
This tag contains the app:draft tag which is used to specify if edition is draft or published. |
<app:control> <app:draft>yes</app:draft> </app:control> |
|
app:draft |
This tag specifies if edition is draft or published. (In example 1 edition is draft whereas in example 2 it is published) |
<app:control> <app:draft>yes</app:draft> </app:control> <app:control> <app:draft>no</app:draft> </app:control> |
Comments
0 comments
Please sign in to leave a comment.