Editorial Update/Textual Amendments/Insertions/Higher Level Insertions
Jump to navigation
Jump to search
If your editorial update task involves high level insertions, here's what you need to do.
- From the ‘Update Overview’ page select the ‘Details’ button next to the update task you are going to complete.
- 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. insert image
- Use the link in the amendments list to link to the ‘affecting provision’ and check the amendment instructions. 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 –“.
- Scroll down the Table of Contents 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 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. Note: 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.
- Once you have located the ‘parent level’ you need to ‘check it out’ to complete the amendment. Select the ‘Check Out for edit’ button which appears next to the parent level, this will launch XMetaL, ready for you to carry out the amendment. Note: When prompted, select ‘save file’. 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 ‘open containing folder’. From the containing folder, select your file, right click and select ‘Open with > XMetal’. XMetaL does not need to be open already.
- 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.
Note:
- 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.
- 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.
- Open the amending provision. 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.
- Read carefully what the amendment is and where it goes, and proceed accordingly. 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.
- In the amending provision highlight and copy the provision that you need to insert by selecting the ukl:P1 tag (select from ukl:P1group if the provision has a title). You can right-click and copy or use the standard ‘edit’ ‘copy’ menu options from the toolbar. Note:Do not use the BlockAmendment tags to copy the provision or provisions you need to insert. This is not currently supported. If you need to copy multiple provisions highlight them all using the ukl:P1, using ‘shift’ on your keyboard.
- 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.
- Highlight the task in the ‘resource manager’ window.
- Use the menu on the tool bar at the top of your screen to select: Legislation > Textual amendment > Addition.
- 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: . 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. 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.
- 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: Legislation > Check in or continue to the next amendment. Confirmation of this should result in an XMetal Author dialogue window stating; Document is checked in successfully. The amending document will now be checked back in. Please close this when finished with.
- Set the extent of the newly inserted provision. This will be the extent of the affecting provision stated in details for the effect you are carrying out.
- Select 'View' – 'Attribute Inspector' in XMetaL – 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.
- Minimise XMetal and go back to the ‘Update Details’ page and refresh that page.
- Check that all the amendments you carried out in XMetaL are set to ‘edit complete’.
- To check the version history and see how the provision would look in the context of the whole Act, select the preview legislation button and check:
- a. Check that the provision appears in the correct place on the Table of Contents.
- 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.
- 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.
- Select Return to Task Overview to continue to apply further updates or complete the Point in Time.
- 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.
- Once you have completed all the amendments for the PiT you are working on, you can either select Next Step to move onto the next Point in Time or Complete Update to submit your work for review.

What to expect
Insertion of a Chapter
- Repeat steps 1-8 of "Insertion of a whole provision or a number of provisions".
- In the amended provision scroll to find the provision that the new Chapter will follow and place cursor in the appropriate place, after /ukl:Chapter 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.
- Highlight the task in the ‘resource manager’ window.
- Use the menu on the tool bar at the top of your screen to select: Legislation > Textual amendments > Addition.
- Repeat steps 13- 20 of "Insertion of a whole provision or a number of provisions".
Insertion of a Schedule
Text to follow.