Skip to content
Pauta4.4.0

Pauta window

About says which edition of Pauta the app is built to and how fully it conforms; the Pauta window shows the evidence. It lists every exception the app records in its pauta.json (see Conformance): the rules that do not apply, the ones it does differently on purpose, and the ones still pending. It is built like the About window: one modal panel, read-only, with a copyable summary. No app has one yet.

Rules on this page 8
IDLevelRule
PWIN-01MUST
Every app has a Pauta window, opened by the help.pauta command: from the Command Palette like every command, from the Help menu’s Pauta Conformance row just above About, and from About’s Pauta conformance link.
PWIN-02MUST
The window shows the edition, the conformance with one sentence that says what it means, a count of exceptions by kind, and every exception: the rule’s ID, its level (MUST or SHOULD), the kind, the reason, and for a deviation or a pending exception its link.
PWIN-03MUST
It reads from pauta.json and AppInfo alone, and takes the conformance from the same helper as About (PAUTA-02). Nothing in it is written in the window’s code.
PWIN-04MUST
Every link opens a fixed address: the edition at https://pauta-project.dev/<edition>/, each rule ID at its address in that edition (the entry’s url), never latest/. The edition’s link, here and in About, runs the help.pautaRules command, so the palette reaches it too.
PWIN-05SHOULD
Pending exceptions come first, then deviations, then app-only (in a template), then not-applicable; within a kind, MUSTs before SHOULDs, then by ID.
PWIN-06SHOULD
Copy as text copies the edition, the conformance and the list as Markdown, one line per exception, and leaves the window open; its label becomes “Copied”.
PWIN-07SHOULD
A Conformance in the docs link runs the help.pautaDocs command, which opens the app’s docs page (PAUTA-13) for this version, /docs/v-<version>/pauta/, where the site serves versioned docs (DOCS-03), and /docs/pauta/ until it does. The README’s badge links the unversioned page, which always shows the latest release.
PWIN-08SHOULD
With no exceptions, the list’s place says so in one line, “No exceptions: Mirada meets every MUST and SHOULD of Pauta 4.2.0.”, and the copy button still works.
  • PWIN-01 MUST Every app has a Pauta window, opened by the help.pauta command: from the Command Palette like every command, from the Help menu’s Pauta Conformance row just above About, and from About’s Pauta conformance link.
    • Check (code): help.pauta is registered, the Help MenuSpec lists it before help.about, and About’s Pauta conformance link runs it through the registry.
    • Reference: no app yet; build it like Editora’s ui/AboutDialog.java.
  • PWIN-02 MUST The window shows the edition, the conformance with one sentence that says what it means, a count of exceptions by kind, and every exception: the rule’s ID, its level (MUST or SHOULD), the kind, the reason, and for a deviation or a pending exception its link.
    • Check (by hand): open the window and compare it with pauta.json, entry by entry.
    • Reference: no app yet; the Anatomy below.
  • PWIN-03 MUST It reads from pauta.json and AppInfo alone, and takes the conformance from the same helper as About (PAUTA-02). Nothing in it is written in the window’s code.
    • Check (code): the window loads the exceptions through one loader and calls the conformance helper; it holds no rule IDs or conformance names of its own.
    • Reference: no app yet.
  • PWIN-04 MUST Every link opens a fixed address: the edition at https://pauta-project.dev/<edition>/, each rule ID at its address in that edition (the entry’s url), never latest/. The edition’s link, here and in About, runs the help.pautaRules command, so the palette reaches it too.
    • Why: an app built to 4.2.0 answers to 4.2.0’s rules; latest/ moves on.
    • Check (code): help.pautaRules is registered and builds the edition URL from pauta.version; rule links use each entry’s url.
    • Reference: ABOUT-06.
  • PWIN-05 SHOULD Pending exceptions come first, then deviations, then app-only (in a template), then not-applicable; within a kind, MUSTs before SHOULDs, then by ID.
    • Why: what the app still owes is what a reader came to find.
    • Check (test): a unit test of the sort.
    • Reference: no app yet.
  • PWIN-06 SHOULD Copy as text copies the edition, the conformance and the list as Markdown, one line per exception, and leaves the window open; its label becomes “Copied”.
    • Check (code): the button sits in the content, not the button bar, like About’s Copy details.
    • Reference: Editora AboutDialog (about.copyDetails, about.copied).
  • PWIN-07 SHOULD A Conformance in the docs link runs the help.pautaDocs command, which opens the app’s docs page (PAUTA-13) for this version, /docs/v-<version>/pauta/, where the site serves versioned docs (DOCS-03), and /docs/pauta/ until it does. The README’s badge links the unversioned page, which always shows the latest release.
    • Check (code): help.pautaDocs is registered and builds the URL from the app’s docs base, like Help → Documentation.
    • Reference: Editora AppInfo.docsUrl().
  • PWIN-08 SHOULD With no exceptions, the list’s place says so in one line, “No exceptions: Mirada meets every MUST and SHOULD of Pauta 4.2.0.”, and the copy button still works.
    • Check (by hand): with an empty exceptions array, open the window.
    • Reference: no app yet.

