parml

The parameter list (<parml>) element contains a list of terms and definitions that describes the parameters in an application programming interface. This is a special kind of definition list that is designed for documenting programming parameters. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information.

Example

Example source:
This code example is a basic method signature:
<codeblock>returnType methodName(pList1, pList2) {</codeblock>
where
<parml>
 <plentry>
  <pt>pList1</pt>
  <pd>is the first variable declaration passed to methodName</pd>
 </plentry>
 <plentry>
  <pt>pList2</pt>
  <pd>is the second variable declaration passed to methodName</pd>
 </plentry>
</parml>
Example output:
This code example is a basic method signature:
returnType methodName(pList1, pList2) {
where
pList1
is the first variable declaration passed to methodName
pList2
is the second variable declaration passed to methodName

Contains

Doctype Content model
ditabase, topic, task, reference, concept, glossary ( plentry) (one or more)

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

Inheritance:

+ topic/dl pr-d/parml

Attributes

Name Description Data Type Default Value Required?
compact Indicates close vertical spacing between the list items. Expanded spacing is the default value. The output result of compact spacing depends on the processor or browser. Allowed values are:
yes
Indicates compact spacing.
no
Indicates expanded spacing.
-dita-use-conref-target
See Using the -dita-use-conref-target value for more information.
(yes | no | -dita-use-conref-target) #IMPLIED No
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
%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 Common attributes described in Other common DITA attributes