Difference between revisions of "Editorial Update/Textual Amendments/Insertions/Provision Level Insertions"

From Legislation Community Editorial Wiki
Jump to navigation Jump to search
Line 123: Line 123:
  
 
If, after making all the considerations outlined above, you decide that the amendment is indeed meant to be made for a limited extent, when you get to Step Two, follow the method outlined in Step Two – limited extent (the other steps remain the same).
 
If, after making all the considerations outlined above, you decide that the amendment is indeed meant to be made for a limited extent, 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====
  
 
===Update process===
 
===Update process===

Revision as of 09:43, 28 February 2024

OVERVIEW

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 - wholly in force

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, Applying partially in force amendments which are then brought further into force over time

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 is downloaded from the Starting Update Page contains all the information that was recorded for the effect you are applying. It should tell you if there is anything unusual about the effect that you need to be aware of in the Comments for Editor. It is also a good idea to double check 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.

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 make your amendment as a limited extent amendment, 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.

If, after making all the considerations outlined above, you decide that the amendment is indeed meant to be made for a limited extent, 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

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 in force for specified purposes) 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 - checking the amendment on the Editorial Site    

Things to remember

Make sure you remove any drafters’ footnotes in the amending text, otherwise these references will appear in the preview as ‘No commentary item can be found for this reference’ because there is no corresponding commentary in the amended legislation.


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 drafter's 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 in force or in force for specified purposes, or is for a limited extent, consequently Step Two is described separately for each scenario.
Whole extent
Step Two - whole extent (wholly in force or in force for specified purposes only)


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 checking the amendment on the Editorial Site (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 checking the amendment on the Editorial Site (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).

    Note: make sure you remove any drafters’ footnotes in the amending text, otherwise these references will appear in the preview as ‘No commentary item can be found for this reference’ because there is no corresponding commentary in the amended legislation.

    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 in force for specified purposes, or is for a limited extent, consequently Step Two is described separately for each scenario.
Whole extent
Step Two - whole extent (wholly in force or in force for specified purposes only)

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, followed by the final task of checking the amendment on the Editorial Site.

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, followed by the final task of checking the amendment on the Editorial Site.

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


Your next task will be to check the amendment in XMetaL, followed by the final task of checking the amendment on the Editorial Site.


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

Checking the amendment in XMetaL

Related reading: Approach to Update - Some Basic Rules and Exceptions, Specific Update Issues
Step Three
  1. 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.


  2. 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:
    Insert Words Whole After.jpg

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



    • If you inserted a sub-provision at the end of a previously inserted provision, make sure you move the closing bracket for the insertion of the provision to the end of the new sub-provision. See an example here: Approach to Update - Some Basic Rules and Exceptions.



    • Remove any Non Breaking Space Characters that may have been added to the amended provision by your insertion. See more on Non Breaking Space Characters.


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

  3. 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:


    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 check the amendment in Step Four (leaving XMetaL open if you have more update to do after this amendment).

Checking the amendment on the Editorial Site

Related reading: Approach to Update - Some Basic Rules and Exceptions, Specific Update Issues
Step Four
  1. Return to the Update Details page and refresh the page by pressing CTRL and F5. The Edit Status should change to Edit Complete.

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

  3. 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). Check that:

    Insertion of words



    Insertion of Words 6.png

    Insertion of Words 7.png

    Insertion of a sub-provision

    Insertion of sub-provision 6.png

    You can also see the examples in the Overview, which show what these amendments look like on the website.

    • the annotation reference and the text of the annotation are correct. The annotation reference will be located just inside the opening square bracket of the inserted text. See more detail on annotations in Annotation Conventions.


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

  5. In the Preview check the timeline and see how the provision would look in the context of the whole item of legislation. Make sure that the correct Point in Time has been created on the timeline to accommodate your amendment and that you can move between the Points in Time on the timeline correctly. If there are any errors in the timeline, correct them using the Timeline Resolver.


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


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


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 Specific Update Issues.

See also 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: