Description
Count collectionParts and seriesParts and add one to combinedDepth only when includeCollectionRoot.
Historical and public-register references combine repositories, series, titles and local identifiers. A syntactic token or hierarchy count helps organize records without authenticating the source or establishing a document's historical or legal meaning.
Count collectionParts and seriesParts and add one to combinedDepth only when includeCollectionRoot.
When to use this tool
Use Public Register Series Depth when you need a literal archival or public-register record operation.
How to use the tool and how it works
- Enter collectionParts, seriesParts, includeCollectionRoot. Keep parallel arrays aligned. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read collectionDepth, seriesDepth, combinedDepth. Use the output convention below.
Count collectionParts and seriesParts and add one to combinedDepth only when includeCollectionRoot.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| collectionParts | Collection Parts | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
| seriesParts | Series Parts | Required. Array of text; maximum UTF-16 length 8192; maximum items 256. |
| includeCollectionRoot | Include Collection Root | Required. Boolean. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| collectionDepth | Collection Depth | Required. Safe integer. |
| seriesDepth | Series Depth | Required. Safe integer. |
| combinedDepth | Combined Depth | Required. Safe integer. |
{
"input": {
"collectionParts": [
"A"
],
"seriesParts": [
"B",
"C"
],
"includeCollectionRoot": true
},
"output": {
"collectionDepth": 1,
"seriesDepth": 2,
"combinedDepth": 4
}
}Limitations and assumptions
- Parts are supplied list entries rather than parsed catalog paths. The count does not verify archival hierarchy, uniqueness or an official description standard.
- 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
Consult the source repository's catalog and description conventions for identity and interpretation. Preserve original references and resolve language, hierarchy and identifier rules before treating a token match as an authenticated record.
References
Similar or alternative tools
- Public Register Volume Token
Serialize repository, series and volumeToken as a JSON-array source key, and flag volume presence by trimmed nonempty text.
- Manuscript Quire Leaf Parity
Floor-divide for bifoliumIndex and return remainder slot.