Contents

Template: o-docttr:Parameter

URI: http://tpl.ottr.xyz/p/docttr/0.1/Parameter

Metadata

🛈 This section contains the data represented by the signature's annotation instances.

ottr:status
ottr:draft
owl:versionInfo
0.1.1
dc:description
Use for documenting each parameter of a published template, providing descriptions and examples.
skos:note
The template should be used in combination with other templates in the same package.
pav:createdOn
2020-08-21T00:00:00Z^^xsd:dateTime
dc:creator
http://folk.uio.no/martige/foaf.rdf#me
skos:editorialNote
Use of this template depends on parameters represented by IRIs, which they are usually not, but we expect this to change soon.
rdfs:seeAlso
o-docttr:
Metadata as RDF graph
o-docttr:Parameter  rdfs:seeAlso  o-docttr: ;
        ottr:status         ottr:draft ;
        dc:creator          <http://folk.uio.no/martige/foaf.rdf#me> ;
        dc:description      "Use for documenting each parameter of a published template, providing descriptions and examples." ;
        pav:createdOn       "2020-08-21T00:00:00Z"^^<http://www.w3.org/2001/XMLSchema#dateTime> ;
        owl:versionInfo     "0.1.1" ;
        skos:editorialNote  "Use of this template depends on parameters represented by IRIs, which they are usually not, but we expect this to change soon." ;
        skos:note           "The template should be used in combination with other templates in the same package." .

Parameters

🛈 The parameters defined by the signature are listed here. Unfortunately parameter names are not informative; fixing it is a planned future feature. An optional parameter will accept the value ottr:none as an argument. A parameter which allows blanks will accept a blank node as argument value.

IndexNameTypeOptionalBlanks allowedDefault value
1resourceottr:IRInonono
2descriptionxsd:stringnonono
3examplexsd:stringyesnono
4notexsd:stringyesnono

Pattern

stOTTR

🛈 stOTTR serialisation of the template without annotation instances.

o-docttr:Parameter[
    ! ottr:IRI ?resource,
    ! xsd:string ?description,
    !? xsd:string ?example,
    !? xsd:string ?note
] :: {
    ottr:Triple(?resource, dc:description, ?description),
    ottr:Triple(?resource, skos:example, ?example),
    ottr:Triple(?resource, skos:note, ?note)
} .

🛈 The pattern of the template is illustrated by expanding a generated instance. Below the generated instance is shown in different serialisations, and its expansion is presented in different formats.

Generated instance

stOTTR
o-docttr:Parameter(x:argument1, _:argument2, _:argument3, _:argument4)
RDF/wOTTR
[ ottr:of      o-docttr:Parameter ;
  ottr:values  ( x:argument1
                 [] 
                 [] 
                 [] 
               )
] .

Visualisation of expanded RDF graph

🛈 Each resource node is linked to its IRI. Type relationships are not visualised, rather each node contains its type.

Hierarchical horizontal layout (dot)
%3 http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI> x:argument1 argument2 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument2 : LUB<rdfs:Resource> dc:description argument4 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument4 : LUB<rdfs:Resource> skos:note argument3 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument3 : LUB<rdfs:Resource> skos:example
Hierarchical vertical layout (dot)
%3 http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI> x:argument1 argument2 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument2 : LUB<rdfs:Resource> dc:description argument4 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument4 : LUB<rdfs:Resource> skos:note argument3 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument3 : LUB<rdfs:Resource> skos:example
Spring model layout (neato)
%3 http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI> x:argument1 argument2 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument2 : LUB<rdfs:Resource> dc:description argument4 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument4 : LUB<rdfs:Resource> skos:note argument3 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument3 : LUB<rdfs:Resource> skos:example
Spring model layout (fdp)
%3 http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI> x:argument1 argument2 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument2 : LUB<rdfs:Resource> dc:description argument4 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument4 : LUB<rdfs:Resource> skos:note argument3 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument3 : LUB<rdfs:Resource> skos:example
Radial layout (twopi)
%3 http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI> x:argument1 argument2 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument2 : LUB<rdfs:Resource> dc:description argument4 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument4 : LUB<rdfs:Resource> skos:note argument3 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument3 : LUB<rdfs:Resource> skos:example
Circular layout (circo)
%3 http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI> x:argument1 argument2 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument2 : LUB<rdfs:Resource> dc:description argument4 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument4 : LUB<rdfs:Resource> skos:note argument3 : LUB<rdfs:Resource> http://example.ottr.xyz/argument/argument1 : LUB<ottr:IRI>->argument3 : LUB<rdfs:Resource> skos:example

Expanded RDF graph

x:argument1  dc:description  []  ;
        skos:example    []  ;
        skos:note       []  .

Interactive expansion

🛈 Click the list to expand/contract one list element. Click 'expand/contact all' to expand/contract all elements. Note that the interactive expansion is not correct for instances that are marked by list expanders.

o-docttr:Parameter(x:argument1, _:argument2, _:argument3, _:argument4)ottr:Triple(x:argument1, dc:description, _:argument2)ottr:Triple(x:argument1, skos:note, _:argument4)ottr:Triple(x:argument1, skos:example, _:argument3)

Dependencies

Dependency graph

🛈 The graph shows all the templates that this template depends on. The colour of the node indicates its namespace. Each node is linked to its documentation page.

