Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Test Case

Expected outcome

Pass / Fail

Tester’s Comments

1

Login to Lawmaker as a PCO user

Overview of Lawmaker Projects and documents

Dashboard displayed or last tab associated to the project you last viewed.

Top-right of the screen shows that I am logged in with my username

Able to see projects that have been created by PCO users

Able to see projects that have a published Bill or Act in them from other organisations

Unable to see projects created by other organisations that do not have a published Bill in them

Status
colourGreen
titlePass

all tests passed

2

Create a New Project

Select Scottish Public Bill > Government Bill

Creating a new project

Note

Ensure you include the word “Bill” at the end of the project/bill Title as a real bill would (this is necessary to test bill-to-act conversion later on in the script)

A new project is created, visible only to users in the same organisation as the current user

It appears on the main Dashboard

Project tab opens for the new document

Editor opens in a new tab showing an ‘empty’ document

Status
colourGreen
titlePass

all tests passed

3

In the Editor, click on Body placeholder

Inserting provisions and other elements

Build-up the Bill Structure by creating: Parts, Chapters, Cross Headings, Sections, sub-sections, paragraphs, and the equivalent Schedules.

Also, create some other elements (eg: definitions, lists)

CCA is displayed

Selecting and adding provisions creates a realistic looking Bill

Structure view (left-hand side of the Editor window) is updated in line with new elements created in the Editor

Status
colourGreen
titlePass
Status
colourRed
titleFail

all tests passed

4

Press Ctrl+S or click on the Save button

Saving your document

From v16.0 onwards, it is possible to cancel the Save action by clicking the ‘cancel' bar at the bottom of the window, provided the save process has not progressed too far

A progress bar appears and progresses to 100%

A message is displayed saying ‘Document Saved’

On the project tab, the version last modified is the same as the time it was saved

Status
colourGreen
titlePass
Status
colourRed
titleFail

all tests passed

5

Add one or more J-Refs to Sections or Schedules

Managing J-refs

J-Refs are displayed in the Editor in Red

Status
colourGreen
titlePass
Status
colourRed
titleFail
with caveat

I am able to add J-refs but if you use the keyboard to select the ‘Save’ button in the add J-ref modal you’ll see a warning banner - logged as SPT-1619:

image-20240219-135540.pngImage Added

6

Create cross reference(s) to sections that contain J-refs.

Cross-references (x-refs)

Click Tag X-refs

Use the Tools menu to display the J-refs in the cross-references (Tools > Show/hide J-refs in cross references)

J-ref should show in square brackets next to the X-ref

Fail
Status
colourGreen
titlePass
Status
colourRed
title

all tests passed

7

Turn on Tracked Changes

Using tracked changes

Delete one or more elements / Insert element(s) and move element(s)

Turn off Tracked Changes

Inserted and deleted text and elements are displayed in the editor and blue (inserted) or red (deleted)

Fail
Status
colourGreen
titlePass
Status
colourRed
title

passed - but note SPT-1611 about Oxygen exceptions occurring when clicking ‘Accept all’ on tracked changes

8

Insert a Table of Contents

Inserting table of contents

Table is inserted at the start of the document

Status
colourGreen
titlePass
Status
colourRed
titleFail

all tests passed

9

Generate PDF

Generating and viewing a PDF

Ensure:

  • ‘Show tracked changes’ is ticked

  • Select ‘Line numbering’

  • Select 'Side-lining'

  • Select ‘Show J-Refs in margins’

  • Select ‘Show J-Refs within cross references’

  • Deselect ‘Record Snapshot’

  • Add a Version Description (random text)

PDF is generated in separate tab; success toastie displays in the bottom-right

Table of Contents is included

Tracked changes are displayed in red for deleted text; blue for inserted text

Line numbering is present and continues throughout the whole document

J-Refs are shown in margins

J-Refs are shown with x-refs

No snapshot is visible on the Project tab

Fail
Status
colourGreen
titlePass
Status
colourRed
title

all tests passed

10

Make some more small changes and close the Editor using the button in the top-left

Prompted to Save changes

Save modal includes the option to save, discard, or cancel

(If the option to save is selected) Changes are saved

(If the option to discard changes is selects) Changes are not saved

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

11

Duplicate a document version

Duplicating a document version

Expand
titleSteps

Click the Actions menu next to a particular version

Select ‘Duplicate’

In the modal, add a new folder and give the version a new name

New folder created with a duplicated version inside it

Folder name and version label correspond to what was typed into the modal

Fail
Status
colourGreen
titlePass
Status
colourRed
title

passed

12

Use the fold button to collapse all sections in a document, and use the Structure View to expand a particular provision

Folding provisions

Expand
titleSteps

Import a reasonably large Bill: https://www.legislation.gov.uk/asp/2022/5/contents

Import legislation from www.legislation.gov.uk

Open the newly created version in the editor,

