Templates for Documents

latest update: 2015-03-20    

Introduction

There are now 19 templates about documents and their content:

About Document Content

  • TypingOfAnInformationRepresentation
  • DefinitionOfDocumentContentWithTemplateSet
  • DocumentDefinitionByExample
  • TranslationOfClassOfInformationRepresentation

About the (class of) physical document

  • InformationOnIndividualDocument
  • ContentsOfADocument
  • ClassOfInformationObjectWithPresentationAndRepresentation
  • DocumentApproval
  • DocumentPublishing
  • DocumentRevision

Documents about a ClassOfIndividual

  • DocumentTypeAboutAClassOfIndividualApplicableYesNo  
  • ReferenceToClassOfIndividualOnDocument
  • RepresentationOfClassOfIndividual
  • RepresentationOfClassOfIndividualWithTemplateSet
  • RepresentationOfClassOfIndividualOnDocument
  • RepresentationOfClassOfIndividualOnDocumentWithTemplateSet

Documents about a PossibleIndividual

  • ReferenceToIndividualOnDocument
  • RepresentationOfIndividualOnDocument
  • RepresentationOfIndividualOnDocumentWithTemplateSet

Things that are in some of these templates

  • PossibleIndividual or ClassOfIndividual
  • ClassOfInformationObject
  • ClassOfInformationPresentation
  • ClassOfInformationRepresentation
  • ClassOfClassOfInformationRepresentation with three subtypes:
    • DocumentDefinition
    • Language
    • RepresentationForm
  • EnumeratedSetOfClass
  • tm:Template

  

Things that are used in document templates

Legend for the interconnections

This topic explains when to use which one.


Templates about Document Content


TypingOfAnInformationRepresentation

Instances of ClassOfInformationRepresentation, that are ofter referred to in other templates, can be typed by classification with a reference ClassOfClassOfInformationRepresentation. The latter is declared as follows:

:RDS7654321 rdf:type dm:ClassOfClassOfInformationRepresentation, owl:Class ;

    rdfs:subclassOf :RDS654321 ; # API 610 PUMP DATA

    rdfs:subclassOf :RDS43166358190 ; # ENGLISH

    rdfs:subclassOf :RDS321098 ; # ASCII

    meta:valEffectiveDate "2010-03-11T00:00:00Z"^^xsd:dateTime .

That ClassOfInformationRepresentation can be one of its subtypes: string, real, integer, boolean, dateTime, or a combination by using the template ClassOfCompositionDefinition.  It can also be defined with a set of template instances.

But it can also be defined with a set of template instances, see next template.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasRepresentation

dm:ClassOfInformationRepresentation

2

hasRepresentationType

dm:ClassOfClassOfInformationRepresentation

 

 


DefinitionOfClassOfInformationRepresentationWithTemplateSet

Next to creating instances of subtypes of ClassOfInformationRepresentation (e.g. string, real, integer, boolean, dateTime, see above template) we can define an instance of ClassOfInformationRepresentation as a union of a set of template instances.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasDefined

dm:ClassOfInformationRepresentation

2

hasTemplateSet

dm:EnumeratedSetOfClass

 

  

NOTE - In case the instance of EnumeratedSetOfClass is considered to be reference data, the instances of the template EnumerationOfClass may be replaced with rdf:type, e.g.:

:TC5803968A552470AB36E0C969A2C0C06 rdf:type dm:EnumeratedSetOfClass,

                                            :T6AD303FED3034CFD841F56933C3D549B,

                                            :TB92E526375AF472C938CF8B13130C6D6,

                                            :T3E55727B196340749CF03ED9F8B807EE,

                                            owl:Thing ;

    meta:valEffectiveDate "2010-03-11T00:00:00Z"^^xsd:dateTime .


DocumentDefinitionByExample

Often the exact definition of an instance of DocumentDefinition (e.g. content and layout of an API610 Pump Specification) is too cumbersome in terms of ISO 15926. Then we can make a reference to such a document class.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasDefinition

