PreTeXtBook / pretext

PreTeXt: an authoring and publishing system for scholarly documents
https://pretextbook.org
Other
254 stars 202 forks source link

Schema improvements #2130

Closed oscarlevin closed 3 weeks ago

oscarlevin commented 2 months ago

This is the start of a bunch of schema and experimental schema improvements. Leaving as draft for now, but would love feedback as I continue to work on this.

One major change to the non-development schema is the tweak the description/shortdescription for images. Previously, if you had @decorative with either "yes" or "no", then it was a violation to have a description or shortdescription. So I remove that rule. I also allow shortdescription and description to come in any order, with the possible other elements of an image. And for now, both are optional.

rbeezer commented 2 months ago

Thanks for making more progress on this.

oscarlevin commented 2 months ago

Do we have an example of a slate holding just text? Am I reading that right?

Line 7808 of the sample article has a slate in an interactive with jessiecode that is just text.

Additional commits:

Regarding this last one, should xml:id still be allowed for images? I realize that there isn't ever a need to xref these, but for the purpose of using a xpointer in an xi:include'd file?

rbeezer commented 2 months ago

Line 7808 of the sample article has a slate in an interactive with jessiecode that is just text.

Right, forgot that we did this.

Should one of these be required?

I don't want to enforce accessibility practices through the schema. (But want to encourage through education!) Would folks just add empty description to feed the validator?

for the purpose of using a xpointer in an xi:include'd file

I'm not real eager to have the schema in the service of xpointer which I think is something of a failed standard/project/implementation. If an xml:id always suggested a possible cross-reference target, then I think we would have enough around to be modular enough. Could be mistaken, but I'd rather start there and see how it shakes out. Or we can talk it through in Drop-In.

rbeezer commented 2 months ago

Is this still a draft? Checking that I am not holding things up.

oscarlevin commented 2 months ago

I want to make a few more improvements tomorrow, then it should be ready for review.

oscarlevin commented 2 months ago

Okay, reorganized my commits into a stable and dev change. I think this is ready to be merged. Still more work to do before the sample-article validates without error, but we are closer.

oscarlevin commented 1 month ago

One more commit added on that adds component in both stable and experimental areas.

rbeezer commented 3 weeks ago

Finally! Sorry for the long delay. This morning's crisis was finding my script for testing the schema... And right after you did a CLI update - sorry.

Looking real good, this is a huge improvement! Found at least one gotcha in sample article source that I will fix shortly (may look for others).

Trimmed some whitespace, and blew up one commit into three, wrote commit messages. But no changes in substance at all.

Website updating right now.