Skip to content
Pauta5.0.0

About window

The About window answers “what exactly am I running?” in one place, and its details are what a bug report needs. Torrenta (AboutDialog), Termina, Modula, Mirada and nux (AboutWindow) follow Editora’s order.

Rules on this page 10
IDLevelRule
Rules
ABOUT-01MUST
Every app has an About window, reached by Help → About, the help.about command, and on macOS the application menu’s About item.
ABOUT-02MUST
About shows the version and build, the runtime, the license, links, and the result of the last update check. The Pauta edition is ABOUT-05.
ABOUT-03SHOULD
Copy details copies the environment block and leaves the window open; its label becomes “Copied”.
ABOUT-04SHOULD
The update status claims nothing before a check has answered: with no answer, or with the check switched off, it says it has not checked, never “up to date”.
ABOUT-10SHOULD
An available update stands out: “Update available” is bold in -state-amber, a color no link or label in About uses, while the links stay -state-accent, “up to date” is -state-green, a failed check -state-red and the last-checked line muted.
Pauta edition and conformance
ABOUT-05MUST
The edition appears in two places: a link, Built to Pauta 4.2.0, among the others, and a line Pauta: 4.2.0 in the environment block, right after the commit, so Copy details carries it.
ABOUT-06MUST
The link opens the edition’s own address, https://pauta-project.dev/<edition>/ (for example https://pauta-project.dev/4.2.0/), which never changes, not latest/, which moves on to newer editions.
ABOUT-07MUST
The number is the edition the app meets, not the newest. Moving to a newer edition means reading its changelog for new or stronger MUSTs, meeting them, then changing the number. An app at Partial names the edition it is working toward instead, and says so (ABOUT-09).
ABOUT-08MUST
The edition has one source: a pauta.version property in pom.xml, filtered into build-info.properties and read by AppInfo, like the app’s own version. The README’s Pauta badge and its “Built to” line name the same edition and change with it.
ABOUT-09MUST
About shows the app’s conformance, Complete, Core or Partial, as the helper computes it from pauta.json (PAUTA-02) and never higher: a link, Pauta conformance: Core, right after the edition’s, that opens the Pauta window, and a line Pauta conformance: Core (2 exceptions) right after the Pauta: line; with one it says (1 exception), with none (no exceptions). At Partial the edition’s link reads Working toward Pauta 4.2.0: the app does not meet that edition yet, so it does not say it is built to it.
  • ABOUT-01 MUST Every app has an About window, reached by Help → About, the help.about command, and on macOS the application menu’s About item.
    • Check (code): help.about is registered and listed in the Help menu, and the macOS application menu’s About item runs it.
    • Reference: Editora ui/AboutDialog.java, ui/MenuBarModel.java (help.about in the Help menu).
  • ABOUT-02 MUST About shows the version and build, the runtime, the license, links, and the result of the last update check. The Pauta edition is ABOUT-05.
    • Check (code): the window reads the version and build from AppInfo, the same text as --version, and shows the update checker’s last answer.
    • Reference: Editora ui/AboutDialog.java, AppInfo; the page’s Spec.
  • ABOUT-03 SHOULD Copy details copies the environment block and leaves the window open; its label becomes “Copied”.
    • Check (code): the button sits in the content, not the dialog’s button bar, so pressing it can’t close the window.
    • Reference: Editora AboutDialog (about.copyDetails, about.copied).
  • ABOUT-04 SHOULD The update status claims nothing before a check has answered: with no answer, or with the check switched off, it says it has not checked, never “up to date”.
    • Check (code): the status falls back to the not-checked text when the checker has no result.
    • Reference: Editora AboutDialog (about.notChecked); the states below.
  • ABOUT-10 SHOULD An available update stands out: “Update available” is bold in -state-amber, a color no link or label in About uses, while the links stay -state-accent, “up to date” is -state-green, a failed check -state-red and the last-checked line muted.
    • Why: in the accent every link wears, the one line that asks for action reads as one more link.
    • Check (code): the update-available style (.about-update) uses -state-amber, and no other About style does.
    • Reference: no app yet. Editora’s .about-update in app.css is -state-accent, the links’ color.
  1. 1Identity. The app icon at 72 px beside the name (26 px, bold). No alert header band, no info graphic: the panel reads as one block, like a native About panel.
  2. 2Version and tagline. Version 14 px muted; a snapshot build appends its Git branch, "0.28.0-SNAPSHOT (feat/map)". The tagline is the README's one-line pitch, 13 px muted.
  3. 3Update status. What the last update check found (see the states below), when it ran, and Check now. Nothing is claimed before a check has answered.
  4. 4Copyright, muted.
  5. 5Links. License, homepage, source code and releases, the Pauta edition the app is built to and its conformance, which opens the Pauta window (see below), and the settings file, which opens in the app (or in the file manager for apps with no editor).
  6. 6Environment. Monospace 11.5 px, muted: version and build time, commit, Pauta edition and conformance, Java and JavaFX versions with vendor, OS with architecture, config folder. Home folders shown as ~.
  7. 7Copy details copies the environment block and stays open; its label becomes "Copied". It sits in the content, not the button bar, so pressing it does not close the panel.
  8. 8Close, the one button, and the default: Enter and Esc both close.

