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

Changes in USJ Schema #225

Closed
7 tasks done
kavitharaju opened this issue Oct 31, 2023 · 3 comments
Closed
7 tasks done

Changes in USJ Schema #225

kavitharaju opened this issue Oct 31, 2023 · 3 comments

Comments

@kavitharaju
Copy link
Collaborator

kavitharaju commented Oct 31, 2023

The changes suggested in USJ schema by the USFM/X Committee

  1. Change oneOf condition to anyOf
  2. Instead of the field {type: "val1:val2"} keep two fields {type:"val1", marker: "val2"}

Changes needed in this repo

  • Update the schema definition at schemas/usj.js
  • Change the USJ generation scripts in python usfm-grammar module
  • Change the List generation scripts the module, that depends on the USJ output
  • Change the code in filtering of USJ based on include_markers and exclude_markers
  • Change the code where USFM is generated back from USJ
  • Change scripts in tests where the output USJ is worked on (to check if all markers are present, unwanted markers are filteres etc)
  • Update the origin-usj.json samples in USFM-Grammar testsuite, (which is a copy of the tcdocs/tests)

Changes to be contributes at usfm-bible/tcdocs

  • Updated USJ json schema definition
  • Updated script to generate USJ from USX
  • Updated testsuite samples of origin-usj.json
@kavitharaju
Copy link
Collaborator Author

PR at tcdocs repo usfm-bible/tcdocs#48

@kavitharaju kavitharaju mentioned this issue Oct 31, 2023
7 tasks
@kavitharaju
Copy link
Collaborator Author

kavitharaju commented Nov 10, 2023

Another change needed

  • Make book-code accept any 3 letter strings, not only from the list of valid book codes.

This requires change at

  • usfm-bible/tcdocs repo and
  • the USJ schema in this repo, which also needs to be tested with existing tests

@kavitharaju
Copy link
Collaborator Author

PR at tcdocs repo usfm-bible/tcdocs#51

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