Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

This page provides additional information about some of the document check messages which you may see when editing a document.

Warnings relating to content

Warnings relating to structure

The body of the document is not divided into an even hierarchical structure. This is because not all provisions in the body are wrapped in the same kind of grouping provision (e.g. a Part).

This is an advisory warning which appears when a document contains Parts, Chapters, cross-headings or other grouping headings, and not all of the clauses, sections or paragraphs in the document are included within those groupings.

To investigate the cause of this message, look at the Structure View on the left-hand side of the Editor screen. The two examples below show document structures which would trigger this warning. In the first, Section 1 appears before the two Parts; in the second, Section 4 appears after Part 1 and before Part 2. (Note that the relative indentation of the section numbers and titles in the Structure View indicates whether the section is within or without the preceding Part.)

image-20240814-121243.png

This type of document structure is sometimes intentional; in those cases the advisory warning can be ignored. If however the intention is to include all sections under Part, Chapter, or cross-headings, you can drag and drop individual provisions within the Structure View into position below the relevant grouping heading.

Warnings relating to IDs

Warnings relating to references

The internal reference citation ______ doesn't match the ID of the target provision (______, stored in the href attribute of the reference element). This may mean the citation has not updated correctly or that it has been manually changed. Recreate the reference unless you are sure the current text and attributes are correct.

This advisory warning alerts you to any internal cross-references which may have been changed in a way that will create unexpected results when using the ‘Update x-refs’ function.

Every cross-reference in a document consists of two essential elements: the reference text and the target information. The reference text is the visible text of the reference which appears in the document. The target information is the system’s record of the provision the cross-reference is referencing. As you draft a document and periodically renumber its provisions, the ‘Update x-refs’ action allows you to update the reference text of any internal cross-references automatically, based on the target information. For example, if you’ve created a cross-reference to ‘section 4' and section 4 is subsequently moved elsewhere in the document and renumbered as section 8, the ‘Update x-refs’ action will automatically correct the reference text of your cross-reference so that it instead reads 'section 8’.

However, this functionality won’t work correctly if the reference text and target information go out-of-sync for any reason. This can happen if you manually change the text of a reference or deliberately alter the target information. Where this has happened, this document check reminds you to check the target information (which appears in the document check message) and compare it with the text of the reference. If they don’t appear to match and you intend to use the ‘Update x-refs’ action, you should remove the reference tags from the cross-reference (by right-clicking on it and selecting ‘remove reference tag’) and then re-create it using either of the following methods:

  • select the text and click the ‘Tag x-refs’ button in the toolbar image-20240814-125030.png

  • right-click on the relevant provision in the Structure View and hover over ‘select reference to copy’, click on the correct reference form to copy it to your clipboard, then highlight the reference text in your document and press Ctrl+V to paste the newly created reference in its place.

Warnings relating to amendments

  • No labels