Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Template vocabulary
Vocabulary to describe a Template Context. Contains information necessary to dynamically instantiate regular contexts. Part of the Persona Data Model 2.0.
Files
- Most recently published
- SVN source: template.owl
UML Overview
Classes
App
A prototype of a context instance that holds app-specific data (e.g. Person entity) if any
- subClassOf ContextPrototype
- 1..1 appURI
- 1..1 description
AppTemplate
A TemplateContext containing a ContextPrototype instance that describes a context to be used to support an app
- 1..1 app
Connector
A prototype of an SideA/SideB context instance. Abstract.
ConnectorTemplate
A TemplateContext containing two ContextPrototypes instances that describe each connector context in a relationship
- 1..1 definer
- 1..1 participant
ContextPrototype
Abstract class. A prototype of an Context instance. The attributes of the prototype are copied into a Context instance
- 0..1 image
- 0..1 imageType
- 0..1 templateRole
- 0..1 viewRoot
Definer
A prototype of a context that is one side of a connector context pair. The Definer side is a context managed by the same party that created the TemplateContext--the party that defines the overall parameters of the connector relationship. In a person-to-business connector. Definer would typically be the business as it is the business that defines the relationship including the set of attributes that will go back and forth.
- subClassOf: Connector
Participant
A prototype of a context that is one side of a connector context pair. The Participant side is a context managed by the other party--not the party that created the TemplateContext that defines the overall parameters of the connector relationship. In a person-to-business connector. Participant would be the person (the PDS owner/user)
- subClassOf: Connector
- 0..1 overlayCode
TemplateContext
A TemplateContext is an abstract class for a context whose attributes act analogous to a "class" for regular context "instances".
- subclassOf ctxt:Context (see Context vocabulary)
WebsiteFacade
A sideA context that instead of being managed by an external party, is created and managed by local code (e.g. JavaScript running locally) acting as a proxy for the "real" issuer.
- subClassOf: SideA
- 0..1 scrapeFillCode
Attributes
app
AppContext ContextPrototype
- domain: AppTemplate
- value: App
appURI
App UI page
- domain: App
- value: xsd:anyURI
definer
Definer context within a pair of Participant/Definer connector contexts
- domain: Connector
- value: SideA
description
Human readable description of this app
- domain: App
- value: xsd:string
image
Background image to use in proxy:Cards or proxy:Apps that point to contexts instantiated from this template context.
- domain: TemplateContext
- value: xsd:base64Binary
imageType
Type of background image to use in proxy:Cards or proxy:Apps that point to contexts instantiated from this template context.
- domain: TemplateContext
- value: one of ("GIF", "JPG", "PNG")
optional
Attribute that may be provided by the side B context in a connector relationship (typically the user). Value is an attribute defined by persona.owl or fp.owl
- domain: SideB
- range: rdf:Property
overlayCode
JavaScript code to invoke to provide web augmentation/overlay.
- domain: SideB
- value: app-data:Overlay
participant
Participant context within a pair of Participant/Definer connector contexts
- domain: Connector
- value: Participant
provided
Attribute provided by either the issuer or the accepter end of a connector relationship. Value is an attribute defined by persona.owl or fp.owl
- domain: Connector
- value: rdf:Property
scrapeFillCode
JavaScript connector code
- domain: WebsiteFacade
- value: app-data:JavaScript
settingsViewRoot
Root of a tree of ViewNodes that describe the UI for the settings control panel for this context
- domain: ContextPrototype
- value: view-builder:ViewNode
templateRole
Default role played by Person entity in contexts instantiated from this context prototype
- domain:ContextPrototype
- value: persona:Role
viewRoot
Root of a tree of ViewNodes that describe the UI for this context
- domain: ContextPrototype
- value: view-builder:ViewNode
Example
Example of a NYTimes template (image data is truncated; imageType is missing). The NYTimes requires email, givenName and familyName attributes to be provided by the user (side "A"). The NYTimes (side "B") provides the user their accountNumber.
template:ConnectorTemplate_1 rdf:type template:ConnectorTemplate ; template:image "0243fa230243fa230243fa230243fa230243fa230243fa23"^^xsd:base64Binary ; template:sideA template:SideA_1 ; template:sideB template:SideB_1 . template:SideA_1 rdf:type template:SideA ; template:provided <http://nytimes/accountNumber> . template:SideB_1 rdf:type template:SideB ; template:provided fp:email , fp:givenName , fp:familyName .