Documentation for QC Documents

Table of Contents

Documentation for QC Documents is a page dedicated to help you learn how to configure our app at different levels, how to use our macros and many more.

Documentation for QC Documents

Configuration

At site level

At site level, you are able to enable/disable the QC Revision dialog across all your Spaces.

To control the QC Revision dialog display in all spaces or in some, follow the steps:

As a site administrator, click on Confluence Application Settings
From the CONFIGURATION section, click on QC Documents Site Admin
Select from the list in which spaces you would like to enable the app.

configuration at site level/ site admin configuration

At space level

Click on Space Settings
Navigate to Add-ons > QC Documents

At page level

Choose to enable/disable QC Revision dialog on a specific Page, by following the steps:

Click on the Page menu > QC –Page Revision Overview
Navigate to the Settings tab

There are three options :

Default – Based on the Space Settings’ “QC – Revision” default value
Enabled
Disabled

configuration at page level/ page settings configuration

Macros

QC Page Property / QC Page Property (Dynamic)

The QC Page Property macro displays a page’s metadata properties like:

the page ID,
last assigned version,
last updated date
page URL,
created date, etc.

Available properties

ID – The ID of this piece of content
Title – The Title of this piece of content
URL – The URL of this piece of content
Version – The version number of this piece of content
Updated date – The latest updated date of this piece of content
Space title – The space title of this piece of content
Created date – The date this piece of content was created
Created by – Who has created this piece of content

Attributes

Parameters	Default	Description
qc-context	Autocomplete field
property	E.g ID, Title, URL, Version, Updated date, Last updated by, Space title	The metadata or value reference to display.
hyperlink	Display as hyperlink

Wiki markup examples

QC Page Property

1 {qc-property-macro}

QC Page Property Dynamic

1 {qc-property-macro-dynamic}

QC Page Property Custom Format

The QC Page Property Custom Format macro displays a page’s metadata (i.e. ID, title, version, updated date, last updated by, space key, space title, created by) in a custom format.

qc page property custom format macro displayed

Attributes

Parameters	Default	Description
qc-context	Autocomplete field
property	For example ‘[ID] – [Title], v.[Version]’. <br>Available parameters:<br>[ID] – page ID,<br>[Title] – page title,<br>[Version] – page version,<br> [Updated date] – Last updated date,<br>[Last updated by] – Last edited user,<br>[Space title] – Space title,<br>[Space Key] – Space key,<br>[Created by]-Created user	The metadata or value reference to display.
hyperlink	Display as hyperlink.

Wiki markup example

{qc-property-macro-custom}

QC Revision Value

The QC Revision Value macro displays the page revision number of the current version of the context.

Wiki markup example

{qc-revision-macro}

QC Revision Table

The QC Revision Table macro displays the revision table a user has set on the QC Page Revision Overview. The table contains the QC Revision Value, the Confluence page version number, and the datetime it was published.

Wiki markup example

{qc-docs-revision-table-macro}

QC Citation Table

The QC Citation Table macro displays a table of other pages that cite the current context. The page will need to be inserted as an internal link using the Confluence UI.

The table contains the Page ID and the Page title.

Wiki markup example

{qc-doc-citation-macro}

QC Internal Reference

The QC Internal Reference macro displays a table with all wiki page references (ie. hyperlinks) mentioned in the current context.

The macro will display only references (ie. hyperlinks) that were inserted as an internal link using the Confluence UI.

The table contains the Page ID and the Page title.

Wiki markup example

{qc-internal-reference-macro}

QC Viewers Table

The QC Viewers table macro displays a table with all the users that viewed the current page.

The macro is not available for older Confluence page versions. It only works at the current version.

The table contains the Viewer’s name and the latest version viewed.

Wiki markup example

{qc-viewers-table-macro}

QC Page Listing

The QC Page listing macro displays a list of all the pages, belonging to a specific space, thus enabling quick filtering.

Attributes

Parameters	Default	Description
qc-space	Autocomplete field	The space key
qc-no-labels	Exclude pages without a label.

Wiki markup example

{qc-doc-page-list-macro}

QC Expiration Date

The QC Expiration Date macro lets you set an expiration date for your documents. There are three different colors that represent the following expiration date statuses:

Red → The document has expired and needs to be reviewed again.
Orange → This is a warning letting you know that the document is about to get expired. By default, the style will change to a warning 7 days before the expiration date, but you can set it to as many days as you want.
Grey → There are still many days until the document expires. By default, this style will change to a warning 7 days before the expiration date, unless you’ve set it otherwise.