3.1.3.1.1 prolog

The <prolog> element contains information about the topic as an whole (for example, author information or subject category) that is either entered by the author or maintained by a software application. Much of the metadata inside the <prolog> will not be displayed with the topic when the topic is rendered, but may be used by processes that generate search indexes or customize navigation.

Contains

Doctype

Content model

topic, concept, ditabase, glossary, glossentry, glossgroup, reference, task, machineryTask

( (author) (any number) then (source) (optional) then (publisher) (optional) then (copyright) (any number) then (critdates) (optional) then (permissions) (optional) then (metadata) (any number) then (resourceid) (any number) then (data or data-about or foreign or unknown) (any number) )

learningAssessment, learningContent, learningOverview, learningPlan, learningSummary

( (author) (any number) then (source) (optional) then (publisher) (optional) then (copyright) (any number) then (critdates) (optional) then (permissions) (optional) then (metadata or lcLom) (any number) then (resourceid) (any number) then (data or data-about or foreign or unknown) (any number) )

Contained by

Doctype

Content model

topic (base), topic (technical content)

topic

concept

topic, concept

ditabase

topic, concept, task, reference, glossentry, glossgroup

glossary, glossentry

topic, concept, glossentry

glossgroup

topic, concept, glossentry, glossgroup

reference

topic, reference

task (strict), task (general), machineryTask

topic, task

learningAssessment

topic, learningBase, learningAssessment

learningContent

topic, learningBase, task, concept, reference, learningSummary, learningAssessment, learningContent

learningOverview

topic, learningBase, learningOverview

learningPlan

topic, learningBase, learningPlan

learningSummary

topic, learningBase, learningSummary

Inheritance

- topic/prolog

<prolog>
  <metadata>
    <audience type="user" job="using" experiencelevel="novice"/>
  </metadata>
</prolog>
Attributes

Name

Description

Data Type

Default Value

Required?

univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)

A set of related attributes, described in 3.4.1.3 univ-atts attribute group

     

global-atts attribute group (xtrf, xtrc)

A set of related attributes, described in 3.4.1.2 global-atts attribute group

     

class

A common attribute described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.1.3.1 Prolog (metadata) elements

Next Topic:  3.1.3.1.2 audience

Parent Topic:  3.1.3.1 Prolog (metadata) elements

Sibling Topics:

3.1.3.1.2 audience

3.1.3.1.3 author

3.1.3.1.4 brand

3.1.3.1.5 category

3.1.3.1.6 component

3.1.3.1.7 copyright

3.1.3.1.8 copyrholder

3.1.3.1.9 copyryear

3.1.3.1.10 created

3.1.3.1.11 critdates

3.1.3.1.12 featnum

3.1.3.1.13 keywords

3.1.3.1.14 metadata

3.1.3.1.15 othermeta

3.1.3.1.16 permissions

3.1.3.1.17 platform

3.1.3.1.18 prodinfo

3.1.3.1.19 prodname

3.1.3.1.20 prognum

3.1.3.1.21 publisher

3.1.3.1.22 resourceid

3.1.3.1.23 revised

3.1.3.1.24 series

3.1.3.1.25 source

3.1.3.1.26 vrmlist

3.1.3.1.27 vrm