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 or file attachments
Adding links
Adding tables
Setting up a 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 and file attachments |
5.1 Adding an image
To place an image into your article, follow the below steps:
STEP 1: Place your cursor at the point you want to add an image.
STEP 2: Click on the files and images icon in the controls panel at the top of the page, to add an image.
STEP 3: This will open a dialog box where you can browse to where your images are, and select one of it. This will place the image where your cursor was.
STEP 4: By default the image will be centre aligned. By clicking on the image, you will be able to perform the following functions:
Add a caption to the image where the placeholder 'Add a caption' text displays when clicked on the image. (Tip: When deleting or moving an image, the caption will move or delete along with the image.)
Align image to the left of the page.
Align image to the centre of the page.
Align image to the right of the page.
Wrap image to the left side around text.
Wrap image to the right side around text.
Link the image to an external link or to another article.
Add an alternative text that will popup when you hover your cursor over the image.
Delete the image.
5.2 Adding a file attachment
To place a file attachment into your article, follow the below steps:
STEP 1: Place your cursor at the point you want to add a file attachment.
STEP 2: Click on the files and images icon in the controls panel at the top of the page, to add a file attachment.
STEP 3: This will open a dialog box where you can browse to where your files are, and select one of it. This will place the file as an attachment where your cursor was.
6. Adding links |
External or internal links can be added to an article using the following steps:
STEP 1: Highlight the text that you want to add a link to.
STEP 2: Click on the link icon in the controls panel at the top of the page or press Ctrl+K on your keyboard, to add a link.
STEP 3: Once the link is clicked, a pulldown window will be displayed to add the link or to select an article to link to.
STEP 4: You can enter the URL link in the space given at the top of the pulldown window. Or you can type in the article name and select from the pages that will be filtered out.
STEP 5: Press the Enter key to add the link to the selected text.
To edit an added link, use the following steps:
STEP 1: Click on the text that the link is embedded to.
STEP 2: Click on the Edit link option and add the new link details and press the Enter key to update details.
STEP 3: Other functions available when editing a link, are listed below:
Display URL: This dropdown will display options where you can display the link as a URL or display the page name inline. By default, none of these options will be used.
Open link in new tab: Use this icon to open the link in a new tab.
Unlink: Unlink the link using this icon.
7. How do I add a table? |
7.1 Adding a table
There are several options how a table can be added.
STEP 1: Place your cursor at the point you want to add a table.
Option 1
STEP 2.1: Click on the table icon in the control panel.
Option 2
STEP 2.2: Click on the + icon in the controls panel at the top of the page. Select or type 'Table' and press Enter to add a table.
Option 3
STEP 2.3: Type in the key / followed by the word 'table' and select the table by clicking on it.
STEP 3: A three row and three column table will be added. If you want more or less rows or columns, follow these steps:
To add a row or column: Click on the cell you wish to add a row or column to, click on the down arrow icon, and select Insert row below to add a row below the selected cell, or select Insert column right to add a column to the right of the selected cell.
To delete a row or column: Click on the cell you wish to delete a row or column from, click on the down arrow icon, and select Delete row to delete the selected row, or select Delete column to delete the selected column.
To expand table: If the table has many columns, you can expand the width of the table by clicking on the double arrow icon. It can be expanded to two sizes to fit the width of page. When it is fully expanded, click on the double arrow icon again to adjust the table to it’s default size.
7.2 Table cell options
There are several options available to be performed on cells, once a table is added. To use these options, click on the cell or several cells and click the down arrow icon to list the options in a dropdown.
Cell background – Add a background colour to the selected cell or multiple cells.
Insert column right: Add a column to the right-hand side of the selected column. See section 7.1 Adding a table: STEP 3 for more details.
Insert row below – Add a row below the selected row. See section 7.1 Adding a table: STEP 3 for more details.
Delete column – Delete the selected column. See section 7.1 Adding a table: STEP 3 for more details.
Delete row – Delete the selected row. See section 7.1 Adding a table: STEP 3 for more details.
Merge cell – Merge multiple cells.
Split cell – Split cells that are merged.
Distribute columns – Adjust the selected columns to be the same distributed width.
Clear cells – Clear all details in the selected cells.
7.3 Table options
There are several options available to be performed on the table, once a table is added. To use these options, click on any cell and click the popup options that appear as in the below figure.
Table options
Header row – Add a header row to the selected table. (Tip: When the table grows in size, this option will help by freezing the header row when scrolling vertically.)
Header column – Add a header column to the selected table. (Tip: When the table grows in size, this option will help by freezing the header column when scrolling horizontally.)
Numbered column – Add a column at the start with auto-numbering. This will add a number starting from 1, to all columns in the table.
Chart icon – Insert a chart below, based on the selected table. See section 7.4 Charts for more details.
Remove table icon – Delete the complete table by clicking on this icon.
7.4 Charts
Once the chart icon is clicked as in the figure below, a default chart will be added based on the created table.
You can customise this chart based on how you wish to display the information in the table. The following options will be available when clicked on top of the chart.
Back to center – This is the default chart width. If you have changed the chart width, then click on this to reset it back to the normal size.
Go wide – If the chart has several values in the X-axis this option can be used for better viewing purposes.
Go full width – This option will increase the chart width to the maximum width of the page. This can used if the chart has many values in the X-axis.
Chart options – Click on this button to open a panel displaying several options to customise the chart.
Chart type – Select this dropdown to select between a Bar, Line, or Pie chart.
Data tab – Select which column to denote as the X-axis if the chart is a bar or line chart, and the Category if the chart is a pie chart. Below that, select the Data series to be represented as the value.
Customize tab – Customise the chart’s Style, Title, and Legend values.
Edit source – Click on this option to edit the values in the table that are displayed in the chart.
Remove chart – Click on this icon to remove the chart.
Risk Type | Total Number of Risks |
---|---|
Strategic | 100 |
Operational | 50 |
Figure 7.4.4
8. How can I setup a table of contents? |
8.1 Adding a table of contents
If a page is too lengthy, adding a table of contents will help you navigate easily within that page. There are two options to setup a page-level table of contents.
STEP 1: Place your cursor at the point you want to add a table of contents (ideally, this will be at the top of a page).
Option 1
STEP 2.1: Click the + icon in the controls panel at the top of the page. Select or type 'Table of Contents' and press Enter to add a table of contents.
Option 2
STEP 2.3: Type in the key / followed by the word 'table of contents' and select the table of contents control by clicking on it.
8.2 Table of contents options
There are several options available to customise the table of contents, once added.
Edit – See section Edit table of contents below, for more details.
Back to center – This is the default table of contents width. If you have changed the table of contents width, then click on this to reset it back to the normal size.
Go wide – If the table of contents have lengthy titles, this option can be used for better viewing purposes.
Go full width – This option will increase the table of contents width to the maximum width of the page.
Remove – Click on this icon to remove the table of contents.
8.2.1 Edit table of contents
Field | Default | Description |
---|---|---|
Output type | list | There are two options to list the titles:
|
Display section numbering | unticked | Display a section numbers to your titles by ticking this checkbox. |
List style | disc |
|
Heading indent | Enter the pixel value to indent the heading levels (e.g. 10px). | |
Separator | brackets |
|
Minimum heading level | 1 | The minimum heading level to list heading titles in the TOC (e.g. 2 will list heading titles from level 2 onwards). |
Maximum heading level | 7 | The maximum heading level to list heading titles in the TOC (e.g. 5 will list heading titles up to level 5). |
Include headings | */ | If set, any headings not matching the regular expression are ignored (e.g. .*\.[1//2]). |
Exclude headings | If set, any headings that match the regular expression are ignored (e.g. .*\.[1//2]). | |
Printable | ticked | If this checkbox is unticked, the TOC will not be visible in the printable output. |
CSS class name | If a CSS class is used to format the page, you can use the class name here to customise the look of the TOC. | |
Absolute URL | unticked | If checked, the links in the TOC will be full URLs. |
9. 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 page.
Tip: Keying in words within “”, will filter out pages having the exact phrase. To filter pages with multiple words which isn’t the exact phrase, enter the words without “”
Please refer the How to use this platform – for all users article for advance search features.
10. How do I delete a page? |
If you want to delete a page, follow the below steps:
STEP 1: Click the more actions (…) icon at the top-right corner of the page.
STEP 2: Select the Delete option.
STEP 3: Once the Delete option 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.
11. How do I copy a page? |
If you want to copy a page, follow the below steps:
STEP 1: Click the more actions (…) icon at the top-right corner of the page.
STEP 2: Select the Copy option.
STEP 3: A popup window will let you select from a dropdown, the 'Parent page' to where you want your new page displayed under.
Note: Clicking the Copy option will let you copy the whole article, including the article headers and all components at all levels.
12. How do I move a page? |
If you want to move a page,
Option 1:
Click the more actions (…) icon at the top-right corner of the page.
Select the Move option.
A popup will display with all articles; simply click on the place that the article needs to be moved.
Option 2:
Simply drag the page that need to be moved on your left-hand side bar under the space.
13. How do I view the page history? |
Select the More Actions (...) icon at the top-right corner of the page.
Click 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 – formatting changes.
14. Can I make a page as a favourite? |
If you want to make a article as your favourite, click on the Star icon.
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.
15. Can I add a label/tag to a page? |
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.