Versions Compared

Key

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

Version 17 includes several improvements to Lawmaker’s referencing tools which extend the x-ref functionality already present in the application. These enhancements should help to improve the quality of references created in Bills and SIs, while also making it easier for Lawmaker users to manage and update the references in their document.

...

The majority of these improvements consist of changes to the existing automated Tag references feature. In version 17, clicking the “tag references” button in the toolbar image-20240802-120805.png will add x-ref tags to both internal and external references in the selected text.

...

Appearance of the references in the Editor

Because we Lawmaker now support supports internal and external references in Lawmaker documentsdocuments (and to address some accessibility concerns), the visual representation of these references has changed. Previously, x-refs were shown in light orange text. From version 17, x-refs display differently:

  • External references now show in blue in the Editor.

  • Internal references now show in purple in the Editor.

There are some other smaller presentational changes to references in the Editor. If an x-ref tag already exists in a document and the target of this reference is changed as a result of the automatic “Tag x-refs” references” function, the changed reference will be shown in dark red. There will also be a corresponding document check warning reminding you to check this reference, because its target (i.e. the thing it links to, either within the current document or on legislation.gov.uk) has changed as a result of the automatic tagging operation.

This scenario won’t happen to many x-refs in practice and will only happen if a user chooses to re-tag provisions using the Tag references feature. The dark red highlighting and corresponding document check have been added to help primary drafters avoid creating inaccurate references when relying on the automatic tagging feature.

The other important visual change is to the appearance of x-refs which you have manually edited using the new ‘Edit ref’ modal (see https://lawmaker.atlassian.net/wiki/spaces/USERMANUAL/pages/500203522/References#How-to-edit-references ). Whenever you change the text or target of a reference using the new modal, it will appear with double-underlining in the Editor. This is a visual aid to help highlight those references which have been changed by the user.

Functionality which is not affected by these changes

Update x-refs

The ‘Update x-refs’ function image-20240802-155411.png has not been changed in version 17. It is still possible to update the text of internal cross-references using ‘update x-refs’ references’ - the presence of external references in a document should have no effect on this functionality.

...