This is a subpage of http://wiki.oasis-open.org/dita/LearningSubcommittee. See the terms of use there.

DITA learning reference topics

Assignments table for reviewing and checking shortdesc's, examples, and attribute lists.

Get the most recent draft language docs here:

1) shortdesc provides the description of the element and its use. Check it for accuracy and completeness. If you need to include more than one or two sentences, then include the additional content in an new section at the top of the refbody.

2) example provides example markup for the element. Check that it is accurate and not too long. In the examples, please do not include any references to specific names of organizational members or other entities. OASIS is the only organization name you might consider using by name in example content. If you find organization names in an example, please re-work the example content.

3) attributes need to match the list of attributes specified for the element in the actual DTD. For that, you need to have a copy of the DTD files, XSD files locate the element definition in them, and compare the attributes.

4) Check DTD definitions vs. XSD definitions:

5) Assignments for reviewing the draft lang. spec topics

Table of DITA 1.2 learning elements

Here's the table of elements and review assignments.

Element

DITA doc file

Who?

shortdesc?

example?

attributes?

Comments

Topics

learningBase

learningBase.dita

Fred E.

shortdesc OK

NA

attr 'id' inconsistent w/ base class

attr 'id' inherits from topic/topic, where it is required

learningBasebody

learningBasebody.dita

Fred E.

shortdesc OK

NA

OK

lcIntro

lcIntro.dita

Fred E.

shortdesc OK

example is OK

'section' is a HUGE and varied element. The examples do not illustrate its range of possibility

lcObjectives

lcObjectives.dita

Fred E.

shortdesc OK

example is good

OK

I am puzzled as to why lcObjectives allows 0-... lcObjectiveGroup children. Isn't one enough since one Group allows 1-... lcObjectives?
JH Although one is most like sufficient for most uses, leaving the content model open has several benefits. Two include: 1) You might want to include different lcObjectiveGroup elements conditionalized for different audiences. 2) A specializer might want to call out specific kinds of objectives in different groups, so would need to have the option to include two or more of them.

lcObjectivesStem

lcObjectivesStem.dita

Fred E.

shortdesc OK

example OK

OK

samples do not show optional attributes. Thus, their use is not explained
JHTrue, but all of the attributes are from the standard DITA set, so why not keep the samples here simple?

lcObjectivesGroup

lcObjectivesGroup.dita

Fred E.

This element is not defined in the XSD. lcObjectivesGroup is in its place
JH My mistake in the original table - the correct element name is lcObjectivesGroup.

lcObjective

lcObjective.dita

Fred E.

shortdesc OK

change verb tense in samples

Use command form create rather than present active creating
JH Done.

lcAudience

lcAudience.dita

Fred E.

shortdesc OK

OK

OK

lcDuration

lcDuration.dita

Fred E.

shortdesc OK

OK

OK

lcTime

lcTime.dita

Fred E.

shortdesc OK

'datatype' attribute missing from sample but listed as required in content model

I don't see where the 'name' and 'value' atts are defined in the xsds. Base type is id'd as data.atts.class.
JH - question for Eric Sirois.

lcPrereqs

lcPrereqs.dita

Fred E.

shortdesc OK

example is good

OK

lcSummary

lcSummary.dita

Fred E.

shortdesc OK

example OK

OK

lcNextSteps

lcNextSteps.dita

Fred E.

shortdesc OK

example OK, but maybe too simple

OK

Example shows learningSummarybody with just one child 'lcNextSteps'. This seems a poor example of learningSummarybody. It is valid, but unlikely.

lcReview

lcReview.dita

Fred E.

shortdesc OK

example OK

OK

lcResources

lcResources.dita

Fred E.

shortdesc OK

example OK

OK

learningOverview

learningOverview.dita

Fred E.

shortdesc OK

example OK

OK

learningOverviewbody

learningOverviewbody.dita

Fred E.

shortdesc OK

ref's to learningOverview example. see learningSummarybody comments

OK

learningSummary

learningSummary.dita

Fred E.

shortdesc OK

example OK

OK

I have problems w/ learningSummarybody as OPTIONAL. But this is standard in all DITA topics.
JH - Yes - a specializer (such as Oracle) would have the option of making these optional elements required!

learningSummarybody

learningSummarybody.dita

Fred E.

shortdesc OK, see comment

ref's to learningSummary element, where this element is shown. Note that learningSummarybody is OPTIONAL in xsd.

OK

example & shortdesc does not clearly show that this element is optional. It implies that it is the main child element of learningSummary
JH - if learningSummarybody is optional in the xsd, this is wrong. However, in the lang spec, the computed table for learningSummary Contains is shows learningSummarybody as part of learningContent, when it really is learningSummary (topic type) that is available as a nested topic in a learningContent topic.

learningPlan

learningPlan.dita

John C.

JH: OK, but could have a better example.

learningPlanbody

learningPlanbody.dita

John C.

JH: OK.

lcProject

lcProject.dita

John C.

JH: OK

lcClient

lcClient.dita

John C.

JH: OK

lcPlanTitle

lcPlanTitle.dita

John C.

JH: OK

lcCIN

lcCIN.dita

John C.

JH: OK

lcModDate

lcModDate.dita

John C.

JH: OK

lcDelivDate

lcDelivDate.dita

John C.

JH: OK

lcPlanSubject

lcPlanSubject.dita

John C.

JH: OK

lcPlanDescrip

lcPlanDescrip.dita

John C.

JH: OK

lcPlanPrereqs

lcPlanPrereqs.dita

John C.

JH: OK

lcNeedsAnalysis

lcNeedsAnalysis.dita

John C.

JH: OK

lcOrganizational

lcOrganizational.dita

John C.

JH: OK

lcGeneralDescription

lcGeneralDescription.dita

John C.

JH: OK

lcGoals

lcGoals.dita

John C.

JH: OK

lcNeeds

lcNeeds.dita

John C.

JH: OK

lcValues

lcValues.dita

John C.

JH: OK

lcOrgConstraints

lcOrgConstraints.dita

John C.

JH: OK

lcPlanAudience

lcPlanAudience.dita

John C.

JH: OK

lcGeneralDescription

lcGeneralDescription.dita

John C.

JH: OK

lcEdLevel

lcEdLevel.dita

John C.

JH: OK

lcAge

lcAge.dita

John C.

JH: OK

lcBackground

lcBackground.dita

John C.

JH: OK

lcSkills

lcSkills.dita

John C.

JH: OK

lcKnowledge

lcKnowledge.dita

John C.

JH: OK

lcMotivation

lcMotivation.dita

John C.

JH: OK

lcSpecChars

lcSpecChars.dita

John C.

JH: OK

lcWorkEnv

lcWorkEnv.dita

John C.

JH: OK

lcWorkEnvDescription

lcWorkEnvDescription.dita

John C.

JH: OK

lcPlanResources

lcPlanResources.dita

John C.

JH: OK

lcProcesses

lcProcesses.dita

Robin S.

JH: OK

lcTask

lcTask.dita

Robin S.

JH: OK

lcTaskItem

lcTaskItem.dita

Robin S.

JH: OK

lcKnowledge

lcKnowledge.dita

Robin S.

JH: OK

lcSkills

lcSkills.dita

Robin S.

JH: OK

lcAttitude

lcAttitude.dita

Robin S.

JH: OK

lcGapAnalysis

lcGapAnalysis.dita

Robin S.

JH: OK

lcGapItem

lcGapItem.dita

Robin S.

JH: OK

lcPlanObjective

lcPlanObjective.dita

Robin S.

JH: OK

lcJtaItem

lcJtaItem.dita

Robin S.

JH: OK

lcGapItemDelta

lcGapItemDelta.dita

Robin S.

JH: OK

lcIntervention

lcIntervention.dita

Robin S.

JH: OK

lcInterventionItem

lcInterventionItem.dita

Robin S.

JH: OK

lcLearnStrat

lcLearnStrat.dita

Robin S.

JH: OK

lcPlanObjective

lcPlanObjective.dita

Robin S.

JH: OK

lcAssessment

lcAssessment.dita

Robin S.

JH: OK

lcDelivery

lcDelivery.dita

Robin S.

JH: OK

lcTechnical

lcTechnical.dita

Robin S.

JH: OK

lcLMS

lcLMS.dita

Robin S.

JH: OK

lcNoLMS

lcNoLMS.dita

Robin S.

JH: OK

lcHandouts

lcHandouts.dita

Scott H.

JH: OK

lcClassroom

lcClassroom.dita

Scott H.

JH: OK

lcOJT

lcOJT.dita

Scott H.

JH: Revised the example.

lcConstraints

lcConstraints.dita

Scott H.

JH: OK

lcW3C

lcW3C.dita

Scott H.

JH: Revised the example.

lcPlayers

lcPlayers.dita

Scott H.

JH: OK

lcGraphics

lcGraphics.dita

Scott H.

JH: Revised the example.

lcViewers

lcViewers.dita

Scott H.

JH: OK

lcResolution

lcResolution.dita

Scott H.

JH: Revised the example.

lcFileSizeLimitations

lcFileSizeLimitations.dita

Scott H.

JH: OK

lcDownloadTime

lcDownloadTime.dita

Scott H.

JH: OK

lcSecurity

lcSecurity.dita

Scott H.

JH: Revised the example.

learningContent

learningContent.dita

Reuben T.

JH: OK

learningContentbody

learningContentbody.dita

Reuben T.

JH: OK

lcChallenge

lcChallenge.dita

Reuben T.

JH: OK

lcInstruction

lcInstruction.dita

Reuben T.

JH: Added some more usage detail to the description.

