Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The pages collected here provide additional information about some of the document check messages which you may see when editing a document.

Warnings

...

Mandatory: A mod element has been nested within another mod element and should be removed

Mandatory: Modification tags (mod) are only required when the provision contains a quoted structure or quoted text. They should be removed if the provision no longer contains either.

Advisory: The unnumbered paragraph appears to start with a number. Insert a numbered paragraph instead if this is what is intended.

Mandatory: Content has been inserted within a text placeholder rather than replacing it. The placeholder should be removed.

Mandatory: Opening words should be followed by at least one paragraph or similar provision.

Advisory: The unnumbered paragraph starts with a quote mark. If this is meant to a definition, delete the unnumbered paragraph and insert a definition element instead. bIf this meant to be a textual amendment, delete the unnumbered paragraph and insert a quoted structure instead.

Mandatory: the section or schedule has an eId containing an occurrence counter. This should be removed before publishing or sharing the document. Renumbering the provision should remove it.

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 window. The two screenshots below show document structures which would trigger this warning. 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. In the first, Section 1 appears before the two Parts; in the second, Section 4 appears after Part 1 and before Part 2.

...

This type of document structure is sometimes intentional; where that is the case, the advisory warning can be ignored. If the intention is to include all sections under Part, Chapter, or cross-headings, and a section has simply become misplaced within the document structure, you can correct this by dragging and dropping individual provisions within the Structure View into position inside the relevant grouping headings.

There are two lists back-to-back when there should only be a single list containing multiple items. To fix, cut and paste all the items into one list and then delete the empty list.

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’ image-20240814-162322.pngImage Removed 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 Lawmaker’s underlying record of where that reference should point to; i.e. the location of the provision the cross-reference is referencing. As you add and delete provisions in a document and reorder and renumber existing provisions, the ‘Update x-refs’ action gives you a means of automatically updating the reference text of any internal cross-references which need to be changed as a result of any renumbering you have made to the provisions in the document. This action relies on the target information stored in each cross-reference.

For example, if you have created several cross-references to ‘section 4' throughout your document, 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-references so that they instead read 'section 8’.

However, this functionality won’t work correctly if the reference text and target information have become out-of-sync for any reason. This can happen if you manually edit the reference text or change the target information. Where this has happened, this document check reminds you to look at the target information (which appears in brackets 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:

  • assuming the text of the reference is correct, and refers to the intended provision, simply select the text and click the ‘Tag x-refs’ button in the toolbar image-20240814-125030.pngImage Removed This will re-create the cross-reference tag with the correct underlying information about its target.

  • if you prefer to manually create the reference, right-click on the relevant target provision in the Structure View, hover over ‘select reference to copy’ in the menu, click on the desired reference form, then highlight the old reference text in your document and press Ctrl+V to paste the newly created reference in its place.

The target of internal reference ____________ cannot be found in this document. It may be in another document or have been deleted. (Target ID: _________)

Reference ________ requires checking as it has been updated.

Multiple reference tags (mref) should surround two or more references. The tags should be removed if they contain only one or no references.

A range reference element (rref) should contain two references. The element can be removed if it contains only one or no references.

Unable to automatically update the cross-reference _________ because of a change in the target provision (Target ID: __________). To fix, remove the reference tag and then re-tag the provision or re-insert the reference.

...

about content

Warnings about document structure

Warnings about references