]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - docs/inventory.md
Implement XTM association reification with native conformance evidence
[topic-maps.git] / docs / inventory.md
1 # Pinned corpus and consulted references
2
3 ## Location and base evidence
4
5 The user approved a new independent Git repository at
6 `/Users/rgb/workspace/topic-maps`, branch `codex/ctm-slice-0`.
7 The directory was checked twice and did not exist; no existing contents were
8 overwritten. The chosen implementation base is an **empty new repository**,
9 with no parent/base commit. The Slice 0 delivery is its root commit, obtained
10 with `git rev-parse HEAD`. No HyperDoc code or commit is the implementation base.
11
12 Before creating it, Git inspection established:
13
14 | Observed checkout | Branch | HEAD | State |
15 | --- | --- | --- | --- |
16 | `/Users/rgb/workspace/hyperdoc-dreyeck-ch` | `dreyeck.ch` | `9a1764250f31013a50965aad324dd72c0662b9cc` | Clean |
17 | `/Users/rgb/workspace/hyperdoc-querying-topicmaps` | `codex/querying-topicmaps` | `ca3c46b6e37b8e5e253c4faabc4819ff36bc64e8` | Clean |
18
19 The actual repository is the shared HyperDoc Git repository whose primary
20 worktree is `/Users/rgb/workspace/hyperdoc`. `git worktree list --porcelain`
21 identified the above worktrees. HyperDoc's ASDF source/test component conventions,
22 `nix/catalog-check.nix` fresh-process flags, and `flake.nix`/`flake.lock` were
23 inspected read-only. The independent project uses ASDF test-op and its own
24 source registry; only the existing nixpkgs revision was reused for a minimal
25 dev shell. No HyperDoc runtime dependencies or authoring systems were imported.
26 No running SBCL image, server, browser application, SSH session or deployment
27 was used for this slice.
28
29 ## Exact versions
30
31 Published ISO standards are the normative authority. These are the consulted
32 web references, not redistributed standard documents:
33
34 | Reference | Edition/revision |
35 | --- | --- |
36 | [CTM](https://www.isotopicmaps.org/ctm/ctm.html) | ISO/IEC 13250-6:2010; consulted web bytes SHA-256 recorded |
37 | [TMDM](https://www.isotopicmaps.org/sam/sam-model/2006-06-18/) | ISO/IEC 13250-2:2006, dated SC34 text 2006-06-18; consulted bytes SHA-256 recorded |
38 | [Heuer CXTM](https://github.com/heuer/cxtm/tree/cd165b150176c1d6842b37be9cc9051b40d4996b) | `cd165b150176c1d6842b37be9cc9051b40d4996b` |
39 | [Ontopia](https://github.com/ontopia/ontopia/tree/49071fea60243540b5581b78702a77ba8064235d) | `49071fea60243540b5581b78702a77ba8064235d` |
40 | [Ontopia externals](https://github.com/ontopia/externals/tree/acba0660303cf9a3bfcb0c0df81319f1e1065bef) | `acba0660303cf9a3bfcb0c0df81319f1e1065bef` |
41 | nixpkgs | `50ab793786d9de88ee30ec4e4c24fb4236fc2674`; independent flake lock |
42
43 [Sources metadata](../references/sources.json) records consultation date,
44 exact immutable source URLs, file digests, web snapshot digests, licenses and
45 distribution comparisons. For Ontopia, the consulted files are its license,
46 `CTMTestCase.java`, `CTMInvalidTestCase.java`, `CTMTopicMapReader.java`, and `ctm.g`.
47 The Java tests use separate valid/invalid directories, compare valid canonical
48 results against baselines and distinguish invalid-topic-map rejection from
49 unexpected exceptions. Ontopia is implementation evidence, not normative
50 authority; none of its implementation is copied or run in this project.
51
52 The externals distribution has **201 valid CTM files, 27 invalid CTM files and
53 201 CXTM baselines**, according to its pinned recursive Git tree. Its own
54 `STATUS.txt` refers to the **CTM and CXTM drafts of 2009-03-xx**. It is not the
55 same revision of the suite used here. The pinned tree and Git-blob comparison
56 are recorded in references; differing files are listed, without assuming test
57 equivalence. The distribution's README describes a Maven repackaging of CXTM
58 inputs. It is not used as a replacement corpus.
59
60 ## Acquisition and byte preservation
61
62 The complete Heuer Git tree was acquired with:
63
64 ```sh
65 git clone https://github.com/heuer/cxtm.git /private/tmp/ctm-slice-0-cxtm
66 git -C /private/tmp/ctm-slice-0-cxtm rev-parse HEAD
67 git -C /private/tmp/ctm-slice-0-cxtm archive --format=tar \
68 cd165b150176c1d6842b37be9cc9051b40d4996b
69 ```
70
71 The archive was extracted under `vendor/cxtm`, without edits, conversion of
72 encodings or nested Git metadata. Its SHA-256 is
73 `19d88764908426ca1971213ef36063a72994a4a199bb3d46ac8b63aa435198d2`.
74 [corpus-lock.json](../references/corpus-lock.json) inventories **all 2,006
75 upstream files** by original path, size and SHA-256. The Lisp lock's expected
76 counts were generated from the recounted CTM subtree. They are observations
77 at this revision, not assumptions imported from a previous GitHub inspection.
78
79 `python3 scripts/corpus.py acquire` reproduces the acquisition when the vendor
80 directory is absent; existing content is verified and never overwritten.
81 `python3 scripts/corpus.py verify` checks the complete manifest, including
82 missing, additional and changed bytes, with no network access.
83 Independent fixtures test those failure modes. The upstream public-domain
84 notice and no-warranty statement remain in `vendor/cxtm/LICENSE.txt`.
85
86 ## Original structure and CTM inventory
87
88 The full upstream root structure is retained:
89
90 ```
91 .gitattributes CHANGES.txt LICENSE.txt README release.py
92 ctm/ jtm/ jtm11/ ltm/ rdf/ snello/ tmcl/ tmxml/
93 web/ xtm1/ xtm2/ xtm21/
94 ```
95
96 Only the CTM subtree supplies this project's initial cases:
97
98 | Original directory/file | Observed count | Classification |
99 | --- | ---: | --- |
100 | `ctm/in/*.ctm` | 231 | Valid-category CTM test inputs |
101 | `ctm/invalid/*.ctm` | 42 | Invalid-category CTM test inputs |
102 | `ctm/baseline/*.ctm.cxtm` | 231 | Expected canonical baselines |
103 | `ctm/in/*.sub` | 13 | Include/mergemap resources |
104 | `ctm/in/*.sub2` | 1 | Additional include resource |
105 | `ctm/invalid/*.sub` | 5 | Invalid-case include/mergemap resources |
106 | `ctm/baseline/name-type.ctm` | 1 | XML-shaped upstream artifact; not a CTM input or a `.cxtm` baseline |
107 | `ctm/STATUS.txt`, `ctm/MISSING.txt` | 2 | Draft qualification and upstream gap notes |
108
109 There are **526 files** in this subtree: 273 inputs, 231 baselines and 22
110 auxiliaries. Every valid input corresponds to `baseline/<input-name>.cxtm`.
111 Missing baselines: **0**. Unmatched baselines: **0**. Invalid cases have no
112 expected CXTM baseline. The JSON report lists every case, baseline and auxiliary
113 resource. Auxiliary contents can be CTM fragments or XML; no decoder is applied
114 by discovery, including to the ISO-8859-5 encoded CTM test.
115
116 ## Limitations retained from upstream
117
118 **The imported CTM tests target the draft dated 2010-03-31. Passing them alone
119 would not establish full ISO/IEC 13250-6:2010 conformity.** They are independent
120 testing evidence; all imported cases remain NOT-RUN in Slice 0.
121
122 The upstream README describes the CTM collection as incomplete. `MISSING.txt`
123 asks for more nested-topic, non-HTTP IRI and template tests, plus invalid
124 duplicate-template and possible infinite-template-loop cases. Those notes are
125 preserved as historical gap statements, not treated as proof of current total
126 absence: the pinned tree already includes `subject-identifier-non-http.ctm`
127 and `invalid/template-name-collision.ctm`. Complete edge-case coverage and a
128 published-edition-versus-draft audit still require review. No filename-based
129 inventory can establish semantic completeness or baseline correctness.