• Home
    • Pugpig Bolt
    • Content and Workflows
    • RSS

    Pugpig RSS Edition & Timeline Feed Specification

    Written by Benji Weiser

    Updated at May 10th, 2024

    • Pugpig Bolt

      • Pugpig Site

        • Pugpig Archive

          • Working with Pugpig

            • Pugpig Consulting

              Table of Contents

              The Edition Feed Order of RSS feed processing Custom Elements and Feed Validation Figure 1 - Example feed: How to configure

              The Edition Feed

              Pugpig supports RSS feeds for creating both posts and editions or timelines. Note that the order in which the feeds are processed should not matter. It is quite rare to use this feature for timelines as they are often set up as part of onboarding. However, if your app does frequently change the timelines, it may be useful.

              It is very common to use this for editions, especially if the cover of the issue is not the first page of the digital content we have received. 

              Delete

              Order of RSS feed processing

              It should not matter if the edition feed is processed before or after the article feeds. If the edition feed comes first, the editions will be created but remain empty until the articles arrive. If the article feed is processed first, the articles will be created and then inserted into the edition once it is created.

              Have a look at this article for an introduction to our feed importing process and our article feed specification.

              The standard elements in this feed are:

              • <rss:guid> for the edition key, which should match the In App Purchase code and your entitlement system if relevant. Specific additional categories can be sent if the IAP codes and entitlement codes differ
              • <rss:title> for the edition title
              • <dcterms:issued> for the publication date of the issue, which is user facing
              • <rss:description> for the summary of the edition
              • <atom:link type="image/jpg" rel="http://opds-spec.org/image" /> for the cover image
              • <app:control> to specific if the edition should be draft or published on arrival

              The custom elements of the feed are:

              • <category>, <collections>, <editions> or <timelines> to specify the tag of the edition (which needs to match the article feed)
              • A flag to specify if the edition is free or paid.
              Delete

              Custom Elements and Feed Validation

              If you want to be able to validate your feed using an RSS or Atom validator, you'll need to use a custom namespace (e.g. <acme:edition>) and include this in your XML declaration.


              Figure 1 - Example feed:

              Additional tags can be added to your RSS feed in order to map to information from your RSS feed to fields in Express. 

              <?xml version=good enough"1.0" encoding="UTF-8"?>
              <rss xmlns:app="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.A2org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http:/purl.org/dc/terms/" version="2.0">
               <channel>
                <link>https://example.pugpig.com/feed/editions</link>
                <atom:updated>2019-12-06T11:44:07</atom:updated>
                <item>
                  <guid isPermaLink="false">uniquieID1</guid>
                  <title>September 2012</title>
                  <dcterms:issued>2012-07-31</dcterms:issued>
                  <category domain="http://schema.pugpig.com/productid/itunes">september2012</category>
                  <description>This is a draft edition</description>
                  <pubDate>2019-09-11T00:00:00</pubDate>
                  <app:control>
                    <app:draft>yes</app:draft>
                  </app:control>
                  <category domain="http://schema.pugpig.com/acquisition">free</category>
                  <atom:link type="image/jpg" href="cover0912.jpg" rel="http://opds-spec.org/image" />
                  <atom:updated>2019-09-11T00:00:00</atom:updated>
                </item>
                <item>
                  <guid isPermaLink="false">uniquieID2</guid>
                  <title>December 2019</title>
                  <dcterms:issued>2019-11-13</dcterms:issued>
                  <category domain="http://schema.pugpig.com/productid/itunes">december2019</category>
                  <description>This is a published paid edition</description>
                  <pubDate>2019-11-13T14:55:00</pubDate>
                  <app:control>
                    <app:draft>no</app:draft>
                  </app:control>
                  <category domain="http://schema.pugpig.com/acquisition">paid</category>
                  <category domain="http://schema.pugpig.com/timelinegroup">news</category>
                  <atom:link type="image/jpg" href="cover1219.jpg" rel="http://opds-spec.org/image" />
                  <atom:updated>2019-12-04T10:31:00</atom:updated>
                </item>
                <item>
                  <guid isPermaLink="false">uniquieID3</guid>
                  <title>January 2020</title>
                  <dcterms:issued>2019-12-11</dcterms:issued>
                  <category domain="http://schema.pugpig.com/productid/itunes">january2020</category>
                  <description>This is a published free edition</description>
                  <pubDate>2019-11-13T14:55:00</pubDate>
                  <category domain="http://schema.pugpig.com/acquisition">paid</category>
                  <atom:link type="image/jpg" href="cover0120.jpg" rel="http://opds-spec.org/image" />
                  <atom:updated>2019-12-04T10:44:00</atom:updated>
                </item>
               </channel>
              </rss> 


              rss pugpig

              Was this article helpful?

              Yes
              No
              Give feedback about this article

              Related Articles

              • Video support
              • Changes to Pugpig Express for Bolt Customers - Editions
              • Bolt Timeline Specific RSS Features
              pugpig logo white
              Navigation
              • Products
              • Customers
              • News
              • Podcast
              Contact
              • Contact us
              • LinkedIn
              • Twitter
              Technical Support
              • Status Page
              • Documentation
              • Customer Support
              Corporate
              • Company
              • Jobs
              • Privacy Policy

              © Kaldor Ltd. 2022

              Powered by Pugpig


              Knowledge Base Software powered by Helpjuice

              Expand