ZDDC/zddc/internal/handler/default-mdl.table.yaml
ZDDC 3a4a1c7f39 feat(mdl): default columns mirror tracking-number components + customizable
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>
2026-05-09 11:09:31 -05:00

84 lines
2.8 KiB
YAML

# Default Master Deliverables List spec, served by zddc-server when no
# operator-supplied table.yaml exists at archive/<party>/mdl/.
#
# Columns mirror the tracking-number component model documented at
# zddc.varasys.io/reference.html#tracking-numbers — every column from
# `originator` through `suffix` is one slot of a deliverable's
# permanent identifier. Optional components ([phase], [area], [suffix])
# render in the table even when blank so the layout stays consistent
# across rows; users on schemas that don't use them can hide the
# columns by overriding this spec (see customization note below).
#
# Beyond the tracking-number fields, the table tracks the deliverable's
# title, planned revision and date, current status, owner, and notes —
# the standard MDL columns operators expect for planning and status
# tracking.
#
# To customize: drop your own table.yaml + form.yaml into the same
# directory (archive/<party>/mdl/). The whole directory IS the table —
# spec, row-edit form, and rows are siblings. Override examples:
# - Hide a column: omit it from the columns: list here.
# - Rename a column header: change `title:`.
# - Add a custom column: append a {field, title} entry AND add a
# matching property in form.yaml's schema.properties so the row
# form lets users fill it in.
# - Tighten column widths: set `width:` (CSS length, e.g. "8em").
# - Pre-filter rows on load: defaults.filter[<field>] = "<text>".
#
# The whole directory is self-contained — copying mdl/ to a new
# project takes the spec, the form, and every row YAML with it.
title: Master Deliverables List
description: Planned and actual deliverables for this party. Columns mirror the tracking-number components plus standard MDL metadata.
columns:
# --- Tracking-number components (in the order they appear in the
# canonical filename: originator-[phase-]project-[area-]discipline-
# type-sequence[-suffix]). Optional components are kept narrow so
# they don't clutter the layout when unused.
- field: originator
title: Originator
width: 8em
- field: phase
title: Phase
width: 5em
- field: project
title: Project
width: 8em
- field: area
title: Area
width: 5em
- field: discipline
title: Disc.
width: 5em
- field: type
title: Type
width: 6em
- field: sequence
title: Seq.
width: 5em
- field: suffix
title: Suffix
width: 5em
# --- Deliverable metadata.
- field: title
title: Deliverable
- field: plannedRevision
title: Rev.
width: 5em
- field: plannedDate
title: Planned
format: date
width: 8em
- field: status
title: Status
width: 6em
enum: [DFT, IFR, IFA, IFC, AFC, AB]
- field: owner
title: Owner
width: 12em
defaults:
sort:
- { field: plannedDate, dir: asc }