Specifications
Every specification page lives in docs_src/docs/development/. This page is the
index: new specifications are added here, not to the sidebar.
A specification defines what Katalog is required to do. The code is never the source of requirements — it may contain unauthorised or buggy behaviour. Where a specification and the code disagree, the specification is what was agreed.
| Page | Subject | Status | Implementation | Test plan |
|---|---|---|---|---|
| SpecAbout | ABOUT — VERSION AND SYSTEM INFORMATION | Approved | — | — |
| SpecApplicationIcon | APPLICATION ICON AND DESKTOP INTEGRATION | Approved | — | — |
| SpecApplicationIconBacklogNotes | APPLICATION ICON — RESEARCH NOTES | Reference | — | — |
| SpecBacklogNotes | Backlog Notes | — | — | — |
| SpecBackup | BACKUP | Draft | complete | — |
| SpecBackupLuckyBackupProfile | BACKUP — GENERATE LUCKYBACKUP PROFILE | Available | complete | — |
| SpecCardsAndTables | CARDS, TABLES AND TREES — SHARED DISPLAY CONVENTIONS | Approved | planned | — |
| SpecCatalogChecksum | CATALOG — FILE CHECKSUM | Available | — | — |
| SpecCatalogIncludeExclude | Spec: Catalog Include / Exclude Rules | — | — | — |
| SpecCatalogMetadata | CATALOG — FILE METADATA | — | — | — |
| SpecCollection | SpecCollection — Import / Update across Collections (#750) | — | — | — |
| SpecCollectionExport | COLLECTION EXPORT — CONVERT A COLLECTION TO ANOTHER MODE | Approved | planned | — |
| SpecCollectionIdentity | COLLECTION IDENTITY — NAMING COLLECTIONS IN THE K3 DRAWER | Approved | planned | — |
| SpecCollectionOpen | COLLECTION OPEN — FIRST RUN AND NEW DATABASE | Approved | complete | — |
| SpecComboBoxes | COMBO BOXES — WIDTH AND DROP-DOWN LIST | Approved | planned | — |
| SpecCommandLine | COMMAND LINE — RUNNING KATALOG ACTIONS FROM A TERMINAL | Draft | K2 partial, K3 planned | — |
| SpecDeviceActiveStatus | DEVICE Active Status | Approved | — | — |
| SpecDeviceComment | DEVICE Comment | Approved | complete | — |
| SpecDeviceStorageRoot | DEVICE Storage Root | Approved | partial | — |
| SpecDevicesPage | DEVICES PAGE — CARDS AND TABLE DISPLAY | Approved | planned | — |
| SpecDevicesSplit | DEVICES: Split a Catalog | — | — | — |
| SpecExplore | EXPLORE — DIRECTORY TREE | Approved | complete | — |
| SpecHostedSecurity | HOSTED SECURITY — ONLY LOCAL OR PRIVATE-NETWORK SERVERS | Approved | K2 complete, K3 planned | — |
| SpecIconButtons | ICON BUTTONS — TOOLTIPS ON ICON-ONLY BUTTONS | Approved | planned | — |
| SpecImportVVV2K | Feature Specification: VVV2K — Full Import of a VVV Database into Katalog | — | — | — |
| SpecKeyboardShortcuts | KEYBOARD SHORTCUTS | Approved | complete | — |
| SpecK2Deployment | K2 DEPLOYMENT — STARTUP OF THE LINUX APPIMAGE ON ANY DESKTOP | Approved | mostly complete | — |
| SpecK3Deployment | K3 DEPLOYMENT — QML MODULES AND PLATFORM INTEGRATION IN PACKAGED BUILDS | Approved | mostly complete | — |
| SpecK3ParityGaps | K3 PARITY GAPS — K2 FEATURES NOT YET IN K3 | Reference | — | — |
| SpecLanguages | LANGUAGES — INTERFACE LANGUAGE SELECTION | Approved | complete | — |
| SpecPageLayout | PAGE LAYOUT — SCROLLBAR MARGIN AND SECTION TITLES | Approved | planned | — |
| SpecMimeVerification | MIME VERIFICATION — VERIFY MIME TYPES ON A CATALOG | Approved | planned | — |
| SpecOperationQueue | OPERATION Queue | Specified | — | — |
| SpecProgressReport | Progress Reporting | — | — | — |
| SpecQualityCheck | QUALITY Check | Draft | planned (phase 1) | — |
| SpecSearchList | SEARCH List as Input | Approved | — | — |
| SpecSearchResults | SEARCH RESULTS | Approved | planned | — |
| SpecSearchResultsFilters | SEARCH RESULTS — QUICK FILTER AND CATALOGS FILTER | Approved | planned | — |
| SpecSelection | SELECTION — SELECTED DEVICE | Approved | planned | — |
| SpecSettingsPage | SETTINGS PAGE — APPLICATION AND COLLECTION TABS | Approved | planned | — |
| SpecStorageIdentity | STORAGE Identity | Approved | planned | TestStorageIdentity |
| SpecTheme | Theme, colour derivation and icon size | Draft | partial | — |
| SpecTypography | TYPOGRAPHY — TEXT SIZE DERIVED FROM THE SYSTEM FONT | Approved | partial | — |
| SpecValidationRules | Form Validation Rules | Approved | partial | — |
| SpecVersionCheck | VERSION CHECK — NEW VERSION AVAILABLE | Approved | complete | — |
| SpecVersions | Version Numbers | — | — | — |
| SpecWindowGeometry | WINDOW GEOMETRY — SIZE AND POSITION OF THE K3 WINDOW | Approved | partial | — |
Conventions
- Requirement IDs use a per-page prefix (
STI-,DSR-,OPQ-…) and are permanent: never renumbered, never reused, retired as[Removed]rather than deleted. - Requirements are grouped as Operational (
-O, why and for whom), Functional (-F, what the system does) and Constructional (-C, how it is built, and the MUST-NOTs). - Each row carries a status:
[Implemented]/[Planned]/[Backlog]/[Removed]. - Specification pages are English only.
Page design rules are in Dev-Documentation.