dm:DocumentDefinition

2

hasExample

dm:ClassOfInformationObject

Use ID defined elsewhere

 


TranslationOfClassOfInformationRepresentation

In cases where an instance of ClassOfInformationRepresentation has been translated, this template represents that fact.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasTranslationInput

dm:ClassOfInformationRepresentation

2

hasTranslationType

dm:ClassOfClassOfRepresentationTranslation

use ID from RDL

3

hasTranslationResult

dm:ClassOfInformationRepresentation

 

 


Templates about the (class of) physical document


InformationOnIndividualDocument

An instance of edm:InformationObject, so an individual document, is classified with the type of document, which contains an instance of ClassOfInformationRepresentation.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasDocument

edm:InformationObject

2

hasDocumentType

dm:ClassOfInformationObject

3

hasInformation

dm:ClassOfInformationRepresentation

 

  

  


ContentsOfADocument

The applicable instance(s) of ClassOfInformationRepresentation determine the "information content" of an "information carrier": an instance of ClassOfInformationObject. Use this template for each applicable instance of ClassOfInformationRepresentation.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasDocument

dm:ClassOfInformationObject

ID to be generated automatically

2

valContents

dm:ClassOfInformationRepresentation

 

  


ClassOfInformationObjectWithPresentationAndRepresentation

This is an extension of the above template, here adding the applicable instance of ClassOfInformationPresentation, to represent aspects like colour, line thickness, bold, italics, etc.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasDocumentType

dm:ClassOfInformationObject

2

hasContents

dm:ClassOfInformationRepresentation

3

hasPresentationType

dm:ClassOfInformationPresentation

 

  


DocumentApproval

The ClassOfInformationObject, or actually its masterfile, has been approved, with a Status.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasApprovedDocument

dm:ClassOfInformationObject

2

hasActivityType

dm:ClassOfActivity

use ID from RDL

3

hasActivity

dm:Activity

ID to be generated automatically

4

hasApprovalStatus

dm:Status

use ID from RDL or elsewhere

5

valApprovalDate

dm:RepresentationOfGregorianDateAndUtcTime

 

 


DocumentPublishing

The ClassOfInformationObject, or actually its masterfile, has been published, with a Status.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasPublishedDocument

dm:ClassOfInformationObject

2

hasActivityType

dm:ClassOfActivity

use ID from RDL

3

hasActivity

dm:Activity

ID to be generated automatically

4

hasPublicationStatus

dm:Status

use ID from RDL or elsewhere

5

valPublishingDate

dm:RepresentationOfGregorianDateAndUtcTime

 

 


DocumentRevision

The ClassOfInformationObject, or actually its masterfile, has been revised to the next revision number.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasRevisedDocument

dm:ClassOfInformationObject

ID to be generated automatically

2

hasActivityType

dm:ClassOfActivity

3

hasActivity

dm:Activity

4

valRevisionDate

dm:RepresentationOfGregorianDateAndUtcTime

 

  


Documents about ClassOfIndividual


DocumentTypeAboutAClassOfIndividualApplicableYesNo

A particular  type if information content  is | is not applicable to an instance of ClassOfIndividual.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasRepresented

dm:ClassOfIndividual

ID to be generated automatically

2

hasDocumentType

dm:DocumentDefinition

use ID from RDL

3

hasApplicableYesNo

dm:ClassOfAssertion

use ID from RDL

  


ReferenceToClassOfIndividualOnDocument

An instance of ClassOfIndividual is referred to on a document (ClassOfInformationObject), no further details (the instance of ClassOfInformatonRepresentation is not in the signature).

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasReferred

dm:ClassOfIndividual

use ID of class of individual already declared elsewhere

2

hasDocument

dm:ClassOfInformationObject

use ID of document already declared elsewhere

  


RepresentationOfClassOfIndividual

An instance of ClassOfIndividual is represented by a subtype of ClassOfInformationRepresentation (e.g. string, real, integer, boolean, dateTime), which is typed with a reference instance of ClassOfClassOfInformationRepresentation.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasRepresented

