Reusable text (also known as Global text) is managed in Chorus using the 'Variables' feature. 'Variables' are also a customer-facing feature. 


The Reusable text (RT) variables are stored in 'NBS Technical' on Chorus 'Sandbox' and are not accessible to customers, only authors.


The 'Organization variables' are the source of truth and are only accessible to Production (Martin) and the Dev Team.

The technical team will edit and maintain the RT in 'Content set variables'.


Chorus can support a given RT variable in multiple content sets, e.g. Aus & UK Uniclass and UK CAWS. All content sets maintained in the Chorus Content Authoring Platform support RT variables.


TOPICS COVERED


Reusable text workflow

Reusable text variables (RT variables) are stored as 'Organization variables' in 'NBS Technical' on Chorus 'Sandbox'. This is the single point of truth.


A dedicated content set is used to edit and maintain RT variables. This is called 'Reusable text'.

The workflow for authoring and deploying Reusable text variables in the Chorus Content Authoring Platform.

The workflow for authoring and deploying Reusable text variables in the Chorus Content Authoring Platform.


The process for editing and deploying RT variables is:

  1. Technical authors will edit the reusable text as 'Content set variables'. 
    1. On Chorus Sandbox > NBS Technical > Content sets > Open the 'Reusable text' content set.
    2. Click on 'Edit variables'.
      A screenshot of 'Edit variables' in the 'Reusable text' content set.A screenshot of 'Edit variables' in the 'Reusable text' content set.

    3. Very important! 
      1. Please do not delete any variables that are in use.
      2. Please do not change the name of any existing variables.
        Both actions will result in the reusable text becoming a 'Missing variable'. See Missing variables for more information about this.
      3. Please be considerate when changing an existing variable. If the variable is used in the clause guidance, the change will trigger a content set 'Update' notification for specifiers in Chorus Production (live). So, it is important to avoid triggering 'Update' notifications to specifiers for minor editorial changes.

  2. Copy-editors will review the variables that have changed in the 'Reusable text' content set.
    1. On Chorus Sandbox > NBS Technical > Content sets > Open the 'Reusable text' content set.
    2. Click on 'Edit variables'.
    3. Order the variable list by 'Last edited'.
    4. Very important! (repeated from step 1.3 above)
      1. Please do not delete any variables that are in use.
      2. Please do not change the name of any existing variables.
        Both actions will result in the reusable text becoming a 'Missing variable'. See Missing variables for more information about this.
      3. Please be considerate when changing an existing variable. If the variable is used in the clause guidance, the change will trigger a content set 'Update' notification for specifiers in Chorus Production (live). So, it is important to avoid triggering 'Update' notifications to specifiers for minor editorial changes.

  3. Production (Martin Day) will deploy the updated variables to bundles.
    Please see Reusable text (2/2): How to deploy changes.


Reporting where a reusable text variable is used

Production (Martin Day) can report where an RT variable is used.

  1. In 'Organization settings' > 'Variables'.
  2. Select the variables you want to report on.
    Important! Please avoid selecting many variables; the report will not run with too many selected.

  3. Click the 'Actions' button >'Create variable report from selection'.


A screenshot of the 'Variables report'.

A screenshot of the 'Variables report'.

Edit reusable text variables

The 'Edit variables' interface includes adding and changing refDocs. 

It also shows the refDoc currency.


Creating new global text variables

Production (Martin Day) will create new variables in the 'Organization variables'. This can be done with the variable name and an empty variable value.


As soon as the 'Organization variable' is created, it will appear in the 'Content set variable' in the 'Reusable text' content set'. You will need to refresh the 'Content set variable' if you have it open when the new variable is created. 


Reusable text variable naming convention

The naming convention was migrated from the legacy RT system into Chorus. For example, '01.01.01 Work to existing § Work to Existing'.


The silcrow ('§') is the divider between the legacy document group and the individual RT.


The 'Content set' variables include both Australia and UK RT variables. Australian RT variables have 'Aus' at the start of their variable name.


Important! Please continue to follow this convention for new RT variables.


Adding reusable text variables to guidance

RT variables are intended for guidance only. They are not intended to be added to clause titles, row titles or suggestion menus.


To add an RT variable:

  • Select the section or clause to check it out.
  • In the Guidance editor, click where you want to add the RT.
  • Use the tilde shortcut (Shift + ~). 
  • Either browse the 'Variables' list or continue to type to filter the menu for the RT variable you are our adding.


Additional software development in the 2025 roadmap

In 2025, we plan to make several improvements to the Chorus Content Authoring platform.


These are:

  • Currency reporting on RT variables.
  • Technical vs Editorial vs Silent content set 'Update' notifications.


About reusable text in Chorus compared to NBS Create

RT deployment in Chorus works differently from NBS Create.


With NBS Create, when an RT was deployed everywhere that used that RT text would be updated, regardless of whether the wider guidance around that RT had been updated.


In Chorus, RT is updated, but the change to the RT is deployed within bundles. This means RT can be screen-checking in

  1. The 'Content set variables'.
  2. The context of the surrounding guidance in the bundle.


Finally, the same RT can be added to multiple content sets. Deploying Rt un bundles allows us to control when to deploy on a per-content set basis.


What RT text was migrated from legacy systems to Chorus in 2024

In 2024, the RT text was brought into Chorus from the legacy systems.


What RT was migrated

  • Specifically, we migrated all RT published in active content in either UK Uniclass or Australia Uniclass.
  • The naming convention from the legacy system.


What RT was not migrated

RT text that was never deployed to active content in the legacy systems. This was not migrated.


A screenshot of the 'Content set variables' in 'NBS Technical' on Chorus 'Sandbox'.

A screenshot of the 'Content set variables' in 'NBS Technical' on Chorus 'Sandbox'.