Difference between revisions of "Editorial Update/Update Editor Checklist"

Revision as of 09:56, 5 January 2023

DRAFT - page being edited

1. Research: is the amendment data correct? do you know what to do when you carry out the update? 2. XMetaL: has your amendment been applied correctly? 3. Preview: double check the point in time (PiT), amendment and annotation before moving on 4. Issues: if you can’t apply your amendment or something goes wrong, check Wiki for workarounds and talk to someone about it first before moving on

Research

Check the TOES data for your amendment

You can use these URLs to check the TOES data:

https://editorial.legislation.gov.uk/changes/affected/<type>/<year>/<number>/data.xls?extended=full-with-co&sort=affecting-year-number

https://editorial.legislation.gov.uk/changes/affecting/<type>/<year>/<number>/data.xls?extended=full-with-co&sort=affecting-year-number

Does the TOES data reflect the amending provision?

Open the amending legislation in legislation.gov.uk and check:

Most importantly, is the effect recorded against the correct affected legislation?

Is the type of effect right?

Commencement?

Is there a commencement order? Look at that.

Extent? Check the extent provision.

Should it be a limited extent/TA amendment? If so, does it require concurrent versions?

Are there savings/transitional provisions?

Is there a Comment to Editor saying your amendment contains (or confers) a power?

Approach to update

Where unsure about what to do, have you consulted the Wiki guidance? If you cannot find what you need, ask a reviewer. Perhaps the Wiki guidance could be added to or improved. Feed this back to Sarah and Richard.

For instructions about how to do provision level and high level insertions, substitutions and repeals, follow the links on the Textual amendments page.

Renumbering provisions: remember that brackets only need to go around the provision number.

Beware in particular of unequal substitutions and high level amendments which change the structure of the document. If in doubt, talk to a reviewer to check your approach before continuing.

See more on Approach to Update, Specific Update Issues, Common Update Errors and Applying partially in force amendments which are then brought further into force over time.

XMetaL

See the detailed guidance on XMetaL and XML tagging.

Look out for:

Beware the order of tasks in the XMetaL Resource Manager. It does not always follow the same order as the tasks shown on the Update Details page. It tends to put whole sub-provision additions first and whole sub-provision repeals last.

Beware amendments to certain types of tagging: sub-provision AND word/s (watch out for pesky conjunctions), definitions, ordered and unordered lists, Annexes in retained EU law, etc. You may need to do more to apply your amendment than just selecting the text and choosing the XMetaL amendment option.

In particular, in ordered lists in definitions (or in retained EU law provisions) you may need to use the number override attribute in the attribute inspector to get the right paragraph number to show in preview.

It may be better to select a part of the amendment tagging and do your amendment step by step rather than picking up the whole amendment by using the block amendment tags.

Where tagging needs to be changed, use the element list. Do not copy and paste tagging (or, if you do, be sure to remove its attribute metadata, e.g. restrict start date, extent, etc).

See the guidance on working with tables on the Tables page.

Check your amendment has actually been registered in XMetaL after you think you’ve applied it. An amendment will not be applied if your cursor is in an illegitimate position in the XML tagging, but XMetaL doesn’t warn you, it just sends you down the page to look at the annotation. Scroll back up to look at what you think you’ve just done to the XML.

Pay attention to existing amendment brackets and commentary references (or comrefs) for drafter’s footnotes as well as existing editorial annotations. This may determine where you place your cursor. Will applying your amendment remove a bracket or a comref? Where all the words for an existing amendment are now removed/replaced then the existing brackets can go. But where one or more words remains the original brackets should remain around those words.

Does the drafter’s footnote need to be kept any longer?

Check annotation (type of effect, affecting provision) while in XMetaL to see if it says what you were expecting, i.e. check that it is the correct annotation for the effect you have just applied. If not, it’s simple to UNDO the effect while still in XMetaL.

If the inserted/substituted text contains a power, have you set the power attribute in the attribute inspector to power = true?

See more on Approach to Update, Specific Update Issues and Common Update Errors.

Preview

Double check your amendment in the update details preview and website preview once checked in.

Look out for:

Sometimes things can go wrong on check in. You may need to refresh the page to see your changes (Ctrl+F5).

Beware common update errors.

Is your PiT reflected in the timeline on website preview? Your amendment may not be visible if the timeline is wrong. Click on the timeline resolver button in website preview to fix this. You can select a PiT to add from the dropdown menu.

Check spacing and punctuation. Are the amendment brackets in the correct position or has one or both of them slipped to an incorrect position, to the end of the provision for example?

Check for images (e.g. formulas and forms) in the affecting provision and, if present, ensure that you use the image tool in website preview to make them appear in your amended provision.

Check that your new annotation reflects the TOES data. In particular check that the In Force Date, In Force Date Qualification and Commencement Order details have been correctly added. (Sometimes dates get reversed or the IFDate and IFDQ data hasn’t come through into the annotation as we would expect).

Blanket amendments: please remember to add a note for reviewer to tell them which provisions you have amended.

See more on Annotation Conventions and Applying partially in force amendments which are then brought further into force over time.

If you need to correct an annotation you can use the edit annotation button in preview or fix it in XMetaL, but beware hyperlinks for multiple cited affecting sub-provisions at same level.

Non-textual auto annotations

Spot check I-notes (coming into force effects), but pay particular attention where affected provision in TOES is complicated, e.g. multiple ranges of sub-provisions or combinations of non-sequential sub-provisions cited. You can use the skeleton view to do this or open the whole doc in website view and use Ctr+F to search for the date in the I-note annotations.

Double check C-notes (non-textual amendments) against TOES data and affecting provision and pay particular attention to “amendment to earlier affecting provision” effects which will require some kind of editorial action and should not really be classed as auto annotations.

Issues

Can you apply your amendment?

If not, please investigate and try to work out why not (TOES error now or earlier? Have we missed an earlier amendment or applied it incorrectly? Is there an error in the affecting legislation?) and then contact a reviewer to consult about the best way of dealing with the situation.

After consulting, do what was agreed and add a note for the reviewer next to the problematic task explaining what you’ve done, what advice you received and who from.

If the problem derives from an error in the affecting legislation, remember to log a Lex Error and add a note for reviewer to tell them you’ve done so:

If there is a system error in carrying out your amendment or an error in the annotation in that it does not properly reflect the TOES data, this should be raised in an email to Richard with a brief description of the issue, details of the TOES effect and the update details page URL so we can feed it back to TSO.

Below are links to common update problems and workarounds:

Update Troubleshooting

Specific Update Issues

Manual Amendments

Where you’ve had to “bodge” an amendment (i.e. by correcting tagging and copying and pasting text), compare the text of your new amended provision to the affecting provision to make sure it’s right using this tool: https://text-compare.com/

Revision as of 09:38, 5 January 2023 (view source) Shayman (talk \| contribs) (→‎Approach to update) ← Older edit		Revision as of 09:56, 5 January 2023 (view source) Shayman (talk \| contribs) Newer edit →
Line 1:		Line 1:
		+
		+	<mark>DRAFT - page being edited</code>

	{\| 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;		{\| 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;