3.2.3.3 refbodydiv

The <refbodydiv> element is similar to the <bodydiv> element in that it provides an informal container for content that may be grouped within a reference. Reference topics place many restrictions on their content compared to generic topics; the <refbodydiv> element maintains these restrictions by only allowing elements that are already available within the body of a reference. There are no additional semantics attached to the <refbodydiv> element; it is purely a grouping element provided to help organize content.

The <refbodydiv> element may nest itself, which means that it may be used by specializers to create structured information within a specialized reference topic. Another common use case for the <refbodydiv> element is to group a sequence of related elements for reuse, so that another topic may reference the entire set with a single conref attribute.

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
ditabase, reference, learningContent (data or data-about or example or foreign or unknown or refbodydiv or refsyn or properties or section or simpletable or table) (any number)

Contained by

Doctype Content model
ditabase, reference, learningContent refbody, refbodydiv

Inheritance

- topic/bodydiv reference/refbodydiv

Example

<reference id="sample-refbodydiv" xml:lang="en">
 <title>Sample for refbody</title>
 <shortdesc>This shows how refbodydiv might be used.</shortdesc>
 <refbody>
  <refbodydiv id="widget1">
   <section>This is one part of the sample</section>
   <refsyn>Syntax for this part</refsyn>
  </refbodydiv> 
  <refbodydiv id="widget2">
    <section>This is another part of the sample</section>
    <refsyn>Syntax for this part</refsyn>
  </refbodydiv>
 </refbody>
</reference>

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 univ-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      

Return to main page.

OASIS DITA Version 1.2 -- OASIS Standard, 1 December 2010
Copyright © OASIS Open 2005, 2010. All Rights Reserved.