Description
Return stanza sequence index with optional pickup credit.
Historical and archival records distinguish source labels, local grid conventions, edition numbers and validity periods. A parsed token or geometric area term cannot establish provenance, historical identity or land rights. Date endpoints, text-counting units and numbering origins must match the original record.
Return stanza sequence index with optional pickup credit.
When to use this tool
Use Public Song Stanza Pickup when checking the stated archival record, grid, edition or validity-period convention.
How to use the tool and how it works
- Enter printedStanza, pickupStanzas, includePickup. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read sequenceIndex. Use the output convention below.
Return stanza sequence index with optional pickup credit. Require nonnegative whole printedStanza/pickupStanzas; sequenceIndex adds pickups only when includePickup.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| printedStanza | Printed Stanza | Required. Safe integer; minimum 0. |
| pickupStanzas | Pickup Stanzas | Required. Safe integer; minimum 0. |
| includePickup | Include Pickup | Required. Boolean. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| sequenceIndex | Sequence Index | Required. Safe integer. |
{
"input": {
"printedStanza": 3,
"pickupStanzas": 1,
"includePickup": true
},
"output": {
"sequenceIndex": 4
}
}Limitations and assumptions
- This is a supplied indexing convention, not song transcription, metrical interpretation or source authentication.
- 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.
- Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Numeric signed-zero results are exported as zero.
Alternative or Complementary methods
Consult the original archive, survey and applicable authority for historical interpretation, provenance or actual property rights.
References
Similar or alternative tools
- Public Township Section Index
Return section position in a supplied township grid.
- Archive Reel Frame Boundary
Return local archive-frame offset and reel inclusion.