Editorial Update/Images

From Legislation Community Editorial Wiki
Jump to navigation Jump to search

Using the Image Tool to insert and substitute images

We can now insert and substitute images using the Editorial Image Tool in the website Preview. The most common images we deal with are formulae and forms. Where, following an amendment in XMetaL, an expected image does not appear as part of the inserted/substituted text when we preview it, or where we simply need to substitute an existing image within a provision, we can now access the image update functionality by clicking on an “Update image” button which will appear in the Preview page in the location of the image. The instructions for using the image update functionality are laid out in the sections below.

Before you use the Image Tool

WARNING: For update tasks involving multiple PiTs, where we have edited Forms images (especially where we are doing several actions, such as inserting, substituting or repealing multiple forms at a specific PiT), the editorial system sometimes gets confused about their start dates and mixes up old and new images a few PiTs further down the line. So, firstly, always check that you have used the timeline resolver to make sure the correct PiT is in place before you start using the image tool to edit the Forms. Secondly, once you have edited Forms images submit for early review at that PiT. The reviewer can then review and publish them and the update feed on publishing will hopefully stabilise the start dates for the images. The update can then be re-allocated back to the editor to carry on with the remaining update.

Also note:

1. If your amendment only involves substituting an existing image within a provision that otherwise stays the same, don't forget to make sure that the PiT for that amendment is showing on the timeline before you carry out the substitution, otherwise you will substitute the image in a previous PiT. Use the timeline resolver to add in the PiT you are working before you substitute the image.


2. The image tool was developed to work with existing image tagging structures. If your amending document includes an image or form that has been tagged in an unconventional way, such as with ukl:IncludedDocument tagging, the image tool cannot currently be used to insert the form or other image as the tagging will not be recognised by the Tool. The form or other image will be missing after you have carried out your amendment and you will need to refer it to TSO in the usual way to get the image or form added.


3. If the “Update image” button is missing from your provision when you preview it, you can click on "Image Data View" in the left hand menu in the preview to display it in the Image Data view: 

Image data view.png


4. When you use the image tool to carry out an insertion or substitution of an image and the amendment only affects that image and not the surrounding text, you do not need to insert any square brackets for the amendment but you will need to make sure you insert an F-note for the amendment in a suitable location.


Other amendments to images

Textual amendments to images

If an image is not being wholly inserted or substituted, but there are textual amendments being made to the details of forms, maps, diagrams, etc. that are held as image files, we are unable to edit the image files ourselves. Instead, Update Editors should manually insert an F-note annotation in a suitable position, invariably at Provision/Part/Schedule/ level, in relation to the form/map/diagram tagging and provide a more explanatory annotation using the drafter’s text.

See Annotation Conventions - textual amendments to images for examples of the form of words to use in the F-note.

A suitable position for the F-note reference might be within the <ukl:Number> tags of the Schedule that contains the form, or within the <ukl:Title> tags of the form if available (see examples below). The Element List window will show you whether it is possible to insert a <ukl:CommentaryRef> tag in your chosen location.

S.I. 2013/3156, Sch. para. 23:

Image amendment 1.png

Image amendment 2.png

S.S.I. 2018/155:

Image amendment 3.png

If the amendments are more complex or so large that it seems unfeasible to include details in the annotation, then we could summarise the amendments in the annotation rather than giving verbatim text, but there should still be a more explanatory F-note than usual. If you have any difficulty formulating such an annotation, consult a Review Editor.

See also Annotation Conventions - textual amendments to images.

Omission of an image

If an amendment requires that an image is omitted, the tagging for the image should be repealed and the image replaced with a dotty line with an F-note:

Image omitted 1.png

Image omitted 2.png

In this example, the forms are located within a Schedule paragraph that has been tagged as a ukl:P1Group, and it was possible to include the dotty line in the XML as follows:


Repeal of a form 3.png


Alternatively, where the image is not contained in a paragraph with its own set of tagging, but is located directly in the ukl:ScheduleBody, a set of ukl:P tags containing the dotty line followed by a non-breaking space and F-note reference may be inserted at the appropriate place, and the existing image and it's tagging can be removed. For example:


Repeal of a form.png


Repeal of a form 2.png


If you are unsure how to do this, contact a Review Editor and they can ask TSO to do the amendment if neccessary.

Retrieved from ‘http://community.legislation.gov.uk/mediawiki/index.php?title=Editorial_Update/Images&oldid=13484’