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

Revision as of 08:42, 10 November 2021

Before you Start

Follow these instructions to carry out the insertion of a whole provision, Chapter, Part or Schedule from the High Level Update Details page, where you will need to have checked out the Parent Level of the provision you are inserting.

If you are inserting a new Schedule, and there are no existing Schedules in the document, you need to insert a ukl:Schedules element after the ukl:Body element of the Main Body before you can insert the new Schedule. For an example of this, see https://www.legislation.gov.uk/uksi/2020/828/schedule/2020-08-15.

Carrying out the amendment in XMetaL

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

Note: These instructions assume you have checked out the relevant parent level or framework, 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.
- In the amending provision highlight and copy the provision that you need to insert by selecting the appropriate opening tag. For example:
  - ukl:P1 (select from ukl:P1group if the provision has a title) for a provision
  - ukl:Part for a Part
  - ukl:Chapter for a Chapter
  - ukl:Schedule for a Schedule
You can also select the BlockAmendment tag to select the whole block of data to be inserted. You can right-click and copy or use the standard 'edit' and 'copy' menu options from the menu bar, e.g.
In the amended provision, scroll to find the provision that the new provision will follow and place the cursor at the end of that provision (i.e. after the closing /ukl:P1group, /ukl:Part, /ukl:Chapter, or /ukl:Schedule tag) and before the opening tags of the next provision. If in doubt you can use the Element list to check which tags are valid where your cursor is currently positioned. For example, the cursor is positioned between the closing /ukl:Part tag of Part 8 and the opening ukl:Part tag of Part 9 when Part 8A is to be inserted:

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.

Insertion of Part menu whole extent.png

This will:

Automatically insert the new provision/Part/Chapter/Schedule, etc. 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; and
Generate a green tick next to the task in the Resource Manager window to show that it has been completed.

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

Insertion of Part XMetaL view after amendment.png

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 provision/Part/Chapter/Schedule, etc. 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.

See more on limited extent amendments.

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

Checking the amendment in XMetaL

Once the provision has been inserted 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);
- 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 provision is positioned correctly and that the tagging is correct, e.g. sometimes the title or number may be incorrectly tagged - if you think this may be the case, check how it has been tagged throughout the rest of the amended document and if necessary correct it. Also:
- If your high-level insertion contains any power-conferring provisions (marked in TOEs Comments for Editor as "Contains power"), you will need to set the ConfersPower attribute to "true" for those provisions. See more on the ConfersPowerAttribute.
- Remember to 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.
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.
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 provision/Part/Chapter/Schedule, etc. appears in the correct place in the Table of Contents;
- Open the new provision/Part/Chapter/Schedule, etc. on its own and check that there are opening and closing brackets around the text with an accompanying F-note reference appearing immediately after the opening amendment bracket. The version history should show one Point in Time as at the date of the insertion;
- Open the parent level and view your amendment to check you’re satisfied that the amendment has formatted correctly, that it is in the right place and that it has square brackets around it and the annotation reference and annotation text are correct. See more detail on annotations in Annotation Conventions; and
- The version history should include a new Point in Time for the newly inserted provision and you should check that you can move between the Points in Time on the timeline correctly;
- You should check the timeline of adopted child provisions if you have inserted a high level provision (e.g. a cross-heading) that adopts existing children and use the timeline resolver if necessary. Often, the latest version of the children lose their altdates and so their previous versions do not display in the timeline, only the date they were adopted by the new parent. Clicking the timeline resolver should fix this.
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.

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

Specific Update Issues

Insertion of a provision that was previously repealed

If a provision is repealed or revoked and then a new provision with the same number is inserted, this should be carried out as a substitution of the existing provision, but the annotation should still read 'inserted' and 'by':

See http://www.legislation.gov.uk/uksi/2012/2996/schedule/4/paragraph/76/2016-04-01 (provision was omitted at previous PiT 1/4/2015 and is now inserted again).

Revival of a previously repealed/revoked provision

If a repealed/revoked provision is revived, we would have to copy the xml from the version previous to the dotty lined version and make a new version from the date it got revived. This would need to be done by a Review Editor using the correction tool.

Multiple insertions of provisions with the same number

We do get genuine instances (admittedly usually resulting from drafting errors), where two provisions with the same number get inserted. We should raise a lex error for these situations. In the meantime we have to account for it in update and we should refer this to TSO to look at the URLs of each provision for us to make sure they work as expected from the ToC.

@@ Line 82: / Line 82: @@
 <li>Scroll back up to the where the amendment was made in the <strong>amended provision</strong> and check the inserted provision is positioned correctly and that the tagging is correct, e.g. sometimes the title or number may be incorrectly tagged - if you think this may be the case, check how it has been tagged throughout the rest of the amended document and if necessary correct it. Also:
-*If your high level insertion contains any power-conferring provisions (marked in TOEs Comments for Editor as "Contains power"), you will need to set the ConfersPower attribute to "true" for those provisions. See more on the [[Editorial_Update/XMetaL_and_XML_tagging#ConfersPower_Attribute|ConfersPowerAttribute]].
+*If your high-level insertion contains any power-conferring provisions (marked in TOEs Comments for Editor as "Contains power"), you will need to set the ConfersPower attribute to "true" for those provisions. See more on the [[Editorial_Update/XMetaL_and_XML_tagging#ConfersPower_Attribute|ConfersPowerAttribute]].
 *Remember to remove any Non Breaking Space Characters that may have been added to the amended provision by your insertion. See more on  [[Editorial_Update/Approach_to_Update_-_Some_Basic_Rules_and_Exceptions#Non_Breaking_Space_Characters|Non Breaking Space Characters]].
 </li>