Editorial Update/Textual Amendments/Insertions/Provision Level Insertions

At a glance

Insertions of words and insertions of sub-provisions are carried out at provision level. Insertions of whole provisions need to be done at the parent level and are described on the Higher Level Insertions page.

Insertion of Words

https://www.legislation.gov.uk/uksi/2020/750/regulation/1

Insertion of a Sub-provision

https://www.legislation.gov.uk/uksi/2020/568/regulation/3

Specific update issues to be aware of with insertions

See also: Approach to Update - Some Basic Rules and Exceptions

Insertions in more detail

Carrying out an insertion of words in XMetaL

These instructions assume you have checked out the relevant provision that is to be amended, that you have set up your XMetaL workspace, and that you are now ready to carry out the amendment. For guidance on the steps required to reach this point, see Starting Update Tasks.

In the amending provision window:
- Read what the amendment is and where in the amended provision it is to be made.
- Highlight and copy the word or words (including punctuation) to be inserted. You can right-click and copy or use the standard 'edit' and 'copy' menu options from the menu bar.
In the amended provision window, place the cursor in the appropriate position in the text (i.e. where the word or words are to be inserted).

WARNING: In secondary legislation, drafters footnotes need to be taken into account when deciding where to place the cursor for the insertion of words. Do not place the cursor between a word and a drafters footnote reference that relates to it. See Taking into account drafters' footnotes when inserting words into secondary legislation.
In the Resource Manager window single click on the task to highlight it.
Your next action will be determined by whether the amendment covers the whole extent or is for a limited extent.

Whole extent

On the menu bar at the top of the page select Legislation - Textual Amendments - Addition.

This will:

Automatically insert the new word or words, bracketed by opening <addition> and closing </addition> tags in the amended provision:

Automatically insert the annotation for this amendment at the end of the amended provision:

Generate a green tick next to the task in the Resource Manager window to show that it has been completed.

Limited extent

On the menu bar at the top of the page select Legislation - Textual Amendments - Limited Extent Addition. In the pop-up 'XMetaL Author Essential', check the Extent entered is correct and click OK. This will:

Automatically insert the new word or words, bracketed by opening <addition> and closing </addition> tags in the amended provision;
Automatically insert the annotation for this amendment at the end of the amended provision, including the limited extent in brackets after the effect e.g. 'Words in art. 7(2) inserted (E.W.S.) (6.4.2017) by The Social Security (Restrictions on Amounts for Children and Qualifying Young Persons) Amendment Regulations 2017 (S.I. 2017/376), regs. 1, 4'; and
Generate a green tick next to the task in the Resource Manager window to show that it has been completed.

See more on limited extent amendments.

Note:

Whether whole or limited extent, after the amendment has been made, the cursor will be situated at the point the automatic annotation was inserted in the amended provision window.

Carrying out an insertion of a sub-provision in XMetaL

If you need to insert a whole provision, follow the instructions for Higher Level Insertions

Note: These instructions assume you have checked out the relevant provision that is to be amended, that you have set up your XMetaL workspace, and that you are now ready to carry out the amendment. For guidance on the steps required to reach this point, see Starting Update Tasks.

In the amending provision window:
- Read what the amendment is and where in the amended provision it is to be made.
- Select the appropriate <ukl:P#> tag to highlight and copy the sub-provision to be inserted:
Sub-Provision: <ukl:P2>
Sub-sub-provision: <ukl:P3>

Note: you can also select the <BlockAmendment> tag, if there is one.

You can right-click and copy or use the standard ‘edit’ and ‘copy’ menu options from the menu bar.
In the amended provision, place the cursor after the closing ukl:P2 or ukl:P3 tag of the sub-provision that precedes the one you are inserting.
Single click on the task to highlight it in the Resource Manager window.
Your next action will be determined by whether the amendment covers the whole extent or is for a limited extent.

Whole extent

On the menu bar at the top of the page select Legislation - Textual Amendments - Addition:

This will:

