schaefera/utStudyBIble
Watch
1
0
Fork
You've already forked utStudyBIble
 0
Code Issues 62 Pull requests Projects Releases Packages Wiki Activity Actions

F6: cross-references and footnotes (module markup + TSK) #13

New issue
Open
opened 2026-10-20 18:52:05 +00:00 by claude-bot · 4 comments
claude-bot commented 2026-10-20 18:52:05 +00:00
Collaborator

Phase 1 item (docs/04-features.md F6).

  • Inline markers for OSIS <note type="crossReference">, <reference> and footnotes.
  • Tap a marker → popup listing each reference with its verse text from the current Bible. Tap → jump; Back → exact previous position (history from the reading window issue). Long-press → second window (v0.2, stub for now).
  • TSK (zCom) as the cross-reference source for any Bible: "Cross-references" in the verse menu. Parse its free-text references (Ps 18:40-43; 78:68); same fallback for relative refs like Elberfelder 1871's Kap 6,5.
  • Greyed out with an explanation when neither the module nor TSK is available.
Phase 1 item (docs/04-features.md F6). - Inline markers for OSIS `<note type="crossReference">`, `<reference>` and footnotes. - Tap a marker → popup listing each reference with its verse text from the current Bible. Tap → jump; Back → exact previous position (history from the reading window issue). Long-press → second window (v0.2, stub for now). - TSK (zCom) as the cross-reference source for any Bible: "Cross-references" in the verse menu. Parse its free-text references (`Ps 18:40-43; 78:68`); same fallback for relative refs like Elberfelder 1871's `Kap 6,5`. - Greyed out with an explanation when neither the module nor TSK is available.
claude-bot commented 2026-10-29 13:15:40 +00:00
Author
Collaborator

Design (agreed with the owner, 2026-10-29)

Mockups: the #13 design canvas (owner's private artifact LKo59hG9K71zkvpJAF6QoB).

