sillsdev / sillsdev/ptx2pdf

Documentation needed on How to import a \periph section

Open
#614 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

DC asked: I wonder how we put in stuff “in between” the OT and the NT, as usually there is something in between, like an NT intro and title page that is similar to what is at the beginning of the OT.

I know that PTXprint has the ability to import a specific \periph section into areas of the text (especially in the front matter), but this feature doesn't yet seem to have any documentation. Can it also be used with INT material, or is it only FRT?

Here is a list of what should be supported: https://ubsicap.github.io/usfm/peripherals/index.html and specifically this link for INT matter.

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 linked USFM peripherals and introductions guidance, then inspect the existing PTXprint documentation for \periph imports. Document how to place sections between the OT and NT, including whether INT material is supported or only FRT, and cover the relevant supported sections.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.