Skip to content

Main content

Annotation Quote Prefix Suffix Budget Tool

Calculate annotation quote prefix suffix budget from explicit caller-supplied inputs.

Loading tool…

Description

Check a supplied quote-context character budget.

Digital editions connect textual witnesses, anchors, page images and source-specific labels. Literal identifier agreement and numerical offsets preserve a supplied convention without proving textual authority, complete coverage or correct editorial interpretation.

Check a supplied quote-context character budget.

When to use this tool

Use Annotation Quote Prefix Suffix Budget when checking supplied edition identifiers, ordering or coordinate conventions.

How to use the tool and how it works

  1. Enter prefixCharacters, quoteCharacters, suffixCharacters, limit. Use the units and conventions below.
  2. Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
  3. Read used, remaining, fits. Inspect fits before interpreting the associated values.

Check a supplied quote-context character budget. Require nonnegative whole prefixCharacters, quoteCharacters, suffixCharacters and limit; sum into used, subtract from limit for remaining and test used <= limit.1

Input fieldMeaning and unitsAccepted input
prefixCharactersPrefix CharactersRequired. Safe integer; minimum 0.
quoteCharactersQuote CharactersRequired. Safe integer; minimum 0.
suffixCharactersSuffix CharactersRequired. Safe integer; minimum 0.
limitLimitRequired. Safe integer; minimum 0.
Output fieldInterpretationReturned shape
usedUsedRequired. Safe integer.
remainingBudget minus use, in the same units; a negative value indicates excess use.Required. Safe integer.
fitsWhether the calculated use is no greater than the supplied budget.Required. Boolean.
json
{
  "input": {
    "prefixCharacters": 10,
    "quoteCharacters": 40,
    "suffixCharacters": 15,
    "limit": 100
  },
  "output": {
    "used": 65,
    "remaining": 35,
    "fits": true
  }
}

Limitations and assumptions

  • Counts are supplied, not measured; the character convention and context sufficiency are not established.
  • 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

Inspect the original edition and its encoding model before treating local record agreement as meaningful textual or historical evidence.

References

  1. Calculation and input contract: digital-humanities/annotation-quote-prefix-suffix-budget — tool.io

Similar or alternative tools