| Key | \nPossible values | \nDescription | \nRequired? | \n
|---|---|---|---|
id | \n prefix string | \n\n Provides a prefix that can be used in the vocabulary\n description and in the generated RDF serializations, e.g., for\n cross-references.\n | \nYes | \n
value | \n URL | \nThe official URL for the vocabulary. | \nYes | \n
context | \n URL | \n\n Provides a default @context file reference, used by all terms unless locally overwritten.\n | \n Yes if the template file contains a context section, otherwise no. | \n
alias@direction, @graph, @id, @included, @index, @json,\n @language, @list, @nest, @none, @reverse, @set,\n @type, and @value.\n import@context files that must be\n imported at the beginning of the generated context file. This is done by generating an array in the\n \"@context\" file, consisting of the array of the URL in this key, followed by the context object\n generated by the tool.\n set_vocabtrue, a @vocab key is added to the context, pointing at the\n official URL for the vocabulary. This makes the vocabulary easily extensible in JSON-LD, though possibly\n creating uncontrolled vocabulary terms on the fly, which may lead to security issues. Default value is false.\n protectedtrue, a \"@protected\" : true key is added to the context, as well as\n all scoped contexts. This makes the context file safer when it is part of several context files referred to in a\n JSON-LD file. Default value is true.\n | Key | \nPossible values | \nDescription | \nRequired? | \n
|---|---|---|---|
comment | \n string | \n\n Refers to a longer description of the term. It may include HTML Flow content elements. The comment will be\n encapsulated into an HTML <div> element and will then\n be displayed verbatim in the HTML version of the vocabulary, and as a\n literal of type rdf:HTML in the\n JSON-LD and Turtle versions.\n | \n Either comment or defined_by is required. | \n
context | \n URLs or the constant vocab or none, or an array thereof | \n \n Used to add information on JSON-LD @context file(s) that “mention” the term; the list of URLs refer to the relevant\n @context file. If the value is vocab, and a global @context file is defined in the\n vocab block, that “default” @context is used. If the value of the property is none,\n there is no context file reference for the term and it will not be added to the generated context, if applicable. The default setting is vocab (i.e., unless it is otherwise specified, the default value is used for the term).\n | \n No | \n
defined_by | \n One or more URLs | \n\n Refers to the formal definition(s) of the term. This should always be a full URL, because it is also used in the generated turtle or JSON-LD\n version of the vocabulary.\n | \nEither comment or\n defined_by is required. | \n
deprecated | \n Boolean | \n\n The key signals whether term is deprecated or not. Default is false. This property is a leftover from earlier\n version and is overwritten, if present, by the value of status.\n | \n No | \n
example | \n One or more blocks | \n\n Blocks with label and json keys providing a (JSON-LD) example with a title. These examples are placed, in the HTML version, to\n the end of the section referring to a term; the examples are ignored in the Turtle and the JSON-LD versions. Care should be taken to use the\n \"|\" block style indicator in the YAML file for the examples.\n If the template names a playground or JSON-LD viewer (see HTML Templating), each example is\n followed, in the HTML version, by an “Open in JSON-LD Playground” button that opens the example in that viewer.\n | \n No | \n
id | \n term string or CURIE | \n\n The identifier of the term. If a term string is used, it is considered to be in the namespace of the vocabulary. If a CURIE is used, the term\n is considered to be external: terms that are formally defined in another vocabulary, and are listed only to increase the readability\n of the vocabulary specification.\n External terms, while they appear in the HTML document generated by the tool, do not result in formal RDF statements\n in Turtle or JSON-LD; they only appear as information only items in the generated document. The CURIE prefix must be defined\n in the prefix top level block.\n | \n Yes | \n
known_as | \n term string | \n\n A term can be used as an alias to the term's label in JSON-LD. It is used when generating a JSON-LD context file, as the name of\n the property in the context file instead of the official label. This means that JSON-LD users, using that context file, must\n refer to this alternative name in their code.\n | \nNo | \n
label | \n string | \n\n Short header label to the term. If missing, the capitalized value of id is used.\n | \n No | \n
see_also | \n One or more blocks | \n\n Blocks with label and url keys, providing a human-readable title and a URL, respectively,\n to an external document that can be referred to by the description of the term.\n (These are translated into an rdfs:seeAlso statement in the vocabulary.)\n | \n No | \n
status | \n \n stable, reserved, or deprecated\n | \n \n The terms are divided, in the HTML output, into these three sections. stable is the default.\n | \n No | \n
type | \n One or more CURIEs | \n\n Refers to RDF types. Note that the tool automatically adds types like rdf:Property, rdfs:Class, etc.;\n this key is to be used for the vocabulary specific types only.\n | \n No | \n
| Key | \nPossible values | \nDescription | \nRequired? | \n
|---|---|---|---|
upper_union | \n boolean | \n\n If several superclasses are specified then, by default, this means the intersection (or logical conjunction) of the classes.\n If the value is true, the statement refers to the union (or logical disjunction) of the classes.\n | \n No | \n
upper_value | \n One or more terms or CURIEs | \nSuperclasses. | \nNo | \n
Class3 and Class4\n upper_union: true\n\n - id: Class5\n label: An example Class5\n one_of: [ex:Individual_1, ex:Individual_2, …,ex:Individual_n]\n comment: The class consists of the listed individuals.\n\n - id: Class6\n label: An example Class6\n comment: just to show how an example can be added to the definition\n example:\n - label: An example usage of Class6\n json: |\n {\n \"@context\": \"https://context-for-class6-example.org\",\n \"id\": \"urn:12345\",\n \"@type\": \"Class6\"\n }\n```\n\n\n#### 1.2.2.3. Property definitions — `property` Block\n\n| Key | \nPossible values | \nDescription | \nRequired? | \n
|---|---|---|---|
container | \n set or list | \n \n If set to one of these values, the entry for the property in the generated JSON-LD @context includes the @container\n keyword, set to @set or @list, respectively. In both cases a warning message is also included in the generated HTML\n text whereby, when using JSON-LD data with this vocabulary, the value for the property is expected to be an array even if there is only one.\n For the particular case of a list value, the range of the property is set to be an rdf:List.\n The value graph is also accepted for the key, as an alternative to the dataset key.\n | \n No | \n
dataset | \n boolean | \n\n This key only influences the generated JSON-LD @context: if the value is true, the JSON-LD @container\n is set to the @graph value for the property, signaling that the value refers to a\n dataset (or graph). See the JSON-LD Specification\n for further details.\n | \n No | \n
domain | \n One or more terms or CURIEs | \n\n The RDF domain statements of the property. If several classes are specified, the statement refers to the union (or logical disjunction) of the classes. \n When generating a JSON-LD @context, the property will appear in the scoped context of each of the classes in the list.\n | \n No | \n
scope | \n One or more terms or CURIEs | \n\n When generating a JSON-LD @context, the property will appear in the scoped context of each of the classes in the list.\n This effect is identical, in this respect, to domain setting, but it does not affect the formal RDF vocabularies. This feature is especially important when using external property terms,\n which should not use domain setting to avoid ontology hijacking.\n | \n No | \n
range | \n One or more terms or CURIES or the single URL or localizableString term | \n \n The RDF range statements of the property. \n If the URL (alternatively: IRI) term is used, the block\n defines a property that has no explicit range type, but whose objects are expected to be IRI references. The generated vocabularies\n annotate these properties as belonging to the owl:ObjectProperty class, which is the reserved term for properties\n whose objects are not supposed to be literals. A corresponding comment is also generated into the HTML description of the term.\n The single term localizableString is a shorthand for setting the range to the array [xsd:string, rdf:langString, rdf:dirLangString],\n with the range_union flag set to true. See below for more details.\n | \n No | \n
one_of\n | One or more terms or CURIEs | \n\n The final range includes an (anonymous) class exclusively consisting of the individuals listed in the value.\n It effectively lists the (CURIE) references that the property is supposed to have.\n Note that the generated context file creates strings as values, mapping to the entries\n in the list.\n The entries are required to refer to individuals.\n | \n No | \n
open_enumeration | \n boolean | \n\n Only meaningful together with one_of. By default, the values listed in one_of are\n turned into an anonymous class defined via owl:oneOf, i.e., a closed enumeration: the\n property's range consists exclusively of the listed individuals. If open_enumeration is set to\n true, the enumeration is treated as open instead: a fresh, named class is generated\n (named after the property, with a Range suffix, e.g. credentialStatus gets a\n CredentialStatusRange class) and used as the property's range, and the one_of\n values are declared as instances of that class. Values not otherwise declared via an individual\n block are automatically added as individuals of that class; external (CURIE-referenced) values are left\n untouched, consistently with how external terms are handled elsewhere in this tool.\n This setting has no effect on the generated JSON-LD @context: the property is still mapped\n the same way as for a closed enumeration.\n | \n No | \n
range_union | \n boolean | \n\n If several range classes are specified then, by default, this means the intersection (or logical conjunction) of the classes.\n If the value is true, the statement refers to the union (or logical disjunction) of the classes.\n | \n No | \n
upper_value | \n One or more terms or CURIEs | \nSuperproperties. | \nNo | \n
| Key | \nPossible values | \nDescription | \nRequired? | \n
|---|---|---|---|
one_of | \n array of strings | \nThis is a shorthand for a pattern property with the value of \"val1\\|val2\\|…\\|valn\", i.e., it restricts the value to a predefined set of strings (without spaces). | \n No | \n
pattern | \n string | \nAn XML Schema regular expression, used to restrict an xsd:string type literal. Note that, while this restriction\n become part of the generated vocabulary, not all RDF/OWL reasoners are capable of processing it. | \n No | \n
upper_union | \n boolean | \n\n If several \"super\" datatypes are specified then, by default, this means the intersection (or logical conjunction) of the datatypes.\n If the value is true, the statement refers to the union (or logical disjunction) of the datatypes.\n | \n No | \n
upper_value | \n One or more terms or CURIEs | \n\"Super\" datatypes that this datatype is derived from. The term `type` can also be used, as an alias to this term | \nNo | \n
…\n Open in JSON-LD Playground\n