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

From Legislation Community Editorial Wiki
Jump to navigation Jump to search
 
(282 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
==Instructions==
+
==OVERVIEW==
  
−
If your editorial update task involves high level insertions, here's what you need to do.<ol><li> From the ‘Update Overview’ page <strong>select the ‘Details’ button</strong> next to the update task you are going to complete.</li>
+
{| class="wikitable"
 +
|<strong>Related reading:</strong> [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#APPROACH_TO_UPDATE_-_SOME_BASIC_RULES_AND_EXCEPTIONS|Approach to Update - Some Basic Rules and Exceptions]], [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#SPECIFIC_UPDATE_ISSUES|Specific Update Issues]]
 +
|}
  
−
<li> The ‘Update Details’ page for high level amendments will show a list of the high level amendments that need to be completed for the Point in Time you are editing (there may be more than one).  The details given are the same as for provision level amendments BUT there is no preview facility built into this page. You will need to select the ‘Preview Legislation’ option to preview the amendments on completion. Directly under the table you will be presented with the Table of Contents for the Act in question. <strong> insert image</strong></li> 
+
===Insertion of a cross-heading and child provision(s)===
  
−
<li> Use the link in the amendments list to link to the ‘affecting provision’ and <strong>check the amendment instructions</strong>.  In particular you should confirm where the inserted provision or provisions is to be placed. For example, the amending document might read: “After section 16 of the Game Licences Act 1860 insert the following section –“.</li>
+
See the insertion of s. 16E and cross-heading in 2004 c. 31:
  
−
<li> <strong>Scroll down the Table of Contents</strong> and find where the section should be inserted.  When carrying out high level amendments you need to decide what ‘level’ you are going to check out in order to make the amendment.  To do this you need to locate where the provision is to go and then ‘check out’ the parent level e.g.  Crossheading, Chapter, Part, Schedule to which that new provision will ultimately belong. (Further information on the structure of the documents held on legislation.gov.uk can be found [[Editorial_Update/XMetal_Tagging_Guide|here]]). You need to check out the document out in this way to make sure that you can position the new provision in the right place in the Act, with the correct XML tagging.
+
https://www.legislation.gov.uk/ukpga/2004/31/part/2/crossheading/safeguarding-partners-for-local-authority-areas/2018-06-29
  
−
<strong>Note:</strong>  If the document you are editing is very small or old there may be no crossheadings or Parts etc. In this case you should check out the ‘main body’ or ‘Schedules’. The options to do this are available at the top of the Table of Contents on the ‘Update Details’ page. At the moment you cannot check out the whole Act.</li>
+
https://www.legislation.gov.uk/ukpga/2004/31/section/16E/2018-06-29
  
−
<li> Once you have located the ‘parent level’ you need to ‘check it out’ to complete the amendment.  <strong>Select the ‘Check Out for edit’ button which appears next to the parent level</strong>, this will launch XMetaL, ready for you to carry out the amendment.
+
See further [[Editorial_Update/Textual_Amendments/Insertions/Higher_Level_Insertions#SCENARIOS|Scenarios]] below.
  
−
<strong>Note:</strong> When prompted, select ‘<strong>save file</strong>’. Once the document has been downloaded, open it by double clicking it in the download box.  Alternatively, right click on the file in the downloads box and select ‘<strong>open containing folder</strong>’. From the containing folder, select your file, right click and select ‘<strong>Open with > XMetal</strong>’. XMetaL does not need to be open already.</li>
+
==IN MORE DETAIL==
  
−
<li> In XMetaL, in the upper pane, you will see that the checked out document includes all the provisions that come under the parent you selected, including any heading, for example 'Part V'. By default the legislation will be shown in ‘tags on view’. In the lower pane (‘resource manager window’) you’ll see the amending tasks you need to carry out. The list will be collapsed by default.  To expand, click on the small cross to the left of the word task.
+
{| class="wikitable"
 +
|<strong>Related reading:</strong> [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#APPROACH_TO_UPDATE_-_SOME_BASIC_RULES_AND_EXCEPTIONS|Approach to Update - Some Basic Rules and Exceptions]], [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#SPECIFIC_UPDATE_ISSUES|Specific Update Issues]], [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#UPDATE_TROUBLESHOOTING|Update Troubleshooting]], [[Editorial_Update/Limited_Extent_Amendments|
 +
Limited extent amendments]], [[Editorial_Update/Applying_partially_in_force_amendments_which_are_then_brought_further_into_force_over_time | Applying partially in force amendments which are then brought further into force over time]], [[Editorial_Update/Update_Editor_Checklist|Update Editor Checklist]]
 +
|}
  
−
<strong>Note:</strong>
+
===Important considerations===
−
* If the resource manager window does not open automatically, you can open it by selecting ‘view’, ‘Resource Manager’. The ‘resource manager’ window can be moved around the page to a position that suits you for editing.
+
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.  
−
* At the moment the tasks in the ‘resource manager’ window does not always give as much information as the task information shown on the ‘Update Details’ page or in the amending legislation. They may also be in a different order. Work is underway to give more information in this task pane.</li>
 
  
−
<li> <strong>Open the amending provision</strong>. To gain a fuller understanding of the content of the amending provision, double click on the task in the resource manager window. The first time you open X-Metal a dialogue box will open asking you for your username and password, once you enter it, it will show you the amending provision.</li>
+
The [[Effects_Spreadsheet|effects spreadsheet]] that you  [[Editorial_Update/Starting_Update_Tasks#Downloading_the_Effects_Spreadsheet|download at the start of the update task]] contains all the information that was recorded for the effect you are applying. You should [[Editorial_Update/Update_Editor_Checklist#Check_the_TOES_data_for_your_amendment|check the TOES data for your amendment]] before you start. In particular, check the [[Effects_Spreadsheet#Comments_for_Editor|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.
  
−
<li> Read carefully what the amendment is and where it goes, and proceed accordingly.
+
Questions to consider:
  
−
Note: You can view the amended and amending provisions separately by alternating between the appropriate tabs in the bottom left of the upper pane OR you can view the amended and amending documents simultaneously by going to the ‘window’ option in the tool bar and then selecting the tile horizontally format.</li>
+
<blockquote>Is the effect wholly in force or partially in force? Is it whole or [[Editorial_Update/Textual_Amendments/Insertions/Provision_Level_Insertions#Limited_Extent_Amendments|limited extent]]? Has your affecting provision itself been amended by an [[Editorial_Update/Amendment_to_Earlier_Affecting_Provision|amendment to earlier affecting provision]] effect? Is there an [[Effects_Spreadsheet#Appended_Commentary|appended commentary]] for the effect? Is your effect a knock-on effect? Does your inserted text [[Editorial_Update/XMetaL_and_XML_tagging#ConfersPower_Attribute|contain power]]? Are there any savings or transitional provisions?</blockquote>        
  
−
<li> In the amending provision <strong>highlight and copy the provision</strong> that you need to insert by selecting the <strong>ukl:P1 tag (select from ukl:P1group if the provision has a title)</strong>. You can right-click and copy or use the standard ‘edit’ ‘copy’ menu options from the toolbar.
+
The answers to these questions will inform how you carry out the amendment, whether you need to amend any of the [[Editorial_Update/XMetaL_and_XML_tagging#Attribute_Inspector|attributes]] of the provision you are amending, also what the [[Editorial_Update/Annotation_Conventions|annotation]] that the Editorial System generates will look like and whether there are any amendments you might need to make to this annotation.  
  
−
<strong>Note:</strong><u>Do not use the BlockAmendment tags to copy the provision</u> or provisions you need to insert. This is not currently supported. If you need to copy multiple provisions highlight them all using the <strong>ukl:P1</strong>, using ‘shift’ on your keyboard.</li>
+
Use the [[Editorial_Update/Update_Editor_Checklist#Check_the_TOES_data_for_your_amendment|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 [[Editorial_Update/Update_Editor_Checklist#XMetaL:_making_sure_that_the_amendment_is_applied_correctly|check the amendment in XMetaL]] and [[Editorial_Update/Update_Editor_Checklist#Preview:_double_check_the_point_in_time_.28PiT.29.2C_amendment_and_annotation_before_moving_on|preview your amendment]].  
  
−
[[File:Higher Level Insertion image 1.jpg|link=]]
+
The following pages also give useful guidance that will help if you are not sure how carry out your amendment:
  
−
<li> In the amended provision scroll to find the provision that the new provision will follow and place the cursor right at the end of that provision (i.e. after the close ukl:P1group  tag of the proceeding provision) and before the open 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.</li>
+
*[[Editorial_Update/Annotation_Conventions | Annotation Conventions]]
 +
*[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#APPROACH_TO_UPDATE_-_SOME_BASIC_RULES_AND_EXCEPTIONS|Approach to Update - Some Basic Rules and Exceptions]]
 +
*[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#SPECIFIC_UPDATE_ISSUES|Specific Update Issues]]
  
−
<li> Highlight the task in the ‘resource manager’ window.</li>
+
====Limited extent amendments==== 
 +
The Editorial System flags possible limited extent amendments with the following message:
  
−
<li> Use the menu on the tool bar at the top of your screen to select: Legislation > Textual amendment > Addition.</li>
+
[[File: Limited_extent_warning_message_2.png|900px]]
  
−
<li> There should be brackets around the newly inserted provision, as well as an annotation reference. At the end of the provision, the annotation commentary explaining the amendment that has just been completed should have been automatically created:
+
The extent of the affected and affecting provision is highlighted in red. You can also view the extent/TA in the effects spreadsheet that [[Editorial_Update/Starting_Update_Tasks#Downloading_the_Effects_Spreadsheet|can be downloaded from the Starting Update Page]].  
−
.
 
−
e.g.  S. 5A (1.3.2004) by Health and Education Act 2003 (c. 90), s. 130, Sch. 18 para. 8
 
  
−
Check that the commentary is accurate and complete.
+
To decide whether or not you need to [[Editorial_Update/Limited_Extent_Amendments#Limited_extent_amendment_options_in_XMetaL|carry out your amendment using the limited extent amendment option in XMetaL]], follow the decision-making process described in the [[Editorial_Update/Limited_Extent_Amendments#Decision_tree_for_deciding_what_is_a_limited_extent_amendment|Decision tree for deciding what is a limited extent amendment]] on the [[Editorial_Update/Limited_Extent_Amendments|Limited Extent Amendments]] page. There is also some specific information about [[Editorial_Update/Limited_Extent_Amendments#Is_your_amendment_a_limited_extent_insertion_of_a_higher_level_provision_.28e.g._a_heading_and_range_of_provisions.2C_or_a_Chapter.2C_Part_or_Schedule.29.3F|how to deal with a limited extent insertion of a higher level provision (e.g. a heading and range of provisions, or a Chapter, Part or Schedule)]] on the Limited Extent page.
  
−
Note: When you carry out the amendment the cursor will be left at the point the automatic annotation was inserted. You will need to scroll back up the page to see the inserted text. </li>
+
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  [[Editorial_Update/Limited_Extent_Amendments#Updating_an_existing_limited_extent_amendment_when_an_identical_amendment_is_applied_for_another_jurisdiction|Updating an existing limited extent amendment when an identical amendment is applied for another jurisdiction]].  
−
<li> Once you are satisfied that the amendment/s are correct and completed, go to the menu at the top of the screen. Check in your work: <strong>Legislation > Check in</strong> or continue to the next amendment.
 
  
−
Confirmation of this should result in an XMetal Author dialogue window stating;
+
If, after making all the considerations outlined above, you decide that the amendment is indeed a limited extent amendment, follow the method outlined [[Editorial_Update/Textual_Amendments/Insertions/Higher_Level_Insertions#Limited_extent_-_wholly_in_force|below]] to carry out the insertion.
−
Document is checked in successfully. The amending document will now be checked back in. Please close this when finished with.</li>
 
  
−
<li><strong>Set the extent of the newly inserted provision</strong>.  This will be the extent of the affecting provision stated in details for the effect you are carrying out.</li>
+
====Partially in force amendments====
−
<li><strong>Select 'View' – 'Attribute Inspector' in XMetaL</strong> – this will open a new window where you can add in the extent of the newly inserted provision. The field is called 'restrictextent'.
 
−
Make sure your cursor is positioned immediately after the P1group (if the provision contains a heading) and just after the P1 open tag (if there is no heading).
 
−
Enter the extent into the restrictextent field e.g. E+W+S.  It is important you add in the extent following this format. If you don't follow this format you will get an error on check-in.</li>
 
  
−
<li> Minimise XMetal and go back to the ‘Update Details’ page and <strong>refresh that page</strong>.</li>
+
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  [[Editorial_Update/Applying_partially_in_force_amendments_which_are_then_brought_further_into_force_over_time#Partially_in_force_amendments|Partially in force amendments]] on the [[Editorial_Update/Applying_partially_in_force_amendments_which_are_then_brought_further_into_force_over_time|Applying partially in force amendments which are then brought further into force over time]] page.  
  
−
==What to expect==
+
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 provision(s) is carried out in the same way as a wholly in force insertion.
  
−
<li> Check that all the amendments you carried out in XMetaL are set to ‘edit complete’.</li>
+
To read more about how partially in force amendments get brought further into force over time, see [[Editorial_Update/Applying_partially_in_force_amendments_which_are_then_brought_further_into_force_over_time#What_happens_when_an_amendment_comes_further.2C_or_fully_into_force.3F|What happens when an amendment comes further, or fully into force?]].
  
−
<li> To check the version history and see how the provision would look in the context of the whole Act,  select the <strong>preview legislation</strong> button and check:
+
===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. Step 2 is divided 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.
  
−
*a. Check that the provision appears in the correct place on the Table of Contents.
+
Carrying out and checking the amendment in XMetaL:
  
−
*b. Open the parent level and check you’re satisfied that the amendment has formatted correctly (including annotation), switch the Point in Time versions on and ensure that there is a new version of the parent as at the date of the insertion.
+
Step One - preparing to carry out the amendment in XMetaL
−
*c. Return to the Table of Contents and open the provision on its own and repeat those checks i.e. check the annotation and Point in Time is correct there too.</li>
 
  
−
<li> Select <strong>Return to Task Overview</strong> to continue to apply further updates or complete the Point in Time.</li>
+
Step Two - selecting the correct XMetaL Legislation menu option to carry out the amendment
  
−
<li>   You should find that the bar chart diagram has turned green indicating that either part or all the amendments within the provision at that point in time have been completed.</li>
+
Step Three - checking the amendment in XMetaL
  
−
<li> Once you have completed all the amendments for the PiT you are working on, you can either select <strong>Next Step</strong> to move onto the next Point in Time or <strong>Complete Update</strong> to submit your work for review.</li></ol>
+
Checking the amendment in the Editorial System:
  
−
==Insertion of a Chapter==
+
Step Four - preview the amendment from the Update Details page 
  
−
===Wholly In Force/Whole Extent===
+
====Things to remember====
  
−
====Instructions====
+
The <strong>[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#SPECIFIC_UPDATE_ISSUES|Specific Update Issues]]</strong> guidance includes some <strong>[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#Editorial_Update_-_some_general_reminders|general Editorial Update reminders]]</strong> to be aware of before you carry out your amendment. Also included is information on <strong>[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#Presentation_of_Revised_Legislation|how amendments are presented]]</strong>. Note, in particular that there may be <strong>[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#.E2.80.98Tidying_up.E2.80.99_amendment_text:_fixing_incorrectly_tagged_amending_provisions_and_removing_unwanted_tagging|tagging that may need to be removed from amendment text]]</strong>, to prevent formatting errors.
  
−
====Before and After====
+
See also the advice on how to [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#Approach_to_.E2.80.98awkward.E2.80.99_amendments|approach more unusual types of amendment]], and [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#APPROACH_TO_UPDATE_-_SOME_BASIC_RULES_AND_EXCEPTIONS|Approach to Update - Some Basic Rules and Exceptions]].
  
−
====Checklist====
 
  
−
===Wholly in Force/Limited Extent===
+
=====Beware of start date issue when inserting a parent and children into a high level grandparent fragment=====
 +
{|class="wikitable" style="border-left:solid 2px red;border-right:solid 2px red;border-top:solid 2px red;border-bottom:solid 2px red; background-color:#e6f2ff;
 +
|-
 +
|<strong>WARNING:</strong> There is currently an issue with inserting a parent and children into a high level grandparent fragment.  The start date is not getting properly added to the inserted parent and then on check in it’s not calculating the empty child start dates correctly because of that.  The workaround is either:
  
−
====Instructions====
+
1. Ensure the high level grandparent you check out to do your insertion has had its timeline resolved beforehand to add the current PiT or ensure that start date is added after check out (if the grandparent has the wrong date that’s part of the problem); or
  
−
====Before and After====
+
2. Make sure the inserted parent has the correct RestrictStartDate before check in; that should then ensure the system calculates the child start dates properly.
  
−
====Checklist====
+
|}
  
−
===In Force Specified Purposes/Partly In Force===
+
====Carrying out the amendment in XMetaL====
  
−
====Instructions====
+
Follow these instructions to carry out the insertion of a whole provision, Chapter, Part or Schedule. The instructions assume that you have checked out the relevant [[Editorial_Update/Starting_Update_Tasks#The_Update_Details_Page_-_High_Level|parent level]] or [[Editorial_Update/Starting_Update_Tasks#Framework_checkout_options|framework]], that you have set up your [[Editorial_Update/Starting_Update_Tasks#Setting_up_your_XMetaL_workspace|XMetaL workspace]], and that you are now ready to carry out the amendment.  For guidance on the steps required to reach this point, see [[Editorial_Update/Starting_Update_Tasks|Starting Update Tasks]].
  
−
====Before and After====
+
{|class="wikitable" style="border-left:solid 2px red;border-right:solid 2px red;border-top:solid 2px red;border-bottom:solid 2px red; background-color:#e6f2ff;
 +
|-
 +
|<strong>Note:</strong>if you are inserting a new Schedule, and there are no existing Schedules in the document, you need to insert a <code>ukl:Schedules</code> element after the <code>ukl:Body</code> 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.
 +
|}
  
−
====Checklist====
+
{| class="wikitable" style="background-color:#f2f2f2;"
 +
|<strong>Step One</strong>
 +
<br/>
 +
<ol><li>In the <strong>amending provision</strong> window:
 +
<br/>
 +
<br/>
 +
*Read what the amendment is and where in the <strong>amended provision</strong> it is to be made. 
 +
<br/>
 +
*In the <strong>amending provision</strong> highlight and copy the provision that you need to insert by selecting the appropriate opening tag:
 +
**<code>ukl:P1</code> (select from <code>ukl:P1group</code> if the provision has a title) for a provision
 +
**<code>ukl:Part</code> for a Part 
 +
**<code>ukl:Chapter</code> for a Chapter
 +
**<code>ukl:Schedule</code> for a Schedule
 +
<br/>
 +
You can also select the <code>BlockAmendment</code> 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.
 +
<br/>
 +
<br/>
 +
[[File:Insertion_of_Part_amending_provision.png|900 px]]
 +
<br/>
 +
<br/>
  
−
<ol><li>Repeat steps 1-8 of [[Editorial_Update/Textual_Amendments/Insertions/Words|"Insertion of a whole provision or a number of provisions"]].</li>
+
<li>In the <strong>amended provision</strong>, 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 <code>/ukl:P1group</code>, <code>/ukl:Part</code>, <code>/ukl:Chapter</code>, or <code>/ukl:Schedule</code> tag) and before the opening tags of the next provision. If in doubt you can use the <strong>Element list</strong> to check which tags are valid where your cursor is currently positioned. For example, the cursor is positioned between the closing <code>/ukl:Part</code> tag of Part 8 and the opening <code>ukl:Part</code> tag of Part 9 when Part 8A is to be inserted:</li>
 +
<br/>
 +
<br/>
 +
[[File:Insertion_of_Part_amended_provision.png|900 px]]
 +
<br/>
 +
<br/>
 +
 
 +
<li>Single click on the task to highlight it in the <strong>Resource Manager</strong> window.</li>
 +
<br/>
 +
<br/>
 +
[[File:Insertion_of_Part_RM.png|link=]]
 +
<br/>
 +
<br/>
 +
<li>Your next action will be determined by whether the amendment covers the [[Editorial_Update/Textual_Amendments/Insertions/Higher_Level_Insertions#Whole_extent_-_wholly_or_partially_in_force|whole extent]] or is for a [[Editorial_Update/Textual_Amendments/Insertions/Higher_Level_Insertions#Limited_extent_-_wholly_in_force|limited extent]].</li></ol>
 +
|}
  
−
<li> In the amended provision scroll to find the provision that the new Chapter will follow and place cursor in the appropriate place, after <strong>/ukl:Chapter</strong> closing tag and before the open tag of the next Chapter. If in doubt you can use the ‘element list’ to check which tags are valid where your cursor is currently positioned.</li>
+
=====Whole extent - wholly or partially in force=====
  
−
<li> Highlight the task in the ‘resource manager’ window.</li>
 
  
−
<li> Use the menu on the tool bar at the top of your screen to select: Legislation > Textual amendments > Addition.</li>
 
  
−
<li>    Repeat steps 13- 20 of [[Editorial_Update/Textual_Amendments/Insertions/Words|"Insertion of a whole provision or a number of provisions"]].</ol>
+
{| class="wikitable" style="background-color:#f2f2f2;"  
 +
|<strong>Step Two</strong>
  
−
==Insertion of a Schedule==
+
On the menu bar at the top of the page select <strong>Legislation - Textual Amendments -  Addition</strong>.
 +
<br>
 +
<br>
 +
[[File:Insertion_of_Part_menu_whole_extent.png|900 px]]
 +
<br>
 +
<br>
 +
This will:
 +
<br>
 +
*Automatically insert the new provision/Part/Chapter/Schedule, etc. bracketed by opening <code><addition></code> and closing <code></addition></code> tags in the <strong>amended provision</strong>;
 +
*Automatically insert the annotation for this amendment at the end of the <strong>amended provision</strong>; and
 +
*Generate a green tick next to the task in the <strong>Resource Manager</strong> window to show that it has been completed.
 +
<br>
 +
<br>
 +
After the amendment has been made, the cursor will be situated at the point the automatic annotation was inserted in the <strong>amended provision</strong> window:
 +
<br>
 +
<br>
 +
[[File:Insertion_of_Part_XMetaL_view_after_amendment.png|1000px]]
 +
|}
  
−
===Wholly In Force/Whole Extent===
+
=====Limited extent - wholly in force=====
  
−
====Instructions====
 
  
−
====Before and After====
 
  
−
====Checklist====
+
{| class="wikitable" style="background-color:#f2f2f2;"
 +
|<strong>Step Two</strong>
  
−
===Wholly in Force/Limited Extent===
+
On the menu bar at the top of the page select <strong>Legislation - Textual Amendments -  Limited Extent Addition</strong>. In the pop-up 'XMetaL Author Essential', check the Extent entered is correct and click <strong>OK</strong>; this will:
 +
*Automatically insert the new provision/Part/Chapter/Schedule, etc. bracketed by opening <code><addition></code> and closing <code></addition></code> tags in the <strong>amended provision</strong>;
 +
*Automatically insert the annotation for this amendment at the end of the <strong>amended provision</strong>, including the <strong>limited extent</strong> in brackets after the effect; and
 +
*Generate a green tick next to the task in the <strong>Resource Manager</strong> window to show that it has been completed.
  
−
====Instructions====
+
See more on [[Editorial_Update/Limited_Extent_Amendments|
 +
limited extent amendments]].
  
−
====Before and After====
+
After the amendment has been made, the cursor will be situated at the point the automatic annotation was inserted in the <strong>amended provision</strong> window.
  
−
====Checklist====
+
Your next task will be to [[Editorial_Update/Textual_Amendments/Insertions/Higher_Level_Insertions#Check_the_amendment_in_XMetaL | check the amendment in XMetaL (Step Three)]], followed by the final task of [[Editorial_Update/Textual_Amendments/Insertions/Higher_Level_Insertions#Preview_the_amendment_from_the_Update_Details_page | previewing the amendment from the Update Details page (Step Four)]].
 +
|}
  
−
===In Force Specified Purposes/Partly In Force===
+
====Check the amendment in XMetaL====
  
−
====Instructions====
+
{| class="wikitable" style="background-color:#f2f2f2;"
 +
|<strong>Step Three</strong>
  
−
====Before and After====
+
<br>
 +
<ol><li><span style = "color:red;"><strong>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</span> [[Editorial_Update/Update_Editor_Checklist#After_you_have_carried_out_the_amendment_in_the_XML|Update Editor Checklist]]</strong>.</li>
  
−
====Checklist====
+
<!--<ol><li>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 <strong>In Force Date Qualification</strong> 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 <strong>In Force Date Qualification</strong> (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 [[Editorial_Update/Annotation_Conventions#Annotations_and_In_Force_Date_Qualifications|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 [[Editorial_Update/Annotation_Conventions#F-notes_.28Textual_Amendments.29|Annotation Conventions]].</li>
 +
 +
<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:
 +
-->
 +
<br>
 +
<br>
 +
Don’t forget to make sure that you
 +
<strong>[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#.E2.80.98Tidying_up.E2.80.99_amendment_text:_fixing_incorrectly_tagged_amending_provisions_and_removing_unwanted_tagging|remove any tagging that is not required in the amendment text]]</strong> (such as drafter’s footnotes, non breaking space characters, internal links and correction slip tagging) and that you have have set the [[Editorial_Update/XMetaL_and_XML_tagging#ConfersPower_Attribute|ConfersPower attribute]] to “true” for any <strong>power-conferring provisions</strong>.
 +
<br>
 +
<br>
 +
Also check that the <strong>extent</strong> of your inserted provision is correct.  If the RestrictExtent attribute is blank, the provision will inherit the extent of the parent into which it has been inserted so you need to check that this is correct. See more on the [[Editorial_Update/XMetaL_and_XML_tagging#RestrictExtent_Attribute|RestrictExtent attribute]].
 +
<br>
 +
<br>
 +
<li>Once you are satisfied that the amendment is correct and complete, select <strong>Legislation - Check In</strong> on the menu bar at the top of the page:
 +
<br>
 +
<br>
 +
[[File:Check_in.png|link=]]
 +
<br>
 +
<br>
 +
</li>
 +
<br>
 +
<li>Click <strong>OK</strong> in the pop-up  [[File:Document_is_checked_in_successfully.png|link=]]</li>
 +
<br>
 +
<li>Close the <strong>amending provision</strong> window and if you have more update to do, leave XMetaL open and go back to the Editorial Site.</li></ol>
 +
|}
  
−
Text to follow.
+
====Preview the amendment from the Update Details page====
  
−
==Examples==
+
{| class="wikitable" style="background-color:#f2f2f2;"
 +
|<strong>Step Four</strong>
 +
 +
<ol><li>Return to the <strong>Update Details</strong> page and refresh the page by pressing <code>CTRL</code> and <code>F5</code>. The <strong>Edit Status</strong> should change to <strong>Edit Complete</strong>.</li>
 +
<br>
 +
<li>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.</li>
 +
<br>
 +
<li>View your amendment using the <strong>Preview Legislation</strong> button to see a website <strong>Preview</strong> of the provision.</li>
 +
<br>
 +
<br>
 +
<li><strong><span style = "color:red;">Carry out all the checks detailed in the</span>  [[Editorial_Update/Update_Editor_Checklist#Presentation_of_Higher_Level_amendments|Update Editor Checklist]]<span style = "color:red;">, to make sure that the amendment is accurate and complete.</span></strong></li>
 +
<br>
 +
<br>
 +
<li>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 <strong>Edit</strong> button to the right of the annotation in <strong>Preview</strong> to edit it without having to check the provision out again in XMetaL, but beware of the [[Editorial_Update/Annotation_Conventions#Editing_annotations_in_the_website_preview|bugs you may encounter when using the annotation Edit function in preview]].</li>
 +
<br>
 +
<li>Once you have finished checking the amendment on the Editorial Site, the update task will be complete and you can [[Editorial_Update/Starting_Update_Tasks#Navigating_the_Update_Task|move on]] to your next update task.</li></ol>
  
−
==Related Topics==
+
 +
<!--*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;
 +
*That the provision/Part/Chapter/Schedule shows the correct <strong>extent</strong>;
 +
*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 [[Editorial_Update/Annotation_Conventions|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 [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#Using_the_Timeline_Resolver_to_resolve_timeline_issues_and_errors_in_stop_dates_in_the_data | 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. 
 +
-->
 +
 
 +
|}
 +
 
 +
<strong>Video Instructions:</strong> [https://www.youtube.com/watch?v=sTD6toP-63A Insertion of a section (wholly in force and whole extent)]
 +
 
 +
==SCENARIOS==
 +
 
 +
Also see [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#SPECIFIC_UPDATE_ISSUES|Specific Update Issues]].
 +
 
 +
===Inserting a new high level heading or cross-heading===
 +
 
 +
Cross-headings are tagged in <code>ukl:Title</code> tags at the top of <code>ukl:Pblock</code> tagging, for example:
 +
 
 +
[[File:Cross-heading_tagging.png|900 px]]
 +
 
 +
When a new cross-heading is inserted and adopts existing child provision(s) from an existing cross-heading, you need to insert new <code>ukl:Pblock</code> tagging after the existing <code>ukl:Pblock</code> tagging and then move the relevant adopted child provision(s) into the new <code>ukl:Pblock</code>.  The same principle applies to other headings (Parts, Chapters, etc).
 +
 
 +
The <code>ukl:Pblock</code> id attribute will automatically be inserted on check-in. It is a good idea to compare the id attribute of the new <code>ukl:Pblock</code> with the id attribute of an adjacent cross-heading to make sure that the id attribute of the new <code>ukl:Pblock</code> is correct, and that it contains all the information about where the cross-heading is located (including Part details if relevant), as the URI will be based on this ID: 
 +
 
 +
[[File:Cross-heading_attributes.png|500 px]]
 +
 
 +
 
 +
See this example in 1990 c. 8, where a new cross-heading is inserted on 26/12/2023 that adopts existing ss. 94-96:
 +
 
 +
https://www.legislation.gov.uk/ukpga/1990/8/part/III/crossheading/termination-of-planning-permission-wales/2023-12-26
 +
 
 +
 
 +
See also this example in 2000 c. 8, where s. 300H was adopted by a new cross-heading on 1/1/2024, when ss. 300G, 300F and a cross-heading were inserted above it:
 +
 
 +
https://www.legislation.gov.uk/ukpga/2000/8/chapter/I/crossheading/general-rulemaking-powers/2024-01-01
 +
 
 +
===Inserting a range of paragraphs including cross-headings into a Schedule===
 +
 
 +
Amendments to insert a range of paragraphs into a Schedule may also include cross-headings, see for example, the insertion of paras. 9A-9D into Sch. 1 of The Education (Postgraduate Master's Degree Loans) (Wales) Regulations 2017, where some of the paragraphs included cross-headings:
 +
 
 +
https://www.legislation.gov.uk/wsi/2017/523/schedule/1/part/2/2021-04-25
 +
 
 +
When previewed, the entire inserted range is surrounded by one set of brackets and each inserted paragraph has its own annotation for the insertion.
 +
 
 +
===Was the parent originally prospective at RA/made date and is it yet to be brought wholly into force?===
 +
 
 +
{|class="wikitable" style="border-left:solid 2px red;border-right:solid 2px red;border-top:solid 2px red;border-bottom:solid 2px red; background-color:#e6f2ff;
 +
|<strong>Whole provisions inserted into Parts/Chapters/Schedules that were originally prospective and have yet to be brought wholly into force should also be treated as prospective, unless the inserted provisions are specifically commenced by means of an amendment made simultaneously to the governing commencement provision.</strong>
 +
|}
 +
 
 +
If the updates you are applying are to a parent level that has not yet been brought into force&#8212;and therefore still showing as prospective&#8212;then any whole provisions that are being inserted into it before the in force date should also be prospective.  They will come into force later, should the Department wish to do so, by means of a commencement order&#8212;at which point the parent too will get a start date.
 +
 
 +
After carrying out the insertion, you will need to use the [[Editorial_Update/XMetaL_and_XML_tagging#Attribute_Inspector|Attribute Inspector]] to edit the element attributes of the newly inserted provision to match the attributes of the parent level, otherwise you will get errors that will prevent you from checking the document back in, as the attributes of the new material (which is not prospective) will clash with the attributes of the existing material (which is prospective).
 +
 
 +
Edit the attributes of the newly inserted provision to match those of the surrounding material:
 +
 
 +
• Delete the value in ‘RestrictStartDate’ so that this field is blank
 +
 
 +
• Set ‘Match’ to ‘false'
 +
 
 +
• Set ‘Status’ to ‘Prospective’
 +
 
 +
[[File:Inserting_a_prosp_provision.png|300px]]
 +
 
 +
Whilst you are editing the attributes also remember to check and amend the [[Editorial_Update/XMetaL_and_XML_tagging#RestrictExtent_Attribute|‘RestrictExtent’ attribute]] and also set the [[Editorial_Update/XMetaL_and_XML_tagging#ConfersPower_Attribute|‘ConfersPower’ attribute]], if you need to.
 +
 
 +
You also need to add a note for the Review Editor to do a TOES correction to add a coming into force effect so that an I-note will be generated for this new provision when it comes into force.
 +
 
 +
====Example: 2017 c. 17, Sch. 22====
 +
 
 +
Sch. 22 was prospective at Royal Assent, except for Pt. 6 which came into force on IP comp day:
 +
 
 +
https://www.legislation.gov.uk/ukpga/2020/17/schedule/22/part/6
 +
 
 +
Pt. 5 was therefore prospective at Royal Assent and is still prospective for the most part, except that so far Commencement Orders have brought into force paras. 24, 81-83:
 +
 
 +
https://www.legislation.gov.uk/ukpga/2020/17/schedule/22/paragraph/24/2022-05-02
 +
https://www.legislation.gov.uk/ukpga/2020/17/schedule/22/part/5/crossheading/minimum-sentences-firearms-and-corrosive-substances
 +
 
 +
Because of that, the Pt. 5 level (and the Sch. 22 level) correctly has start dates on the timeline: for the first commenced para. 24 and then one PiT for each subsequent amendment to it (because that’s how the editorial tool works), even though most of these either hit prospective provisions (and don’t create a new dated version) or insert new paragraphs into the prospective schedule that will need to be commenced later under s. 417:
 +
 
 +
https://www.legislation.gov.uk/ukpga/2020/17/schedule/22
 +
 
 +
https://www.legislation.gov.uk/ukpga/2020/17/schedule/22/part/5
 +
 
 +
https://www.legislation.gov.uk/ukpga/2020/17/section/417
 +
 
 +
Unless the drafters amend s. 417 at the same time as they insert a new paragraph in Sch. 22 to say that the new paragraph is also in force on the date of its insertion, then that new paragraph should be prospective and only get a start date by virtue of a subsequent Commencement Order.
 +
 
 +
 
 +
===Inserting a provision into a parent level that is not yet in force - removing an unnecessary PiT===
 +
 
 +
If you are inserting a new whole provision into a parent level that is prospective (i.e. not yet in force), and the editorial system has inserted a PiT for the start date of the newly inserted whole provision, you can remove it using the [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#Scenario_4:_Corrections_-_Remove_a_date_where_only_one_PiT_exists_to_create_a_wholly_prospective_provision_or_add_a_date_to_a_provision_which_is_no_longer_prospective|timeline resolver]]. If that doesn’t work, check the provision out in XMetaL, remove the start date and set the status to prospective in the attributes (as described [[Editorial_Update/Textual_Amendments/Insertions/Higher_Level_Insertions#Was_the_parent_originally_prospective_at_RA.2Fmade_date_and_is_it_yet_to_be_brought_wholly_into_force.3F|above]]).
 +
 
 +
===Insertion of a provision that was previously repealed===
 +
 
 +
This scenario is described here: [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#Inserting_a_provision_or_sub-provision_that_was_previously_repealed|Specific Update Issues - Inserting a provision or sub-provision that was previously repealed]].
 +
 
 +
===Revival of a previously repealed/revoked provision===
 +
 
 +
This scenario is described here: [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#Inserting_a_provision_or_sub-provision_that_was_previously_repealed|Specific Update Issues - Revival of a previously repealed/revoked provision]].
 +
 
 +
===Multiple insertions of provisions with the same number===
 +
 
 +
This scenario is described here [[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#Multiple_insertions_of_provisions_with_the_same_number|Specific Update Issues - Multiple insertions of provisions with the same number]].
 +
 
 +
==RELATED PAGES==
 +
*[[Editorial_Update/Textual_Amendments/Insertions/Provision_Level_Insertions|Provision Level Insertions]]
 +
*[[Editorial_Update/Amendment_to_Earlier_Affecting_Provision | Amendment to Earlier Affecting Provision]]
 +
*[[Editorial_Update/Annotation_Conventions | Annotation Conventions]]
 +
*[[Editorial_Update/Applying_partially_in_force_amendments_which_are_then_brought_further_into_force_over_time | Applying partially in force amendments which are then brought further into force over time]]
 +
*[[Editorial_Update/Limited_Extent_Amendments|Limited extent amendments]]
 +
*[[Editorial_Update/Lists|Lists]]
 +
*[[Editorial_Update/Manual_Amendments|Manual Amendments]]
 +
*[[Editorial_Update/Images|Images]]
 +
*[[Editorial_Update/Tables|Tables]]
 +
*[[Editorial_Update/XMetaL_and_XML_tagging|XMetaL and XML tagging]]
 +
 
 +
Editorial Update approach, specific issues and troubleshooting:
 +
*[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#APPROACH_TO_UPDATE_-_SOME_BASIC_RULES_AND_EXCEPTIONS|Approach to Update - Some Basic Rules and Exceptions]]
 +
*[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#SPECIFIC_UPDATE_ISSUES|Specific Update Issues]]
 +
*[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#UPDATE_TROUBLESHOOTING|Update Troubleshooting]]

Latest revision as of 17:04, 28 April 2025

OVERVIEW

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

Insertion of a cross-heading and child provision(s)

See the insertion of s. 16E and cross-heading in 2004 c. 31:

https://www.legislation.gov.uk/ukpga/2004/31/part/2/crossheading/safeguarding-partners-for-local-authority-areas/2018-06-29

https://www.legislation.gov.uk/ukpga/2004/31/section/16E/2018-06-29

See further Scenarios below.

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. There is also some specific information about how to deal with a limited extent insertion of a higher level provision (e.g. a heading and range of provisions, or a Chapter, Part or Schedule) on the Limited Extent page.

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, follow the method outlined below to carry out the insertion.

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 provision(s) is carried out in the same way as a wholly in force insertion.

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. Step 2 is divided 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 that 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.


Beware of start date issue when inserting a parent and children into a high level grandparent fragment
WARNING: There is currently an issue with inserting a parent and children into a high level grandparent fragment. The start date is not getting properly added to the inserted parent and then on check in it’s not calculating the empty child start dates correctly because of that. The workaround is either:

1. Ensure the high level grandparent you check out to do your insertion has had its timeline resolved beforehand to add the current PiT or ensure that start date is added after check out (if the grandparent has the wrong date that’s part of the problem); or

2. Make sure the inserted parent has the correct RestrictStartDate before check in; that should then ensure the system calculates the child start dates properly.

Carrying out the amendment in XMetaL

Follow these instructions to carry out the insertion of a whole provision, Chapter, Part or Schedule. The instructions assume that 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.

Note: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.
Step One


  1. 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:
      • 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.

    Insertion of Part amending provision.png

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


    3. Insertion of Part amended provision.png

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


    4. Insertion of Part RM.png

  4. Your next action will be determined by whether the amendment covers the whole extent or is for a limited extent.
Whole extent - wholly or partially in force
Step Two

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

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.

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 drafter’s 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.

    Also check that the extent of your inserted provision is correct. If the RestrictExtent attribute is blank, the provision will inherit the extent of the parent into which it has been inserted so you need to check that this is correct. See more on the RestrictExtent attribute.

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


  3. Click OK in the pop-up Document is checked in successfully.png

  4. Close the amending provision window and if you have more update to do, leave XMetaL open and go back to the Editorial Site.

Preview the amendment from the Update Details page

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 using the Preview Legislation button to see a website Preview of the provision.


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


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

  6. 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 a section (wholly in force and whole extent)

SCENARIOS

Also see Specific Update Issues.

Inserting a new high level heading or cross-heading

Cross-headings are tagged in ukl:Title tags at the top of ukl:Pblock tagging, for example:

Cross-heading tagging.png

When a new cross-heading is inserted and adopts existing child provision(s) from an existing cross-heading, you need to insert new ukl:Pblock tagging after the existing ukl:Pblock tagging and then move the relevant adopted child provision(s) into the new ukl:Pblock. The same principle applies to other headings (Parts, Chapters, etc).

The ukl:Pblock id attribute will automatically be inserted on check-in. It is a good idea to compare the id attribute of the new ukl:Pblock with the id attribute of an adjacent cross-heading to make sure that the id attribute of the new ukl:Pblock is correct, and that it contains all the information about where the cross-heading is located (including Part details if relevant), as the URI will be based on this ID:

Cross-heading attributes.png


See this example in 1990 c. 8, where a new cross-heading is inserted on 26/12/2023 that adopts existing ss. 94-96:

https://www.legislation.gov.uk/ukpga/1990/8/part/III/crossheading/termination-of-planning-permission-wales/2023-12-26


See also this example in 2000 c. 8, where s. 300H was adopted by a new cross-heading on 1/1/2024, when ss. 300G, 300F and a cross-heading were inserted above it:

https://www.legislation.gov.uk/ukpga/2000/8/chapter/I/crossheading/general-rulemaking-powers/2024-01-01

Inserting a range of paragraphs including cross-headings into a Schedule

Amendments to insert a range of paragraphs into a Schedule may also include cross-headings, see for example, the insertion of paras. 9A-9D into Sch. 1 of The Education (Postgraduate Master's Degree Loans) (Wales) Regulations 2017, where some of the paragraphs included cross-headings:

https://www.legislation.gov.uk/wsi/2017/523/schedule/1/part/2/2021-04-25

When previewed, the entire inserted range is surrounded by one set of brackets and each inserted paragraph has its own annotation for the insertion.

Was the parent originally prospective at RA/made date and is it yet to be brought wholly into force?

Whole provisions inserted into Parts/Chapters/Schedules that were originally prospective and have yet to be brought wholly into force should also be treated as prospective, unless the inserted provisions are specifically commenced by means of an amendment made simultaneously to the governing commencement provision.

If the updates you are applying are to a parent level that has not yet been brought into force—and therefore still showing as prospective—then any whole provisions that are being inserted into it before the in force date should also be prospective. They will come into force later, should the Department wish to do so, by means of a commencement order—at which point the parent too will get a start date.

After carrying out the insertion, you will need to use the Attribute Inspector to edit the element attributes of the newly inserted provision to match the attributes of the parent level, otherwise you will get errors that will prevent you from checking the document back in, as the attributes of the new material (which is not prospective) will clash with the attributes of the existing material (which is prospective).

Edit the attributes of the newly inserted provision to match those of the surrounding material:

• Delete the value in ‘RestrictStartDate’ so that this field is blank

• Set ‘Match’ to ‘false'

• Set ‘Status’ to ‘Prospective’

Inserting a prosp provision.png

Whilst you are editing the attributes also remember to check and amend the ‘RestrictExtent’ attribute and also set the ‘ConfersPower’ attribute, if you need to.

You also need to add a note for the Review Editor to do a TOES correction to add a coming into force effect so that an I-note will be generated for this new provision when it comes into force.

Example: 2017 c. 17, Sch. 22

Sch. 22 was prospective at Royal Assent, except for Pt. 6 which came into force on IP comp day:

https://www.legislation.gov.uk/ukpga/2020/17/schedule/22/part/6

Pt. 5 was therefore prospective at Royal Assent and is still prospective for the most part, except that so far Commencement Orders have brought into force paras. 24, 81-83:

https://www.legislation.gov.uk/ukpga/2020/17/schedule/22/paragraph/24/2022-05-02 https://www.legislation.gov.uk/ukpga/2020/17/schedule/22/part/5/crossheading/minimum-sentences-firearms-and-corrosive-substances

Because of that, the Pt. 5 level (and the Sch. 22 level) correctly has start dates on the timeline: for the first commenced para. 24 and then one PiT for each subsequent amendment to it (because that’s how the editorial tool works), even though most of these either hit prospective provisions (and don’t create a new dated version) or insert new paragraphs into the prospective schedule that will need to be commenced later under s. 417:

https://www.legislation.gov.uk/ukpga/2020/17/schedule/22

https://www.legislation.gov.uk/ukpga/2020/17/schedule/22/part/5

https://www.legislation.gov.uk/ukpga/2020/17/section/417

Unless the drafters amend s. 417 at the same time as they insert a new paragraph in Sch. 22 to say that the new paragraph is also in force on the date of its insertion, then that new paragraph should be prospective and only get a start date by virtue of a subsequent Commencement Order.


Inserting a provision into a parent level that is not yet in force - removing an unnecessary PiT

If you are inserting a new whole provision into a parent level that is prospective (i.e. not yet in force), and the editorial system has inserted a PiT for the start date of the newly inserted whole provision, you can remove it using the timeline resolver. If that doesn’t work, check the provision out in XMetaL, remove the start date and set the status to prospective in the attributes (as described above).

Insertion of a provision that was previously repealed

This scenario is described here: Specific Update Issues - Inserting a provision or sub-provision that was previously repealed.

Revival of a previously repealed/revoked provision

This scenario is described here: Specific Update Issues - Revival of a previously repealed/revoked provision.

Multiple insertions of provisions with the same number

This scenario is described here Specific Update Issues - Multiple insertions of provisions with the same number.

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/Higher_Level_Insertions&oldid=17040’