Difference between revisions of "Editorial Update/Non-textual Amendments"

From Legislation Community Editorial Wiki
Jump to navigation Jump to search
(Created page with "<ol><li> Select ‘Current work’ and from under the heading ‘Online update and review online update’ <strong>select document allocated for online update</strong>.</li>...")
 
 
(50 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
<ol><li> Select ‘Current work’ and from under the heading ‘Online update and review online update’ <strong>select document allocated for online update</strong>.</li>
+
==Overview==
  
−
<li> You will be taken to a page showing a diagram of all the ‘Points in Time’ that have been allocated to you for ‘Edit Update’ and the number of amending effects to be undertaken at each particular point in time. Click on the green ‘<strong>Start Task</strong>’ button to begin.</li>
+
Non-textual effects alter the meaning, scope or application of an affected provision without altering the text. During update, any non-textual amendments are listed under ‘Auto Annotations’ on the Update Overview page.
 +
The system will automatically create an annotation which you need to check and, if necessary, edit.  
  
−
<li> You will be taken to the ‘Update Overview Page’, this page lists the amendment tasks that you need to complete for the first Point in Time you have been allocated. The amendment tasks are grouped into a number of categories:
+
<strong>Note:</strong> If the point in time you are editing says ‘automatic annotations only’ then by default none of the headings listed above will be ‘open’ (the arrows next to the heading will be pointing to the right and not downwards indicating either there are no amendments of that type or that they have all been completed).
  
−
• High Level Amendments: Amendment that will require you to check out more than just a single provision e.g. a whole Part or Schedule.
+
==Checking auto annotations==
−
• Provision Level Amendments: Amendments that only affect individual provisions e.g. insertion of words
 
−
• <strong>Automatic Amendments: These are amendments that do not change the text (but alter the scope or meaning of the text in some way).  The system will automatically create an annotation which you can check and edit if necessary</strong>.
 
  
−
<strong>Note: If the point in time you are editing says ‘automatic annotations only’</strong> then by default none of the headings listed above will be ‘open’ (the arrows next to the heading will be pointing to the right and not downwards indicating either there are no amendments of that type or that they have all been completed).<strong>insert image</strong></li>
+
These instructions assume that you are on the <strong>Update Overview</strong> page. For guidance on the steps required to reach this point, see [[Editorial_Update/Starting_Update_Tasks|Starting Update Tasks]].
  
−
<li> You need to check that the auto annotation that has been applied is correct. To do this <strong>click on the arrow immediately to the left of the heading ‘Auto Annotations’</strong>. This will ‘open’ up the list of amendments.<strong>insert image</strong></li>
+
<ol>
 +
<li>To check that the auto annotation that has been applied is correct, click on the arrow immediately to the left of the <strong>Auto Annotations</strong> heading. This will open up the list of amendments.</li>
 
   
 
   
−
<li> <strong>Click on the first ‘Details’ button</strong> which appears next to each of the provisions that have had an auto annotation applied to them. This will take you to the ‘Update Details’ page.<strong>insert image</strong></li>
+
<li>Click on the <strong>Details</strong> button next to the first provision in the list that has had an auto annotation applied to it. This will take you to the ‘Update Details’ page.</li>
  
−
<li> Check that the amendment’s <strong>status is ‘auto-applied’</strong>.</li>  
+
<li>Check that the status of the amendment has been set as <strong>auto-applied</strong>.</li>  
  
−
<li> Select the <strong>Newly Edited version</strong> tab to see a preview of the updated provision. Check the annotation commentary is listed under ‘modifications’ (there <u>won’t</u> be a corresponding C-note reference in the text of the legislation).  Check that the commentary structure is correct (see additional guidance on commentary conventions for further details).<strong>insert image</strong></li>
+
<li>Select the <strong>Newly Edited Version</strong> tab to see a preview of the updated provision. Check the annotation is listed under ‘modifications’ (there <u>won’t</u> be a corresponding C-note reference in the text of the legislation).  Check that the annotation structure is correct (see more detail on the structure of non-textual effect annotations in [[Editorial_Update/Annotation_Conventions#C-notes_.28Non-textual_Effects.29|Annotation Conventions]]).</li>
  
−
<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:
+
<li> To check the version history and see how the provision would look in the context of the whole item of legislation, select the <strong>preview legislation</strong> button and check:
  
−
* The right point in time has been created at provision level to accommodate this amendment.
+
* the right point in time has been created at provision level to accommodate this amendment;
−
* and the annotation commentary is correct.
+
* the annotation is correct.
  
−
Note: a Point in Time will be created even if that Point in Time only contains non-textual amendments.<strong>insert image</strong></li>
+
<strong>Note:</strong> a Point in Time will be created even if that Point in Time only contains non-textual amendments.</li>
  
−
<li> If you spot an error in the commentary you can check out the provision and edit the commentary:
+
<li> If you spot an error in the annotation you can edit it using the <strong>[[Editorial_Update/Annotation_Conventions#Editing_annotations_in_the_website_preview|edit function]]</strong> in the preview, or you can check out the provision and edit the annotation in XMetaL:
  
−
* Select ‘<strong>Check out for edit</strong>’ from the ‘Update Details’ page, this will launch XMetaL, ready for you to edit the commentary.
+
* Select <strong>Check out for edit</strong> from the <strong>Update Details</strong> page to open the provision in XMetaL and carry out your edits.
−
* Once you are satisfied that the annotation is correct. Go to the menu at the top of the screen and check in your work: <strong>Legislation > Check in</strong>.
+
* If the annotation has not been generated and is completely missing, you can insert the annotation by placing the cursor after the opening <code><ukl:Pnumber></code> tag and selecting the task in <strong>Resource Manager</strong>. Next select <strong>Legislation -  Non-Textual Amendments - Insert Commentary</strong> from the menu bar at the top of the page. The annotation inserted should be a C-note, you can check this by looking in the <strong>Attributes</strong> (select <strong>View - Attribute Inspector</strong> from the top menu bar).  
 +
* 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>
 +
 +
<br>
 +
*Click <strong>OK</strong> in the pop-up  [[File:Document_is_checked_in_successfully.png|link=]]</li>
 +
<br>
 +
 
 +
<li>Minimise XMetaL and go back to the <strong>Update Details</strong> page and refresh the page by pressing <code>CTRL</code> and <code>F5</code>.</li>
 +
 
 +
<li>Check that you are satisfied with any changes you have made using the <strong>Newly Edited version</strong> tab. To preview the annotation and to check the timeline and see how the provision would look in the context of the whole item of legislation, select the <strong>Preview Legislation</strong> button.</li>
 +
 
 +
<li>You can now [[Editorial_Update/Starting_Update_Tasks#Navigating_the_Update_Task|navigate]] to the next part of your update task.</li>
 +
 
 +
</ol>
 +
 
 +
==Scenarios==
 +
 
 +
===Missing task details for non-textual amendments on the Update Details page===
 +
 
 +
See:
 +
 
 +
[[Editorial_Update/Approach_to_Update,_Specific_Update_Issues_and_Update_Troubleshooting#Missing_task_details_for_non-textual_amendments_on_the_Update_Details_page|Missing task details for non-textual amendments on the Update Details page]].
 +
 
 +
===Applying “Appointed Day(s)” effects as P-notes===
 +
 
 +
These effects are usually recorded along with a Suggested Commentary that gets used to construct the annotation, in the format:
 +
 
 +
[Provision number]: [Date] specified for the purposes of [specified provision] ...  
 +
 
 +
They are auto-applied by the Editorial System as P-notes, see for example:
 +
 
 +
https://www.legislation.gov.uk/eur/2017/625/article/154
 +
 
 +
https://www.legislation.gov.uk/eur/2017/625/annex/6
 +
 
 +
See also [[Preparation_Tasks/Record_Effects#Exercises_of_power_to_appoint_a_day_or_specify_a_date|Exercises of power to appoint a day or specify a date]] on the Record Effects page.
 +
 
 +
==Related Pages==
  
−
Confirmation of this should result in an XMetal Author dialogue window stating;
+
===Editorial Principles===
−
Document is checked in successfully.</li>
 
  
−
<li> Minimise XMetaL and go back to the ‘Update Details’ page and <strong>refresh that page</strong>.</li>
+
*[[Editorial_Principles#Non-textual_Effects|Non-textual Effects]], including [[Editorial_Principles#Examples_of_non-textual_effects|Examples]]
  
−
<li> Check that you are satisfied with any changes you have made using the <strong>Newly Edited version</strong> tab to preview the commentary annotation.</li>
+
===Editorial Update===
  
−
<li> If there are more amendments to be made to the Point in Time you are working on you can use the ‘Next and Previous’ buttons on the ‘Update Details’ page to move onto the next provision. Alternatively, select <strong>Return to Task Overvie</strong>w. You should find that the bar chart diagram has turned partially green indicating that either part or all the amendments within that point in time have been completed.</li>
+
*[[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/Applying_“coming_into_force”_effects|Coming Into Force Effects]]
  
−
<li> If there are no more effects to be applied to your Act, from the ‘Update Overview’ page select: <strong>Complete update > Last step</strong>.  If you have been allocated multiple Point in Times to update select <strong>Next Step</strong> to continue to the next Point in Time.</li></ol>
+
Approach, errors 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 15:59, 6 March 2025

Overview

Non-textual effects alter the meaning, scope or application of an affected provision without altering the text. During update, any non-textual amendments are listed under ‘Auto Annotations’ on the Update Overview page. The system will automatically create an annotation which you need to check and, if necessary, edit.

Note: If the point in time you are editing says ‘automatic annotations only’ then by default none of the headings listed above will be ‘open’ (the arrows next to the heading will be pointing to the right and not downwards indicating either there are no amendments of that type or that they have all been completed).

Checking auto annotations

These instructions assume that you are on the Update Overview page. For guidance on the steps required to reach this point, see Starting Update Tasks.

  1. To check that the auto annotation that has been applied is correct, click on the arrow immediately to the left of the Auto Annotations heading. This will open up the list of amendments.
  2. Click on the Details button next to the first provision in the list that has had an auto annotation applied to it. This will take you to the ‘Update Details’ page.
  3. Check that the status of the amendment has been set as auto-applied.
  4. Select the Newly Edited Version tab to see a preview of the updated provision. Check the annotation is listed under ‘modifications’ (there won’t be a corresponding C-note reference in the text of the legislation). Check that the annotation structure is correct (see more detail on the structure of non-textual effect annotations in Annotation Conventions).
  5. To check the version history and see how the provision would look in the context of the whole item of legislation, select the preview legislation button and check:
    • the right point in time has been created at provision level to accommodate this amendment;
    • the annotation is correct.
    Note: a Point in Time will be created even if that Point in Time only contains non-textual amendments.
  6. If you spot an error in the annotation you can edit it using the edit function in the preview, or you can check out the provision and edit the annotation in XMetaL:
    • Select Check out for edit from the Update Details page to open the provision in XMetaL and carry out your edits.
    • If the annotation has not been generated and is completely missing, you can insert the annotation by placing the cursor after the opening <ukl:Pnumber> tag and selecting the task in Resource Manager. Next select Legislation - Non-Textual Amendments - Insert Commentary from the menu bar at the top of the page. The annotation inserted should be a C-note, you can check this by looking in the Attributes (select View - Attribute Inspector from the top menu bar).
    • 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


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

  7. Minimise XMetaL and go back to the Update Details page and refresh the page by pressing CTRL and F5.
  8. Check that you are satisfied with any changes you have made using the Newly Edited version tab. To preview the annotation and 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.
  9. You can now navigate to the next part of your update task.

Scenarios

Missing task details for non-textual amendments on the Update Details page

See:

Missing task details for non-textual amendments on the Update Details page.

Applying “Appointed Day(s)” effects as P-notes

These effects are usually recorded along with a Suggested Commentary that gets used to construct the annotation, in the format:

[Provision number]: [Date] specified for the purposes of [specified provision] ...

They are auto-applied by the Editorial System as P-notes, see for example:

https://www.legislation.gov.uk/eur/2017/625/article/154

https://www.legislation.gov.uk/eur/2017/625/annex/6

See also Exercises of power to appoint a day or specify a date on the Record Effects page.

Related Pages

Editorial Principles

Editorial Update

Approach, errors and troubleshooting:

Retrieved from ‘http://community.legislation.gov.uk/mediawiki/index.php?title=Editorial_Update/Non-textual_Amendments&oldid=16776’