The Weagree Wizard supports dynamic cross-references. Any numbered clause, inside the template itself or any library component like a global building block or schedule, can be cross-referenced from any location in the document. Cross-references are presented in the Template Creation Tool as tags. They are ‘finalised’ upon document generation, so that they will always refer to the correct clause number in the generated document. They are fully functional Word fields as well: Ctrl-clicking on one will navigate directly to the referenced clause and can be updated if any manual changes are made to the Word document. Various options are available in the Weagree Wizard to customise the appearance of any cross-reference.
TABLE OF CONTENTS
A. Inserting an internal cross-reference
B. Inserting an external cross-reference
C. Customising a cross-reference
D. Troubleshooting
A. INSERTING AN INTERNAL CROSS-REFERENCE
Adding a cross-reference from one non-global building block or contract clause in the template outline to another (an ‘internal’ cross-reference) is simple.
1. Locate the building block or contract clause where the cross-reference must be inserted.
2. Select the text that must be replaced by the cross-reference (if any).
3. Click Create a cross-reference. A pop-up will appear.
4. Select the (global) building block or contract clause that must be referenced.
Note: always select a building block or contract clause that has a numbered style like Level 1 or Level 2.
5. Click Insert.
Note: you may want to customise the cross-reference before inserting it. It is also possible to make some manual adjustments afterwards. See section C below.
6. Click Save the changes made (or press Ctrl+S).
Note: the above method can also be used to make building blocks and contract clauses reference themselves (e.g. “In this Clause [cross-reference]…”). This is possible in global building blocks and global contract clauses as well.
B. INSERTING AN EXTERNAL CROSS-REFERENCE
Cross-references to and from library components like global contract clauses, definitions and schedules (‘external’ cross-references) are also possible. However, apart from referencing a global building block or a global contract clause (subclauses of either excepted) within the template outline, this cannot be done directly in the way described above. The reason is that the Create a cross-reference pop-up only shows the immediate contents of the opened template or component.
Creating such a cross-reference therefore requires a slightly different approach. It also demands changing one customisation option:
1. Open the template or library component (containing the subcomponent) to which the cross-reference must point.
2. Click Create a cross-reference.
3. Select the component that must be referenced.
4. Click Options.
5. Select the first Type of cross-reference option (Inserts the paragraph number from the cross-referred paragraph as that number appears in the document).
6. Click Insert.
7. Select and cut (Ctrl+X) the inserted cross-reference tag.
8. Locate the building block or contract clause, or open the library component (and locate the contract clause inside it) which must contain the cross-reference.
9. Paste the cross-reference where it must appear.
10. Click Save the changes made (or press Ctrl+S).
C. CUSTOMISING A CROSS-REFERENCE
The appearance (and underlying operation) of a cross-reference can be customised in a few different ways. Once you have selected the component you need to cross-refer to (step 4 of section A or step 3 of section B above), you may click Options to change its configuration.
Each setting changes a modifier in the reference tag and can therefore also be manually applied after creation of the tag. Its basic format is [reference.Component name.modifier.component number]. For example, the default tag for a contract clause named Term and termination with the database number 427 would be [reference.Term and termination.RH.427]. The component name is only there to help the user; it does not affect the operation of the cross-reference.
1. Type of cross-reference
These settings are mutually exclusive and determine the basic composition of the cross-reference.
a. The first option (modifier: NH) replicates the exact numbering of the cross-referenced component. For example, when a Level 3 subclause is referenced, it will simply result in “(a)” instead of “1.1(a)”. You should always use this option in two cases:
i. when creating a cross-reference in a building block or contract clause above the first component in the template outline with Level 1 styling; or
ii. when cross-referencing from inside a schedule or annex.
b. The second option (modifier: RH) shows a contextual number. For example, when a Level 3 subclause of the same clause is referenced, it will also result in “(a)” instead of “1.1(a)” like the NH modifier. However, when the subclause belongs to a different clause, the complete “1.1(a)” number will be shown instead.
c. The third option (modifier: WH) includes the full hierarchical context. When cross-referencing a provision in an annex, this essentially has the same effect as the RH modifier. When referring to a template outline component, however, this will result in odd cross-references like [Schedule 0.Annex 0.Part I1.1(a)].
2. Options / Switches
These settings may be combined, although not all options are available for each type of cross-reference.
a. The first option may be enabled to correct any text formatting mismatch. Ordinarily, this can be left disabled.
b. The second option produces a hyperlinked cross-reference in the generated document: if the user Ctrl-clicks it, the page will jump to the cross-referenced component. It is enabled by default.
c. The third option may be enabled to automatically append above or below to the cross reference (e.g. “1.3 below” or “(a) above”).
d. The fourth option may be enabled to only include the actual component number in the cross-reference. For example, if Level 1 numbering is configured to preface the number with, then by default a cross-reference to the first Level 1 component would read “Article 1”. When enabled, this would be changed to just “1”.
3. Formatting
These settings only affect text included as part of the cross-reference and are self-explanatory.
4. To save the current settings as the defaults for next time, click Default.
5. To reset the original settings, click Reset.
D. TROUBLESHOOTING
For additional instructions on fixing any broken or otherwise incorrect cross-references, click here.
