Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Target references "added" text (add \xta ...\xta*) #10

Closed
klassenjm opened this issue Jul 5, 2016 · 0 comments
Closed

Target references "added" text (add \xta ...\xta*) #10

klassenjm opened this issue Jul 5, 2016 · 0 comments

Comments

@klassenjm
Copy link
Contributor

klassenjm commented Jul 5, 2016

Proposal

  • Add character marker pair \xta …\xta* for “target reference(s) added / extra text”.
  • Recommend that \xt is only used to mark the target reference elements (rather than nesting \+xta …\+xta* inside of \xt which could be very problematic when trying to find and parse actual references)

A companion USX 3.0 proposal exists at: ubsicap/usx#8

Details

Being able to accurately parse and validate references strings is important. It becomes increasingly so when parsing references to generate machine readable forms (e.g. in USX / XML conversions). An additional marker is needed to mark text which should be ignored

In ParaTExt, the Scripture Reference Settings can be configured to ignore certain strings found in reference elements such as \xt or \r elements when checking references. However, in some texts the marked content may not be consistent and therefore cannot be easily added to the Scripture Reference Settings ignore list. Additionally, not all USFM text will be handled by ParaTExt and in these contexts an explicit marker would be useful.

Examples

\x - \xo 3.0 \xta Compare with \xt Mk 1.1-8; Lk 3.1-18; \xta and 
\xt Jn 1.19-28 \xta parallels.\x*

Application Support Requirements

In cross reference export / import tools, need to consider how to handle cross references with \xta ...\xta* markup. The content of \xta ...\xta cannot be automatically adapted when importing to another project.

@klassenjm klassenjm added this to the 3.0.rc1 milestone Jul 5, 2016
@klassenjm klassenjm removed the editor label Jul 5, 2016
@klassenjm klassenjm changed the title Cross reference "extra" content (add \xta ...\ Cross reference "extra" content (add \xta ...\xta*) Jul 9, 2016
@klassenjm klassenjm added the new label Jul 12, 2016
@klassenjm klassenjm changed the title Cross reference "extra" content (add \xta ...\xta*) Cross reference "added" text (add \xta ...\xta*) Jul 18, 2016
@klassenjm klassenjm changed the title Cross reference "added" text (add \xta ...\xta*) Target references "added" text (add \xta ...\xta*) Jul 18, 2016
klassenjm added a commit that referenced this issue Jul 26, 2016
@klassenjm klassenjm modified the milestones: 3.0.rc1, 3.0.rc2 Sep 9, 2016
@klassenjm klassenjm modified the milestones: 3.0.rc2, 3.0.0 Oct 27, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant