As you are developing your specification, you can mark articles and clauses as complete. A counter and a pie chart show how many items in each section and system are complete, helping you track your progress. This article explains how to mark items in your specification as complete.
TABLE OF CONTENTS
- Overview
- Marking as complete
- How to edit a completed item
- Mark as complete with empty values
- Tracking progress with your specification
- How the completion count is calculated
- Video overview of marking your spec content as complete
Related articles:
- Copying 'Completed' articles and clauses
- Marking items as complete or incomplete in bulk
- Update notifications for completed items
Overview
- Marking parts of your spec as complete works for all content sets.
- Specifiers must have ‘Contributor’ permissions (and above) for the spec to mark articles and clauses as complete/ incomplete.
- Readers can see items as complete but cannot change the status.
- When an article or clause is complete, it becomes read-only. You can mark it as incomplete to make further changes.
- When copied, a completed article or clause will change to become incomplete.
- You do not need to fill in the whole article or clause to mark it as complete. However, a warning message is shown when you attempt to mark something as complete, and it has empty values.
- The ‘Contents’ tab contains a ‘Complete’ column.
- The ‘Complete’ column displays a count of the number of articles or clauses in the section or system and how many are complete.
- It also shows a pie chart to help you track your progress.
- When all of the articles or clauses are complete the pie chart will turn into a green tick.
Marking as complete
To mark something as complete, click on the Tick icon to the left of the article or clause.
Screenshot showing the 'Mark as complete' tick icon in the specification editor
- Specifiers who can edit the specification can mark items as complete.
- Items that are checked out – either to you or to someone else – cannot be marked as complete until they are checked in.
- Completed items have a green background and the name and date stamp from when they were completed. They become read-only and cannot be edited without being marked as incomplete first.
How to edit a completed item
Completed items become read-only and cannot be edited without being marked as incomplete first.
To mark something as incomplete, click on the Tick icon.
Screenshot showing how to mark an item as incomplete
When an article or clause is marked as incomplete the last edited date of the item will be updated to the present time. The last edited details for rows will remain unchanged.
Screenshot showing the last edited date changing when an item is marked as incomplete
Mark as complete with empty values
You can mark articles and clauses as complete, even if they still have empty values. However, a warning is displayed.
We recommend that rows are completed or parked before you mark the article or clause as complete, but there may be valid reasons for needing to mark something complete when it isn’t fully done.
Empty values will continue to be published even if the article or clause is marked as complete.
Spec check will still report where articles or clauses contain empty values even if they are marked as complete.
Screenshot showing the warning dialog that is displayed when you mark an item with empty values as complete
Tracking progress with your specification
The Complete column in the Contents grid will display a count and graphic of how much progress has been made in the section or activity, product or system.
The column can be sorted by order of most or least complete.
When all of the articles or clauses in a section or system are complete this is indicated by the green tick icon.
Screenshot showing the completed column which displays the count and pie chart of the completed items
How the completion count is calculated
For sectional content sets
- Counted: active articles or clauses, completed articles or clauses and parked items.
- Not counted: headings or section parts and deleted articles or clauses.
For system-based content sets (Uniclass work sections only)
- Each Activity, Element/ function, Product and System in the 'Contents' grid has a completed pie chart and count.
- Counted: active clauses, completed clauses and linked clause (excluding clauses linked into elements/ function clauses *1).
- Not counted: headings, deleted clauses, placeholders or broken links.
*1 - Elements/ function clauses will be show with count of 0 of 1 (if the EF clause itself is active), or 1 of 1 (if the EF clause itself is marked as complete), irrespective of any clauses linked into the EF clause.
Video overview of marking your spec content as complete
The short video (no audio) below demonstrates how to mark your spec content as complete.
Related articles:
Update notifications for completed items