Authoring Guide 1.0
Refer to this authoring guide when creating new site pages for the crn.com site
General Authoring Practices
Authors should review general authoring practices
Divider
Sample Pages
Divider
How to Edit
Divider
Preview, Publish & Delete Content
Once a document is created in Sharepoint, you can preview the corresponding web page and eventually publish the content to your production website.
The preview function is used to share pages with stakeholders before they are published and available to the general public on your website.
In order to preview, publish, or delete content, Franklin Sidekick is provided that can be installed as a bookmarklet or a browser extension.
Ideally Authors can use a pre-configured link for your project from a fellow author, via the “Share Your Sidekick” function, in the sidekick itself.
Divider
Blocks
Blocks are a way to work with more structured content and add special functionality to your site. What blocks are available on your site depends on what your development team has implemented and differs from site to site. The only block that is common to all sites is the metadata block.
Regardless of site, the structure of a block is always the same: it is a table with a merged first row that serves as the block name (header row). The header row may have specific formatting like a background color to increase their discoverability and differentiation in a document.
Below you can find an inventory of blocks that can be used in your blog articles as per design specification.
Available blocks
Divider
OOTB Block Collection
Refer to the official documentation to view all available blocks that can be used in your block articles
Custom Blocks
All blocks created for CRN.com are available to view in our Sidekick library to view/copy
See here
Divider
Buttons
There are often primary and secondary buttons and the default styling is usually defined for default content and/or specified by a containing block.
Bold and Italic (<strong> and <em>) and possibly combinations thereof can be used to specify alternative variations of primary/secondary
Sample Buttons
Divider
Auto-Blocks
Section Dividers
Description : Authors have the ability to add content section dividers.
Authors can just write divider( or Divider) in the content structure with Fixed Font (eg. Courier New) and once preview/publish, would translate into a section divider
divider
Metadata
Section Metadata
Description : Author can create section breaks by adding --- (three minuses) to the document
Sharepoint: just put --- (three minuses) on a single line to create a section
Other section metadata variations can be found here
Page Metadata
Metadata is information about your page that is invisible to visitors, but important to search engines and social media sites that want to find your content or embed it.
- For more information, Please check the official documentation here
For setting metadata in bulk, Metadata file for crn.com can found here
divider
Redirects
Authors can manage redirects in a most intuitive way as a spreadsheet called redirects (or redirects.xlsx) in the root of your project folder.
Author should review general practices around Redirects
Redirects file for crn.com can found here
divider
Placeholders
Author should review general practices around Placeholders
Placeholders file for crn.com can found here