codeblock

The <codeblock> element represents lines of program code. Like the <pre> element, content of this element has preserved line endings and is output in a monospaced font. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information.

Contains

( text data or ph or codeph or synph or filepath or msgph or userinput or systemoutput or b or u or i or tt or sup or sub or uicontrol or menucascade or term or xref or cite or q or boolean or state or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or draft-comment or required-cleanup or fn or indextermref or indexterm) (any number)

Contained by

body, section, example, desc, p, note, lq, li, itemgroup, dd, fig, stentry, draft-comment, fn, linkinfo, entry, conbody, prereq, context, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, propdesc, pd

Inheritance

topic/pre, pr-d/codeblock

Attributes

Name Description Data Type Default Value Required?
%display-atts; (scale, frame, expanse) A set of related attributes, described at %display-atts; parameter entity PE not applicable Not applicable
%univ-atts; (%select-atts;, %id-atts;, translate, xml:lang) A set of related attributes, described at %univ-atts; parameter entity PE not applicable Not applicable
spectitle The specialized title attribute allows architects of specialized types to define a fixed or default title for a specialized element. Not intended for direct use by authors. CDATA #IMPLIED No
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass, xml:space Common attributes described in Other common DITA attributes

Example

<codeblock>
/* a long sample program */
Do forever
  Say "Hello, World"
End
</codeblock>

OASIS DITA Language Specification v1.0 -- 09 May 2005
Copyright (c) OASIS Open 2005. All Rights Reserved.