Description
Encode an explicit document, surface and zone marginalia anchor.
Digital editions separate source readings, editorial uncertainty, witness locators, image requests, identifiers and rights statements. XML character/attribute rules differ from display labels, while URI fragments and TEI pointers need their target-document context. An identifier key or formatted token does not authenticate a witness, validate an edition or authorize reuse.
Encode an explicit document, surface and zone marginalia anchor.
When to use this tool
Use Marginalia Anchor Surface Zone Key when you already have documentId, surfaceId, zoneId and need to encode an explicit document, surface and zone marginalia anchor.
How to use the tool and how it works
- Enter documentId, surfaceId, zoneId. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read token. Use the output convention below.
Enter documentId, surfaceId, zoneId using the field constraints below. Encode these values, in exactly that order, as a JSON array and return the serialized array as text in token. String values are preserved without trimming or external terminology lookup.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| documentId | Document Id | Required. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192. |
| surfaceId | Surface Id | Required. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192. |
| zoneId | Zone Id | Required. Text; minimum UTF-16 length 1; maximum UTF-16 length 8192. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| token | Token | Required. Text; maximum UTF-16 length 8192. |
{
"input": {
"documentId": "D17",
"surfaceId": "S4",
"zoneId": "Z2"
},
"output": {
"token": "[\"D17\",\"S4\",\"Z2\"]"
}
} Limitations and assumptions
- The result records supplied values without resolving facsimile geometry. Sources and asserted relationships are not independently authenticated.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
Alternative or Complementary methods
Validate the complete XML/TEI document or IIIF request when technical conformance matters, and inspect the original witness and rights record for editorial use. Preserve uncertain readings, source order and attribution rather than treating local tokens as verified scholarly interpretations.
References
Similar or alternative tools
- Facsimile Recto Verso Page Key
Build an exact facsimile page key from supplied leaf text and side token.
- Manuscript Quire Signature Source Token
Preserve explicit manuscript quire-signature transcription and source locator.