The DITA Learning and training content specialization: Overview, processing, and sample content

This zip provides sample content and processing for use with the OASIS DITA 1.2 learning and training content specialization.

Purpose

This zip includes sample source content that provides overview and assumptions about the goals and objectives of the DITA 1.2 learning and training content specialization. It also provides a set of sample content about four learning objects that describe the goals and purpose of the specialization.

You can use these samples to test and evaluate of how the learning and training content specialization works.

How to use this content with the DITA Open Toolkit

You can use this content with the DITA Open Toolkit 1.5.
  1. Download and install the DITA Open Toolkit 1.5.
    • Download the most recent DITA OT 1.5 build install zip from http://sourceforge.net/projects/dita-ot/
      Note: For best results, download the full_easy_install_bin option.
    • Unzip the DITA OT install zip to your local drive, usually to c:\ root.
  2. Unzip dita12_learning_samples.zip into the DITA OT root directory that contains build_demo.xml and is usually named \DITA-OT1.5.
    • This creates a learningsamples folder in the samples directory and a plugins folder with a org.oasis.learning plugin, which provides specialized processing for the learning content.
    • This readme is also included in the learningsamples folder.
  3. Run startcmd.bat from the DITA OT root directory that you just installed to open a command prompt.
    Note: Opening the command prompt with startcmd.bat sets up the necessary classpath and other environment variables you need to complete the next steps.
  4. Run this command:
    ant -f integrator.xml

    This calls the plugin integrator, which installs the plugin files and enables the specialized processing for the learning content.

  5. Then run a test build using the default toolkit setups (using the supplied ANT files, or the Java™ command line).
    • Use this command line to build the sample learning overview, assumptions, and learning objects topics:
      java -jar lib/dost.jar /i:samples/learningsamples/ditaref-learning-rlo_samples.ditamap /transtype:xhtml /outdir:samples/learningsamples/sampleout

      Launch samples/learningsamples/sampleout/index.html in your web browser to view the results.

      Note: The zip provides pre-built HTML outputs in the samples/learningsamples/out folder. Open samples/learningsamples/out/index.html or samples/learningsamples/out/ditaref-learning-rlo_samples.chm to view the pre-built learning sample output.
    • Use the prompted ant demo build. After running the command ant -f build_demo.xml in the main toolkit directory, enter the input file name samples/learningsamples/ditaref-learning-rlo_samples.ditamap and then set other options as appropriate.

Building SCORM Output

This zip also provides basic processing to support processing to a SCORM 2004 output that follows the best practices for a basic SCORM template, as outlined here -SCORM best practices templates.

To build SCORM output:
  1. From the DITA OT root directory, run startcmd.bat to open a command prompt.
    Note: Opening the command prompt with startcmd.bat sets up the necessary classpath and other environment variables you need to complete the next steps.
  2. Then run a build using this command line:
    java -jar lib\dost.jar /i:samples/learningsamples/ditaref-learning-rlo_samples_scorm.ditamap /outdir:samples/learningsamples/scormout /transtype:scorm
  3. Look for results in samples\learningsamples/scormout.

To use this output with a SCORM-compliant LMS or other run-time environment, you will need to put imsmanifest.xml and the html, and other output files into a SCORM zip package, with all the necessary supporting XSD files.

See SCORM Schema Files for information about how to obtain the XSD files you need

Learning stub topics and sample test content

The learningsamples folder also includes the following stub topics, maps, and sample test content:
  • stub_learningobject.ditamap
  • stub_learningPlan.dita
  • stub_learningOverview.dita
  • stub_learningContent.dita
  • stub_learningAssess.dita
  • stub_learningSummary.dita
  • learningsample.ditamap
  • testlearningAssess.dita
  • testlearningContent.dita
  • testlearningOverview.dita
  • testlearningPlan.dita
  • testlearningSummary.dita

Overview: The DITA Learning and training content specialization

The DITA 1.2 learning and training content specialization specifies a set of specialized DITA topics, a learning interactions domain, a learning metadata domain, and a learning map domain to support creating and delivering structured learning content with DITA.

Learning topic types

A set of five specialized topic types provide the basic content ingredients for creating structured, modular learning content with DITA 1.2.

Learning Plan topic type
Describes learning needs and goals, instructional design models, task analyses, learning taxonomies, and other information necessary to the lesson planning process.
Learning Overview topic type
Identifies the learning objectives, includes other information helpful to the learner, such prerequisites, duration, and intended audience.
Learning Content topic type
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.
Learning Summary topic type
Recaps and provides context for the learning objectives and provides guidance to reinforce learning and long-term memory.
Learning Assessment topic type
Presents instruments that measure progress, encourage retrieval, and stimulate reinforcement of the learning content, and can be presented before the content as a pre-assessment or after the content as a post-assessment checkpoint or test.

Learning map domain

The learning map domain defines a set of specialized topic references for structured learning content as learning objects and groups in a DITA map.

learningGroup
A container to introduce and group learning objects into higher-level organizations, such as course-level, module-level, or lesson-level. A learningGroup can contain other learningGroup elements, allowing you to organize learning content at course, module, or other higher-levels of hierarchy.
learningObject
A container to introduce and group the topic references for a learning object.
learningPlanRef
A topic reference to a learning plan or other topic that provides the learning plan.
learningOverviewRef
A topic reference to a learning overview or other topic that introduces the learning object.
learningPreAssessmentRef
A topic reference to a learning assessment or other topic that is used as a pre-assessment.
learningContentRef
A topic reference to a learning content topic or topic, task, concept, reference or other specialized topic.
learningContentComponentRef
A topic reference to a learning content topic or topic, task, concept, reference or other specialized topic.
learningSummaryRef
A topic reference to a learning summary or other topic that provides the summary.
learningPostAssessmentRef
A topic reference to a learning assessment or other topic that is used as a post-assessment.

Learning interactions domain

The learning interactions domain defines a set of basic learning interactions elements as a DITA domain. This domain is made available in the learningAssessment topic type.

  • lcOpenQuestion
  • lcTrueFalse
  • lcSingleSelect
  • lcMultipleSelect
  • lcMatching
  • lcHotspot

Learning metadata domain

The learning metadata domain defines a set of basic learning metadata elements as a DITA domain.

  • lcLom is the container element for the learning metadata. In topics, it is available where you can use metadata in the prolog. In learning maps, it is available where can use topicmeta with the learning topic references.
  • lomAggregationLevel
  • lomContext
  • lomCoverage
  • lomDifficulty
  • lomInstallationRemarks
  • lomIntendedUserRole
  • lomInteractivityLevel
  • lomInteractivityType
  • lomLearningResourceType
  • lomOtherPlatformRequirements
  • lomSemanticDensity
  • lomStructure
  • lomTechRequirement
  • lomTypicalAgeRange
  • lomTypicalLearningTime