Editorial Update/Textual Amendments/Insertions/Provision Level Insertions

From Legislation Community Editorial Wiki
Revision as of 12:51, 9 May 2025 by Shayman (talk | contribs) (→‎OVERVIEW)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

OVERVIEW

Related reading: Approach to Update - Some Basic Rules and Exceptions, Specific Update Issues

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.

The Overview section gives examples of what these amendments look like on the website.

Insertion of words

Whole extent - wholly in force

Provision Level Insertions 1.png

Provision Level Insertions 2.png

https://www.legislation.gov.uk/uksi/2020/750/regulation/1/2021-01-06

How to carry out an insertion of words

Whole extent - partially in force

Provision Level Insertions 5.png

Provision Level Insertions 6.png

https://www.legislation.gov.uk/uksi/2018/1248/regulation/14/2019-03-21


How to carry out an insertion of words

Limited extent - wholly in force

Provision Level Insertions 10.png

https://www.legislation.gov.uk/ukpga/2018/12/schedule/2/paragraph/10/2019-07-23

How to carry out an insertion of words

Insertion of a sub-provision

Whole extent - wholly in force

Provision Level Insertions 3.png

Provision Level Insertions 4.png

https://www.legislation.gov.uk/uksi/2020/568/regulation/3/2021-04-23

How to carry out an insertion of a sub-provision

Whole extent - partially in force

Provision Level Insertions 7.png

This example also shows how s. 1 was renumbered as s. 1(1) (for specified purposes) by the previous amendment to allow for the insertion of s. 1(2) (for specified purposes).

How to carry out an insertion of a sub-provision

Limited extent - wholly in force

Provision Level Insertions 9.png
How to carry out an insertion of a sub-provision

Insertion of a sub-provision and word

Renumbering 16.png


Provision Level Insertions 11.png

How to carry out an insertion of a sub-provision and word

IN MORE DETAIL

Related reading: Approach to Update - Some Basic Rules and Exceptions, Specific Update Issues, Update Troubleshooting, Limited extent amendments, Applying partially in force amendments which are then brought further into force over time, Update Editor Checklist

Important considerations

Before you commit yourself to carrying out your amendment, make sure that you have considered all the factors that will influence how you carry it out.

The effects spreadsheet that you download at the start of the update task contains all the information that was recorded for the effect you are applying. You should check the TOES data for your amendment before you start. In particular, check the Comments for Editor to see if there is anything unusual about the effect that you need to be aware of, or if the amendment text contains power. Also look at the commencement details of the affecting document and look at the affecting provision itself.

Questions to consider:

Is the effect wholly in force or partially in force? Is it whole or limited extent? Has your affecting provision itself been amended by an amendment to earlier affecting provision effect? Is there an appended commentary for the effect? Is your effect a knock-on effect? Does your inserted text contain power? Are there any savings or transitional provisions?

The answers to these questions will inform how you carry out the amendment, whether you need to amend any of the attributes of the provision you are amending, also what the annotation that the Editorial System generates will look like and whether there are any amendments you might need to make to this annotation.

Use the Update Editor Checklist to make sure that you have researched everything you need to before you carry out your amendment and refer back to it throughout the task, particularly when you check the amendment in XMetaL and preview your amendment.

The following pages also give useful guidance that will help if you are not sure how carry out your amendment:

Limited extent amendments

The Editorial System flags possible limited extent amendments with the following message:

Limited extent warning message 2.png

The extent of the affected and affecting provision is highlighted in red. You can also view the extent/TA in the effects spreadsheet that can be downloaded from the Starting Update Page.

To decide whether or not you need to carry out your amendment using the limited extent amendment option in XMetaL, follow the decision-making process described in the Decision tree for deciding what is a limited extent amendment on the Limited Extent Amendments page, where you may also need to consider creating a concurrent version of the provision (and subsequently carrying out the amendment fully in the relevant version of the provision).

You may find that your amendment has already been carried out as a limited extent amendment for another jurisdiction, in which case you will need to follow the guidance on Updating an existing limited extent amendment when an identical amendment is applied for another jurisdiction.

