Skip to content

0.10.0 Release Notes

Gregory Engel edited this page Apr 8, 2019 · 1 revision

ANS 0.10.0

Enhanced Elements

Enhanced Interstitial Link

The Interstitial Link (interstitial_link) element has new optional traits.

  • description - A text element which contains supplementary text to the link. May contain text formatting. May or may not be considered as part of the clickable part of the link, depending on implementation.
  • image - An image element which should be stored as a reference. Must be considered part of the clickable part of the link.
{
  "_id": "0987654321",
  "type": "interstitial_link",
  "url": "https://www.washingtonpost.com/politics/can-clinton-and-trump-ride-to-big-victories-in-next-weeks-acela-primary/2016/04/20/ea6454fc-064e-11e6-bdcb-0133da18418d_story.html",
  "content": "Can Clinton and Trump ride to big victories in next weeks Acela primary?",
  "description": {
    "type": "text",
    "content": "<em>Emboldened</em> by dominant victories in <strong>New York</strong>, Hillary Clinton and Donald Trump plunged swiftly Wednesday into the next batch of primaries in five states along the Northeast Corridor, where they hope to bury or break their challengers for the Democratic and Republican presidential nominations."
  },
  "image": {
    "type": "reference",
    "referent": {
      "type": "image",
      "id": "AAAAAFGHIJKLMNOPQRSTUVWXYZ",
      "provider": ""
    }
  }
}

Schema: https://github.com/washingtonpost/ans-schema/blob/master/src/main/resources/schema/ans/0.10.0/story_elements/interstitial_link.json

New Element Types

Link List

A new Link List (link_list) content element has been added. A Link List can be used to represent links to external sources or other articles. Unlike related_content it may be positioned within the document, floated to the left or right, and may contain links to external websites or non-ANS content, and may have a distinct title. It consists of a series of the newly-enhanced interstitial links and a title.

  • title -- The title of the link list.
  • items -- A sequence of interstitial links.

Example:

{
  "_id": "ABC",
  "type": "link_list",
  "subtype": "more-information",
  "alignment": "right",

  "title": "Learn More",
  "items": [
    {
      "_id": "DEF",
      "type": "interstitial_link",
      "subtype": "highlight",
      "url": "https://www.washingtonpost.com/politics/can-clinton-and-trump-ride-to-big-victories-in-next-weeks-acela-primary/2016/04/20/ea6454fc-064e-11e6-bdcb-0133da18418d_story.html?hpid=hp_rhp-top-table-main_5states-1025a%3Ahomepage%2Fstory",
      "content": "Can Clinton and Trump ride to big victories in next weeks Acela primary?",
      "description": {
        "type": "text",
        "content": "<em>Emboldened</em> by dominant victories in <strong>New York</strong>, Hillary Clinton and Donald Trump plunged swiftly Wednesday into the next batch of primaries in five states along the Northeast Corridor, where they hope to bury or break their challengers for the Democratic and Republican presidential nominations."
      },
      "image": {
        "type": "reference",
        "referent": {
          "type": "image",
          "id": "AAAAAFGHIJKLMNOPQRSTUVWXYZ",
          "provider": ""
        }
      }
    },

    {
      "_id": "GHI",
      "type": "interstitial_link",
      "subtype": "skinny",

      "url": "https://www.washingtonpost.com",
      "content": "See more from The Washington Post"
    }
  ]
}

Schema: https://github.com/washingtonpost/ans-schema/blob/master/src/main/resources/schema/ans/0.10.0/story_elements/link_list.json

Custom Embed

A new Custom Embed (custom_embed) content element has been added to include externally-sourced content within a story. It contains a URL, an ID, and arbitrary configuration data. The URL and ID should be used in conjunction when rendering to retrieve an oembed-like payload describing the embedded content. (E.g., a video iframe.) The configuration data can include information specific to the context of the embed (e.g. autoplay, start position.)

Example:

{
  "_id": "WXYZABCDEFGHIJKLMNOPQRSTUV",
  "type": "custom_embed",

  "subtype": "my_custom_video",
  "alignment": "left",
  "channels": [ "web" ],

  "embed": {
    "id": "12345",
    "url": "https://my.custom.video.com/api/embed/",
    "config": {
      "autoplay": true,
      "startPos": 32
    }
  }
}

Schema: https://github.com/washingtonpost/ans-schema/blob/master/src/main/resources/schema/ans/0.10.0/story_elements/custom_embed.json

Divider

A divider (divider) content element has been added. It represents a visual divide in the presentation of a story. (E.g. an HTML <hr> tag.) It has no unique properties or traits.

Example:

{
  "_id": "VUTWXYZABCDEFGHIJKLMNOPQRS",
  "type": "divider"
}

Schema: https://github.com/washingtonpost/ans-schema/blob/master/src/main/resources/schema/ans/0.10.0/story_elements/divider.json