dm:ClassOfIndividual

2

valRepresentation

dm:ClassOfInformationRepresentation

 

3

hasRepresentationType

dm:ClassOfClassOfInformationRepresentation

use ID from RDL

  


RepresentationOfClassOfIndividualWithTemplateSet

An instance of ClassOfIndividual is represented by a typed instance of ClassOfInformationRepresentation, that in turn is defined by a set of template instances.

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasRepresented

dm:ClassOfIndividual

2

hasRepresentation

dm:ClassOfInformationRepresentation

ID to be generated automatically

3

hasRepresentationType

dm:ClassOfClassOfInformationRepresentation

4

hasTemplateSet

dm:EnumeratedSetOfClass

 

  


RepresentationOfClassOfIndividualOnDocument

Information about an instance of ClassOfIndividual is represented by an instance of a subtype of ClassOfInformationRepresentation (e.g. string, real, integer, boolean, dateTime), which is typed with a reference instance of ClassOfClassOfInformation Representation and contained in a document (ClassOfInformationObject).

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasRepresented

dm:ClassOfIndividual

use ID of declared elsewhere.

2

hasDocument

dm:ClassOfInformationObject

use ID of declared elsewhere.

3

valRepresentation

dm:ClassOfInformationRepresentation

4

hasRepresentationType

dm:ClassOfClassOfInformationRepresentation

 

  


RepresentationOfClassOfIndividualOnDocumentWithTemplateSet

Information about an instance of ClassOfIndividual is represented by an instance of ClassOfInformationRepresentation, which is:

  • defined with a set of template instances, 
  • typed with a reference instance of ClassOfClassOfInformation Representation and
  • contained in a document (ClassOfInformationObject).

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasRepresented

dm:ClassOfIndividual

use ID of declared elsewhere.

2

hasDocument

dm:ClassOfInformationObject

use ID of declared elsewhere.

3

hasRepresentation

dm:ClassOfInformationRepresentation

4

hasRepresentationType

dm:ClassOfClassOfInformationRepresentation

5

hasTemplateSet

dm:EnumeratedSetOfClass

use ID of declared elsewhere.

 


Documents about PossibleIndividual


ReferenceToIndividualOnDocument

An instance of PossibleIndividual is referred to on a document (ClassOfInformationObject), no further details (the instance of ClassOfInformatonRepresentation is not in the signature).

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasReferred

dm:PossibleIndividual

use ID of individual already declared elsewhere

2

hasDocument

dm:ClassOfInformationObject

 

  


RepresentationOfIndividualOnDocument

Information about an instance of PossibleIndividual is represented by an instance of a subtype of ClassOfInformationRepresentation (e.g. string, real, integer, boolean, dateTime), which is typed with a reference instance of ClassOfClassOfInformation Representation and contained in a document (ClassOfInformationObject).

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasRepresented

dm:ClassOfIndividual

use ID of declared elsewhere.

2

hasDocument

dm:ClassOfInformationObject

use ID of declared elsewhere.

3

valRepresentation

dm:ClassOfInformationRepresentation

4

hasRepresentationType

dm:ClassOfClassOfInformationRepresentation

 

  


RepresentationOfIndividualOnDocumentWithTemplateSet

Information about an instance of PossibleIndividual is represented by an instance of ClassOfInformationRepresentation, which is:

  • defined with a set of template instances, 
  • typed with a reference instance of ClassOfClassOfInformation Representation and
  • contained in a document (ClassOfInformationObject).

Role No

Role Name

Role Object Type

Remarks & Examples

1

hasRepresented

dm:PossibleIndividual

2

hasDocument

dm:ClassOfInformationObject

3

hasRepresentation

dm:ClassOfInformationRepresentation

4

hasRepresentationType

dm:ClassOfClassOfInformationRepresentation

5

hasTemplateSet

dm:EnumeratedSetOfClass