usfm-bible / tcdocs

Technical Committee Documents
Other
9 stars 9 forks source link

Extend USFM marker \mi to \mi# #75

Open klassenjm opened 1 month ago

klassenjm commented 1 month ago

Cloning an issue from the legacy usfm repo : https://github.com/ubsicap/usfm/issues/131, from @rfpng

In August 2018 I made a proposal to the Paratext support group to extend the USFM marker \mi to \mi#. Apparently this is now recorded as PTXS-16994 (The original confirmation I received had the number PTXS-17401).

Unfortunately I never heard if my proposal was considered. The issue is still important to me: In an NT I typeset, \mi1 and \mi2 was used in the glossary. This worked very well but in electronic publishing this causes problems because the process doesn't know about \mi#.

Here is the structure of a glossary entry: \li1 - Main Entry Headline \pi1 - Main Entry Description \mi1 - Indented non-first-line-indented paragraph

The above works fine, but some of the entries also have sub-entries as follows: \li2 - Sub Entry Headline \pi2 - Sub Entry Description \mi2 - Further indented non-first-line-indented paragraph ← Doesn't exist, and that's the problem!

Many paragraph markers have numbered counterparts, but \mi doesn't. It would be very helpful to me if it did!

Thank you very much for considering this.

PS: I'll gladly send you more information about this if needed.

mhosken commented 1 month ago

accepted in 3.1

rfpng commented 1 month ago

This is wonderful! When might 3.1 become available?

klassenjm commented 1 month ago

USFM 3.1 - as a specification - is expected to be formally complete by July 2024. How soon applications and tools support the updates in the specification is another question. However, supporting \mi1, \mi2, \mi3 is likely not difficult in most cases. In Paratext it will be a matter of seeing the main USFM stylesheet updated, or a project adding these additional numbered markers to a project customized stylesheet. It is likely quite modest updates in others tools to support these additions.

klassenjm commented 1 month ago

@mhosken Could you update the schema for mi1, mi2, mi3