If, after making all the considerations outlined above, you decide that the amendment is indeed a limited extent amendment, when you get to Step Two, follow the method outlined in Step Two – limited extent (the other steps remain the same).

Partially in force amendments

Amendments are not always brought wholly into force at once, frequently they are brought into force gradually over two or more points in time (PiTs). This is described in more detail in the section on Partially in force amendments on the Applying partially in force amendments which are then brought further into force over time page.

If an insertion has been brought into force for specified purposes only, the commencement detail “for specified purposes” will get added after the in force date when the annotation is generated. The insertion of a word(s) or a sub-provision(s) is carried out in the same way as a wholly in force insertion.

See the examples in the Overview: Insertion of words - whole extent - partially in force and Insertion of a sub-provision - whole extent - partially in force.

To read more about how partially in force amendments get brought further into force over time, see What happens when an amendment comes further, or fully into force?.

Update process

In these instructions, the update process has been broken down into four steps, Steps 1-3 are carried out in XMetaL and Step 4 on the Editorial site after check-in. Steps 1 and 2 are explained separately for insertions of words and sub-provisions (and Step 2 is further subdivided into whole extent (wholly in force or partially in force) and limited extent). The checks made in Steps 3 and 4 are the same, whichever route you take to get there.

Carrying out and checking the amendment in XMetaL: 

Step One - preparing to carry out the amendment in XMetaL

Step Two - selecting the correct XMetaL Legislation menu option to carry out the amendment

Step Three - checking the amendment in XMetaL

Checking the amendment in the Editorial System: 

Step Four - preview the amendment from the Update Details page

Things to remember

The Specific Update Issues guidance includes some general Editorial Update reminders to be aware of before you carry out your amendment. Also included is information on how amendments are presented. Note, in particular, there may be tagging that may need to be removed from amendment text, to prevent formatting errors.

See also the advice on how to approach more unusual types of amendment, and Approach to Update - Some Basic Rules and Exceptions.

Carrying out an insertion of words in XMetaL

The amendment of the data is carried out in XMetaL and the instructions that follow assume that 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.

Step One
  1. 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.

    Insertion of Words 1.png

  2. 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.


  3. In the Resource Manager window single click on the task to highlight it.


  4. Your next action will be determined by whether the amendment covers the whole extent and is either wholly or partially in force, or is for a limited extent, consequently Step Two is described separately for each scenario.
Whole extent
Step Two - whole extent (wholly or partially in force)


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

Insertion of Words 3.png

This will:

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



Insertion of Words 5.png

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



Insertion of Words 4.png

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


Once the amendment has been made, the cursor will be situated at the point the automatic annotation was inserted in the amended provision window.

Your next task will be to check the amendment in XMetaL (Step Three), followed by the final task of previewing the amendment from the Update Details page (Step Four).


Limited extent
Step Two - limited extent

Before continuing, make sure you have read the section on Limited Extent Amendments above.

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
  • Generate a green tick next to the task in the Resource Manager window to show that it has been completed.

Once the amendment has been made, the cursor will be situated at the point the automatic annotation was inserted in the amended provision window.

Your next task will be to check the amendment in XMetaL (Step Three), followed by the final task of previewing the amendment from the Update Details page (Step Four).

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.

The amendment of the data is carried out in XMetaL and the instructions that follow assume that 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.

Step One
  1. 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 <ukl:BlockAmendment> tag, if there is one (but remember, if you are inserting a sub-provision and word, you will need to insert the sub-provision and word separately so won't be able to do the amendment in one go (see below).

    You can right-click and copy or use the standard ‘edit’ and ‘copy’ menu options from the menu bar.

    Insertion of sub-provision 1.png


  2. 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.

  3. Single click on the task to highlight it in the Resource Manager window.

    4. Your next action will be determined by whether the amendment covers the whole extent and is either wholly in force or partially in force, or is for a limited extent, consequently Step Two is described separately for each scenario.
Whole extent
Step Two - whole extent (wholly or partially in force)

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

Insertion of sub-provision 2.png

This will:

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

Insertion of sub-provision 4.png

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

Insertion_of_sub-provision_3.png

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


Your next task will be to check the amendment in XMetaL (Step Three), followed by the final task of previewing the amendment from the Update Details page (Step Four).

Limited extent
Step Two - limited extent

Before continuing, make sure you have read the section on Limited Extent Amendments above.

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.

Once the amendment has been made, the cursor will be situated at the point the automatic annotation was inserted in the amended provision window.

Your next task will be to check the amendment in XMetaL (Step Three), followed by the final task of previewing the amendment from the Update Details page (Step Four).

Inserting a sub-provision and word

Amending provision:

Insertion of sub-provision and word 5.png

You will not be able to insert this in one go, you will need to insert the sub-provision and the word separately, because the word needs to be inserted into the tagging at the end of the previous sub-provision (without bringing in the surrounding tagging such as the ukl:P3para and ukl:Text tags in this example):

1. Carry out the insertion of the sub-provision, as described in Steps One and Two above (selecting the whole extent (wholly in force or in force for specified purposes only) or limited extent method as appropriate).

Insertion of sub-provision and word 1.png

2. Make sure that the annotation includes the words “and word” after the amended provision.

Insertion of sub-provision and word 4.png

3. Insert the word at the end of the preceding provision (you can just copy and paste it from the amending provision).

Insertion of sub-provision and word 2.png

4. Move the opening brackets for the insertion of the sub-provision to come just before the inserted word.

Insertion of sub-provision and word 3.png


See the completed amendment: https://www.legislation.gov.uk/anaw/2016/6/section/45

Your next task will be to check the amendment in XMetaL (Step Three), followed by the final task of previewing the amendment from the Update Details page (Step Four).

Check the amendment in XMetaL

Step Three


  1. Whilst still in XMetaL, you need to check that the amendment has been carried out correctly and that the annotation is accurate and complete by carrying out all the checks detailed in the Update Editor Checklist.


  2. Don’t forget to make sure that you remove any tagging that is not required in the amendment text (such as drafters footnotes, non breaking space characters, internal links and correction slip tagging), and that you have have set the ConfersPower attribute to “true” for any power-conferring provisions.


  3. Once you have carried out all the checks and you are satisfied that the amendment is correct and complete, select Legislation - Check In on the menu bar at the top of the page:

    Check in.png


  4. Click OK in the pop-up

    Document is checked in successfully.png


  5. Close the amending provision window and go back to the Editorial Site to preview your amendment (leaving XMetaL open if you have more update to do after this amendment).



Preview the amendment from the Update Details page

Step Four


Return to the Update Details page and refresh the page by pressing CTRL and F5. The Edit Status should change to Edit Complete.

  1. If there was anything unusual about the amendment that you need to draw to the attention of the review editor, you can add a note by clicking on the note icon to the right of the edit status.


  2. View your amendment by selecting the Newly Edited Version tab (to see the provision text and a summary of the provision attributes) or the Preview Legislation button (to see a website Preview of the provision).

    Tip: If you need to check any of the attributes of the provision you have amended, this can easily be done by selecting the Newly Edited Version tab where you will see the relevant attributes of your provision listed.

  3. Carry out all the checks detailed in the Update Editor Checklist, to make sure that the amendment is accurate and complete.


  4. If you need to make any corrections to the amendment, check the provision back out and make any changes as necessary in XMetaL before checking the provision back in and previewing the provision again. Note that if you only need to correct an annotation, you can click on the Edit button to the right of the annotation in Preview to edit it without having to check the provision out again in XMetaL, but beware of the bugs you may encounter when using the annotation Edit function in preview.


  5. Once you have finished checking the amendment on the Editorial Site, the update task will be complete and you can move on to your next update task.



See the Overview above, for some examples of what these amendments look like on the website.

Video Instructions: Insertion of words (wholly in force and whole extent)

Video Instructions: Insertion of a sub-provision (wholly in force and whole extent)

SCENARIOS

See Renumbering; in particular this example where a new sub-provision is inserted when a provision is renumbered as a sub-provision and an em dash also needs to be inserted at the start of the indent.

RELATED PAGES

Editorial Update approach, specific issues and troubleshooting:

Retrieved from ‘http://community.legislation.gov.uk/mediawiki/index.php?title=Editorial_Update/Textual_Amendments/Insertions/Provision_Level_Insertions&oldid=17108’