What are references in Lawmaker?
...
Valid internal references will show as purple , e.g. “section 3(2)(a)”
External references will show as blue, e.g. “section 7 of the Housing (Scotland) Act 2000”
References that are invalid or have been manually altered are shown with different formatting which is described below in relation to specific features (the formatting is also summarised in the table here: Formatting of below: under Table describing formatting of different references). The formatting in the editor is not replicated in the PDF version of the document but references will become hyperlinks in the PDF that can be used to jump to the target of the reference.
Creating references
References can be created in two ways, using the Tag references feature (which tags both internal and external references) or by copying a reference to a provision via the structure view or the right-click context menu and pasting it into your document (for internal references only).
...
Once created, references can be manipulated and modified using the right-click context menu, the toolbar menus or by the floating toolbar, but .
Note that the text within them can not reference tags cannot be directly edited in the Editor (to prevent . This is to reduce the risk of the metadata associated with the reference going out-of-sync with the text displayed).
For internal references, you can:
Update them, so that the text of the reference contains the up-to-date number of the provision which it refers
Remove the reference mark-up (but leave the text behind),
Mark a reference to be ignored which has previously incorrectly been marked up as a reference.
Make the Editor jump to the location of the target provision.
Show or hide j-refs within references.
Modify the underlying metadata and text displayed text and the underlying metadata via the Edit Reference dialog box.
...
Remove the reference mark-up or mark it to be ignored (as you can with internal references)
Open a new tab in the browser containing the provision referred to as it appears on www.legislation.gov.uk.
For SI/SSIs only, add an automatically-generated legislative history footnote, derived from data on www.legislation.gov.uk.
Modify the displayed text and the underlying metadata and text via the Edit Reference dialog box.
...
When the tag operation finishes, you will see all the references Lawmaker has identified highlighted in the Editor according to the table here: https://lawmaker.atlassian.net/wiki/spaces/USERMANUAL/pages/edit-v2/500203522#Formatting-of-reference-below: Formatting of reference types. Internal and external references are, in particular, distinguishable from one another by their colour.
...
To identify external references, Lawmaker relies on data about enacted legislation from www.legislation.gov.uk. Lawmaker can’t therefore identify references to legislation that has not yet been enacted or made. This also means that, if for some reason www.legislation.gov.uk is not available for a period of time, then Lawmaker will not be able to properly identify external references during that time but the Tag reference function will otherwise work as expected for internal references.
Lawmaker identifies and marks up both references to external provisions and to the documents containing those provisions. While sometimes references consist of both together, e.g. “section 12 of the Scotland Act 1998”, Lawmaker is also able to identify references to external provisions where the context determines that they relate to an enacted document rather than the document containing them. In particular, it will do this:
...
Lawmaker will also identify external references that use an alias instead of the full title of the legislative document, e.g. references to “the 2007 Act” or “the 1998 Regulations”. It does this by searching for definitions of the alias elsewhere within the document, either of the form of a full definition like ““the “the 2007 Act” means the Criminal Justice Act 2007” or a parenthetical definition like “…the Criminal Justice Act 2007(“the 2007 Act”)”.
...
Where however Lawmaker detects that the target of an existing reference has changed (e.g. because the context in which that reference sits has changed), the reference will be changed accordingly but it will be marked as requiring checking. Such references will appear dark red brown in the Editor (e.g. “regulation 52”) and each one will also be highlighted with a document check error. From the document check panel, you can confirm that the reference remains valid or you can remove the reference mark-up if you think it is no longer appropriate.
...
| Note |
|---|
You can’t currently create references to EU provisions using this method. |
...
| Info |
|---|
Turning on the full-depth mode to see all provisions in the Structure View - especially in big documents - might have an impact on the Editor performance, slowing it down. Using the right-click context menu in the Editor will be faster and perform better. |
Floating toolbar for references
...
To stop the accidental modification of the text of references (without the underlying metadata being updated if necessary), references are not directly editable in the editor (although you can delete a whole reference).
...
For external references, clicking on Goto Ref will open a new tab in the browser and will navigate to the target provision or document in www.legislation.gov.uk.
How to update internal references to reflect
...
renumbering of provisions
The Update references feature enables you to update the number component within internal references to match the current number of the target provision. For example, if there is a reference to “section 5” but what was section 5 has been renumbered to section 7 then updating the reference will result in the reference changing to “section 7”.
...
Lawmaker will try and update both valid and invalid internal references . If but not references that have been marked as “manual” due to the metadata being edited. If Lawmaker can no longer find the target of a valid reference in the current document then it will change the reference’s status to invalid. Equally, if Lawmaker finds the target of an invalid reference then it will change the reference’s status to valid.
...
This can be useful if you need to make a minor change the reference text, e.g. to adjust the capitalisation of the word “section”. However, any more significant changes to the text or other metadata fields should be done with care by expert users or in consultation with the Lawmaker support teamwith care by expert users or in consultation with the Lawmaker support team.
| Info |
|---|
If you change any text field other than Reference text then the Status will automatically change to “Manual”. This means your changes will be preserved during any re-tagging operation but will also stop the Update references feature from operating on the reference. Changes to the the Reference text field will not impact on the Status and so will not stop Update references from working. |
...
How to ‘ignore’ references that have been tagged
...
If you choose to remove the reference tags from one part of a complex referencecompound reference (e.g. “sections 5 to 7 of the Police Act 2007”), Lawmaker will automatically remove the mark-up from all other parts at the same time.
...
The reference will show up as valid when you first paste it in. However, when you update the cross-references in text, any reference to another document will show up as Invalid (grey highlighted text) and the reference won’t be updated. If at a future point the target provision is copied into the same document (or, in the case of an amendment, it is applied to the Bill), then the reference should return to being valid when you update the cross-references again.
Table describing formatting of different references
| Anchor | ||||
|---|---|---|---|---|
|
This table lists the different formatting possibilities of references and what that means. Invalid references and references that require checking are also highlighted in the Document Checks panel.
Format of reference | Description | Notes |
|---|---|---|
Purple text | Valid internal reference | The target provision has been identified and the citation should update correctly when you update x-refs. |
Blue text | Valid external reference | |
Grey text with a light grey highlight | Invalid reference | An internal reference, the target of which cannot be found in the document (it may, however, exist in another document) or an external reference, the target document of which couldn’t be located on www.legislation.gov.uk. |
Dark red Brown text | Reference requiring checking | A reference that has been modified as part of the Tag references operation that needs to be checked by the user to ensure it remains correct. |
Double underlining | Manually edited reference | A reference the properties of which have been manually edited by the user and which will not be modified by any subsequent Tag references operation. |
Black text with orange highlight | Internal reference which can’t be resolved | Lawmaker can find the target provision but is unable to update the reference text automatically. This is usually because the target provision has changed in some way, e.g. it has be promoted or demoted. To fix this, it is generally best to remove the existing reference and either re-tag the reference if it remains correct or insert a new reference. |
Grey text with dotted grey underline | Ignored reference | The reference text of this cross-reference will not be updated as part of an Update references operation. |
...