Introduction
A general guide and notes on how to add and style content in this user manual using Confluence.
General style
Here are a few pointers to maintaining a consistent style:
Use Heading 2 as the top level of headings within a page (Heading 1 looks too much like the page title).
Use other heading levels in a hierarchical fashion.
By default, body text shouldn’t be numbered or in bullets. Use bullets for a list of things and use numbers for a sequential list (e.g. a series of steps that the user is to take).
Use panels to call out specific information (type “/info”, “/error”, “/warning”, “/note”, “/success” to create them).
Use expandable panels sparingly (type “/expand”) and, if used, make sure the heading/text that is always visible clear indicates what the expanded content will relate to (e.g. avoid “more information” etc.).
Use bold to highlight menu items and buttons referred to on pages, e.g. Document menu > Edit as XML.
Refer to the different screens within Lawmaker using consistent terminology: Dashboard, Project tab, Amendment Workspace tab, Amendment Manager tab, Official Lists tab, the Editor.
Use “/children” to insert lists of child pages to create mini tables of contents wherever appropriate.
Avoid blank pages that just exist as a parent of child pages. Add a list of child pages at least but consider also adding some general text that is appropriate to the whole section.
Converting old style pages
Pages copied across from the old version of confluence need to be converted to the new format. The basic steps, assuming the page has been copied over already:
Click on the pencil icon to edit the page.
Click on Preview button at bottom of page to convert to new format.
Update heading styles so top level uses Heading 2.
Make any other obvious tweaks to the page.
Add a label “Revise”.
Delete “OLD -” from the beginning of the title if present.
Click Publish to publish the updated version.
Using labels to indicate status
Use the following labels to indicate the status of pages as we transfer content across from the old site:
Revise - Page has been converted to new format but hasn’t been updated
WIP - Page is currently being revised
Review - Page has been revised but would benefit from being reviewed