Introduction
The editor Editor uses a the Content Completion Assistant (CCA) to help you insert provisions and other elements into your document. It ensures that what you insert is valid XML content. It in terms of document structure and the underlying XML.
The CCA offers a list of provisions and their other elements that are valid at your cursor’s location and will insert your selected provision in the next correct place in the document.
How to insert a provision using the Content Completion Assistant (CCA)
To insert a provision:
Press Enter to activate the CCA
...
.
Select the provision
...
you wish to insert
...
. You can use the up and down arrow keys or your mouse or you can start typing the name of the provision you want.
Press Enter again.
The selected provision/element will be inserted in the next correct place.
How to insert a provision using the keyboard shortcut for default next element
Place cursor in either the heading or text element for a provision and press Ctrl + Enter
The system will insert the next default element
How to insert a provision using right-click menu in the Editor
The system will present a context menu
Select “Insert element…”
The system will present the CCA
How to insert a provision using the upper toolbar
Place cursor in the provision that you want to insert your new provision after
Select Insert > Insert Element… from the drop-down menu in the upper toolbar
The system will present the CCA
Hints and tips
| Info |
|---|
Hints and tips |
, e.g. if your cursor is within a paragraph of a Regulation and you select “Regulation” from the CCA then a new Regulation will be inserted after the current Regulation.
Your cursor will move into the provision that is inserted.
(You can also bring up the CCA by using the Insert element… option in the right-click context menu or in the toolbar, Insert menu>Insert element….)
How to insert next default provision
You can quickly insert the next default provision for the context your cursor is in by pressing Ctrl+Enter.
The provision that will be inserted in the provision that would appear at the top of the CCA had you pressed Enter. This will generally be the same provision as the one your cursor is in with the exception of when your cursor is a heading, opening words or closing words.
How to insert an additional text paragraph within a provision
You can insert an additional paragraph of text within a provision e.g. a step which contains two <p> paragraphs of text by using the keyboard short cut shortcut Shift + Enter.
You can use the search input field at the top of the CCA to quickly find the desired provision/element. It will dynamically display matching provisions/elements that begin with the characters entered in the search field.
You can navigate through the list of valid provisions/elements using the up and down arrow keys or select them using the mouse.
Provisions are being auto-numbered using the auto-assign number rule (see Annex 6 - ‘Auto-assign numbering rule’ in Annexes)
Whenever a provision is inserted, the cursor will appear by default in the heading or if provision doesn’t have a heading, into the text element
...
Note on the ordering and contents of the CCA
The CCA will show all the valid sibling elements and valid child elements that you can insert.
A sibling element is an element that will be inserted after the current element your cursor is in. For example, if your cursor is in a subsection then a sibling would be another subsection. Or if your cursor was in the opening words of a paragraph then a sibling would be a sub-paragraph.
A child element is an element that will be inserted within the current element your cursor is in. For example, if your cursor is in a subsection then a child would be a paragraph, definition or step.
The CCA first shows the valid sibling
Essentially the rule has been built such that sibling element and provisions will appear first in the insert menu (also referred to as the Content Completion Assistant (CCA)) with valid child provisions appearing after. As a provision rarely exists in isolation, the rule will also provide sibling provisions for all parent provisions further up the provision ‘branch’ you are in. There is a special rule applied to ‘heading’, ‘content’ and ‘closing word’ elements within the provisions which have enabled us to dictate the first element/provision at the top of the Content Completion Assistant which is used by the ‘default next element’ insert shortcuts. See ‘Next default element’ table to find out what these special rules are.
| Info |
|---|
Hints and tips
|
Schedule paragraphs will convert to schedule sub-paragraphs when you insert another schedule subparagraph after the schedule paragraph’s content
...
It is possible to insert bullet lists into your documents (bills & SIs). If you right-click on the bullet point and select "Update List Style" you can change the bullet point to an em-dash list or no bullet point.
Screencasts
Creating SI/SSIs and inserting provisions
...