Description
Return a supplied regional-title sorting key.
Regional records connect place labels, language coverage, source vintages, calendar offsets and historical units. A literal label or supplied year offset can organize metadata without resolving changes in borders, calendar systems or naming authority. Unknown and ambiguous values must retain their explicit flags.
Return a supplied regional-title sorting key.
When to use this tool
Use Regional Title Particle Sort Flag when checking the stated regional record, period, hierarchy or text convention.
How to use the tool and how it works
- Enter title, particle, ignoreParticle. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read sortKey, particleRemoved. Inspect particleRemoved before interpreting the associated values.
Return a supplied regional-title sorting key. Require nonempty particle; remove it only when ignoreParticle and title has that exact prefix, return whether removed.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| title | Title | Required. Text; maximum UTF-16 length 8192. |
| particle | Particle | Required. Text; maximum UTF-16 length 8192. |
| ignoreParticle | Ignore Particle | Required. Boolean. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| sortKey | Sort Key | Required. Text; maximum UTF-16 length 8192. |
| particleRemoved | Particle Removed | Required. Boolean. |
{
"input": {
"title": "The Archive",
"particle": "The ",
"ignoreParticle": true
},
"output": {
"sortKey": "Archive",
"particleRemoved": true
}
}Limitations and assumptions
- No trimming, case folding or locale collation occurs; actual language-specific title policy and source identity are not inferred.
- 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 original sources, applicable calendar and historical naming/measurement authorities for geographic or historical interpretation.
References
Similar or alternative tools
- Print State Number Token
Parse a print-state number after a supplied prefix.
- Public Census Enumeration Token
Parse a source-namespaced census reference.