Reusable content is convenient when working with multiple pages that require the exact same information or a reusable format with different content. End-user tools for creating reusable content come in the form of assets, snippets, include files, binary files, and auxiliary sites. Generally, editing include files is limited to system designers and template developers, and those users only will see an editable region button. Additionally, the use and design of templates themselves and the use of XML stylesheets are a shortcut to utilizing common code and common content.
Snippets, Assets, and Includes
Snippets provide a template or a format with information that can be changed. For example, the site may require a specific format or structure for tables. This can be created in a snippet and inserted on a page any number of times. Once inserted on the page, the content becomes a part of the page and editable. Because the snippet is no longer linked to the original file, editing the original snippet does not affect the pages on which it was inserted.
For more information, visit the Snippets page.
Assets are used to provide the same information on any number of pages. When the content of the asset is updated, so are the pages that subscribe to it. This is useful for global content and content that should be protected from changes. This also provides a way to insert server-side and client-side code on the pages.
For more information, visit the Assets page.
Include files are similar to assets in that they are considered global and editing the include file updates all pages that are using it. The main difference is that include files are hardcoded into particular locations within the page templates, whereas assets can be placed in any editable region, allow flexibility around where they appear.
For more information, visit the Includes page.
Snippets are site-specific, meaning that snippets have to be configured for each site on which they should be used. Assets are available cross-site, with the exception of Live Delivery Platform's image galleries and forms. This means that the same asset can be used on both the main site and the intranet site if desired. Using include files across sites is possible but depends on multiple factors including the server's settings, the site's configuration, and the configuration of the include.
The following table provides a few examples of ways that snippets, assets, and includes are utilized. Keep in mind that this list is not all-inclusive and not restrictive; that is, examples that are snippets can also be utilized as assets, and vice versa.
|Image placeholder with caption|
|Non-recurring formatted text|
|Recurring text, common content|
|President's name, email addresses, phone numbers|
|An article, quote, or accolade that requires departmental branding|
|Widgets, and other third-party code|
|Headers and footers|
|Include statements designed to be included on a page post-transformation.|