-
Notifications
You must be signed in to change notification settings - Fork 70
Configuration
Once the Publish to Apple News plugin has been installed and activated, the next step is configuration. To begin, choose Settings > Apple News from the WordPress Admin panel.
This plugin is not responsible for setting up or managing your News Publisher channel with Apple, nor does using this plugin guarantee that Apple News will accept your content. Please see the Apple Developer and Apple News Publisher documentation and terms on Apple's website for complete information.
To enable content from your WordPress blog to be published to your Apple News channel, you must obtain and enter your Apple News API credentials from Apple. These can be found in your iCloud Publisher account under Channel Info > API Key.
Please note that once you obtain your secret, it cannot be obtained again unless you replace the API Key. Once you have these settings, copy them into the API Key, Secret, and Channel fields at the top of the Apple News settings page.
Once entered and if your channel has been approved, you can begin publishing WordPress posts to Apple News.
You will also notice a few more general settings underneath these fields. This determines how content will be published to your Apple News channel from WordPress.
- Automatically publish to Apple News: Set this to 'yes' to automatically publish every post to your Apple News channel when it's published in WordPress.
- Automatically update Apple News: Set this to 'yes' to automatically update every published post in Apple News when it's updated in WordPress.
- Asynchronously publish to Apple News: Publish to Apple News using a single scheduled event rather than on publish. This is generally only necessary if you're forced to use bundled images and you're having issues with timeouts on publish. We generally recommend leaving this set to 'no' and using remote images.
This allows you to choose the post types that are eligible for publishing to Apple News. If you have multiple custom post types, you may not want them all to publish to Apple News and this gives you granular control.
You can also choose whether or not you want a meta box for handling per post settings and publishing to Apple News on the post edit screen. We recommending setting this to 'yes' as it's the most convenient way to handle publishing to Apple News right where you're already editing.
The Publish to Apple News plugin creates a default layout for Apple News. However, many of the individual component settings can be highly customized so you can create your own unique design for your Apple News content. Starting with version 1.2.0, we've also introduced a live web preview that shows an approximation of what your content will look like in Apple News. If you're on macOS, you can also see a live preview of all fonts that you select.
First, some general notes on settings:
- All sizes are in points. Please enter only the number. Note that Apple does automatically adjust some font sizes automatically for different device screen sizes and orientations and therefore font sizes may not always be exact. If you want to test settings, please download Xcode and the News Preview tool.
- Colors can be selected using the WordPress color picker or by entering the HTML color code in
#123456
format. - Font dropdowns show a live preview of the font on macOS only.
The following components can currently be customized via the formatting settings:
Layout margin: The left and right margins for components that aren't full width, such as the cover.
Layout gutter: The spacing between columns of components.
Read more about layout options in the Apple News Format Reference.
The body corresponds to the main paragraphs of text in your content. Anything enclosed in a <p>
tag gets converted to a body component. You can format the body with the following options:
Body font size Body font color Body font hyperlink color Body background color Body alignment: Can be left, right or center.
Read more about formatting the body in the Apple News Format Reference.
The first letter at the beginning of your post can be converted to a drop cap, which is a large letter that span multiple paragraphs. It's a nice visual touch for your readers, though not required. You can format the drop cap with the following options:
Drop cap font Use initial drop cap: Turns the drop cap on and off. Drop cap font color
Read more about formatting the drop cap in the Apple News Format Reference.
Byline font Byline font size Byline font color Byline format by #author# | #M j, Y | g:i A#
Set the byline format. Two tokens can be present, #author# to denote the location of the author name and a PHP date format string also encapsulated by #. The default format is "by #author# | #M j, Y | g:i A#". Note that byline format updates only preview on save. (The byline displays the article's author and date) Headings AvenirNext-Bold
Header font color
#333333
Header 1 font size
48
Header 2 font size
32
Header 3 font size
24
Header 4 font size
21
Header 5 font size
18
Header 6 font size
16
Pull quote AvenirNext-Bold
Pull quote font size
48
Pull quote color
#53585f
Pull quote border color
#53585f
Pull quote border style
Pull quote border width
3
Pull quote transformation
(Articles can have an optional Pull quote.)
Gallery Gallery type
(Can either be a standard gallery, or mosaic.)
Advertisement Enable advertisements
Ad Frequency
1
A number between 1 and 10 defining the frequency for automatically inserting Banner Advertisement components into articles. For more information, see the Apple News Format Reference.
Ad Margin
15
The margin to use above and below inserted ads.
Advanced settings allow you to set custom content height settings. In most cases, the default settings will provide the best results. However, you can also enter custom values if desired (values are typographical point sizes). To return to the default values, simply clear any values entered into these fields.
For support, please file an issue here on GitHub or visit the WordPress.org support forum.