Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Cyber Essentials Knowledge Hub is based on a Confluence space and displayed using Refined.

...

Add a text line in red that states The below will appear on the Refined page at

Type “/excerpt”. Click on the box and select Edit (the pencil icon). Name the excerpt - typically this would be M_TCB_ExampleArticle. Paste the article text into the box.

...

Navigate to the CEKH space and create a new page in the location you wish it to appear in Refined. Refined will show the pages in the same order and with the same structure as they appear in the Confluence space.

Add title

Type in the page title, e.g. Example Article.

Create page from template

The page will be created using a template, go to the bar at the right, type TMPL, and the available templates will appear under the search bar.

In this example an article is being created, so choose TMPL_ContentPage.

Update PageProperty

Add the details to the PageProperty control of the article.

Add graphic

There is a default graphic for the page, this can be changed by hovering over the image, clicking on the grey portion of the box and clicking the Edit (pencil) icon. This will enable you to select the image you need, the default location for images is the IGS page IGS:KH_DefaultImages and the available images are shown in the dropdown. Any other page could also be used as the image source, you must use the space code followed by a colon followed by the name of the page where the image is stored. Once the image is selected, check Remove border panel and click Save.

Link to master text

Next, click the excerptInclude control and set the source as IGS : M_Example Article and the excerpt as M_TCB_ExampleArticle (or whatever your source is). The excerpt from the IGS page will appear inside the excerptInclude.

Create and add PDF

As this is a content page, there should be a downloadable PDF of the page. The PDF is generated from the Confluence page using the built-in PDF creator.

At the right side of the Layout control is a piece of text that says ‘Downloadable PDF’. Click on the left/right arrow to expand the width of the Layout so that you can edit the text. Replace this with the author name, publishing date, etc. The text will appear correctly in the Refined page, but you may have to play with the placement of the text to get the right result in the PDF as the image can obscure it.

Click Publish and you will see the new page listed in the folder structure at the left.

To create the PDF, go to the 3 dots at the top right and click on Export>Export to PDF. Once it has been created, click Download PDF. On a Mac you will immediately see the file appear in the download alert at the top of the browser. Navigate to the file location (usually the Download folder) and change the file name to the article name (just remove the extraneous text from the file name).

Once the PDF file is created, go back into the page and add ‘Download PDF’ under the article info. Drag the PDF file from the file location to just under the text and a link will appear. In Change View select Display Thumbnail. Close up the Layout using the expand control.

Step 3 - Update Master page

Click on the Example Article in the navigation bar and click the three dots. Select Copy Link.

Navigate to the IGS M_Example Article page and paste the link into the PageProperties control and next to ‘The below will appear…’

Step 4 - Document Control

Documents must be approved by Neil Furminger, Joe Checketts or Jane Waterfall.

Controlled pages have Page Property tables, and QMS area has Page Property Control Macros which work off labels. Any page with the specified labels and CE label will be listed by the macro under the document control registers. The system filters out any page with DRAFT at the start of the title.

Donna will add the document number once the page has been approved.

Do not remove the document control labels from MASTER versions or macros will not retrieve pages.

Add comment to page at Donna saying ‘ready to be approved’. Document number will be added to page properties table.

The labels ‘ce’ and ‘guide’ should be added to the page in order for them to appear in the document control system.

There are two categories of review period for the Knowledge Hub articles. These are annual (for the majority of documents) and bi-weekly (for the end of life pages, which require frequent updates to remain accurate). Specify the approval dates etc in the PageProperties control and add either the Annual or Bi-weekly period in the Review and Consultation field.

Operating System Support

...