learningOverviewRef

Darwin Information Typing Architecture (DITA) Version 1.3 Part 3: All-Inclusive Edition

version
1.3
author
OASIS DITA Technical Committee

Use a learningOverviewRef element to include a topic reference to a learning overview topic as part of a learningObject element.

By default, a learningOverviewRef is expected to link to a learningOverview topic. However, the href in a learningOverviewRef can link to content of any type that you want to use as a learning overview in 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.

Inheritance

+ map/topicref learningmap-d/learningOverviewRef

Example

See learningObject.

Attributes

The following attributes are available on this element: Universal attribute group, Link relationship attribute group (with narrowed definitions of href and format, given below), Attributes common to many map elements (without the collection-type attribute, and with a narrowed definition of chunk, given below), Topicref element attributes group, outputclass, keys, and keyref.

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.
format
On this element, the format attribute has a default value of "dita", because it usually links to DITA learning topics. If linking to something other than DITA, set the format attribute as described in The format attribute.
chunk
On this element, the chunk attribute has a default value of "to-content", which causes the current branch of content to be published as a single unit. See Chunking for more information and for details on other supported values.