Skip to content

Latest commit

 

History

History
101 lines (81 loc) · 6.43 KB

rdfsinfounits_chunks.md

File metadata and controls

101 lines (81 loc) · 6.43 KB
Raw

The iirds:InformationUnit is an abstract base class for pieces of intelligent information. Information units link user assistance content to metadata; they represent a specific set of metadata for a piece of information. iiRDS Generators MUST NOT use the iirds:InformationUnit class directly but MUST use one of the subclasses. An instance of an iirds:InformationUnit subclass MUST have an IRI and MUST NOT be a blank node.

The class iirds:InformationUnit has the following subclasses:

  • iirds:Document is a collection of information for an audience and a specific purpose.

  • iirds:Topic is a self-contained piece of information which deals with a single subject. The reader understands a topic without any additional information.

  • iirds:Fragment is a piece of information that a reader understands only if additional context information is provided.

  • iirds:Package is a collection of iirds:InformationUnits bundled with the corresponding metadata within an iiRDS package. Each iiRDS package MUST have exactly one corresponding iirds:Package instance in the metadata. Information units MAY point to the package that they belong to with the property iirds:is-part-of-package. The corresponding iirds:Package instance of an iiRDS package MUST NOT be a member of another iiRDS package expressed by the property iirds:is-part-of-package.

The subclasses iirds:Document, iirds:Topic, and iirds:Fragment represent metadata sets for intelligent information in different granularities: from document to fragment level. iirds:Document, iirds:Topic, and iirds:Fragment MAY be used according to specific requirements.

  • Examples of documents are Maintenance Manuals, Operation Instructions, and Sales Catalogs.
  • Examples of topics are a task about turning on a mobile phone or a list of all UI elements of a computer program.
  • Examples of fragments are a hazard statement, table rows, or an exploded view drawing of a pump.

iirds:Document, iirds:Topic, and iirds:Fragment MAY refer to a physical file or a part of a file in the iiRDS package. But iirds:Document, iirds:Topic, and iirds:Fragment MAY also model abstract entities without a physical file in the iiRDS package.

In this example, fragments point to error code entries that are listed within a troubleshooting topic.

<iirds:Topic rdf:about="http://metadata.example.com/iirds/fragments/E01/languages/en/versions/1">
	<iirds:title>List of event codes</iirds:title>
	<iirds:has-rendition>
		<iirds:Rendition>
			<iirds:format>text/html</iirds:format>
			<iirds:source>content/07_Troubleshooting.html</iirds:source>
		</iirds:Rendition>
	</iirds:has-rendition>
	<iirds:relates-to-product-lifecycle-phase rdf:resource="http://iirds.tekom.de/iirds#Fault"/>
	<iirds:relates-to-product-lifecycle-phase rdf:resource="http://iirds.tekom.de/iirds#Diagnostics"/>
	<iirds:has-topic-type rdf:resource="http://iirds.tekom.de/iirds#GenericTroubleshooting"/>
</iirds:Topic>
<iirds:Fragment rdf:about="http://metadata.example.com/iirds/fragments/E01/languages/en/versions/1">
	<iirds:title>Event code E01</iirds:title>
	<iirds:has-rendition>
		<iirds:Rendition>
			<iirds:format>text/html</iirds:format>
			<iirds:source>content/07_Troubleshooting.html</iirds:source>
			<iirds:has-selector>
				<iirds:FragmentSelector>
					<rdf:value>xpointer(id('fragment-E01'))</rdf:value>
				</iirds:FragmentSelector>
			</iirds:has-selector>
		</iirds:Rendition>
	</iirds:has-rendition>
	<iirds:relates-to-product-lifecycle-phase rdf:resource="http://iirds.tekom.de/iirds#Fault"/>
	<iirds:relates-to-product-lifecycle-phase rdf:resource="http://iirds.tekom.de/iirds#Diagnostics"/>
	<iirds:has-topic-type rdf:resource="http://iirds.tekom.de/iirds#GenericTroubleshooting"/>
</iirds:Fragment>
<iirds:Fragment rdf:about="http://metadata.example.com/iirds/fragments/E04/languages/en/versions/1">
	<iirds:title>Event code E04</iirds:title>
	<iirds:has-rendition>
		<iirds:Rendition>
			<iirds:format>text/html</iirds:format>
			<iirds:source>content/07_Troubleshooting.html</iirds:source>
			<iirds:has-selector>
				<iirds:FragmentSelector>
					<rdf:value>xpointer(id('fragment-E04'))</rdf:value>
				</iirds:FragmentSelector>
			</iirds:has-selector>
		</iirds:Rendition>
	</iirds:has-rendition>
	<iirds:has-topic-type rdf:resource="http://iirds.tekom.de/iirds#GenericTroubleshooting"/>
</iirds:Fragment>
<iirds:Fragment rdf:about="http://metadata.example.com/iirds/fragments/E15/languages/en/versions/1">
	<iirds:title>Event code E15</iirds:title>
	<iirds:has-rendition>
		<iirds:Rendition>
			<iirds:format>text/html</iirds:format>
			<iirds:source>content/07_Troubleshooting.html</iirds:source>
			<iirds:has-selector>
				<iirds:FragmentSelector>
					<rdf:value>xpointer(id('fragment-E15'))</rdf:value>
				</iirds:FragmentSelector>
			</iirds:has-selector>
		</iirds:Rendition>
	</iirds:has-rendition>
	<iirds:has-topic-type rdf:resource="http://iirds.tekom.de/iirds#GenericTroubleshooting"/>
</iirds:Fragment>

An iirds:Document links to an iirds:DirectoryStructure with topics that form an Operation Instruction, but does not link to a single physical file directly. In this case, the document is not represented by a physical file, but by the collection of topics.