Choosing your Version Strategy

qc r&u byline current version

By using the QC Read & Understood for Confluence Cloud app, the user gets to choose the page version control strategy.


There are two strategies to choose:

  1. based on the built-in Confluence page version control
  2. based on the page property macro.

Be aware that the chosen strategy will apply in all of your pages within the Space.


Based on Confluence page version control

This option does not require any more configuration. Users can just start to review pages and R&U their content.

The native Confluence page version number will be tracked by the app.


Based on Page Property macro

The Page Property macro can be used so you can keep track of your page version.


Adding the Page Property to your page


The Page Properties macro uses key/value pairs.


To add the Page Properties macro to a page:

  1. In the editor, choose Insert > Other Macros > Page Properties
  2. In the macro body create a two column table
  3. In the left column list your keys – these will be the column headings in your report table
  4. In the right column list the value for each key – these will populate the rows in your report table
  5. Save your page

Note:

Please note to use the Page Properties Macro horizontally.


Here’s how the macro looks on your page:

page properties macro diplayed

Setting up the parameters


Back to the Space Settings page:

space settings

In this page, we choose the key Version to define the page version 2.5.0 . This key should be typed in the Page Property Header field at the Page Properties Settings section.


The Version format field , will allow you to define two things:

  1. how many numbers your version would have [3 (Major.Minor.Revision), 2 (Major.Minor), 1 (Major)]. This could be useful, if you decide that the page version will have, in our case, 3 version numbers i.e. Major.Minor.Revision (such as 3.5.4) where:
    • Major number, to be increased when there are changes to a document that require the document to be re-approved(either by an individual or a group)
    • Minor number, to be increased whenever there are minor document amendments, and
    • Revision number, to be increased whenever there are spelling or grammar corrections,
  2. for which numbers the users would require to re-confirm that they have read and understood the page.

The field gives the user the following options:

  • Major.Minor.Revision
    • The user will require to re-confirm changes in all numbers
  • Major.Minor.*
    • The user will require to re-confirm changes only when Major and Minor changes occur. Revision changes will not affect the user’s page R&U approval status.
  • Major.Minor
    • The user will require to re-confirm changes when Major or Minor changes occur.
  • Major.*
    • The user will require to re-confirm changes only when Major changes occur. Minor changes will not affect the user’s page R&U approval status.
  • Major.*.*
    • The user will require to re-confirm changes only when Major changes occur. Minor and Revision changes will not affect the user’s page R&U approval status.
  • Major
    • The user will require to re-confirm changes when Major changes occur.
Updated on October 22, 2020

Was this article helpful?

Related Articles