Hierarchical horizontal layout (dot)
%3 o-docttr:Parameter o-docttr:Parameter ottr:Triple ottr:Triple o-docttr:Parameter->ottr:Triple
Hierarchical vertical layout (dot)
%3 o-docttr:Parameter o-docttr:Parameter ottr:Triple ottr:Triple o-docttr:Parameter->ottr:Triple
Spring model layout (neato)
%3 o-docttr:Parameter o-docttr:Parameter ottr:Triple ottr:Triple o-docttr:Parameter->ottr:Triple
Spring model layout (fdp)
%3 o-docttr:Parameter o-docttr:Parameter ottr:Triple ottr:Triple o-docttr:Parameter->ottr:Triple
Radial layout (twopi)
%3 o-docttr:Parameter o-docttr:Parameter ottr:Triple ottr:Triple o-docttr:Parameter->ottr:Triple
Circular layout (circo)
%3 o-docttr:Parameter o-docttr:Parameter ottr:Triple ottr:Triple o-docttr:Parameter->ottr:Triple

List of dependencies

🛈 The number in parenthesis is the number of instances of each template.

o-docttr:Parameterottr:Triple (3)

Depending templates

🛈 The templates in this library that depend on this template.

None found.

Metrics

🛈 Dependency graph metrics. Depth is the number of steps to a leaf node in the dependency graph. Branching is the number of outgoing edges from a node.

Templates used

Direct dependencies
  • Number of instances: 3
  • Templates used: (1 templates)
Complete expansion

Vocabulary introduced

Direct dependenciesComplete expansion

Serialisations

stOTTR

o-docttr:Parameter[
    ! ottr:IRI ?resource,
    ! xsd:string ?description,
    !? xsd:string ?example,
    !? xsd:string ?note
]
@@o-docttr:Provenance(
    o-docttr:Parameter,
    "2020-08-21T00:00:00Z"^^xsd:dateTime,
    none,
    (<http://folk.uio.no/martige/foaf.rdf#me>),
    none),
@@o-docttr:Signature(
    o-docttr:Parameter,
    none,
    "Use for documenting each parameter of a published template, providing descriptions and examples.",
    none,
    ("The template should be used in combination with other templates in the same package."),
    (<http://tpl.ottr.xyz/p/docttr/0.1/>),
    ("Use of this template depends on parameters represented by IRIs, which they are usually not, but we expect this to change soon.")),
@@o-docttr:Version(
    o-docttr:Parameter,
    ottr:draft,
    "0.1.1",
    none,
    none)
 :: {
    ottr:Triple(?resource, dc:description, ?description),
    ottr:Triple(?resource, skos:example, ?example),
    ottr:Triple(?resource, skos:note, ?note)
} .

RDF/wOTTR

o-docttr:Parameter  rdf:type  ottr:Template ;
        ottr:annotation  [ ottr:of      o-docttr:Signature ;
                           ottr:values  ( o-docttr:Parameter ottr:none "Use for documenting each parameter of a published template, providing descriptions and examples." ottr:none ( "The template should be used in combination with other templates in the same package." ) ( o-docttr: ) ( "Use of this template depends on parameters represented by IRIs, which they are usually not, but we expect this to change soon." ) )
                         ] ;
        ottr:annotation  [ ottr:of      o-docttr:Version ;
                           ottr:values  ( o-docttr:Parameter ottr:draft "0.1.1" ottr:none ottr:none )
                         ] ;
        ottr:annotation  [ ottr:of      o-docttr:Provenance ;
                           ottr:values  ( o-docttr:Parameter "2020-08-21T00:00:00Z"^^xsd:dateTime ottr:none ( <http://folk.uio.no/martige/foaf.rdf#me> ) ottr:none )
                         ] ;
        ottr:parameters  ( [ ottr:modifier  ottr:nonBlank ;
                             ottr:type      ottr:IRI ;
                             ottr:variable  _:b0
                           ]
                           [ ottr:modifier  ottr:nonBlank ;
                             ottr:type      xsd:string ;
                             ottr:variable  _:b1
                           ]
                           [ ottr:modifier  ottr:nonBlank , ottr:optional ;
                             ottr:type      xsd:string ;
                             ottr:variable  _:b2
                           ]
                           [ ottr:modifier  ottr:nonBlank , ottr:optional ;
                             ottr:type      xsd:string ;
                             ottr:variable  _:b3
                           ]
                         ) ;
        ottr:pattern     [ ottr:of      ottr:Triple ;
                           ottr:values  ( _:b0
                                          skos:example
                                          _:b2
                                        )
                         ] ;
        ottr:pattern     [ ottr:of      ottr:Triple ;
                           ottr:values  ( _:b0
                                          skos:note
                                          _:b3
                                        )
                         ] ;
        ottr:pattern     [ ottr:of      ottr:Triple ;
                           ottr:values  ( _:b0
                                          dc:description
                                          _:b1
                                        )
                         ] .

Prefixes

🛈 Prefixes are removed from all listings on this page for readability, but are listed here in RDF Turtle format.

@prefix ottr:       <http://ns.ottr.xyz/0.4/>.
@prefix dc:         <http://purl.org/dc/elements/1.1/>.
@prefix o-docttr:   <http://tpl.ottr.xyz/p/docttr/0.1/>.
@prefix rdf:        <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
@prefix xsd:        <http://www.w3.org/2001/XMLSchema#>.
@prefix skos:       <http://www.w3.org/2004/02/skos/core#>.