DITA RDF ontology
type: Ontology
creator: Colin Maudry
created: 2013-01-04
modified: 2014-08-03
description: The DITA RDF ontology translates the semantics of a subset of the vocabulary described in the DITA 1.2 specification in a format that can be understood in the semantic Web of data. By Colin Maudry, licensed under the terms of the Unlicense (public domain).
license: unlicense.org
preferred namespace prefix: dita

Doctype
type: Class
comment: All the DITA document types.

Topic
subclass of: Doctype
comment: DITA topics are the basic units of DITA content and the basic units of reuse. Each topic contains a single subject. Topics may be of specific specialized information types, such as task, concept, or reference, or may be generic, that is, without a specified information type.

Map
subclass of: Doctype
comment: DITA maps are documents that organize topics and other resources into structured collections of information. DITA maps specify hierarchy and the relationships among the topics; they also provide the context in which keys are defined and resolved.

Bookmap
subclass of: Map
comment: The DITA bookmap specialization represents the key markup requirements for managing DITA content through book-oriented publication processes, including book metadata and book structures for organizing content.

Concept
subclass of: Topic
comment: The DITA concept document type uses the concept information type.

Task
subclass of: Topic
comment: The strict task document type supports the development of instructions for the completion of a procedure.

Reference
subclass of: Topic
comment: The DITA reference document type uses the reference information type.

LearningBase
subclass of: Topic
comment: The learningBase topic type is not used to deliver any actual learning content, but instead provides a set of common elements for use in the other more specific learning content types.

LearningOverview
subclass of: LearningBase
comment: A Learning Overview topic identifies the learning objectives, includes other information helpful to the learner, such as prerequisites, duration, intended audience, and can include information and strategies that seeks to gain attention and stimulate recall of prior learning.

LearningContent
subclass of: LearningBase
comment: A Learning Content topic provides the learning content itself, and enables direct use of content from DITA task, concept, and reference topics, as well as additional content of any topic type that supports specific objectives declared in the Learning Overview topic type.

LearningSummary
subclass of: LearningBase
comment: A Learning Summary recaps and provides context for the achievement or accomplishment of learning objectives, provides guidance to reinforce learning and long-term memory, and may pose questions to enhance encoding and verification of the learning content.

LearningAssessment
subclass of: LearningBase
comment: A Learning Assessment presents questions or interactions that measure progress, encourage recollection, and stimulate reinforcement of the learning content, and can be presented before the content as a pre-assessment or as a post-assessment test.

LearningPlan
subclass of: LearningBase
comment: A Learning Plan topic describes learning needs and goals, instructional design models, task analyses, learning taxonomies, and other information necessary to the lesson planning process.

DITA base reference object
type: Class
comment: The DITA reference object is used to link, fetch or push content in relation with another file or object.

Topicref
subclass of: DITA base reference object
comment: The topicref element identifies a topic (such as a concept, task, or reference) or other resource.

Mapref
subclass of: Topicref
subclass of: DITA base reference object
comment: The mapref element is a convenience element that is equivalent to a topicref element with the format attribute set to 'ditamap'.

Keydef
subclass of: Topicref
subclass of: DITA base reference object
comment: The keydef element is a convenience element that is used to define keys without any of the other effects that occur when using a topicref element: no content is included in output, no title is included in the table of contents, and no linking or other relationships are defined.

Keyref
subclass of: DITA base reference object
comment: The keyref attribute provides an indirect, late-bound reference to topics, to collections of topics (ditabase), to maps, to referenceable portions of maps, to non-DITA documents, to external URIs, or to XML content contained within a key definition topic reference.

Image
subclass of: DITA base reference object
comment: Include artwork or images in a DITA topic by using the image element.

Conref
subclass of: DITA base reference object
comment: This attribute is used to reference content that can be reused.

Conkeyref
subclass of: DITA base reference object
comment: The conkeyref attribute provides an indirect content reference to topic elements, map elements, or elements within maps or topics.

