ddialliance / ddimodel

Model for DDI Lifecycle
Other
14 stars 6 forks source link

Enhancement for `ContentType` documentation #35

Open romaintailhurat opened 8 months ago

romaintailhurat commented 8 months ago

Several pieces are amiss in the ContentType documentation in 4.0:

Also, for this last element, the type documentation - langString - could be completed with references to what is a langString and some syntax examples.

If this material is not already in the making, i can try to provide something (with a proper PR).

DanSmith commented 8 months ago

Hi Romain,

Yes, the MultilingualStringValue does need a description added, feel free to offer a PR.

The langString type is defined as a pair of a character string and a language tag.

Each serialization handles the langString type in it's own native manner. In XML this is done with the xml:lang attribute, in RDF the content is a RDF literal with type http://www.w3.org/1999/02/22-rdf-syntax-ns#langString and a language tag. In json it is a string and language tag pair.

Documentation for the built in COGS primitive type langString is found in https://github.com/Colectica/cogs-web/blob/master/docs/_sources/modeler-guide/primitive-types.rst.txt , If you'd like to expand the documentation there feel free to offer a PR for that as well.

wlthomas commented 5 months ago

New property needs documentation.