FeedBuilder Custom Fields

The FeedBuilder plugin helps you generate content feeds for just about any purpose. Using FeedBuilder you can generate anything from Podcasts and general RSS feeds to custom mobile app feeds.

One of the really powerful features of the plugin is the ability to define custom field values using a simple template language. First you'll need to understand the Twig template language. Twig allows us to create the logic used in these custom fields. (If Twig isn't your thing, contact us to build the custom feed for you.)

The custom field basically acts as a mini-template within the system. It's processed just like any other template. When it is processed, the system injects the "item" being templated, e.g. the article, media, blog post, etc.

For example, let's say we wanted to add the text "The State News: " before all article headlines in a feed's "title" field.

First, click the pencil icon next to the title field's value:

The field should convert to a custom entry box, looking like this:

Now, you can insert your Twig template. Your article is available to the template as:

{{item}}

So, using Twig, we can print out the article's headline using {{item.headline}}, and add the text "The State News: " before it:

Now, when the feed is generated, all the article headlines will appear as "The State News: ORIGINAL ARTICLE HEADLINE".

Currently, the plugin sources support the following properties:

Articles

item.headline Headline
item.subhead Subhead
item.url Default URL for article
item.copy_formatted Full article contents 
item.abstract_formatted Article abstract contents 
item.created Time article was created (in seconds) 
item.modified Last modified time (in seconds) 
item.published Publication time (in sections) 
item.authors A collection of authors 
item.tags A collection of tags

Media

item.title Media title, if defined
item.url URL to the file's full size file
item.urlPreview URL to the file's preview size file
item.urlThumbnail URL to the file's thumbnail size file 
item.urlOriginal URL to the original file 
item.urlDefault By default, this is the URL to the file's multimedia page
but can be overridden
item.caption_formatted File's full caption 
item.created File's created time (in seconds)
item.modified File's last modified time (in seconds) 
item.published File's published time (in sections) 
item.authors A collection of authors 
item.tags A collection of tags 

Blog Posts

item.headline Headline
item.url Default URL for post
item.copy_formatted Full post contents 
item.abstract_formatted Article abstract contents 
item.created Time article was created (in seconds) 
item.modified Last modified time (in seconds) 
item.published Publication time (in sections) 
item.authors A collection of authors 
item.tags A collection of tags

Eclipse and Pre1

item.copy Full ad content
item.url Default URL to the ad
item.created Now (provided for compatibility)
item.modified Now (provided for compatibility) 

Google Calendar

item.title Event title
item.calendar Parent calendar name 
item.content Event description 
item.start_time Event start day and time (in seconds) 
item.end_time Event end day and time (in seconds) 
item.url Default URL for event (leads back to site, not Google calendar) 
item.location Event's raw location 
item.created Event created time 
item.modified Event modified time 
Have more questions? Submit a request

Comments

Powered by Zendesk