Difference between revisions of "Editorial Update/Images"

Revision as of 11:56, 21 December 2022

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 formulas 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, we can now access the Image Update functionality by clicking on an “Update image” button which will appear in the Preview page in place of the missing image. The instructions for using this Image Update functionality are laid out below.

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

Image is contained within a newly inserted or substituted provision

Example 1: Substitution of a provision which includes two formulae

From the Update Details page, select the Preview provision button. You will see the formatted version of the newly substituted provision. Select the first Update Image button:

You will be taken to the Image Data Update page:

Select the radio button for the first formula and then select the Update Affected Image button. You will be taken back to the preview version of the amended provision where the new formula is displayed.

You should then repeat the same process for the second formula, by first selecting the Update Image button, then selecting the radio button for the second formula on the Image Data Update page and then selecting the Update Affected Image button. This will result in the formatting of the images for both formulae in the amended provision:

Example 2: Substitution of a Form in a Schedule

From the preview of the provision, select the Update Image button in the amended Schedule:

On the Image Data Update page, select the radio button of the image to be substituted:

Next, select the Update Affected Image button:

You will be returned to the amended document where the image is displayed. An F-note annotation can be inserted at the Sch. 2 Title level by checking out the Schedule conventionally in XMetal.

What to do if the amending image has not formatted on the Image Data Update page

Example 1: One amending image is missing

In the preview of the amended provision, select the Update Image button.

You will be taken to the Image Data Update page, however the affecting image is missing, and you will not be able to select the Update Affected Image button:

To combat the non-appearance of the amending document’s details, select the amending document’s provision reference from the Editor’s dashboard. Once formatted, copy and paste the URL into the Fetch Custom Provision box on the Image Data Update page (in this example, the URL is https://www.legislation.gov.uk/uksi/2018/425/regulation/5).

The affecting image should then appear and you will be able to select the radio button to the right of the new formula and then select the Update Affected Image button:

You will be returned to the amended provision with the new image formula having replaced the old image formula:

Example 2: Two amending images are missing

From the provision preview, select the first Update Image button:

You will be taken to the Image Data Update page where the affecting images will be missing. To combat the non-appearance of the amending document’s details, select the amending document’s provision reference from the Editor’s dashboard. Once formatted, copy and paste the URL into the Fetch Custom Provision box on the Image Data Update page.

In this example, the affecting provision for both images is:

https://www.legislation.gov.uk/uksi/2016/257/regulation/23/made#regulation-23

Once the Fetch Custom Provision button is selected, the options of the new images from the affecting provision is displayed. Select the appropriate radio button and then select the Update Affected Image button.

You will be taken back to the updated amended provision preview, where the change of formula has been made for the first formula.

Next, repeat this process for the second image by selecting the second Update Image button.

You will again be taken through to the Image Data Update page. Again, paste the URL of the amending document into the Fetch Custom Provision box.

Select the appropriate radio button for the second image substitution and then select the Update Affected Image button.

You will be returned to the updated amended provision preview, with both formulae now having been substituted.

You should then check out the amended provision in XMetal and insert or edit the F-note annotation, if necessary. In this instance the amendment was exclusively to substitute the image formulae without any text so inserting an F-Note conventionally in XMetal was necessary.

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. For example, 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:

S.S.I. 2018/155:

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.

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:

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:

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:

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

@@ Line 274: / Line 274: @@
 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 <strong>Review Editor</strong>.
+See also [[Annotation_Conventions#Textual_amendments_to_images|Annotation Conventions - textual amendments to images]].
 ===Omission of an image===