learningAssessment

learningAssessment.dita

Reuben T.

JH: OK

learningAssessmentbody

learningAssessmentbody.dita

Reuben T.

JH: OK

lcInteraction

lcInteraction.dita

Reuben T.

JH: OK

Learning domain

lcTrueFalse

lcTrueFalse.dita

Reuben T.

JH: OK

lcSingleSelect

lcSingleSelect.dita

Reuben T.

JH: OK

lcMultipleSelect

lcMultipleSelect.dita

Reuben T.

JH: OK

lcSequencing

lcSequencing.dita

Reuben T.

JH: OK

lcMatching

lcMatching.dita

Reuben T.

JH: OK

lcHotspot

lcHotspot.dita

Reuben T.

JH: OK

lcOpenQuestion

lcOpenQuestion.dita

Reuben T.

JH: OK

lcQuestion

lcQuestion.dita

Reuben T.

JH: OK

lcOpenAnswer

lcOpenAnswer.dita

Reuben T.

JH: OK

lcAnswerOptionGroup

lcAnswerOptionGroup.dita

Reuben T.

JH: OK

lcAsset

lcAsset.dita

Reuben T.

JH: OK

lcFeedbackCorrect

lcFeedbackCorrect.dita

Reuben T.

JH: OK

lcFeedbackIncorrect

lcFeedbackIncorrect.dita

Reuben T.

JH: OK

lcAnswerOption

lcAnswerOption.dita

Scott H.

JH: OK

lcAnswerContent

lcAnswerContent.dita

Scott H.

JH: OK

lcSequenceOptionGroup

lcSequenceOptionGroup.dita

Scott H.

JH: OK

lcSequenceOption

lcSequenceOption.dita

Scott H.

JH: OK

lcSequence

lcSequence.dita

Scott H.

JH: OK

lcMatchTable

lcMatchTable.dita

Scott H.

JH: OK

lcMatchingHeader

lcMatchingHeader.dita

Scott H.

JH: OK

lcMatchingPair

lcMatchingPair.dita

Scott H.

JH: OK

lcItem

lcItem.dita

John H.

JH: OK

lcMatchingItem

lcMatchingItem.dita

John H.

JH: OK

lcHotspotMap

lcHotspotMap.dita

John H.

JH: OK

lcArea

lcArea.dita

John H.

JH: OK

lcCorrectResponse

lcCorrectResponse.dita

John H.

JH: OK

lcFeedback

lcFeedback.dita

John H.

JH: OK

lcInstructornote

lcInstructornote.dita

John H.

JH: OK

Map domain

John H.

learningObject

learningObject.dita

Troy K.

JH: Added more description to point out that matching the topic content type is optional.

learningOverviewRef

learningOverviewRef.dita

Troy K.

JH: Added more description to point out that matching the topic content type is optional.

learningPlanRef

learningPlanRef.dita

Troy K.

JH: Added more description to point out that matching the topic content type is optional.

learningContentRef

learningContentRef.dita

Troy K.

JH: Added more description to point out that matching the topic content type is optional.

learningSummaryRef

learningSummaryRef.dita

Troy K.

JH: Added more description to point out that matching the topic content type is optional.

learningAssessmentPostRef

learningAssessmentPostRef.dita

Troy K.

JH: Added more description to point out that matching the topic content type is optional.

learningAssessmentPreRef

learningAssessmentPreRef.dita

Troy K.

JH: Added more description to point out that matching the topic content type is optional.

learningGroup

learningGroup.dita

Troy K.

JH: OK

Metadata domain

John H.

lomAggregationLevel

lomAggregationLevel.dita

John H.

JH: OK

lomContext

lomContext.dita

John H.

JH: OK

lomCoverage

lomCoverage.dita

John H.

JH: OK

lomDifficulty

lomDifficulty.dita

John H.

JH: OK

lomInstallationRemarks

lomInstallationRemarks.dita

John H.

JH: OK

lomIntendedUserRole

lomIntendedUserRole.dita

John H.

JH: OK

lomInteractivityLevel

lomInteractivityLevel.dita

John H.

JH: OK

lomInteractivityType

lomInteractivityType.dita

John H.

JH: OK

lomLearningResourceType

lomLearningResourceType.dita

John H.

JH: OK

lomOtherPlatformRequirements

lomOtherPlatformRequirements.dita

John H.

JH: OK

lomSemanticDensity

lomSemanticDensity.dita

John H.

JH: OK

lomStructure

lomStructure.dita

John H.

JH: OK

lomTechRequirement

lomTechRequirement.dita

John H.

JH: OK

lomTypicalAgeRange

lomTypicalAgeRange.dita

John H.

JH: OK

lomTypicalLearningTime

lomTypicalLearningTime.dita

John H.

JH: OK

LearningContent/lcReftopics (last edited 2008-07-16 13:29:04 by john_hunt)