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 an OPC user

Overview of Lawmaker

Note

Dashboard Functionality is tested in other scripts

Dashboard displayed (or last tab associated with the project you last viewed)

Top-right menu on the dashboard shows that I am logged in with my username

Able to see projects that have been created by OPC 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
Status
colourRed
titleFail
(delete as appropriate)

2

Create a New Project

Select UK Public Bill > Government Bill

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)

Creating a new project

Expand
titleSub tests

Can select:

-types

-sub-types

-title

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 template document

Status
colourGreen
titlePass
Status
colourRed
titleFail

3

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

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

4

Click on Body placeholder

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

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

Tip

You can copy and paste elements eg: create one part, with various sub elements and then copy to create more structure.

You can copy text for your bill from http://legislation.gov.uk

CCA is displayed

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

5

Insert 2 schedules

The "SCHEDULES" heading will appear before the first schedule

If “Auto-renumbering” is OFF then schedules will not be renumbered 

If “Auto renumbering” is ON then schedules will not be renumbered (feels counter intuitive but is technically by design if not intention) 

Status
colourGreen
titlePass
Status
colourRed
titleFail

6

Press Ctrl+S or click on the Save button

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

7

Renumber the whole Bill

Renumbering provisions

All provisions will be renumbered sequentially including all their descendants.

Note

This action shouldn’t renumber any locked numbers, and those locked numbers will influence subsequent numbers

Status
colourGreen
titlePass
Status
colourRed
titleFail

8

Add one or more J-Refs to Sections or Schedules

(v13) Managing J-refs

J-Refs are display in the Editor in Red

And the J-ref will be visible in the structure view

Status
colourGreen
titlePass
Status
colourRed
titleFail

9

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

Click Tag X-refs

(v13) Cross-references (x-refs)

You can toggle on and off to display the J-ref in cross-references (Tools > Show/hide J-refs in cross references)

Status
colourGreen
titlePass
Status
colourRed
titleFail

10

Turn on Track Changes

Using tracked changes

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

Inserted and deleted elements are display in the editor and blue (insert) or red (deleted)

Status
colourGreen
titlePass
Status
colourRed
titleFail

11

Insert a Table of Contents

Inserting table of contents

Table of Contents is inserted at the start of the document

"Front cover" appears in the Structure View

Status
colourGreen
titlePass
Status
colourRed
titleFail

12

Generate PDF

Generating and viewing a PDF

Ensure:

  • Show tracked changes is ticked

  • Select Side-lining

  • Show J-Refs in margins

  • Show J-Refs within cross references

  • Deselect Record Snapshot

  • Add Version Description (random text)

PDF is generated in separate tab

Table of Contents is included

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

J-Refs are shown in margins

J-Refs are shown with x-refs

No snapshot is visible on the Project tab

PDF Version is named using the text entered in the ‘Version description’ field

Status
colourGreen
titlePass
Status
colourRed
titleFail

13

Delete the table of contents

Expand
titleTips

Place your curser in the ToC

Click on ToC on the Breadcrumb

Press delete or backspace

Table of contents is removed

Status
colourGreen
titlePass
Status
colourRed
titleFail

14

Close the Editor

Prompted to Save changes

Status
colourGreen
titlePass
Status
colourRed
titleFail

15

Duplicate a document

Expand
titleTips

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

Documents and folders on the Project Tab

New folder created with a duplicated version inside it

Note

Documents and the folders on the 'Project' tab are now sorted alphanumerically. By default, folders will always be collapsed when you first open a project.

Status
colourGreen
titlePass
Status
colourRed
titleFail

16

Open a document version in the Editor

Use the fold button in the toolbar, then use the Structure View to expand a particular provision

Folding provisions

Expand
titleSteps

Import a reasonably large Bill: https://www.legislation.gov.uk/ukpga/2023/36/contents/enacted

Import legislation from www.legislation.gov.uk

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

Status
colourGreen
titlePass
Status
colourRed
titleFail

17

Create a new working version

Expand
titleSteps

On the Project tab, click Document Actions

Select Create New working version

In the modal, create a new folder or select an existing folder

Input a new name for the new version