Xref
subclass of: DITA base reference object
comment: Use the cross-reference (xref) element to link to a different location within the current topic, or a different topic within the same help system, or to external sources, such as Web pages, or to a location in another topic.

Link
subclass of: DITA base reference object
comment: The link element defines a relationship to another topic. Links are typically sorted when displayed based on their attributes, which define the type or role of the link's target in relation to the current topic.

Coderef
subclass of: DITA base reference object
comment: The coderef element references an external file that contains literal code.

Keyword
type: Class
comment: The keyword element identifies a keyword or token, such as a single value from an enumerated list, the name of a command or parameter, product name, or a lookup key for a message.

Varname
subclass of: Keyword
comment: The variable name (varname) element defines a variable that must be supplied to a software application.

Parmname
subclass of: Keyword
comment: When referencing the name of an application programming interface parameter within the text flow of your topic, use the parameter name (<parmname>) element to mark up the parameter.

LearningObject
subclass of: Topicref
subclass of: DITA base reference object
comment: learningObject organizes topic references to DITA learning topics as a learning object.

LearningPlanRef
subclass of: Topicref
subclass of: DITA base reference object
comment: Use a learningPlanRef element to include a topic reference to a learning plan topic as part of a learningObject.

LearningPreAssessmentRef
subclass of: Topicref
subclass of: DITA base reference object
comment: Use a learningPreAssessmentRef element to include a topic reference to a learning assessment topic as part of a DITA learningObject.

LearningOverviewRef
subclass of: Topicref
subclass of: DITA base reference object
comment: Use a learningOverviewRef element to include a topic reference to a learning overview topic as part of a learningObject.

LearningContentRef
subclass of: Topicref
subclass of: DITA base reference object
comment: Use a learningContentRef element to include a topic reference to a learning content topic as part of a DITA learningObject.

LearningContentComponentRef
subclass of: Topicref
subclass of: DITA base reference object
comment: Use a learningContentComponentRef element to include a topic reference to a topic that acts as a subtopic of a learningContent topic.

LearningSummaryRef
subclass of: Topicref
subclass of: DITA base reference object
comment: Use a <learningSummaryRef> to include topic reference to a learning summary topic in a DITA learning object.

LearningPostAssessmentRef
subclass of: Topicref
subclass of: DITA base reference object
comment: Use a learningPostAssessmentRef element to include a topic reference to a learning assessment topic as part of a DITA learningObject.

Key
type: Class
comment: The DITA key-reference mechanism provides a layer of abstraction so that the resources addressed by references can be defined globally at the DITA map level instead of locally in each topic.

Prodinfo
type: Class
comment: The prodinfo metadata element contains information about the product or products that are the subject matter of the current topic.

element
type: Property
comment: Indicates that the file contains the target element.
range: Resource
domain: Doctype

referenceObject
type: Property
sub property of: element
comment: Describes a reference object that is part of a DITA file.
domain: Doctype
range: DITA base reference object

text
type: Property
range: string
domain: Resource
comment: The text contained in the element

title
sub property of: title
type: Property
range: string
comment: The title element contains a heading or label for the main parts of a topic, including the topic as a whole, its sections and examples, and its labelled content, such as figures and tables.

id
type: Property
range: string
comment: The DITA identity attribute provides a mechanism for identifying content for linking.

xtrf
type: Property
range: string
comment: xml-trace-filename, the original filename

searchtitle
type: Property
range: string
domain: Doctype
sub property of: metadata
comment: The searchtitle element is used to specify a title that should be displayed by search tools that locate the topic.

shortdesc
type: Property
range: string
domain: Doctype
comment: The short description (shortdesc) element occurs between the topic title and the topic body, as the initial paragraph-like content of a topic, or it can be embedded in an abstract element.

author
sub property of: author
type: Property
range: string
domain: Doctype
comment: The author metadata element contains the name of the topic's author.

