Guidance links

Note: Currently only available in CAWS worksections and CAWS prelims.

You can link one piece of guidance to another by using the guidance link menu. 

You can add a guidance link to any type of guidance: Scope, general guidance, clause guidance, and row guidance. 

Link to guidance in this section 

1. Select any editable guidance area, add a space, and type gl: 
2. The guidance link menu will open:
   
    
3. The menu shows the guidance from the current section in the following order: 
   1. General guidance, e.g. section F10 
   2. General guidance parts, e.g. general guidance 1.1 etc. 
   3. Clause guidance, e.g. clause F10/110 etc.
4. Select the guidance you want from the menu.
5. The menu will close and the link will be added with the appropriate default display text:
   
   
   

Note: Please add a space before you type gl: to open the guidance link menu. Chorus will not recognise the gl: command if it is directly before or after another word.

Link to guidance in another section 

1. Select any editable guidance area, add a space, and type gl:  
2. The guidance link menu will open. 
3. Type the code of the section you want to link to:
   
    
4. The menu will close for a moment and reopen to show that section’s guidance.  
   1. If the section is large, it may take a little time for the menu to open.
5. The menu shows the guidance from the selected section in this order:
   1. General guidance, e.g. section F10 
   2. General guidance parts, e.g. general guidance 1.1 
   3. Clause guidance, e.g. clause F10/110 
6. Select the guidance you want from the menu. 
7. The menu will close and the link will be added with the appropriate default display text:
   
    

Link to guidance not in this bundle 

You can link to any published content from the current content set using the methods described above. 

If you later add a linked section to the bundle, Chorus will know that the section is now part of this bundle and will manage the guidance links for you. 

Filter the menu 

As you type, the guidance link menu will filter by code. 

• gl: – shows all guidance in this section. 
• gl:/ – shows only clause guidance in this section. 
• gl:p – shows only amendment clauses in this prelims section. 
• gl:10 – shows any guidance in this section with 10 in the code, e.g. 10, 100, 110, F10. 
• gl:F10 – shows all guidance from that section. 
• gl:F10/ – shows all clause guidance from that section.
  
  

Display text 

When you add a guidance link, the display text is automatically formatted to follow current team guidelines.  

If the default display text format isn’t what you need, you can edit it directly, or by editing the link using the Add link dialog box.

 

‘Small works only’ sections 

If guidance is in a section that is only allocated to the Small works library, an SW suffix is shown after the code in the guidance link menu: 

This will help you link to the correct clause guidance when working on 2 similar sections within the same bundle. 

General guidance parts 

You can link to individual general guidance parts. 

The guidance link menu will show the current part codes and titles:

 

If these codes and titles are edited in this bundle, or new general guidance parts are added, the guidance link menu will update to match. 

If I update the part code or title, will it break all the links to it? 

No. Behind the scenes, each general guidance part has a unique ID. The links use the ID, not the text you type. 

Why does the guidance link menu show a code with question mark?  

If a general guidance part code is unclear, or missing, the guidance link menu will show a question mark after the section code:

 This won’t cause broken links, but it will give you unexpected display text: 

Prelims 

Contracts 

In Prelims, the guidance link menu will only show content from the same contract as the current section:

 

Alternative and amendment clauses 

The guidance link menu shows the suffixes we use in Prelims to identify and manage the alternative clauses and amendment clauses: 

In addition, the alternative clause have (x of y) notation after the clause title to show where each clause sits in the sequence:

 

Known limitations 

• Guidance links are not yet supported across all content sets. Currently only available for CAWS worksections and prelims. 
• There are no checks yet for broken links.  
  • We hope to extend the existing broken external link styles and reports to internal links. 
• You cannot navigate the links in preview mode. It will open a blank tab. 
  • We know this would save the team a lot of time, but we currently have a technical limitation. 
• If you open an existing guidance link for edit, it will open in the ‘Add link’ dialog box. 
  • There isn’t yet a dedicated tab for the guidance links.  
  • You can change the display text and the address.  
  • You cannot search for guidance parts from the Add link dialog box. 
• Guidance links show the external link icon, even though they are internal links.  
  • We’ll remove this in due course. 
• You can only filter by code. You cannot filter by title, library or contract. 
• You cannot link to content in someone else’s bundle. 
• You will not be stopped from linking to guidance in another library.  
  • For example, if you are in a section from the Building library, you can still link to guidance from the Small works library or the Early stage library.
  • Clauses in a ‘Small works only’ section will show as SW after the clause code in the guidance link menu. E.g. F10/10SW 
• When searching for links in a different section, the guidance link menu will close for a moment and then reopen.  
  • This can take a little time and it can look as though the action has failed. Please be patient. 
  • If the menu doesn’t reopen, please check that you typed the correct code. 
• Please add a space before you type gl: to open the guidance link menu.  
  • Chorus will not recognise the gl: command if it is directly before or after another word - it will think gl: text is part of the other word.