sillsdev / sillsdev/interlinearizer-extension
Add lexicon ref resolution when copying a Paratext 9 import for editing
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 0
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 55
Description
The PT9 import stack ships a lexicon-resolution seam with nothing plugged into it, so every import
persists gloss text and no lexicon refs. That deferral (#273) is right for the import project
itself. It is not right for an editable copy, which is the one place PT9 lexeme identity becomes
unrecoverable.
Current state
- The seam exists and is fully wired.
Pt9LexiconResolver
(src/converters/pt9/lexiconResolver.ts) offers
resolveEntry(key)->EntryRefandresolveSense(key, senseId)->SenseRef. Every ref site the
converter can produce already calls it: morphemeentryRef/senseRefand token-level
glossSenseRefinanalysisMerger.ts, morpheme refs on
bare-word payloads inbareWordAnalyses.ts. Outcomes are
counted in the import report (senses.entryRefsResolved/entryRefsUnresolved, same for senses). - Nothing supplies an implementation.
pt9ImportService.importPt9Projectcalls
convertPt9Project({ data, books, importedAt })with noresolver, so
unresolvedPt9LexiconResolverapplies, every lexeme counts as unresolved, and imported analyses
carry inlined gloss text and zero refs. - The identity is in the payload, not missing.
Pt9InterlinearProjectData.lexiconcarries
entrieskeyed by composed lexeme-key id andsenseswith ids and per-language glosses - the same
datapt9GlossSourcealready reads for gloss text. For PT9
the seam's work is minting refs from data in hand, not looking anything up.
Why the copy is the case that matters
lexiconResolver.ts records the current rationale: a PT9-authority ref "would store fine as a
foreign ref, but nothing would ever resolve it; re-importing recovers the identity instead."
That holds for the import project, which is frozen and replaced wholesale by savePt9Import on
every run. It does not hold for a copy:
createEditableCopyclones the analysis, keepssourceProjectId, and dropspt9Import.- Re-import finds its target through
getPt9ImportForSource, which matches onpt9Import. A copy
carries none, so no re-import ever touches one.
So the artifact the user actually edits and keeps is the one artifact whose dropped PT9 lexeme
identity cannot be recovered. Re-importing produces a fresh import project; the user's edits stay
behind in the old copy, still refless.
Ask
- Implement a PT9-authority resolver over the served
Pt9Lexiconand pass it from
pt9ImportService. - Name the authority constant (
paratext9, following whatever convention #226 fixes). - Decide
projectId. PT9's lexicon lives in the PT9 project, so the id space is partitioned and a
ref must carry one.LexiconRef.projectIdalready anticipates exactly this: "an authority whose
lexicon lives in a Paratext project may well use a Paratext project id here, even the analyzed
project's own." - Test the case this issue exists for: an import that carries refs, copied, still carries them.
- Fold and render
report.sensesin the import report summary.foldReport
(Pt9ImportModal.tsx) deliberately leaves it out today, since with no resolver every run
would show zero resolved;ReportTotalscarries a TODO pointing here.
Display does not change, and must not. No registered resolver declares paratext9, so per
#225/#269 every minted ref is foreign - never resolved, never dropped, rendered as the stored
free-form gloss, which import already inlines. These refs are provenance now and resolvable later.
Open questions
entryIdis not a GUID here. The model documentsEntryRef.entryIdasIEntry.id(GUID); a
PT9 ref carries a composed lexeme key (Stem:exauc,Word:a:2). Either that doc widens to
"whatever the authority mints" or PT9 refs need a different shape. Widening looks right -
authorities are opaque by design - but it should be written down, not assumed.- Senses with no id.
Pt9GlossOutcome.defaultSinglecan produce gloss text from a sense carrying
no id, andbareWordAnalysesonly attempts asenseRefwhen the languages agree on exactly one
id. Confirm an entry-only ref is the intended outcome there. - Minting only, or a provider too? Minting is self-contained. Actually resolving these refs needs
something that declares theparatext9authority - a PT9 lexicon provider, which is a live
candidate for the tier-1 slot in #46 and for #44's "create from Paratext 9 data." Mint regardless;
whether this issue also provides is the open part.
Non-goals
No PT9 lexicon provider, no lexicon UI, no writes to any lexicon. Minting refs during import and
keeping them through createEditableCopy.
Blocked on
#226, for the convention naming an authority constant. This is the first code path in the repo that
mints a ref, and #226 exists partly so the first writer does not improvise a label that then
persists.
Relationship
Completes #150's scope item 3 (gloss-text resolution) on the identity half - #150's open question
"import to glossSenseRef vs. literal gloss text vs. both?" is answered here as both. What a
resolvable ref renders as is #227's ladder.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with src/converters/pt9/lexiconResolver.ts, pt9ImportService, analysisMerger.ts, bareWordAnalyses.ts, and Pt9ImportModal.tsx; resolve the authority convention from blocked issue #226. Trace createEditableCopy and the PT9 import report, then add coverage for refs surviving an editable copy and for the folded senses totals. Done means PT9 imports mint refs, copies retain them, and the report renders sense totals without changing display behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- backend, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100