Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

This article contains:

1. Introduction

The article contains all essential information for you to make full use of this platform’s features as an editor. The following sections will be covered in this document:

  • Creating and editing a page

  • Heading Styles

  • Differentiating content in different coloured panels

  • Adding images

  • Adding links

  • Adding tables

  • Setting up a page-level table of contents

  • Searching for content

  • Deleting a page

  • Copying a page

  • Moving a page

  • Viewing page history

  • Adding a page favourites

  • Adding a label/tag to a page

  • Standards to follow when creating articles

2. How do I create or edit a page?

2.1 Creating a page

There are two options to create a page.

  • STEP 1: Go to the main page you wish to create the new page under.

Option 1: Create button at the top

  • STEP 2.1: Click on the Create button at the top of the page.

Option 2: Creating from side navigation panel

  • STEP 2.2: Click the plus icon under the main article you want to create the new page under.

2.2 Adding a page title

  • Once the page is created, add a unique page title at the top of the page.

Note: Every page created under this space will require to have a unique name. Therefore, if a page is created with an already existing name, an error message ‘A page with this name already exists.’ will be displayed. Hence, please enter a title name which doesn’t exist.

  • Click on the Publish button to create the page.

2.3 Editing a page

Once a page has already been created. Follow these steps to edit the page.

  • STEP 1: Click on the pencil icon at the top of the page to edit.

  • STEP 2: Once you have edited the page, click on the Publish button at the top, to update and publish the page.

3. How do I add different heading styles?

You can add different heading levels within an article using the 'Text styles' control at the top of the page.

  • STEP 1: Click on the pencil icon at the top of the page to edit the page.

  • STEP 2: To give a heading style to a title, select on the heading you typed, click on the 'Text styles' dropdown at the top of the page, and select the heading level you want to set your title with.

Note: By specifying a heading style to your title, it will help you when generating the auto table of contents for the page, and will create a link to each title within a page (once published, this link can be copied and used as a direct link to the specific title).

4. How do I add a coloured panel to highlight content?

To highlight specific content areas within an article, you have several options that can be used. Below are some of these options and how it can be added into your article.

There are two options how this can be done.

  • STEP 1: Place your cursor at the point you want to add a panel.

Option 1: Adding panel via the + icon (macros) in the controls panel

  • STEP 2.1: Click on the + icon in the controls panel at the top of the page.

  • STEP 2.2: Select or type in the panel name and press Enter to add the required panel. See the below table for more details on the different panels available.

Option 2: Adding panel using the shortcut key /

  • STEP 2.3: Type in the key / followed by the panel name and select the panel by clicking on it. See the below table for more details on the different panels available.

  • STEP 3: Add any content into the panel you added.

  • STEP 4: You can change the colour and icon of a default panel once it’s added as well. To do this, click inside the panel, and in the control box below it, select a suitable icon or colour and click outside.

  • STEP 5: To delete a panel, click inside the panel, and in the control box below it, click on the remove icon at the end.

Refer the table below to see a list of default panels available to be selected from.

Icon

Panel

Description

Info

A blue coloured panel with an info icon. This panel can be used for additional notes or information.

Note

A purple coloured panel with a note icon. This panel can be used for any special notes or things that need to stand out.

Success

A green coloured panel with a tick icon. This panel can be used for success messages (e.g. Page is successfully created) or tips.

Warning

A yellow coloured panel with an exclamation icon. This panel can be used for warning messages or examples.

Error

A red coloured panel with a cross icon. This panel can be used for error messages (e.g. Do you want to delete this page?).

Add emoji

Select this emoji icon to customise the panel icon and select from a list of emojis available.

Remove emoji

Select this option to remove the panel icon (emoji) and leave it only as a coloured box.

5. Adding images

To place an image or a file attachment into your article, follow the below steps.

  • STEP 1: Click on the Files and images icon to add an image or a file. This component displays a series of images or files related to a particular project. This component can also be configured to show a series of custom images.

  • STEP 2: Once the image icon is clicked select the image and press the Enter key.