Click the Fold button to collapse all provisions

Now select a section from the structure view

The Editor will jump to the selected provision, and unfold it

fold button

Fail
Status
colourGreen
titlePass
Status
colourRed
title

pass, but note the known issue where the selected and following schedule para are unfolded on selection

13

Renumber whole bill

Renumbering provisions

All the provisions are renumbered in the Editor

The numbering in the structure view is sequential

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

14

Delete all J-refs

https://lawmaker.atlassian.net/wiki/spaces/USERMANUAL/pages/9339123/Managing+J-refs#How-to-delete-all-J-refs

No J-refs visible in the Editor
No J-refs visible in the Structure View

Fail
Status
colourGreen
titlePass
Status
colourRed
title

passed

15

Edit Portion of a document

Opening and editing a portion of document

Note
  1. Your selection can’t include different hierarchical levels (e.g. a whole part and a section from another part) - instead you need to select both parts or only select the sections from each part that you need to edit.

  2. Renumber and tag/update x-refs will only be run over the provisions you have in the Editor - not the whole document in the backend.

The selected subset of provisions is opened in the Editor

The section or schedule nums are locked or grouping level nums (for body only - not in schedules)

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

16

Share with Scottish Parliament

Sharing a document with another organisation

Using the menu next to a version of the Bill on the Project Tab, select Share version and choose the Scottish Parliament

Significant version of the Bill appears on the project tab with the same name as the working version

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

17

Login as a Scottish Parliament user and view shared significant version

Duplicate the significant version to create a new working version

The project should be accessible from the dashboard

A significant version of the Bill will appear on the Project Tab with the same name as the original working version

After duplicating, a working version of the Bill will appear on the project tab with the specified name under the specified folder heading

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

18

Check and edit document information for the bill using the Document Information panel in the Editor

Add an Introduction Date

Managing document information

Note

Note that there is sometimes a delay between changing a value in this panel and the text changing in the main editor pane

Document information displays correctly

Able to edit: Title, Session, Year, Rubric

Details are changed or populated in the main editor pane after the change is made in the Doc Info panel

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

19

Manage members on a bill

Add a proposer and supporters to the Bill (using the manage members modal which is accessible from the Doc Info panel)

Managing document information

Manage Members modal displays

Able to search for SP members in the ‘Proposer’ and ‘Supporter’ fields

Able to pick names from the dropdown list

Able to click Update to add the members to the bill

Able to click Cancel to close the modal without saving changes

Fail
Status
colourGreen
titlePass
Status
colourRed
title

passed

20

Add Back cover to the Bill

Inserting Scottish Bill and Act front and back covers

Back cover will be inserted at the end of the Bill in the Editor

Back cover shows the Bill is being introduced by the proposer

Back cover shows the Bill is being supported by the supporters

Back cover shows the introduction date

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

21

Generate PDF of the bill and publish it

Publishing a Bill document version

Able to generate a PDF

Able to publish a PDF

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

22

Duplicate the published significant version of the Bill

Duplicating a document version

Able to create a duplicate working version from the significant version

Status
colourGreen
titlePass
Status
colourRed
titleFail

pased

23

Update document info for the Bill (As amended at Stage 2)

Managing document information

Expand
titleSteps

Open the duplicated ‘As Introduced’ version in the Editor

Update the ‘Version rubric’ in the Document Information panel on the right; pick the ‘As Amended at Stage 2’ version rubric

Rubric text in the Editor is updated accordingly

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

24

Share with PCO

Sharing a document with another organisation

A significant version of the Bill will appear on the project tab with the same name as the working version

Significant version will be visible to PCO users as well

The significant version will not be visible to other users (e.g. HoC/HoL)

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

25

Login as an SP user and create Act version of Scottish Bill:

Converting a Scottish Bill into an Act

New working version created containing an act version of the Bill

Status
colourGreen
titlePass
Status
colourRed
titleFail

26

Update passed

26

Open the Act version in the Editor and update document info for SP Act:

Update ‘Passed Date’ and ‘Assent Date’ in the Document Information pane in the Editor

Preface of the Bill is updated accordingly

Status
colourGreen
titlePass
Status
colourRed
titleFail

passed

27

Generate PDF of this version (official print)

PDF snapshot created and visible on the Project Tab

status
Status
colourGreen
titlePass

passed

colourRed
titleFail
28

Publish Official print

28

Submit Act version to TNA

Submitting a Scottish Act to TNA

A significant version of the Act will be created on the project tab

The significant version will be visible to users in other organisations

A copy of the Act is available through the PDR API

Fail
Status
colourGreen
titlePass
Status
colourRed
title

passed

29

Download zip file

Downloading a ZIP file of a document

A zip file is created containing XML, PDF and (where the bill contains images) TIFF files

Fail
Status
colourGreen
titlePass
Status
colourRed
title

passed

30

31

32