Description
Reorder supplied unique facsimile canvas IDs by a complete zero-based permutation.
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.
Reorder supplied unique facsimile canvas IDs by a complete zero-based permutation.
When to use this tool
Use Facsimile Canvas Page Order when you already have canvasIds, zeroBasedOrder and need to reorder supplied unique facsimile canvas IDs by a complete zero-based permutation.
How to use the tool and how it works
- Enter canvasIds, zeroBasedOrder. Follow any array-alignment requirements below. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read orderedCanvasIds. Use the output convention below.
Require equal-length arrays, unique canvas IDs and unique order indices; every index must be a safe integer in [0,length-1]. Return IDs in that index order.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| canvasIds | Canvas Ids | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
| zeroBasedOrder | A full unique permutation of indices 0..canvasIds.length-1; both arrays may be empty. | Required. Array of safe integer; maximum items 256. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| orderedCanvasIds | Ordered Canvas Ids | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
{
"input": {
"canvasIds": [
"c1",
"c2",
"c3"
],
"zeroBasedOrder": [
2,
0,
1
]
},
"output": {
"orderedCanvasIds": [
"c3",
"c1",
"c2"
]
}
}Limitations and assumptions
- Empty arrays are accepted and IDs may be empty text if unique. No manifest, image, reading order, page identity or IIIF resource is retrieved or verified.
- 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
- IIIF Image Rotation Mirror Token
Format a supplied IIIF-style rotation token with an optional mirror marker.
- Facsimile Recto Verso Page Key
Build an exact facsimile page key from supplied leaf text and side token.