The entries above show the layout with Mirada’s name; they are not Mirada’s record.

  1. 1Edition. The Pauta mark at 72 px beside "Pauta" and the edition, in About's name style.
  2. 2Conformance. A pill: Complete green, Core accent, Partial amber. Below it, one sentence in the tagline style that says what it means for this app.
  3. 3Counts. How many exceptions of each kind, muted. A kind with none is left out.
  4. 4Group header. One per kind present: Pending, Deviation, Not applicable, in that order. The list scrolls past about ten rows; the rest of the window stays put.
  5. 5Exception row. The rule's ID in monospace, linked to the rule in this edition; its level, MUST or SHOULD, muted; the reason; for a pending exception, the issue number as a link.
  6. 6Decision link. A deviation links its decision record by number.
  7. 7Links. The edition's rules at its own address, and the app's conformance page in its docs.
  8. 8Copy as text copies the summary as Markdown and stays open; its label becomes "Copied".
  9. 9Close, the one button and the default: Enter and Esc both close.
PropertyValueReference
KindA modal dialog owned by the window, styled through Dialogs.styled like AboutAboutDialog.show
Width560 px; the list scrolls at about ten rows.pauta-list
HeadThe Pauta mark PNG at 72 px; “Pauta” and the edition 26 px bold.about-name
Conformance pillComplete -color-success-*, Core -color-accent-*, Partial -color-warning-*.pauta-conformance
Rule IDJetBrains Mono 12 px, accent, a link.pauta-rule
Sourcepauta.json in the app’s resources and pauta.version through AppInfoConformance
ConformanceThe conformance helper, never storedPAUTA-02
KeyEnglish
command.help.pautaPauta Conformance
command.help.pauta.descShow which edition of Pauta this app implements, how fully it conforms, and the rules it does not meet.
command.help.pautaRules / .descPauta Rules / Open the rules of the Pauta edition this app is built to, in your browser.
command.help.pautaDocs / .descPauta Conformance in the Docs / Open the page of this app’s documentation that lists its Pauta exceptions.
dialog.pauta.titlePauta Conformance
pauta.editionPauta {0}
pauta.conformance.complete / .core / .partialComplete / Core / Partial
pauta.conformance.complete.desc{0} meets every MUST and SHOULD of this edition.
pauta.conformance.core.desc{0} meets every MUST of this edition; {1,choice,1#1 SHOULD is|1<{1} SHOULDs are} pending.
pauta.conformance.partial.desc{0} does not meet every MUST yet: {1,choice,1#1 is|1<{1} are} pending.
pauta.kind.pending / .deviation / .appOnly / .notApplicablePending / Deviation / For each app made from it / Not applicable
pauta.count.pending{0,choice,1#1 pending|1<{0} pending}
pauta.count.deviation{0,choice,1#1 deviation|1<{0} deviations}
pauta.count.appOnly{0,choice,1#1 for each app|1<{0} for each app}
pauta.count.notApplicable{0,choice,1#1 not applicable|1<{0} not applicable}
pauta.decisionDecision {0}
pauta.rules / pauta.docsPauta {0} rules / Conformance in the docs
pauta.noneNo exceptions: {0} meets every MUST and SHOULD of Pauta {1}.
pauta.copy / pauta.copiedCopy as text / Copied

The reasons themselves come from pauta.json, in English (PAUTA-08); the window’s own words are in the catalogs like every other string. Counts use MessageFormat’s choice so English reads “1 SHOULD is pending”, not “1 SHOULDs are”. A command description takes no arguments, so it says “this app”.

Pauta 4.4.0 · · Changelog · This page in the latest edition