Decisions

  1. Markers: small raised letters. The label is the module's own n if it has one, else a–z restarting at "a" in each verse ("aa" as a fallback past z; 6a measures the busiest verse to confirm it's rare). No Display setting and no dot style in #13 → #116.
  2. Verse sheet: tapping the verse number opens a sheet with Cross-references (TSK · N), Notes and Copy verse. A row with nothing behind it (e.g. no notes in this verse) is greyed out with a reason.
  3. Long lists: capped at 5 with "Show all N". Tapping that grows the sheet to near full height and lists all N with full verse text, scrolling.
  4. A reference the current Bible lacks: shown greyed with "Not in this Bible", not hidden.
  5. Long-press on a reference: offers nothing until the second window (v0.2).
  6. Relative references (Kap 6,5): not in #13 → #117. Until then they stay plain text, never wrong links.
  7. TSK missing: the Cross-references row is greyed, with "Needs the TSK module" and an Install TSK button that opens Modules on TSK.
  8. Bottom sheet: one reusable control in qml/controls/ (Strong's and morphology will reuse it).

Split into PRs (one at a time):

  • 6a sword: note bodies, <reference osisRef>, ThML <scripRef>; marker positions in runs. Goldens for KJV, BSB, Darby, Elberfelder. No UI.
  • 6b core: reference parser (core/src/bible/refs.rs) for TSK free text, osisRef and cross-chapter ranges; TSK sweep ≥ 99.9 % parsed. No UI.
  • 6c render/worker/glue/QML: markers, the generic bottom sheet, note popup, tap a reference to jump (Back returns to the exact spot). Phone check.
  • 6d TSK cross-references from the verse sheet, greyed and Install TSK when missing; memory effect of the second open module stated against docs/07. Phone check.

🤖 Generated with Claude Code

## Design (agreed with the owner, 2026-10-29) Mockups: the #13 design canvas (owner's private artifact LKo59hG9K71zkvpJAF6QoB). **Decisions** 1. **Markers:** small raised letters. The label is the module's own `n` if it has one, else a–z restarting at "a" in each verse ("aa" as a fallback past z; 6a measures the busiest verse to confirm it's rare). No Display setting and no dot style in #13 → #116. 2. **Verse sheet:** tapping the verse number opens a sheet with Cross-references (TSK · N), Notes and Copy verse. A row with nothing behind it (e.g. no notes in this verse) is greyed out with a reason. 3. **Long lists:** capped at 5 with "Show all N". Tapping that grows the sheet to near full height and lists all N with full verse text, scrolling. 4. **A reference the current Bible lacks:** shown greyed with "Not in this Bible", not hidden. 5. **Long-press on a reference:** offers nothing until the second window (v0.2). 6. **Relative references** (`Kap 6,5`): not in #13 → #117. Until then they stay plain text, never wrong links. 7. **TSK missing:** the Cross-references row is greyed, with "Needs the TSK module" and an **Install TSK** button that opens Modules on TSK. 8. **Bottom sheet:** one reusable control in `qml/controls/` (Strong's and morphology will reuse it). **Split into PRs** (one at a time): - **6a** sword: note bodies, `<reference osisRef>`, ThML `<scripRef>`; marker positions in runs. Goldens for KJV, BSB, Darby, Elberfelder. No UI. - **6b** core: reference parser (`core/src/bible/refs.rs`) for TSK free text, osisRef and cross-chapter ranges; TSK sweep ≥ 99.9 % parsed. No UI. - **6c** render/worker/glue/QML: markers, the generic bottom sheet, note popup, tap a reference to jump (Back returns to the exact spot). Phone check. - **6d** TSK cross-references from the verse sheet, greyed and Install TSK when missing; memory effect of the second open module stated against docs/07. Phone check. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
claude-bot commented 2026-10-30 09:16:12 +00:00
Author
Collaborator

Phone QC: merged main 6bc07b8 (all of F6: 6a to 6d)

Installed on the phone; the footer shows 6bc07b83e.

Checked on the phone (ute2e taps, shots, journal), or by e2e where the phone tools can't reach:

  • Note markers in the text; a tap opens the note sheet with each reference and its verse text. A tap jumps there, and Back returns to the exact place (6a–6c, e2e note-sheet).
  • A tap on a verse's text (not only its number) opens its sheet, in both the verse-per-line and running-text layouts. Checked on John 11:4 and 11:10, and in e2e verse-text-tap.
  • The verse sheet shows the verse under its reference, its notes (greyed "none in this verse" when empty) and TSK's cross-references with the BSB's text: five, then "Show all 21". The jump to John 11:45 and Back to John 11:1 work.
  • Without TSK, the row is greyed with "Needs the TSK module" and an "Install TSK" button (e2e verse-sheet-no-tsk). A removed or updated TSK is closed or reopened (core tests).
  • The copy icon sits at the sheet's title in Suru style: a tap copies, and a long press shows "Copy this verse" (the tooltip is in e2e verse-copy; too brief to catch with the phone tools).
  • A swipe over the text scrolls without opening a sheet.
  • Memory: +3.3 MB PSS with TSK sheets open (63078 → 66342 kB).

For you (feel and sign-off only):

  • Does tapping the text feel right next to the note markers? Do the markers stay easy to hit, and are there any accidental sheet opens while reading or scrolling?
  • The sheets in the system's dark theme.
  • Sign-off for #13. I'll keep the issue open until then.

Screenshots are on PR #130.

## Phone QC: merged main 6bc07b8 (all of F6: 6a to 6d) Installed on the phone; the footer shows `6bc07b83e`. **Checked on the phone (ute2e taps, shots, journal), or by e2e where the phone tools can't reach:** - [x] Note markers in the text; a tap opens the note sheet with each reference and its verse text. A tap jumps there, and Back returns to the exact place (6a–6c, e2e note-sheet). - [x] A tap on a verse's text (not only its number) opens its sheet, in both the verse-per-line and running-text layouts. Checked on John 11:4 and 11:10, and in e2e verse-text-tap. - [x] The verse sheet shows the verse under its reference, its notes (greyed "none in this verse" when empty) and TSK's cross-references with the BSB's text: five, then "Show all 21". The jump to John 11:45 and Back to John 11:1 work. - [x] Without TSK, the row is greyed with "Needs the TSK module" and an "Install TSK" button (e2e verse-sheet-no-tsk). A removed or updated TSK is closed or reopened (core tests). - [x] The copy icon sits at the sheet's title in Suru style: a tap copies, and a long press shows "Copy this verse" (the tooltip is in e2e verse-copy; too brief to catch with the phone tools). - [x] A swipe over the text scrolls without opening a sheet. - [x] Memory: +3.3 MB PSS with TSK sheets open (63078 → 66342 kB). **For you (feel and sign-off only):** - [ ] Does tapping the text feel right next to the note markers? Do the markers stay easy to hit, and are there any accidental sheet opens while reading or scrolling? - [ ] The sheets in the system's dark theme. - [ ] Sign-off for #13. I'll keep the issue open until then. Screenshots are on PR #130.
claude-bot commented 2026-10-30 11:29:28 +00:00
Author
Collaborator

PR #131 is merged (1889ec6): the verse and note sheets now scroll on a drag, short and after Show all. They close on a tap on the dimmed page or on Back, no longer on a downward swipe. Merged main is installed on the phone (build 1889ec689).

Still open here: your feel items from the checklist above and your sign-off.

PR #131 is merged (1889ec6): the verse and note sheets now scroll on a drag, short and after Show all. They close on a tap on the dimmed page or on Back, no longer on a downward swipe. Merged main is installed on the phone (build 1889ec689). Still open here: your feel items from the checklist above and your sign-off.
claude-bot commented 2026-10-30 14:33:31 +00:00
Author
Collaborator

#134 is merged. It covers the remarks from today:

  • Note markers are link blue and italic, as in the mockup: #1557a0 in light, #8ab4f8 in dark.
  • A tap within half a touch size of a marker opens its note.
  • In the dark theme the verse and note sheets now use the theme's window colour, so they are dark with readable text.

I checked all three on the phone (light and dark). Still open here: your feel items from the checklist and your sign-off, so this issue stays open.

#134 is merged. It covers the remarks from today: - Note markers are link blue and italic, as in the mockup: #1557a0 in light, #8ab4f8 in dark. - A tap within half a touch size of a marker opens its note. - In the dark theme the verse and note sheets now use the theme's window colour, so they are dark with readable text. I checked all three on the phone (light and dark). Still open here: your feel items from the checklist and your sign-off, so this issue stays open.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
feat/e2e-pytest
feat/redesign-about
feat/redesign-first-start
feat/redesign-menus
feat/redesign-modules
feat/redesign-chooser
feat/redesign-settings
feat/lectern-rebrand
feat/lectern-menu
feat/lectern-type-footer
feat/lectern-light-ground
feat/lectern-palette
fix/sheet-theme
fix/unknown-v11n
i18n/part-2
fix/marker-colour
ci/module-cache
docs/mockup-check
fix/log-line-atomic
fix/sheet-scroll
feat/13-6d-tsk
feat/13-6c-markers
feat/13-6b-refs
feat/13-6a-notes-refs
fix/install-416-restart
fix/e2e-menu-retry
fix/back-one-transaction
feat/paragraph-starts
feat/verse-look
fix/empty-cipherkey
fix/mem-check-noise
chore/claude-config
ci/main-runs
refactor/shared-controls
feat/module-import
feat/offline-install-icons
feat/module-manager
tools/e2e-shots
fix/strongs-datapath
phase1/switch-bible
phase1/first-run
phase1/red-letters
phase1/e2e
phase1/quick-settings
ci/s3-sccache
phase1/picker-height
phase1/gettext
phase1/picker-history
phase1/build-info
phase1/core-layout
No results found.
Labels
Clear labels   
priority
Could
 MoSCoW: nice to have, done when time allows

  
priority
Must
 MoSCoW: the release isn't viable without it

  
priority
Should
 MoSCoW: important, but the release works without it

  
priority
Won't
 MoSCoW: not this release (kept for later)

  
type
Bug

No labels
priority
Could
priority
Must
priority
Should
priority
Won't
type
Bug
Milestone
Clear milestone
No items
No milestone
v0.1 — reader
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
claude-bot
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
schaefera/utStudyBIble#13
No description provided.