Click Create

A new working version is created which will appear on the 'Project' tab under the appropriate folder heading.

Clicking on it to open it in the Editor will reveal an empty new document, allowing you to start drafting

Status
colourGreen
titlePass
Status
colourRed
titleFail

18

Edit Portion of a document

Opening and editing a portion of document

Note
  1. You can't select 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

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

Status
colourGreen
titlePass
Status
colourRed
titleFail

19

Close the Editor and Finalise the document

Info

To test the ‘Renumber’ part of the Finalise action, you should randomly renumber some of the provisions using the Editor and save the document

Finalising a document

Assuming you selected all options:

All provisions in the document, including provisions in quoted structures, are renumbered

All existing cross references in the document and update them accordingly - including those within quoted structures

If Insert Front Cover is selected: any existing front cover is replaced, including the Table of Contents

If you select Insert Table of Contents: any table of contents if there is one but will leave other parts of the front cover as they are.

Status
colourGreen
titlePass
Status
colourRed
titleFail

20

Move a version to a new folder

Documents and folders on the Project Tab

Selected version is moved to another existing folder or to the newly created folder specified in the modal

Status
colourGreen
titlePass
Status
colourRed
titleFail

21

Share a version with the House of Commons

Sharing a document with another organisation

A Significant version of the Bill is created on the project tab

This version is also visible to HoC users

This version is not visible to users in other organisations

Status
colourGreen
titlePass
Status
colourRed
titleFail

22

Login as a HoC user

Dashboard displayed (or last tab associated with the project you last viewed)

Top-right menu on the dashboard shows that I am logged in with my username

Able to see projects that have been created by HoC 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
Status
colourRed
titleFail

23

Open the project created by OPC in previous steps

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

Status
colourGreen
titlePass
Status
colourRed
titleFail

24

Make a working copy of the significant version

Expand
titleSteps

Use the Actions menu next to the Significant version

Select Duplicate version

Choose a folder name

Choose a version name

Click Create

A working version of the Bill is created, duplicating the content of the significant version

The new working version appears in the selected folder or newly created folder (with the name specified in the modal)

Able to open and edit the new working version

Status
colourGreen
titlePass
Status
colourRed
titleFail

25

Mark sections/schedule paragraphs/subsections/schedule sub-paragraphs in UK Bill as "money provision" so that it (and all its descendants) is rendered in italics in the Editor and PDF

Marking 'money provisions'

Able to set provisions as money provisions

Money provisions should appear italic in the Editor and in the generated PDF

Descendants of those provisions also display in italics

Status
colourGreen
titlePass
Status
colourRed
titleFail

26

Update document information for the new working version

Example details to add/change:

Session: 58/1, Bill year: 2021, Bill number: Bill 221, version rubric: "As introduced", printed by: "House of Commons"

Managing document information

Bill title and version rubric are updated in the editor, corresponding to the changes made in the Doc Info panel

On the Dashboard showing all projects, Bill number and session are updated

Status
colourGreen
titlePass
Status
colourRed
titleFail

27

Manage proposers and supporters on a Bill in the Editor

Managing proposers and supporters on inline amendments

Able to add and remove proposers and supporters

Able to change the order of names by dragging and dropping in a different order

Status
colourGreen
titlePass
Status
colourRed
titleFail

28

Add Back cover to the Bill

Inserting UK Bill and Act front and back covers

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

And the back cover will show the Bill is being introduced by the proposer

And the back cover will show the Bill is being supported by the supporters

And the back cover will show the introduction date

Status
colourGreen
titlePass
Status
colourRed
titleFail

29

Re-insert the Back cover after changing proposers and supporters and updating the printed date

Back cover is reinserted and replaces the existing one

And proposers/supporters names are updated

And the printed date is updated

Status
colourGreen
titlePass
Status
colourRed
titleFail

30

Insert a Front cover

Inserting UK Bill and Act front and back covers

Front cover shows the Bill title in the editor

Any existing Table of Contents is replaced with an up-to-date Table of Contents

Status
colourGreen
titlePass
Status
colourRed
titleFail

31

Generate a PDF of the Bill with line numbering and footers; include a footer note

