Guides and Sample Code

Developer

Apple News Format Reference

Document Revision History

This table describes the changes to Apple News Format Reference.

Date

Notes

2017-11-28

Document revision 1.17. Minor clarifications were made in this revision.

2017-09-19

Updated the document for iOS 11.


Added information about the new Aside, Data Table, and HTML Table components.


Added information about the contentDisplay property to the Chapter, Container, Header, and Section pages.


Added information about the attachment property to the Linear Gradient Fill Style and Video Fill Style pages.


Added information about the alignment property to the Collection Display page.


Added information about authors and accessoryText to the About Article Tiles page.


Updated the thumbnailURL property on the Article Metadata page.


Miscellaneous small improvements.

2017-06-06

Document revision 1.13. Documented new features supported by the iOS 11 beta seed. Additionally there were minor updates to clarify terminology.


Available in iOS 11 beta: Updated Link Addition and HTML Markup for Apple News Format to support adding links to components within the article.


Available in iOS 11 beta: Updated Advertising Settings to support being able to dynamically place ads between paragraphs and details for the new distanceFromMedia property.


Available in iOS 11 beta: Updated Units of Measure for Components to support the new dg and dm unit properties for setting margins.


Available in iOS 11 beta: Added the new Collection Display topic that describes how to size and position child components within a container.


Updated Caption Descriptor to clarify the example code.


Updated the GIF thumbnail usage text in Article Metadata and Image Guidelines.

2017-04-11

Document revision 1.12. Minor updates to clarify terminology.


Updated Article Metadata to clarify the campaignData property.


Updated HTML Markup for Apple News Format to clarify styling differences.

2017-03-01

Document version 1.11. Updated the Cover Art component and removed the Vine Post component.


A new section was created to raise visibility of Top-Level Properties and Article Metadata.


Updated the Chapter and Section components to clarify where they are typically used.


Added the target property, used with target elements that have their format set to html, to the Anchor component


Updated Cover Art object to clarify how this works with the metadata and to add isPreview information to Featured Stories.


Removed Vine Post component.


Image resolution guidelines have been updated. See Image Guidelines.

2017-01-11

Document version 1.10. Added details about lists when using HTML markup. Several other small clarifications and corrections.


Added the About Article Tiles section.


Changed the URL property to be required in the Gallery Item section.


Corrected the margin property definition in the Component Layout section.


Clarified the behavior when the gutter and margin properties are set to a negative value in the Layout section.


Added the new List Item Style section and the related orderedListItems and unorderedListItems properties to the Text Style section.


Clarified lists in the Markdown for Apple News Format section.


Added information about automatically inserting medium rectangle advertisements on iPhone and iPod touch in the Advertising Settings section.

2016-11-15

Made many small clarifications to enhance this document's usability, including consolidating image information into an appendix.


Added alternative <s> tag for HTML strikethrough in the HTML Markup for Apple News Format section.


Added an Image Guidelines appendix to provide recommendations and requirements for the images you use.


Corrected default loop value in Video Fill Style.

2016-10-06

Added details for additional authoring capabilities and formatting options to existing style components, including the new HTML markup support.


Added support for HTML Markup for Apple News Format.


Added HTML Markup for Apple News Format requirements for Author, Body, Byline, Caption, Heading, Illustrator, Intro, Photographer, Pull Quote, Quote, and Title objects as well as the Caption Descriptor property.


Updated descriptions under Top-Level Properties and Article Metadata for HTML Markup for Apple News Format support.


Enhanced property descriptions for the Text Style object.


Enhanced the guidelines for ad placements for the advertisingSettings property in the section on Top-Level Properties.


Updated the information on ISO 8601 date format for dateCreated, dateModified, and datePublished in the Article Metadata section.


Enhanced information for layout scaling from device to device under Prepare for Automatic Scaling for Devices.


Added information on Supported Character Sets.


Removed the section on Nested Components in Creating Content for News.

2016-09-14

Added a new object, updated component and metadata properties, and modified properties and support for Markdown.


Enhanced the property descriptions for the Layout component to provide additional context for The Column System.


Added the Text Decoration object.


Modified the description for the Text Stroke Style object.


Removed animations and behaviors as supported properties for the Chapter component.


Added information about dynamic ad under the Advertising Settings object.


Added guidelines for the document-level identifier in the Top-Level Properties section.


Updated the dateModified and datePublished properties in the Article Metadata section.


Added a topic on URL image formats under Creating Content for News.


Enhanced content for list formatting in Markdown for Apple News Format.


Added information about emphasis technique in Markdown for Apple News Format.


Modified the code example for escaping Markdown in the Markdown for Apple News Format.

2016-07-11

Added information about article layout and updated properties and support for Markdown.


Added an overview of The Column System for Apple News Format.


Added properties to Image Fill Style.


Added support for Map and Place components in Markdown for Apple News Format.


Added code examples in the Markdown for Apple News Format section to show emphasis within links.

2016-06-13

Added new components and updated support for Markdown.


Added Facebook Post component.


Added Vine Post component.


Added Cover Art definition and guidelines.


Added videoURL in the Article Metadata properties.


Added code examples in the Markdown for Apple News Format section to show emphasis inside of words.


Added information in the Markdown for Apple News Format section about the beginning and ending spaces within a component that uses markdown.


Added Map and Place components to the supported markdown components in the Markdown for Apple News Format section.


Added a section about the behavior of Inline Text Styles when used in Markdown for Apple News Format.


Explained escaping sequences in Markdown for Apple News Format.


Added information about the behavior of the targetComponentIdentifier property in the Anchor component.


Corrected information about the behavior of the Image Role component in the Component Role Summary section.


Added additional components to under Component Role Summary.

2016-05-04

Updated document content for multiple components.


Added Map, Map Item, Map Span, and Place components.


Clarified guidelines for Banner Advertisement.


Added information about posting older articles to the section on Article Metadata.


Added bannerType property and information about the frequency of ad appearances within an article to the Advertising Settings component.


Added a section on Percent Encoding.


Deprecated Scalable Image and Text (Abstract) components.

2016-03-15

Added properties and components for the custom JSON format for creating content for the News app. You can now create articles with the latest version of JSON format.


Updated version-level support for JSON articles ("version": "1.1").


Added first line indent, hanging punctuation, and paragraph spacing properties to the Component Text Style component.


Added raised drop caps property to the Drop Cap Style component and increased the maximum number of lines from 6 to 10.


Added videoFill.loop, text shadow, and text stroke properties to the Text Style component.


Added caption descriptor property to Scalable Image, Gallery Item, Photo, Figure, and Portrait components.


Added Shadow, Link Addition, and Offset components.


Added Caption Descriptor, Advertising Settings, and Advertising Layout referenced properties.


Standardized caption descriptor property for Scalable Image subclasses.

2016-01-20

Updated document that enhances descriptions of the custom JSON format for creating content for the News app.

2015-10-26

New document that describes the custom JSON format for creating content for the News app.