About names the edition of these guidelines the app implements and how fully it conforms (Conformance), so a user, a bug report and a reviewer all know which rules the app answers to. The app template shows both; Termina’s About names its edition but not its conformance.

  • ABOUT-05 MUST The edition appears in two places: a link, Built to Pauta 4.2.0, among the others, and a line Pauta: 4.2.0 in the environment block, right after the commit, so Copy details carries it.
  • ABOUT-06 MUST The link opens the edition’s own address, https://pauta-project.dev/<edition>/ (for example https://pauta-project.dev/4.2.0/), which never changes, not latest/, which moves on to newer editions.
  • ABOUT-07 MUST The number is the edition the app meets, not the newest. Moving to a newer edition means reading its changelog for new or stronger MUSTs, meeting them, then changing the number. An app at Partial names the edition it is working toward instead, and says so (ABOUT-09).
    • Check (by hand): audit the app against the MUSTs of the edition it names.
    • Reference: no app yet.
  • ABOUT-08 MUST The edition has one source: a pauta.version property in pom.xml, filtered into build-info.properties and read by AppInfo, like the app’s own version. The README’s Pauta badge and its “Built to” line name the same edition and change with it.
    • Check (code): pom.xml defines pauta.version, build-info.properties carries it, AppInfo reads it, and the README names the same number.
    • Reference: The app template’s pom.xml, build-info.properties and AppInfo.java; Termina’s the same, with AppInfo.java.
  • ABOUT-09 MUST About shows the app’s conformance, Complete, Core or Partial, as the helper computes it from pauta.json (PAUTA-02) and never higher: a link, Pauta conformance: Core, right after the edition’s, that opens the Pauta window, and a line Pauta conformance: Core (2 exceptions) right after the Pauta: line; with one it says (1 exception), with none (no exceptions). At Partial the edition’s link reads Working toward Pauta 4.2.0: the app does not meet that edition yet, so it does not say it is built to it.
Newer release
Update available: 0.28.0
Last checked 5 minutes ago. Check now
Current
You are up to date.
Last checked 2 hours ago. Check now
Never checked
Not checked for updates yet. Check now
Checking
Last checked 2 hours ago. Checking…
Failed
Update check failed: connection timed out
Check now

“Update available” links to that release’s page. An update check that is switched off must never read as “up to date”: with no answer, the panel says it has not checked.

PropertyValueReference
KindA modal dialog owned by the window, styled through Dialogs.styled so it gets app.css and the UI fontAboutDialog.show
LayoutOne column, 14 px between blocks; content padding 6 8 2 8.about-content
IconThe app icon PNG at 72 pxicon-128.png
Name / version / tagline26 px bold / 14 px muted / 13 px muted.about-name, .about-version, .about-tagline
Update colorsAvailable: amber, bold (ABOUT-10). Up to date: green. Failed: red. Last checked: muted.about-update*
EnvironmentJetBrains Mono 11.5 px, muted.about-env
Source of the versionMaven-filtered build-info.properties, read by AppInfo: the same text as --version and a problem reportAppInfo
Pauta editionpauta.version in pom.xml, filtered into build-info.properties; the link opens https://pauta-project.dev/<edition>/the app template’s and Termina’s AppInfo.pautaUrl
Pauta conformanceComputed from pauta.json by the conformance helper; the link opens the Pauta windowConformance
KeyEnglish
dialog.about.titleAbout {0}
about.versionVersion {0}
about.updateAvailableUpdate available:
about.upToDateYou are up to date.
about.lastCheckedLast checked {0}.
about.notCheckedNot checked for updates yet.
about.checkNow / about.checkingCheck now / Checking…
about.homepage / about.releasesHomepage / Source code and releases
about.pauta / about.pautaWorkingTowardBuilt to Pauta {0} / Working toward Pauta {0}
about.pautaConformancePauta conformance: {0}
about.copyDetails / about.copiedCopy details / Copied
Editora's About window
Editora.

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