audience
type: Property
sub property of: element
comment: The audience metadata element indicates, through the value of its type attribute, the intended audience for a topic.
range: Audience
domain: Doctype

permissions
type: Property
comment: The permissions prolog element specifies the level of entitlement needed to access the content.
range: string
domain: Doctype

source
sub property of: source
type: Property
range: string
domain: Doctype
comment: The source element identifies a resource from which the present topic is derived, either completely or in part.

publisher
type: Property
range: string
domain: Doctype
comment: The publisher metadata element contains the name of the person, company, or organization responsible for making the content or subject of the topic available.

copyright
type: Property
range: string
domain: Doctype
comment: The copyright element specifies legal ownership of the content.

othermeta
type: Property
comment: The othermeta element can be used to identify properties not otherwise included in <metadata> and to assign name/content values to those properties.

keyword
type: Property
sub property of: element
comment: The keyword element identifies a keyword or token, such as a single value from an enumerated list, the name of a command or parameter, product name, or a lookup key for a message.
range: string
range: Keyword

category
type: Property
sub property of: element
comment: The category element represents any category by which a topic might be classified for retrieval or navigation.
range: string

language
type: Property
comment: The language of the file as specified in @xml:lang, and supposed to conform to RFC 1766.
range: language

prodinfo
type: Property
sub property of: element
domain: Doctype
range: Prodinfo
comment: Connects a DITA file with the product information that it is related to.

topicref
sub property of: referenceObject
comment: The topicref element identifies a topic (such as a concept, task, or reference) or other resource.

mapref
sub property of: topicref
sub property of: referenceObject
comment: The mapref element is a convenience element that is equivalent to a <topicref> element with the format attribute set to 'ditamap'. The hierarchy of the referenced map is merged into the container map at the position of the reference, and the relationship tables of the child map are added to the parent map.

keydef
sub property of: topicref
sub property of: referenceObject
range: Key
domain: Map
comment: The keydef element is a convenience element that is used to define keys without any of the other effects that occur when using a topicref element: no content is included in output, no title is included in the table of contents, and no linking or other relationships are defined.

mainbooktitle
type: Property
range: string
comment: The mainbooktitle element contains the primary title information for a book.

booktitlealt
type: Property
range: string
comment: The booktitlealt element contains the alternative title, subtitle, or short title for a book. It may be specialized into a specific element for those or other purposes.

booklibrary
type: Property
range: string
comment: The booklibrary element contains the library information for a book. Library entries contain information about the series, library, or collection of documents to which the book belongs.

part
sub property of: topicref
sub property of: referenceObject
comment: The part element references a part topic or a map that references part topics for the book. A new part is started. Use <part> to divide a document's chapters into logical groupings. For example, in a document that contains both guide and reference information, you can define two parts, one containing the guide information and the other containing the reference information.

chapter
sub property of: topicref
sub property of: referenceObject
comment: The chapter element references a topic or map as a chapter within a book.

notices
sub property of: topicref
sub property of: referenceObject
comment: The notices element references a topic containing special notice information, for example, legal notices about supplementary copyrights and trademarks associated with the book.

frontmatter
sub property of: topicref
sub property of: referenceObject
comment: The frontmatter element contains the material that precedes the main body of a document. It may include items such as an abstract, a preface, and various types of book lists such as a toc, tablelist, or figurelist.

backmatter
sub property of: topicref
sub property of: referenceObject
comment: The backmatter element contains the material that follows the main body of a document and any appendices. It may include items such as a colophon, legal notices, and various types of book lists such as a glossary or an index.

subtopic
type: Property
domain: Topic
range: Topic
comment: Topics can be nested.

xref
sub property of: referenceObject
comment: Use the cross-reference (xref) element to link to a different location within the current topic, or a different topic within the same help system, or to external sources, such as Web pages, or to a location in another topic.

link
sub property of: referenceObject
comment: The link element defines a relationship to another topic. Links are typically sorted when displayed based on their attributes, which define the type or role of the link's target in relation to the current topic.

