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

extensions.txt allowing multiple categories #80

Open
mhosken opened this issue Sep 11, 2024 · 5 comments
Open

extensions.txt allowing multiple categories #80

mhosken opened this issue Sep 11, 2024 · 5 comments
Milestone

Comments

@mhosken
Copy link
Collaborator

mhosken commented Sep 11, 2024

\rem, \sts are both allowed in a number of places in the grammar. Do we want to allow this for other markers and to allow the \category field to take a list of categories?

@mhosken mhosken added this to the 3.1.1 milestone Sep 11, 2024
@KentSpiel
Copy link
Collaborator

KentSpiel commented Sep 12, 2024

Do we want . . . to allow the \category field to take a list of categories?

I believe we already do allow a list of categories. For example in a Biblica project \cat ex st dup\cat* means a footnote should be included in an extended and standard typeset and is marked as potentially needing deduplication. Do you mean something else by list?

@jwickberg
Copy link
Collaborator

I thought Paratext had a restriction on categories in the marker check, but I just looked at the code and it doesn't appear to care what is put there. We did add some UI to guide users in adding categories and the UI may be restrictive.

@KentSpiel
Copy link
Collaborator

The UI is implemented for Study Bibles in the Study Bible project interface. In Study bibles the category is limited by the interface to one category. That said multiple categories can be implemented using combined categories such as, for example, ex:st:dup.

Biblica use case

In Biblica we had a need to mark footnotes for reduplication. We also needed to mark footnotes for different publication styles where some publishers wanted minimal footnotes and others wanted to publish with all the footnotes, and others somewhere in between. Initially we added some markup to the verse numbers, which we used in our publishing process and stripped when we put the project on the DBL.
However, when @mhosken made clear to me that categories were legal in al footnotes I immediately implemented them in all our projects as the "correct" way to do what we were doing. I also considered if we should create combined categories using colons or simply list the categories separated by spaces. Martin and I discussed this and concluded that spaces should be legal in category content and it was simpler to just list the categories. By the way, in our implementation the order of categories is not important.
I do not expect Paratext to implement a Category IU for standard projects, nor do I expect the Study Bible UI to support multiple categories for notes. That said I would like for any such UI to not overwrite category info that may already be in the project.

@mhosken
Copy link
Collaborator Author

mhosken commented Sep 23, 2024

No this is the \category field in extensions.md not the \cat marker in USFM.

@mhosken mhosken changed the title extensions.md allowing multiple categories extensions.txt allowing multiple categories Sep 23, 2024
@mhosken
Copy link
Collaborator Author

mhosken commented Nov 18, 2024

Added to 3.1.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants