learningGroup
Use a <learningGroup> to structure learning objects into higher-level organizations, such as course-level, module-level, or lesson-level.
In addition to organizing learningObjects, a learningGroup may include topic references to learningPlan, learningOverview. and learningSummary topics, and may also include references to learningAssessment topics. A learningGroup can also contain other <learningGroup> elements, allowing you to organize learning content at course, module, or other higher levels of hierarchy.
Contains
Note: These models represent only the default document types distributed by OASIS. Actual content models will differ with each new document type.
Doctype | Content model |
learningBookmap, learningMap | |
Contained by
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 |
Inheritance
+ map/topicref learningmap-d/learningGroup
Example 430. Example
<map id="learningGroup_example">
<!-- a learningGroup can appear anywhere in a map hierarchy but always
follows a consistent information pattern -->
<!------------------------------------------------------------------->
<!-- a course=level learning group -->
<learningGroup href="course_top_Overview.dita" type="learningOverview">
<!------------------------------------------------------------------->
<learningPlanRef href="course_Plan_topic.dita" type="learningPlan" />
<learningOverviewRef href="course_Overview.dita" type="learningOverview"/>
<!------------------------------------------------------------------->
<!-- module-level learning groups -->
<learningGroup href="module1_Overview.dita" type="learningOverview">
<!------------------------------------------------------------------->
<learningOverviewRef href="module1_Overview.dita" type="learningOverview"/>
<!------------------------------------------------------------------->
<!-- This module has two lesson-level groups of learning objects -->
<learningGroup href="lesson1_Overview.dita" type="learningOverview">
<!------------------------------------------------------------------->
<learningOverviewRef href="lesson1_Overview.dita" type="learningOverview"/>
<!-- learning objects in lesson1 -->
<learningObject collection-type="sequence" href="lo1_Overview.dita" type="learningOverview">
. . .
</learningObject>
<learningObject collection-type="sequence" href="lo2_Overview.dita" type="learningOverview">
. . .
</learningObject>
<learningAssessmentRef href="lesson1_Assessment.dita" type="learningAssessment"/>
<learningSummaryRef href="lesson1_Summary.dita" type="learningSummary"/>
</learningGroup>
<!------------------------------------------------------------------->
<learningGroup href="lesson2_Overview.dita" type="learningOverview">
<!------------------------------------------------------------------->
<learningOverviewRef href="lesson1_Overview.dita" type="learningOverview"/>
<!-- learning objects in lesson2 -->
<learningObject collection-type="sequence" href="lo3_Overview.dita" type="learningOverview">
. . .
</learningObject>
<learningObject collection-type="sequence" href="lo4_Overview.dita" type="learningOverview">
. . .
</learningObject>
<learningAssessmentRef href="lesson2_Assessment.dita" type="learningAssessment"/>
<learningSummaryRef href="lesson2_Summary.dita" type="learningSummary"/>
</learningGroup>
</learningGroup>
<!------------------------------------------------------------------->
<learningGroup href="module2_Overview.dita" type="learningOverview">
<!------------------------------------------------------------------->
<learningOverviewRef href="module1_Overview.dita" type="learningOverview"/>
<!-- learning objects in module 2 (no lesson-level groups) -->
<learningObject collection-type="sequence" href="loA_Overview.dita" type="learningOverview">
. . .
</learningObject>
<learningObject collection-type="sequence" href="loB_Overview.dita" type="learningOverview">
</learningObject>
. . .
<learningObject collection-type="sequence" href="loC_Overview.dita" type="learningOverview">
</learningObject>
<learningAssessmentRef href="module2_Assessment.dita" type="learningAssessment"/>
<learningSummaryRef href="module2_Summary.dita" type="learningSummary"/>
</learningGroup>
<!------------------------------------------------------------------->
<learningAssessmentRef href="course_Assessment.dita" type="learningAssessment"/>
<learningSummaryRef href="course_Summary.dita" type="learningSummary"/>
</learningGroup>
<!------------------------------------------------------------------->
</map>
Attributes
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) | | | | |
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | | | | |
global-atts attribute group (xtrf, xtrc) | | | | |
class, outputclass, keyref | | | | |
Parent topic