href
type: Property
comment: The href attribute is used by many elements to provide a reference to another DITA topic or map, to a specific element inside a DITA topic or map, or to an external Web page or other non-DITA resource.
domain: DITA base reference object

keyref
type: Property
range: Key
comment: The keyref attribute provides an indirect, late-bound reference to topics, to collections of topics (ditabase), to maps, to referenceable portions of maps, to non-DITA documents, to external URIs, or to XML content contained within a key definition topic reference.

keyname
type: Property
comment: The name of the key.
domain: Key
range: string

format
type: Property
comment: The format attribute identifies the format of the resource being cross referenced.
domain: DITA base reference object
range: string

scope
type: Property
comment: The scope attribute identifies the closeness of the relationship between the current document and the target resource.
domain: DITA base reference object
range: string

keys
type: Property
domain: Keydef
domain: Topicref
comment: This attribute is used to reference content that can be reused.
range: Key

conref
type: Property
range: Doctype
comment: This attribute is used to reference content that can be reused.
domain: Conref

conkeyref
type: Property
range: Key
comment: The conkeyref attribute provides an indirect content reference to topic elements, map elements, or elements within maps or topics.
domain: Conkeyref

class
type: Property
comment: Attribute used to store the class attribute and identify the nature of the Conref/Conkeyref.
range: string
domain: Conkeyref
domain: Conref

Audience
type: Class
comment: The audience metadata element indicates, through the value of its type attribute, the intended audience for a topic.

type
type: Property
comment: Indicates the kind of person for whom the content of the topic is intended. Note that this differs from the type attribute on many other DITA elements.
range: string
domain: Audience

job
type: Property
comment: Indicates the high-level task the audience for the topic is trying to accomplish.
range: string
domain: Audience

experiencelevel
type: Property
comment: Indicates the level of experience the audience is assumed to possess.
range: string
domain: Audience

created
sub property of: created
comment: The created element specifies the document creation date using the date attribute.
range: W3CDTF
domain: Doctype

created (golive)
type: Property
comment: The publication or general availability (GA) date, entered as YYYY-MM-DD, where YYYY is the year, MM is the month from 01 to 12, and DD is the day from 01-31.
range: W3CDTF
domain: Doctype

created (expiry)
type: Property
comment: The date when the information should be retired or refreshed, entered as YYYY-MM-DD, where YYYY is the year, MM is the month from 01 to 12, and DD is the day from 01-31.
range: W3CDTF
domain: Doctype

revised
sub property of: revised
comment: The revised element in the prolog is used to maintain tracking dates that are important in a topic development cycle, such as the last modification date, the original availability date, and the expiration date.
range: W3CDTF
domain: Doctype

revised (golive)
type: Property
comment: The publication or general availability (GA) date, entered as YYYY-MM-DD, where YYYY is the year, MM is the month from 01 to 12, and DD is the day from 01-31.
range: W3CDTF
domain: Doctype

revised (expiry)
type: Property
comment: The date when the information should be retired or refreshed, entered as YYYY-MM-DD, where YYYY is the year, MM is the month from 01 to 12, and DD is the day from 01-31.
range: W3CDTF
domain: Doctype

prodname
type: Property
range: string
domain: Prodinfo
comment: The prodname metadata element contains the name of the product that is supported by the information in this topic.

platform
type: Property
range: string
domain: Prodinfo
comment: The platform metadata element contains a description of the operating system and/or hardware related to the product being described by the prodinfo element.

vrm Version
type: Property
range: integer
domain: Prodinfo
comment: The vrm element contains information about a single product's version, modification, and release, to which the current topic applies.

vrm Release
type: Property
range: integer
domain: Prodinfo
comment: The vrm element contains information about a single product's version, modification, and release, to which the current topic applies.

vrm Modification
type: Property
range: integer
domain: Prodinfo
comment: The vrm element contains information about a single product's version, modification, and release, to which the current topic applies.