learningObject organizes topic references to DITA learning topics as a learning object.
A learningObject follows a specific sequence of topic references to learning content, starting with a learningPlan, then a learning overview or learning pre-assessment, one or more learning content topics, a learning summary, and one or more learning post-assessment topics.
By default, the topic references in a learningObject are expected to use the learning-specific topic types. However, the href can point to content of any type that you want to structure as a learning object. In this way, you can structure any existing DITA content as a learning object, and then take advantage of the learning-specific processing available for building and packaging that content for delivery in a learning system or learning context.
| Doctype | Content model |
|---|---|
| learningBookmap, learningMap | ( (topicmeta) (optional) then (learningPlanRef) (optional) then ( (learningOverviewRef) or (learningPreAssessmentRef) ) (any number) then (learningContentRef) (one or more) then ( (learningPostAssessmentRef) or (learningSummaryRef) ) (any number) ) |
| Doctype | Content model |
|---|---|
| learningBookmap | map, topicref, relcolspec, relcell, frontmatter, backmatter, draftintro, preface, chapter, part, appendix, notices, glossarylist, topichead, topicgroup, anchorref, topicset, topicsetref, keydef, learningGroup |
| learningMap | map, topicref, relcolspec, relcell, topichead, topicgroup, anchorref, topicset, topicsetref, keydef, learningGroup |
<map title="learningobject_example">
<!-- learningObject clusters can appear anywhere in a map hierarchy but always
follow a consistent information pattern within the LO -->
<learningObject collection-type="sequence" href="topOverview.dita" type="learningOverview">
<learningPlanRef href="testlearningPlan.dita" type="learningPlan">
</learningPlanRef>
<learningOverviewRef href="testlearningOverview.dita" type="learningOverview">
</learningOverviewRef>
<learningContentRef href="testlearningContent.dita" type="learningContent">
<learningContentComponentRef href="termA.dita" type="glossentry"/>
<learningContentComponentRef href="termB.dita" type="glossentry"/>
</learningContentRef>
<learningAssessmentRef href="testlearningAssess.dita" type="learningAssessment">
</learningAssessmentRef>
<learningSummaryRef href="testlearningSummary.dita" type="learningSummary">
</learningSummaryRef>
</learningObject>
</map>
| Name | Description | Data Type | Default Value | Required? |
|---|---|---|---|---|
| navtitle | Specifies the title of the topic as it will appear in the navigation or tables of contents that are generated from the map. Beginning with DITA 1.2, the preferred way to specify the navigation title in a map is with the navtitle element, available inside the topicmeta element. | CDATA | #IMPLIED | No |
| href | A pointer to the resource represented by the <topicref>. See The href attribute for detailed information on supported values and processing implications. References to DITA content cannot be below the topic level: that is, you cannot reference individual elements inside a topic. References to content other than DITA topics should use the format attribute to identify the kind of resource being referenced. | CDATA | #IMPLIED | No |
| query | This attribute is deprecated. It may be removed in the future. | CDATA | #IMPLIED | No |
| copy-to | Use the copy-to attribute on the
<topicref> element to provide a different file name
for a particular instance of the topic in the map (for example, to separate out
the different versions of the topic, rather than combining them on output). The
links and navigation associated with that instance will point to a copy of the
topic with the file name you specified.
Use the <linktext> and <shortdesc> in the <topicref>'s <topicmeta> to provide a unique name and short description for the new copy. |
CDATA | #IMPLIED | No |
| type | The topic type of the map reference. | CDATA | learningOverview | IMPLIED |
| topicref-atts attribute group (collection-type, processing-role, type, scope, locktitle, format, linking, toc, print, search, chunk) | A set of related attributes. See topicref-atts, topicref-atts-no-toc, and topicref-atts-without-format attribute groups. | |||
| univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
| global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
| class, outputclass, keyref | Keyref provides a redirectable reference based on a key defined within a map. See The keyref attribute for information on using this attribute. Class and outputclass are described in Other common DITA attributes |
Return to main page.
OASIS DITA Version 1.2 -- OASIS Standard, 1 December 2010
Copyright © OASIS Open 2005, 2010. All Rights Reserved.