ZDDC
3a4a1c7f39
Per the reference doc at zddc.varasys.io/reference.html#tracking-numbers,
a tracking number is composed of: originator, [phase], project,
[area], discipline, type, sequence, [suffix]. The default Master
Deliverables List now surfaces every component as its own column,
plus the standard MDL metadata (title, plannedRevision,
plannedDate, status, owner). Columns appear in the canonical
filename order so the table reads left-to-right like the tracking
number itself.
Optional components ([phase], [area], [suffix]) render in the
table even when blank — keeps the layout consistent across rows.
Projects on a schema that doesn't use them hide the columns by
overriding (see customization).
Form schema (default-mdl.form.yaml):
- One JSON Schema property per tracking-number component, plus
the deliverable metadata. originator / project / discipline /
type / sequence are required; phase / area / suffix are
optional. The schema is intentionally permissive — free-text
strings on every component, no enums or regex constraints.
Projects pick their own conventions for originator codes,
discipline vocabularies, etc.; a default that imposed a
fixed set would just get in the way.
- Phase 2's editable-cell widget factory derives the right
per-cell editor from this schema: text inputs for the
components, the existing select for `status` (which keeps
its enum), date input for `plannedDate`, textarea for
`notes`.
Customization (the "way for end users to customize"):
- Drop your own table.yaml and / or form.yaml into the rows
directory (archive/<party>/mdl/, or any directory hosting a
table). Operator-supplied files override the embedded defaults
ATOMICALLY — there's no field-level merge, the operator file
wins entirely. This matches every other "spec on disk wins"
convention in zddc-server.
- Hide a column: omit it from the columns: list.
- Rename a column header: change `title:`.
- Add a column: append a {field, title} entry AND add a
matching property in form.yaml's schema.properties.
- Tighten constraints: use `enum:`, `pattern:`, `minLength:`
etc. on form.yaml properties.
- Pre-filter rows on load: defaults.filter[<field>].
The whole rows-directory is self-contained — copying mdl/ to a
new project takes the spec, the form, and every row YAML
together.
Documentation:
- AGENTS.md "Tables system" gains a paragraph on the default-MDL
column set + the customization mechanism + a pointer to the
embedded source files.
- tables/template.html help panel rewrites the body to cover:
* What the directory IS (spec + form + row YAMLs together).
* Editable-cell keyboard shortcuts (the Phase 1-5 sequence
we just shipped — arrows, Tab, Enter, F2, Delete, Ctrl+D /
R / C / V / Z, Shift+arrow / Shift+click for ranges).
* The auto-save model + per-row state swatch colors.
* The customization model with a worked file-tree example.
Replaces the obsolete pre-Phase-1 wording that referenced
`*.table.yaml` parent files and click-to-navigate-row UX.
Tests: no schema test changes — the default YAMLs are loaded
through the same RecognizeTableRequest / RecognizeFormRequest
paths that already cover the fallback. Full Playwright + Go
suites green (44 + 13).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
96 lines
3.5 KiB
YAML
96 lines
3.5 KiB
YAML
# Default row schema for a Master Deliverables List entry, served by
|
|
# zddc-server when no operator-supplied form.yaml exists at
|
|
# archive/<party>/mdl/.
|
|
#
|
|
# Properties cover every component of the ZDDC tracking-number model
|
|
# (zddc.varasys.io/reference.html#tracking-numbers) plus the standard
|
|
# MDL metadata (title, planned revision, planned date, status, owner,
|
|
# notes). The schema is intentionally permissive on the components
|
|
# (free-text strings, no regex / enum constraints) — projects choose
|
|
# their own conventions for originator codes, discipline vocabularies,
|
|
# etc., and a default that imposed a fixed set would just get in the
|
|
# way.
|
|
#
|
|
# To customize: drop your own form.yaml into archive/<party>/mdl/
|
|
# (the same directory as table.yaml). Tighten constraints with
|
|
# `enum:`, `pattern:`, `minLength:`, etc. Add fields and they'll
|
|
# appear in the row-edit form; add a matching column to table.yaml
|
|
# to surface the field in the table view too.
|
|
|
|
title: Deliverable
|
|
description: One planned or in-flight deliverable. The first eight fields are components of this row's tracking number; the rest are deliverable metadata.
|
|
|
|
schema:
|
|
type: object
|
|
required: [originator, project, discipline, type, sequence, title]
|
|
additionalProperties: false
|
|
properties:
|
|
# --- Tracking-number components (matches the reference doc's
|
|
# field definitions, in order). originator / project / discipline
|
|
# / type / sequence are the structural minimum; phase / area /
|
|
# suffix are optional and project-dependent.
|
|
originator:
|
|
type: string
|
|
title: Originator
|
|
description: Organizational unit responsible for this deliverable (e.g. ACME).
|
|
minLength: 1
|
|
phase:
|
|
type: string
|
|
title: Phase
|
|
description: Optional project phase code (e.g. ECI, EPC). Leave blank if your tracking-number schema doesn't use phases.
|
|
project:
|
|
type: string
|
|
title: Project
|
|
description: Project identifier, or your corporate placeholder (e.g. 000000) for non-project deliverables.
|
|
minLength: 1
|
|
area:
|
|
type: string
|
|
title: Area
|
|
description: Optional area / budget code (e.g. B02). Leave blank if unused.
|
|
discipline:
|
|
type: string
|
|
title: Discipline
|
|
description: Engineering or functional group code (EL, ME, CV, PM, ...).
|
|
minLength: 1
|
|
type:
|
|
type: string
|
|
title: Document type
|
|
description: Document category code within the discipline (SPC, DWG, RPT, ...).
|
|
minLength: 1
|
|
sequence:
|
|
type: string
|
|
title: Sequence
|
|
description: Zero-padded integer (0001, 0042, 2623). Stored as a string so leading zeros survive YAML.
|
|
minLength: 1
|
|
suffix:
|
|
type: string
|
|
title: Suffix
|
|
description: Optional structural-part suffix (-A for Appendix A, -01 for Sheet 1). Use only for parts of the SAME deliverable; separate documents get their own tracking number.
|
|
|
|
# --- Deliverable metadata.
|
|
title:
|
|
type: string
|
|
title: Deliverable title
|
|
minLength: 1
|
|
plannedRevision:
|
|
type: string
|
|
title: Planned revision
|
|
description: Issue revision label, e.g. A, B, IFR, IFC.
|
|
plannedDate:
|
|
type: string
|
|
title: Planned date
|
|
format: date
|
|
status:
|
|
type: string
|
|
title: Current status
|
|
enum: [DFT, IFR, IFA, IFC, AFC, AB]
|
|
owner:
|
|
type: string
|
|
title: Owner
|
|
description: Email or party name responsible for producing this row.
|
|
notes:
|
|
type: string
|
|
title: Notes
|
|
ui:
|
|
notes:
|
|
ui:widget: textarea
|