6. Adding links

  • To add a link to your page, click on the link icon placed on the toolbox.

  • Once the link icon is clicked, you will get a popup.

  • Type the URL on the space given to link the page.

7. How do I add a table?

  • STEP  1: To add a table, click on the table icon on the toolbox or click on the down arrow, select table, and press the Enter key.

  • STEP 2: Clicking the table icon auto generates three column table; you can either add or remove columns and rows by clicking the down arrow, simply click on the double arrow to expand the table

  • STEP 3: You can give a header row, header column, numbered column, pie chart or even delete the table by clicking the table option below the table.

7.1 Table options

  • Cell background – You can filter the background color of the table.

  • Insert column right: If you want to add columns to the right-hand side of the table then you can press this filed.

  • Insert row below – By default it’s three row and three columns, this filter lets you to add rows below.

  • Delete column – If you wish to delete a column, this filter enables you to delete a column.

  • Delete row – This filter allows you to delete a row.

  • Merge cell – This filter allows you to merge cells.

  • Split cell – This filter will be active if the cells are merged.

10. How can I setup a page-level table of contents?

Once the page is created, click on the drop-down arrow, search for the table of contents on the search bar or key in the search word within / (slash), and press the Enter key.

11. Searching for content

  • To search any content quickly, simply click on the search bar at the top of the page.

  • Key in the search word within “” (double quotations) and select the page if you see the exact same page.

Please refer the How to use this platform – for all users article for more information.

12. How do I delete a page?

If you want to delete a page,

  • Select the more actions () icon at the top-right corner of the page.

  • Select the delete option.

  • Once the Delete button is clicked, a popup message ‘Send to trash?’ will appear, click on the Delete button to delete the page or click on Cancel button to cancel deleting the page.

13. How do I copy a page?

  •  If you want to copy an article, click the Copy button placed at the top right corner under more actions ().

  • Clicking the Copy button allows you to copy the whole article, including the article header and the components of all levels.

14. How do I move a page?

If you want to move a page,

  • Select the more actions () icon at the top-right corner of the page.

  • Select the Move option.

  • Once the Move button has been clicked, a popup will display with all articles; simply click on the place that the article needs to be moved or simply drag the page that need to be moved on your left-hand side bar under the space.

15. How do I view the page history?

  • Select the More Actions (...) icon at the top-right corner of the page.

  • Select Page history.

  • Clicking Page history gives the current version with all versions created, published date and the Author.

  • Actions can be either restored or deleted as per your wish.  

  • clicking the Compare selected version, shows the comparison of previous versions.

  • denoting with three colours:

    • Red - lines that were removed from the article.

    • Green - lined that were added to the article.

    • Blue - formating changes.

16. Can I make a page as a favourite?

  • If you want to make a article as your favourite, click on the Star button.

  • Click Camms > Starred on your left-hand side under your profile to find the page which has been starred.

  • Clicking on the star makes it easier to find.

17. Can I add a label/tag to a page?

  1. Option 1: Select the more actions () icon at the top-right corner of the page and Select Add labels.

2. Option 2: Click on the labels icon below the page to add a label.

  • Once the add Labels button is clicked, a popup will display as ‘labels’. Type the label name, press the Enter key on your keyboard and click the Close button.

18. Standards to follow when creating articles

  1. Each button used in the article will be displayed in Bold letters with all CAPITAL or the first letter CAPITAL.

2. Each icon used in the article will be displayed with Bold letters with lower case letters.

3. Figure captions - centre aligned and italicised

4. Page names - within single quote marks (e.g. This will open the 'Risk Register' page)

5. Each Link path attached to the article will be displayed in with bolded letters underlined.

(e.g.  menu > workspace > my settings)

6. Each link attached to the article will be displayed in italicise. (www.Google.com)

7. Each note used in the article will be displayed in blue color, whereas each tips used will be displayed in green colour.

  • No labels