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.


Contents

[edit] Example

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

[edit] Contains

Doctype Content model
ditabase, topic, task, reference, concept, glossary ( 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 or data or data-about or

foreign or unknown) (any number)

[edit] Contained by

Doctype Parents
ditabase desc, p, note, lq, li, itemgroup, dd, fig, stentry, draft-comment, fn, entry, abstract, body, section, example, linkinfo, conbody, prereq, context, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, propdesc, glossdef, pd
topic desc, p, note, lq, li, itemgroup, dd, fig, stentry, draft-comment, fn, entry, abstract, body, section, example, linkinfo, pd
task desc, p, note, lq, li, itemgroup, dd, fig, stentry, draft-comment, fn, entry, abstract, body, section, example, linkinfo, prereq, context, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, pd
concept desc, p, note, lq, li, itemgroup, dd, fig, stentry, draft-comment, fn, entry, abstract, body, section, example, linkinfo, conbody, pd
reference desc, p, note, lq, li, itemgroup, dd, fig, stentry, draft-comment, fn, entry, abstract, body, section, example, linkinfo, refsyn, proptypehd, propvaluehd, propdeschd, propdesc, pd
glossary desc, p, note, lq, li, itemgroup, dd, fig, stentry, draft-comment, fn, entry, abstract, body, section, example, linkinfo, conbody, glossdef, pd

[edit] Inheritance:

+ topic/pre pr-d/codeblock


[edit] Attributes

Name Description Data Type Default Value Required?
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
%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;, %localization-atts;) A set of related attributes, described at %univ-atts; parameter entity PE not

applicable

Not applicable
%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      

TOC: Language Specification 1.1
Parent topic: Programming elements
Previous topic: apiname
Next topic: codeph

Retrieved from "http://www.ditawiki.org/index.php/Codeblock"

This page has been accessed 227 times. This page was last modified 11:47, 13 July 2007.





This page
Discuss this page
Post a comment
Printable version
My pages
Log in / create account