Automatically insert the new sub-provision, bracketed by opening <addition> and closing </addition> tags in the amended provision:

Automatically insert the annotation for this amendment at the end of the amended provision:

Generate a green tick next to the task in the Resource Manager window to show that it has been completed.

Limited extent

On the menu bar at the top of the page select Legislation - Textual Amendments - Limited Extent Addition. In the pop-up 'XMetaL Author Essential', check the Extent entered is correct and click OK; this will:

Automatically insert the new sub-provision, bracketed by opening <addition> and closing </addition> tags in the amended provision;
Automatically insert the annotation for this amendment at the end of the amended provision, including the limited extent in brackets after the effect; and
Generate a green tick next to the task in the Resource Manager window to show that it has been completed.

Note:

Whether whole or limited extent, after the amendment has been made, the cursor will be situated at the point the automatic annotation was inserted in the amended provision window.

See more on limited extent amendments.

Checking the amendment in XMetaL

Once the insertion has been made and the annotation has been automatically generated, check that the annotation is accurate and complete. Carry out any edits if necessary (refer back to the effects spreadsheet if you need to):
- Type of Effect is correct;
- Punctuation is correct (e.g. no unnecessary spaces);
- Date cited is that of the Point of Time you are editing and where applicable the correct In Force Date Qualification has been added after the date (check effects spreadsheet for any qualifications). If your amendment is not ‘wholly in force’ and has a different type of In Force Date Qualification (for example ‘for specified purposes’), this will be noted in the annotation and you will need to check the annotation to make sure that this has been rendered correctly: for further details on what the annotation should look like see Annotations and In Force Date Qualifications;
- If a limited extent amendment, the extent is referenced;
- Affected provision is correct;
- Affecting provision is correct;
- Savings are referenced (where applicable); and
- Commencement order is referenced (where applicable).
See more detail on the structure of textual amendment annotations in Annotation Conventions.
Scroll back up to the where the amendment was made in the amended provision and check the inserted wording or sub-provision is positioned correctly. If inserting a word or words, delete any unnecessary spaces between the existing punctuation and the inserted tags and words, or insert a space if appropriate.

Where words are inserted and the inserted text starts with punctuation, leave a space between the existing text and the opening square bracket, and where there is punctuation in the existing text immediately after the closing square bracket, close up any space between the closing square bracket and the punctuation, i.e.:
```
Existing text [, inserted words], existing text.
```
For example:

In this example, the space has been closed up between the closing addition tag and the semi-colon (at the position of the cursor).

See also: Approach to Update - Some Basic Rules and Exceptions for further guidance on other edits you may need to make.

Once you are satisfied that the amendment is correct and complete, select Legislation - Check In on the menu bar at the top of the page:
Click OK in the pop-up
Close the amending provision window and if you have more update to do, leave XMetaL open and go back to the Editorial Site.

Checking the amendment on the Editorial Site

Go back to the Update Details page and refresh the page by pressing CTRL and F5 at the same time.
Select the Newly Edited Version to see a preview of the updated provision. Check that your amendment and annotation commentary are formatted as you would expect.
To check the timeline and see how the provision would look in the context of the whole item of legislation, select the Preview Legislation button and check that the amendment is formatted correctly

Insertion of Words
- The new words are inserted in the right place and have square brackets surrounding them, and annotation reference and the text of the annotation are correct:
See more detail on annotations in Annotation Conventions.

Insertion of Sub-provisions
- The new sub-provision is inserted in the right place and has square brackets surrounding it, and the annotation reference and the text of the annotation are correct:
See more detail on annotations in Annotation Conventions.
Also check the timeline to make sure that the right point in time has been created to accommodate this amendment and that you can move between the Points in Time on the timeline correctly.
Check that the amendment edit status is set to Edit Complete. You can also add any notes for the review editor by clicking on the note icon to the right of the edit status. You may need to add a note if there was anything unusual about the amendment that you need to draw to the attention of the review editor.
You can now navigate to the next part of your update task.