When you publish with 'Detailed revisions', the platform publishes the text that was both added and deleted compared to your previous version. Styling is used to indicate added and deleted text so that the reader can see how the document has changed. This article gives examples of how this will appear in the published specification.
When publishing your specification to either MS Word or PDF, the platform will:
- Style added text in blue with an underline.
- Style deleted text in
red with a strikethrough. - Add a border in the right-hand margin. The border helps to spot single-word or character differences.
These styles can be controlled in the stylesheet. Please see Customizing detailed revisions styling.
Topics covered in this article:
How detailed revisions appear when published
Added items
For added articles, clauses, sections and systems, the platform will:
- Show an ‘ADDED’ revision label.
- Style the code, prefix, title and suffix text with the ‘chorus-compare-added’ (blue + underline).
- Add a grey border in the right-hand margin.
Screenshot of the published specification showing the 'ADDED' revision label, blue and underline styling on the title, and the border in the margin.
Revised items
For articles, clauses, sections and systems that have been revised, you will see:
- The ‘REVISED’ revision label.
- Text that has been added is formatted with the ‘chorus-compare-added’ style (blue + underline).
- Text that has been deleted is formatted with the ‘chorus-compare-deleted’ style (
red + strikethrough). - A grey border in the right-hand margin.
Screenshot of the published specification showing the 'REVISED' revision label, the blue and red detailed revision styling, and the border in the margin.
Text formatting
Changes to text formatting are detected and shown as changed by detailed revisions. The platform will display the previous format as deleted and the current format as added.
Formatting detected by detailed revisions is:
- Bold, italic, underline.
- Subscript and superscript.
- Strikethrough.
Screenshot of the published specification showing the blue and red detailed revision styling when text formatting is changed.
Hyperlink changes
Detailed revisions will detect when either the hyperlink display text or hyperlink URL has changed. In either scenario, the platform will display the previous hyperlink as deleted and the current hyperlink as added.
Screenshot showing how changes in hyperlink display text and hyperlink URLs are shown as changed.
Table changes
When any part of a table has changed, the platform will publish the previous table as deleted and the current table as added. Table changes could be changes to cell text, formatting, or table rows and columns.
Screenshot showing that when a change is made to a table, the previous table is shown as deleted and the current table is shown as added.
Empty rows
If an empty row is added or deleted from the article or clause, the platform inserts some explanatory text to indicate the empty row. It will show as:
- ‘(Empty row added)’.
- ‘
(Empty row deleted)’.
Screenshot showing the explanatory text that is published when an empty row is added or deleted.
Table of Contents shows added and deleted text
Changes to the code, prefix, title and suffix will be published in the table of contents, but they are not styled. The platform will publish both the added and deleted text, but all of the text will be in the normal style.
There is a technical constraint with showing more than two styles in the table of contents. Therefore, the text cannot be styled as added or deleted in the table of contents.
Screenshot showing the table of contents, which could show both added and deleted text when the code, prefix, title or suffix has changed.
Screenshot shows the body of the spec and how the added and deleted styling indicates how the item has changed.
Changes that are not highlighted by detailed revisions
Row number changes – changes to row numbers caused by inserting new rows or parking rows are not detected by detailed revisions.
Dynamic clause numbers – for content sets with calculated article and clause numbers, changes in numbers caused by inserting new items or parking items are not detected by detailed revisions.
Complete/ incomplete – the completed status of articles and clauses is not published.