]> dreyeck.freedombox.rocks Git - topic-maps.git/blob - docs/coverage.md
Implement XTM occurrence reification with native conformance evidence
[topic-maps.git] / docs / coverage.md
1 > Historical Slice 0 inventory below. Current Slice 18 implementation and the
2 > explicit Template exclusions are documented in
3 > [Reading CTM Templates](reading-ctm-templates.md) and
4 > [Slice 18 validation](slice-18-validation.md). The historical “No” column below
5 > describes Slice 0, not the current reader.
6
7 # Coverage and standards traceability
8
9 Three independent questions are recorded separately: specification coverage,
10 corpus evidence and Common Lisp implementation. **CTM parsing/deserialization
11 is implemented for none of these features in Slice 0.** Corpus files provide
12 expected contracts; they are not executed and none is PASS.
13
14 Normative reference: [ISO/IEC 13250-6:2010, consulted CTM text](https://www.isotopicmaps.org/ctm/ctm.html).
15 TMDM semantics refer to the [2006 edition](https://www.isotopicmaps.org/sam/sam-model/2006-06-18/).
16 The corpus targets the **CTM draft dated 2010-03-31**; passing it alone cannot
17 establish full published-edition conformity. Revisions are pinned in inventory.
18
19 ## Reviewed Slice 1 subjects
20
21 Paths in this table are relative to `vendor/cxtm/ctm`; every listed file exists
22 and its contents were inspected. Clause associations were checked against the
23 consulted normative text and are recorded on the corresponding case records.
24 They identify applicable clauses, not exhaustive coverage of those clauses.
25
26 | Feature specified by CTM | Evidence in corpus | Verified normative clauses | Implemented in CL? |
27 | --- | --- | --- | --- |
28 | Local Topic Identifiers | `in/simple.ctm` | [3.3.6](https://www.isotopicmaps.org/ctm/ctm.html#sec-topic-identity), 3.8, 3.2 | No |
29 | Subject Identifiers | `in/subject-identifier.ctm`, `in/topic-subject-identifier.ctm` | 3.3.6; 3.8 or 3.9 respectively | No |
30 | Subject Locators | `in/subject-locator.ctm`, `in/topic-subject-locator.ctm` | 3.3.6; 3.8 or 3.9 respectively | No |
31 | Item Identifiers | `in/item-identifier.ctm`, `in/topic-item-identifier.ctm` | 3.3.6; 3.8 or 3.9 respectively | No |
32 | Simple Topic Names | `in/name.ctm`, `in/name2.ctm` | [3.11](https://www.isotopicmaps.org/ctm/ctm.html#sec-name), 3.8 | No |
33 | Prefix resolution | `in/prefix-duplicate.ctm`, `in/prefix-multiline.ctm`, `invalid/prefix-undefined.ctm` | [3.3.4](https://www.isotopicmaps.org/ctm/ctm.html#sec-creating-iris-from-qnames), [3.16.1](https://www.isotopicmaps.org/ctm/ctm.html#dir-prefix); multiline also 3.3.1 | No |
34 | Document IRI handling | `in/simple.ctm`, `in/subject-identifier-relative.ctm`, `in/subject-locator-relative.ctm`, `in/item-identifier-relative.ctm` | 3.2, [3.3.3](https://www.isotopicmaps.org/ctm/ctm.html#sec-creating-iris), 3.3.6 | No |
35
36 The foundation assigns explicit fixture Document IRIs; that metadata operation
37 is not an implementation of CTM's resolution/deserialization rules.
38
39 ## Other represented features
40
41 Representative inputs were inspected to establish that the corpus includes
42 these constructs. The specification defines them in the indicated sections;
43 individual edge-case mappings and draft/final alignment still require review.
44 These cases keep empty clause lists until that review is done.
45
46 | Corpus feature | Representative input | Relevant section / mapping review | Implemented? |
47 | --- | --- | --- | --- |
48 | Associations and role notation | `in/association-binary.ctm` | [3.13](https://www.isotopicmaps.org/ctm/ctm.html#sec-assoc); detailed case mapping pending | No |
49 | Occurrences | `in/occurrence-string.ctm` | [3.10](https://www.isotopicmaps.org/ctm/ctm.html#sec-occurrence); detailed mapping pending | No |
50 | Variants | `in/variant.ctm` | [3.12](https://www.isotopicmaps.org/ctm/ctm.html#sec-variant); detailed mapping pending | No |
51 | Templates | `in/template-simple.ctm` | [3.14](https://www.isotopicmaps.org/ctm/ctm.html#sec-template), 3.15; detailed mapping pending | No |
52 | Include and mergemap resources | `in/include.ctm`, `in/mergemap.ctm` and their `.sub` files | 3.16.2–3; detailed mapping pending | No |
53 | Wildcards | `in/wildcard.ctm` | 3.3.8; detailed mapping pending | No |
54 | Encoding | `in/encoding-8859-5.ctm` | 3.6 and 3.2; detailed mapping pending | No |
55
56 Additional filename families cover scope, reification, type-instance/subtype
57 shortcuts, numeric/date values, escapes and nested topics. Their clause/case
58 correspondence is explicitly **unreviewed** in this slice. Nothing infers a
59 coverage claim from the prefix of a filename alone.
60
61 ## Known gaps and what Slice 1 needs
62
63 The original `MISSING.txt` is retained; its historical notes overlap some later
64 additions (see inventory). A comprehensive boundary-value matrix, all invalid
65 paths, cross-construct interactions and the 2010 draft/final audit are pending.
66 A canonical baseline proves neither its own correctness nor exhaustive coverage.
67 No canonicalizer, lexer, parser, model or deserializer exists in this project.
68
69 Slice 1 needs an actual reader and the minimal semantic support warranted by
70 its chosen cases. It must address local identifiers, the three explicit identity
71 forms, simple names, prefix binding and explicit Document-IRI resolution.
72 Semantic baselines must not be replaced by success flags or mocked model data.
73 If only a reader exists initially, canonical comparison remains NOT-RUN or
74 UNSUPPORTED as appropriate until a warranted comparison path exists.
75
76 ## First five proposed semantic cases
77
78 1. **`ctm/in/simple.ctm`** — a single local identifier. Establishes a Topic and
79 its Document-IRI-relative item identity without adding names or relations.
80 2. **`ctm/in/subject-identifier.ctm`** — a Topic referenced directly by a
81 Subject Identifier; distinguishes subject identification from local item identity.
82 3. **`ctm/in/subject-locator.ctm`** — the explicit Subject Locator form; keeps
83 that property distinct from a Subject Identifier.
84 4. **`ctm/in/item-identifier.ctm`** — the explicit Item Identifier form; completes
85 the three identity forms without extra topic-tail syntax.
86 5. **`ctm/in/name.ctm`** — a simple name and its canonical representation,
87 extending the first local Topic case with one descriptive assertion.
88
89 Each has a matching original CXTM baseline. They form a small semantic set
90 rather than merely accepted strings. Next come `prefix-multiline.ctm`,
91 `prefix-duplicate.ctm`, `invalid/prefix-undefined.ctm` and the three relative
92 identifier cases. These proposed selections do not change their NOT-RUN status.
93
94 **Ready for Slice 1: Yes.** The reproducible test foundation is available for
95 review. Slice 1 is not started automatically.