OpenSite/Reference/Features/Shared settings

From BathAfrica Documentation
Jump to navigation Jump to search
OpenSite 0.0.1 · DevelopmentSource scope and availability


Read and change a named setting, and see which scope supplied the value.

Stable identifier
settings.shared

Status reported by source

Implemented in the reviewed development source. Historical test evidence is recorded by the repository; no test rerun or product release is claimed by this publication.

Units

Setting numbers are not canonical engineering quantities. units.profile selects presentation only.

Behavior

Resolution order is session, document, workspace, user, then the application default. The CLI can read a setting, write a user value, reset it, and save opensite-settings version 1. A second save keeps the previous file as path.bak. Language, country, unit profile, and standards package are separate keys. Supported types are boolean, integer, real, and text. A preserved plugin value becomes active when a later schema accepts it. A token or credential key is rejected. That rejection does not make a value or an extension payload secret-proof.

Errors

Exit 1 for an unknown key, a rejected value, or a file that cannot be read. Exit 2 for arguments the command does not accept. A malformed file returns corrupt_settings and leaves memory unchanged. An unsupported format version returns unsupported_version.

Limitations

User preferences and permitted document overrides are exposed by the desktop Preferences/Document settings UI. A saved-workspace host remains pending. Lists, paths and structured setting values are not implemented as general preference pages. Workspace/document context ids do not open a workspace or document. Session values are not saved. One backup generation is kept; directory fsync is not claimed.

Available hosts

Shared foundation settings service, CLI and embedded Python, plus desktop Edit → Preferences and permitted Edit → Document settings pages.

Licensing and access

Credential-like keys are rejected. That filter is not a secret store and not an entitlement check.

Verification evidence

Repository evidence references (not rerun for this publication): CTest foundation.settings and cli.preferences. ADR-0021. Local Windows results are in docs/verification/Phase-3-Acceptance.md.


Try this workflow

Set preferences — a worked lesson with expected results.

Documentation basis

Source-reviewed against development commit 77c3fee13944bcc4b5d487c77eb1f82fbe4c6ea7, branch feature/phase-13c-properties-python-expressions. This review inspected the implementation and repository evidence; it did not run the Windows application or repeat CTest.

  • src/foundation/settings.cpp
  • src/gui/preferences_window.cpp
  • docs/verification/Phase-11P-Preferences.md

OpenSite overview · Reference · Guides