bible-technology / scripture-burrito

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

Remove content that describes an XML representation that no longer exists #251

Closed jonathanrobie closed 3 years ago

jonathanrobie commented 3 years ago

This text describes the format of metadata.xml, which no longer exists.

Most Content in Text, not Attributes

This is partly a stylistic choice, but it also reflects the need to handle a wide range of UTF-8 characters in many fields. (It is considered bad practice to put localized strings into attributes.) Attributes are mainly used as qualifiers for the “main” content.

Few Empty Elements, Many Optional Elements

The children of most root elements (identification, format, etc) are required. Many elements below that level are optional but, if they are present, they must contain content. This is to avoid confusion between a value that is unspecified and a value that is specified as an empty string. So

The Holy Bible La Sainte Bible

is permitted, as is

The Holy Bible

but

The Holy Bible

is not permitted.

Order is Generally Unimportant

Most elements at all levels can appear in any order (or interleaved, in the terms of XML schema). Exceptions include a few elements that must appear as the first children of the root element and publication structures which communicate a specific content order.

jtauber commented 3 years ago

Part of an overall sweep of all existing documentation I'm doing as part of 0.4

jtauber commented 3 years ago

this is addressed in #270