Generating and viewing a PDF

Expand
titleSub tests

Make sure there are some track changes edits in the version of the Bill

In the ‘Generate PDF’ modal, select ‘show changes applied’

Confirm that output PDF shows changes applied

PDF opens in new tab

And the PDF contains line numbering and footers

Footer note text is correct

Status
colourGreen
titlePass
Status
colourRed
titleFail

32

Publish a significant version of the generated PDF

Publishing a Bill document version

Significant version created on the right-hand side of the Project tab

Significant version visible to users in other organisations

Copy of the Bill accessible through the PDR API

Status
colourGreen
titlePass
Status
colourRed
titleFail

33

Create an ‘as amended’ folder by duplicating a version

Expand
titleSteps

Using the Actions menu next to a version on the Project tab, select Duplicate version

Create a new folder (“Committee”) and give the version a label (“as amended”)

Tick the option which removes page/line numbers

New working version with the specified name in the specified folder is created

Status
colourGreen
titlePass
Status
colourRed
titleFail

34

Open the newly created ‘as amended’ version in the editor and change some Document Information:

Change the ‘printed' date

Update the document rubric

Re-insert the front and back covers

Text shown in the main Editor pane update accordingly

Text on the front and back covers is updated accordingly

Status
colourGreen
titlePass
Status
colourRed
titleFail

35

Share a new copy with the House of Lords

Sharing a document with another organisation

Expand
titleSteps

Duplicate a version of the Bill

Specify a version name (“House copy 1”) and folder (“House copy”)

Strip out page and line numbering

From the Actions menu next to the new version, select Share version

In the modal, select the House of Lords

Significant version created on the right-hand side of the Project Tab

This version is visible to HoL users

Status
colourGreen
titlePass
Status
colourRed
titleFail

36

Login as a HoL user, navigate to the same project, and Duplicate a version of this shared copy to create a new working version

Able to create a new working version in the folder specified in the modal

Version label has the name the user specified in the modal

Status
colourGreen
titlePass
Status
colourRed
titleFail

37

Update the Document information from the Actions menu on the Project Tab to make this the “as brought from the Commons” version

Specify a Bill number, e.g. HL Bill 29

Specify a ‘brought from’ date

Specify that it is printed by the House of Lords

Update the Proposer and Supporter info

All changes are possible in the modal

Clicking Update works as expected

When opening the document in the Editor, new document information is visible (you may have to re-insert the front and back covers)

Status
colourGreen
titlePass
Status
colourRed
titleFail

38

Generate a PDF of this version and then create a Significant version

Generating and viewing a PDF Publishing a Bill document version

Able to generate PDF

Able to select Publish from the Actions menu next to the PDF snapshot

Warning modal is displayed

On clicking Publish, a new significant version is created on the right-hand side of the Project Tab

Version is accessible through the PDR API with the correct House and docType values

Status
colourGreen
titlePass
Status
colourRed
titleFail

39

Create an Act version of the Bill

Converting a UK Bill into an Act

New working version created containing an Act version of the bill

Status
colourGreen
titlePass
Status
colourRed
titleFail

40

Open this new version in the Editor and change some Document Information

Expand
titleSteps

Check the Act Title is correct

Update Year, Chapter number and Assent date

Save the document

Act title is correct

Text on the cover and preface change accordingly in the main Editor pane

Status
colourGreen
titlePass
Status
colourRed
titleFail

41

Generate a PDF of this Act version

PDF snapshot is generated

Status
colourGreen
titlePass
Status
colourRed
titleFail

42

Submit the Act to TNA

From the Actions menu next to the PDF snapshot, select ‘Submit to TNA’

Warning is displayed, with Submit and Cancel buttons

On clicking Submit, a new Significant version is created

Act is available through the PDR API

Status
colourGreen
titlePass
Status
colourRed
titleFail

43

Download a ZIP of the Act and resolve dates in the XML

Downloading a ZIP file of a document

Able to download a ZIP of the Act

ZIP contains the Act XML, PDF, and any images

Status
colourGreen
titlePass
Status
colourRed
titleFail

44

45

46

...