Wiki · iiRDS core concepts · Information units
iiRDS Package: the information unit that describes a complete delivery
Every iiRDS delivery is described by exactly one iiRDS Package instance in its metadata. The Package is a subclass of InformationUnit, but it does not stand for a manual or a topic: it stands for the bundle itself, the documents, topics and fragments exchanged together with their metadata. It carries the iiRDS version the delivery complies with, an optional format restriction for the archiving and handover variants, and general metadata such as title, language and identities. This guide explains how the Package class relates to the physical ZIP archive, how information units point to it, how nested packages work, and what the Package means for migration, MedTech handover and AI ingestion pipelines.
Valid for iiRDS 1.3Last reviewed Level: Introductory
- Technical documentation
- Machinery
- MedTech
- AI retrieval
Definition
In iiRDS (intelligent information Request and Delivery Standard), a Package is the information unit that bundles other information units with their metadata for exchange. Each iiRDS package has exactly one iirds:Package instance in its metadata, which states the iiRDS version the package complies with.
An iiRDS package, in the lowercase sense, is what a Generator hands to a Consumer: one ZIP archive with content files and META-INF/metadata.rdf. The class iirds:Package is how that delivery appears inside its own metadata. The specification requires exactly one such instance per package, with an IRI, and exactly one iirds:iiRDSVersion value.
Because Package is a subclass of InformationUnit, it can carry the same general metadata as a document: title, language, revision, identities, product variant and content lifecycle status. The optional iirds:formatRestriction marks the restricted variants iiRDS/A and iiRDS/H.
Documents, topics and fragments may state their membership with iirds:is-part-of-package. The Package of the delivery itself must not be part of another package; only nested child packages point to their parent. For the physical layout, see the container and ZIP guide.
In one sentence
The iirds:Package instance is the metadata record of the delivery as a whole, while the ZIP archive is the file that carries it.
Example
A manufacturer of palletizing robots ships documentation for model X200 to a customer's service portal. The authoring system exports one file, machine-x200_en.iirds. Inside, META-INF/metadata.rdf contains a single iirds:Package with the IRI https://example.com/iirds/packages/machine-x200, iirds:iiRDSVersion "1.3" and the title "X200 documentation". The operating manual is an iiRDS Document; around 400 service procedures are topics, and warnings inside them are fragments. The gripper supplier's documentation arrives as a nested package, declared in the parent metadata as a second iirds:Package that points to the parent with iirds:is-part-of-package.
How it applies
Technical documentation
The Package is the anchor for everything a delivery says about itself. A content delivery portal reads it first to check the iiRDS version and variant, then imports the bundled units. Title, language and revision on the Package help editors and portals tell successive deliveries of the same documentation apart.
Migration
Until iiRDS 1.2, a nested package was referenced through iirds:has-rendition pointing to the nested ZIP archive. From iiRDS 1.3, omitting that relation is recommended, and Consumers are advised to ignore it; content is read from the nested package's own metadata. Generators migrating older exports should update this pattern and set iirds:iiRDSVersion to "1.3".
MedTech
For handover of documentation for a specific device, iiRDS/H mandates metadata on the Package: at least one party with the role Creator whose vCard names an organization. Combined with PDF/A documents, the Package makes the delivery identifiable by manufacturer. Using iiRDS/H does not in itself demonstrate regulatory compliance.
AI and retrieval
For an ingestion pipeline, the Package is the provenance record. Storing its IRI, version and revision with every indexed chunk lets a retrieval system trace an answer back to the exact delivery, and replace all chunks of a package when a newer revision arrives.
Package vs. Document vs. ZIP archive
| Concept | What it is | Where it lives |
|---|---|---|
| iiRDS Package | Information unit describing the whole delivery | One instance in metadata.rdf |
| iiRDS Document | One deliverable for an audience and purpose | Any number per package |
| iiRDS ZIP archive | The physical .iirds file |
Not an RDF resource |
Metadata about products, audiences or lifecycle phases normally sits on the documents and topics; the Package holds metadata about the delivery as a whole.
In RDF
A minimal Package with one document that declares its membership. Shown in Turtle for readability; inside a package, metadata.rdf is written in RDF/XML.
@prefix iirds: <http://iirds.tekom.de/iirds#> .
<https://example.com/iirds/packages/machine-x200> a iirds:Package ;
iirds:iiRDSVersion "1.3" ;
iirds:title "X200 documentation" .
<https://example.com/iirds/operating-manual> a iirds:Document ;
iirds:is-part-of-package <https://example.com/iirds/packages/machine-x200> .
In topic-based authoring and modular architectures
In topic-based authoring, a publication is assembled from reusable modules, often through a DITA map. The iiRDS Package is the delivery-side counterpart: one export bundles the modules as topics and fragments, with their metadata, and the Package describes that bundle. A map is not converted into the Package; a map-level deliverable is usually modeled as a Document. In modular delivery architectures, each package is an independently versioned unit. Suppliers deliver their own packages, a machine builder nests them, and a portal replaces a whole package when a new revision arrives, without touching the others.
Concept cluster
How this concept connects to the other iiRDS core concepts.
- iiRDS container and ZIP archiveThe container and ZIP archive are the physical form of the delivery that the Package instance describes.
- iiRDS InformationUnitPackage is one of the four subclasses of the abstract InformationUnit class.
- iiRDS DocumentDocuments are the deliverables bundled in a package and may point to it with iirds:is-part-of-package.
- iiRDS TopicTopics are the fine-grained units that unrestricted packages carry for intelligent delivery.
- iiRDS RenditionRenditions locate the content files of the bundled units by paths relative to the package root.
- iiRDS GeneratorA Generator produces the package and its single Package instance.
- iiRDS ConsumerA Consumer reads the Package first to learn the iiRDS version and variant it must handle.
Also searched as
- iiRDS Package
- iirds:Package
- iiRDS package metadata
- iiRDS delivery package
- iirds:iiRDSVersion
- nested iiRDS packages
- iiRDS package
- package
Questions this article answers:
- what is an iiRDS package
- iirds:Package vs iiRDS ZIP archive
- how to declare the iiRDS version of a package
- nested iiRDS packages supplier documentation
Explore further
In the glossary
Frequently asked questions
- What is an iiRDS package?
- An iiRDS package is a bundle of information units with their content and metadata, delivered from an iiRDS Generator to an iiRDS Consumer as an iiRDS ZIP archive. Its metadata contains exactly one iirds:Package instance describing the bundle.
- What is the difference between iirds:Package and the .iirds file?
- The .iirds file is the ZIP archive that physically carries the delivery. The iirds:Package instance is the RDF resource inside metadata.rdf that describes that delivery.
- Which property is mandatory on iirds:Package?
- Exactly one iirds:iiRDSVersion value, for example 1.3, is required. The property iirds:formatRestriction is optional and takes A or H for the restricted variants.
- Do documents and topics have to reference the package?
- No. Information units may point to their package with iirds:is-part-of-package, but the specification does not require it.
- Can an iiRDS package contain other packages?
- Unrestricted iiRDS packages may nest other iiRDS packages, for example supplier documentation, and the parent metadata must contain an iirds:Package for each nested child. iiRDS/H packages must not contain nested ZIP archives and use component trees instead.
- Is a package the same as a document?
- No. A document is one deliverable for an audience and purpose, such as an operating manual, while the package is the bundle of all deliverables and their metadata exchanged together.
Conclusion
The iiRDS Package is small in terms of properties but central to exchange: it tells every Consumer which iiRDS version and variant it is reading. Keep exactly one Package instance per delivery, give it a stable IRI, and use nesting or component trees to represent supplier documentation.