codeph

The code phrase (<codeph>) element represents a snippet of code within the main flow of text. The code phrase is displayed in a monospaced font for emphasis. 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) (any number)

Contained by

title, shortdesc, section, example, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, linkinfo, entry, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, screen, b, u, i, tt, sup, sub, codeph, codeblock, synph, pt, pd, fragref, synnote

Inheritance

topic/ph, pr-d/codeph

Attributes

Name Description Data Type Default Value Required?
%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
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass Common attributes described in Other common DITA attributes

Example

<p>The second line of the sample program code, <codeph>Do forever</codeph>, 
represents the start of a loop construct.</p>

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