Checklist
The Checklist schema builds interactive checklists, procedures and test protocols: tasks marked OK, failed or skipped, check boxes, ratings, input fields, photos, signatures and GPS positions, with a progress panel and a status report. It ships with the Productivity docs package.
Schema and versions
Property | Value |
|---|---|
Schema names |
|
Package | Productivity docs |
Versioning | On — saves are kept in History when the subscription includes Revisions (Which documents keep a version history) |
Indexed for search |
|
The package holds several versions of the schema, named with a number suffix (Checklist up to Checklist.2). The folder's New menu offers only the newest; existing documents keep the version they were created with. A document's Schema value is the full name, such as Checklist.2.
Document fields
The top level of a Checklist.2 document. The counters are hidden fields the form keeps up to date as items are completed; read them in templates and listings instead of counting yourself.
Field | Type | Meaning |
|---|---|---|
| Array | The checklist items, in order — see the element types below |
| Text (hidden) | Overall status, set by the form |
| Number (hidden) | Items that succeeded, failed, were skipped, remain, and in total |
| Text (hidden) | Optional link shown as a button in the progress panel |
| Check box | The edit-lock toggle in the editor |
| Lists of | The properties panel: what the checklist is for, when to use it, who carries it out and may change it, and the reporting, documentation and time requirements |
| Check box | Goals ticked in the properties panel |
Element types
Each item in Fields is an object with an ObjectVariant. These are the types on the toolbar:
ObjectVariant | What it is | Main fields |
|---|---|---|
| A task with OK / Fail / Skip buttons, optional expected result, sub-tasks, images and failure notes |
|
| A single check box |
|
| A rating on a scale you set up ( |
|
| An input: single or multi line text, email, phone, URL, number, range, date, time, month, year, week, or date and time |
|
| Records the current position |
|
| A photo taken or pasted |
|
| A drawn signature |
|
| An attached file |
|
| A button that runs a JavaScript function in the browser; the code resolves or rejects a promise with a message |
|
| A heading with its own items, optionally repeating ( |
|
| Content between the items |
|
Radio, Bulletlist and Group items also exist in the form. Most items share Name (the field name), Required (must be completed before the checklist is complete), Criteria (a JavaScript condition that decides when the item is shown), HideReports, ID and Timestamp.
Templates
Template | Output |
|---|---|
Status report | HTML report of the checklist — downloadable, and allowed for publishing |
Status report (PDF) | The same report as PDF, for download |
Published checklist | A web version of the checklist |
Status badge (embed) | A small status badge |
Execution time report | HTML report of the time spent |
On a published site, a document of this schema is rendered with the site's display template #/Checklist.2.hash (or #/Checklist.2.html) when there is one. Without it, Docly uses the first template in the schema that allows publishing — here Status report. See Create display templates for your schemas.
Create one
Install the Productivity docs package in the workspace (Standard packages), then choose the schema in a folder's New menu.
From a script, the drive or the CLI: write a
.doclyfile whoseSchemaisChecklist.2— see The Docly file format and Creating new docly files. Copy an existing document for the full field set.