Skip to content

Skeleton XML Jinja Post Variables

Jorge Puente-Sarrín edited this page Feb 7, 2019 · 10 revisions

Post Variables

{
    "id": Integer,
    "headline": String,
    "subheadline": String,
    "roar_authors": Array,
    "description": String,  // Article body
    "brief": String,  // Excerpt
    "media_brief": String,  // Excerpt without stripped media
    "primary_tag": String,
    "tags": Array,
    "public_tags": Array,  // Exclude tags with leading "*" or "~"
    "section": Object,
    "basename": String,  // URL Slug
    "page_title": String,  // SEO headline
    "meta_description": String,  // SEO description
    "exclude_from_search_results": Boolean,
    "image": String,  // Lead image URL
    "image_thumb": String,  // Lead image thumbnail URL
    "image_size": String,  // Format: "<width>x<height>"
    "image35x35": String,
    "image210x": String,
    "image300x": String,
    "image600x": String,
    "image980x": String,
    "photo_credit": String,
    "photo_caption": String,
    "frontpage_headline": String,
    "teaser_image": String,  // Article image URL for listings
    "teaser_image35x35": String,
    "teaser_image210x": String,
    "teaser_image300x": String,
    "teaser_image600x": String,
    "teaser_image980x": String,
    "teaser_photo_credit": String,
    "teaser_photo_caption": String,
    "google_amp": Boolean,
    "instant_article": Boolean,
    "og_title": String,  // Social headline
    "og_description": String,  // Social description
    "custom_post_tweet_text": String,  // Custom tweet text
    "social_teaser_image": String,  // Article image URL for social shares
    "social_teaser_image35x35": String,
    "social_teaser_image210x": String,
    "social_teaser_image300x": String,
    "social_teaser_image600x": String,
    "social_teaser_image980x": String,
    "social_teaser_photo_credit": String,
    "social_teaser_photo_caption": String,
    "original_url": String,  // URL of ingested article if any
    "direct_links_out": Boolean,  // Enable redirection to original URL
    "created_ts": Integer,  // Timestamp of publish date
    "created_date": String,  // Publish date in format "MM/DD/YYYY"
    "formated_created_ts": String,  // Publish date in configured short format
    "formated_full_created_ts": String,  // Publish date in configured long format
    "post_url": String,
    "google_amp_post_url": String,
    "roar_specific_data": Object
}

Note

image, teaser_image, and social_teaser_image might have more related fields depending on ratios/sizes configuration.

Author Variables

roar_authors field is an array of objects which have the following schema:

{
    "id": Integer,
    "name": String,  // Slug
    "title": String,
    "about_html": String,  // Bio
    "avatar": String  // Avatar URL
}

Section Variables

section is an object with the following schema:

{
    "id": Integer,
    "name": String,  // Slug
    "title": String,
    "tags": Array,
    "meta_tags": Array,
    "meta_title": String
}

Clone this wiki locally