sillsdev / sillsdev/ptx2pdf

Need test-cases to ensure structural note classes work properly

Open
#1,077 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

No action
Dominant language
Python
Stars
33
Forks
15
PR merge metrics
No merged PRs in 30d

Description

As stated in 9eb9cb3 there should be some fully-conformant USFM3.1 testcases to ensure that the right thing is begin done with structural / non-structural markers in notes. The list of structural markers is hard-coded and may not be correct.

It is suggested that a hand-crafted set of notes be added to an existing or new chapter in test/projects/minitests

Once such a test-suite exists, then the 2 \implicitcl@setrue lines in ptx-note-style.tex can be removed, and the prototype code tested.

Correct behaviour of \xt in \x and other notes needs to be better understood and implemented

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing or new chapter under test/projects/minitests and the structural-marker handling in ptx-note-style.tex. Build hand-crafted USFM3.1 note cases covering structural and non-structural markers, including \xt within \x and other notes; done means the cases validate the intended behavior and the two \implicitcl@setrue lines can be removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
tex
Domain
testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.