DITA Resource Center

learningOverview

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.

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
learningOverview ( (title) then (titlealts) (optional) then (shortdesc or abstract) (optional) then (prolog) (optional) then (learningOverviewbody) then (related-links) (optional) then (no-topic-nesting) (any number) )

Contained by

This element is not contained by any other elements.

Inheritance

- topic/topic learningBase/learningBase learningOverview/learningOverview

Example

<learningOverview id="understanding_the_basics" xml:lang="en-us">
  <title>Overview: Understanding the basics</title>
  <shortdesc>Mail basics start from the inbox, viewing and opening messages
    you receive, and moving them to appropriate mail folders for easy access and
    retrieval.</shortdesc>
  <learningOverviewbody>
    <lcAudience>The intended audience includes new users of the company email
      system and anyone wanting a refresher on the basic features.</lcAudience>
    <lcDuration>
      <title>Expected duration</title>
      <lcTime value="00:30">It should take you no more than 30 minutes to complete
        this module.</lcTime>
    </lcDuration>
    <lcObjectives>
      <lcObjectivesStem>When you complete this lesson, you'll know how to perform
        the following mail basics:</lcObjectivesStem>
      <lcObjectivesGroup>
        <lcObjective>Viewing the inbox</lcObjective>
        <lcObjective>Opening a message</lcObjective>
        <lcObjective>Moving messages to a folder</lcObjective>
      </lcObjectivesGroup><
    </lcObjectives>
  </learningOverviewbody>
</learningOverview>

Attributes

Name Description Data Type Default Value Required?
id This ID enables topics to be referenced uniquely by topicrefs in DITA maps. ID Yes
conref-atts attribute group (conref, conrefend, conaction, conkeyref) A set of related attributes; includes all of the attributes described in id-atts attribute group except for the id attribute.
xmlns:ditaarch Declares the default DITA namespace. "http://dita.​oasis-open.​org/​architecture/​2005/"
DITAArchVersion Designates the version of the architecture that is in use. The default value will increase with each release of DITA. CDATA "1.2" No
domains Indicates the specialized domains that are included in the DTD or Schema. This value will differ depending on what domains are included in the current DTD or Schema. CDATA Varies based on the DTD or Schema; a sample value is "(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic indexing-d)" No
select-atts attribute group (props, base, platform, product, audience, otherprops, importance, rev, status) A set of related attributes, described in select-atts attribute group
localization-atts attribute group (translate, xml:lang, dir) A set of related attributes, described in localization-atts attribute group.
global-atts attribute group (xtrf, xtrc) A set of related attributes, described in global-atts attribute group
class, outputclass Common attributes described in Other common DITA attributes
domains Indicates the specialized domains that are included in the DTD or Schema. This value will differ depending on what domains are included in the current DTD or Schema. CDATA Varies based on the DTD or Schema; a sample value is "(topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic indexing-d)" No

Was this page helpful?