Versions Compared

Key

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

...

  • 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.

...

...

16. Standards to follow when creating articles

  • Table of Contents

  • Headings

  • Button/Icons – Buttons with text will be denoted in bold and with the first letter capitalised, followed by the word 'button'. Buttons without text displayed as icons will be denoted in bold and in all simple letters, followed by the word icon.

Panel
bgColor#F4F5F7

Examples:

  • Click the Login button.

  • Click the edit icon to modify a record.

  • Window/Page names – When listing out page/window names, it will be denoted within ‘single quotes'.

Panel
bgColor#F4F5F7

Example:

  • This will open the 'Risk Register' page.

  • Links – Any links or article paths listed will be underlined and italicised.

Panel
bgColor#F4F5F7

Example:

  • See article Administration – Users and Staff fore more details on permissions related to users and staff.

  • File paths – When adding the path of a window/page, it will be denoted in bold and underlined.

Panel
bgColor#F4F5F7

Example:

  • Go to Menu > Workspace > My Settings to configure which page to display as the product Home Page.

...

Images – Images are best represented when captured for the full width of the page. However, if the image size is smaller than the full page width, it is best displayed when center-aligned. Further, if the image is slim and tall, it is best displayed left-aligned.

...

Figure captions – Captions should be used wherever

...

Notes/Tips/Examples

...

Steps

3. Figure captions - centre aligned and italicised

4. 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 italicised and underlined. (www.google.com)

...

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

...