search

bible-technology / scripture-burrito

Scripture Burrito Schema & Docs 🌯
http://docs.burrito.bible/
MIT License
21 stars 14 forks source link

Document parascriptural_word_alignment.xml #41

Closed jag3773 closed 5 years ago

jag3773 commented 5 years ago

The docs/examples/parascriptural_word_alignment.xml example file is failing the xmllint test and needs fixed. Check the Travis build log for the exact error.

Not sure if this is for @mvahowe or @joelthe1 ...

joelthe1 commented 5 years ago

@jag3773 , couldn't figure out what exactly is the issue. Doesn't this say that parascripturalWordAlignment is the correct name of the flavor?

jag3773 commented 5 years ago

Yeah, I'm not sure either, @mvahowe may need to load it up in Oxygen and see where exactly the problem lies.

mvahowe commented 5 years ago

@joelthe1 @jag3773 Oxygen displayed 15 errors. Some of them were typos and/or careless copy-paste XML surgery, some were URNs, others required schema tweaks. I pushed my latest to master (forgot to do a PR, will do better next time).

The remaining part is to sort out the refs section. I can't do that because I don't know what we are trying to do there. Right now we have one lid element containing child elements and one lid element containing text. Everyone will thank you for not making both of those options valid. ie, if you are going to use child elements, ever, put everything in one or more child elements.

You could fix this around line 175 of the schema. Let me know if you need help.

Obviously I have no idea if the metadata here is actually useful, how many fields should be required, whether we could validate the syntax of any of the text fields, etc.

joelthe1 commented 5 years ago

@mvahowe, I have Slacked you some of the changes I had in mind. Could you take a look?

mvahowe commented 5 years ago

@joelthe1 Thanks! I made some changes, and the metadata now validates. (@jag3773 then eventually convinced Travis that this is true :-) )

I also restructured the documentation of this flavor, in a similar style to the 5 scriptural flavors. Could you replace my text in square brackets with something more informative? This flavor has attracted a lot of interest in various places, because it's a long way from anything DBL has done before, and also because it overlaps with the remit of the Copenhagen Alliance. I think that explaining where the format came from, who has worked on it, etc, would help.

jag3773 commented 5 years ago

Fixed in #61