Documentation Around Category, Flavor Type, and Flavor Requirements and Extensibility

[jtauber]

(this is for initial drafting of language around flavours and extensibility to eventually be incorporated into the docs)

Each burrito is of a particular flavor and a particular category.

Categories

The category of a burrito is defined at the top level meta > category which takes one of the values: source, derived, template.

Here are the fields allowed / required by each category. (S/s = source, D/d = derived, T/t = template; uppercase indicates required):

• meta S D T
  • category S D T
  • templateName T
  • version S D T
  • dateCreated S D T
  • defaultLanguage S D T
  • generator s d t
  • normalization s d t
  • comments s d t
• idAuthorities S D t
• identification S D t
• confidential S D t
• type S D t
• relationships s d t
• languages s* d* t
• targetAreas s d t
• agencies s d t
• copyright s D t
• promotion d
• ingredients s d t
• names s* d* t
• progress s
• recipe D

If the flavor type is scripture or gloss the language and names properties become required in source and derived burritos.

Flavor Types

Each flavor is of a particular flavor type which is specified in the type > flavorType > name property which can take the values: scripture, gloss, parascriptural, or peripheral.

• flavorType SC GL PA PE
  • name SC GL PA PE
  • flavor SC GL PA PE
    • name
    • ... addition flavor-specific properties ...
  • currentScope SC GL pa pe
  • canonType SC GL pa pe
  • canonSpec SC GL pa pe

Note that from a schema point-of-view, the only thing the flavor type restricts (besides flavor is whether currentScope, canonType, and canonSpec are optional or not.

Flavors

*** IN PROGRESS ***

[jtauber]

Looking at it this way, the following question immediately come to mind:

• is promotion allowable where it should be?
• is progress allowable where it should be?
• do we need four flavor types or just two?