Knowledge Hub construction
- Joe Checketts
Knowledge Hub pages are built in three stages. The content consisting of images, text and boilerplate (repeated text throughout the site) is created in the CE Knowledge Hub Refined(CKHR) Confluence space. This content is placed in pages in the Cyber Essentials Knowledge Hub (CEKH) space using the Confluence /excerpt and /excerptInclude elements. The Refined plugin is then pointed at the CEKH space and creates a site, adding a navigation bar and standardized formatting. Confluence formatting elements such as Layouts and text size are retained in the Refined pages.
Different page types in the CEKH space are based on a series of templates (prefixed with TMPL). These templates provide a standardised layout and structure for each type of page.
The text is stored in the CKHR space and is subject to document control using the method of placing a PageProperties table in the Master pages. The graphics and boilerplate are stored in the CKHR space and added to the CEKH pages using /includeExcerpt elements.
This means that the Refined content can be easily controlled and updated by modifying the contents of the CKHR space.
CE Knowledge Hub Refined (CKHR) space
This is the backend space where the content is stored. The excerpts on these pages are used to build the pages in the live space. CKHR space contains a replica of the Knowledge Hub structure with each area and page laid out in the same way. The CKHR pages are the master pages and the CEKH pages are the target pages which will Refined will work from.
Page names in the CEKH space are used as the page names for the Refined site. Master pages in the CKHR space are the same names prefixed with M_. On each master page is a PageProperties table containing the metadata for the page which is used for document control. The content is placed in an /include box which contains the text that will appear on the target page.
This space also includes the Knowledge Hub backend area where images and standard text is stored.
Cyber Essentials Knowledge Hub (CEKH) space
This is the ‘live’ space that is rendered into web pages by Refined. The content of this space is generated from the backend space. Any changes to the structure of this space will be reflected in the public-facing site.
CEKH space contains the pages that Refined uses to create the public-facing site. It also contains the templates used to build each type of page. Pages here will usually consist of several /insert excerpt controls which are given the location of the source /include controls from the master pages.
Pages in the CEKH space are either navigation pages or content pages. Navigation pages provide links to the sub-pages of the section. Content pages contain /insert excerpt controls which display the content from the master pages in the CKHR space.
Excerpts
Using /excerpt and /excerptInclude, content from one page can be displayed on another. Any changes made to the excerpt content will be automatically propagated to the public pages.
