14.6. parml

L'élément de liste de paramètres (<parml>) contient une liste de termes et de définitions qui décrit les paramètres dans une interface de programmation d'application. Il s'agit d'un type spécial de liste de définition conçu pour documenter les paramètres de programmation. Cet élément appartient au domaine programming DITA, un jeu spécial d'éléments DITA conçus pour documenter des tâches, concepts et informations de référence de programmation.

Exemple

Exemple de 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>
Exemple de sortie :

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

Contient :

Doctype Modèle de contenu
ditabase, topic, task, reference, concept, glossary ( plentry) (un ou plus)

Contenu par :

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

Héritage :

+ topic/dl pr-d/parml

Attributs :

Nom Description Type de donnée Valeur par défaut Obligatoire ?
compact Indique un espacement vertical serré entre les éléments de la liste. Par défaut, l'espacement est étendu. Le résultat en sortie d'un espacement compact dépend du processeur ou du navigateur. Les valeurs permises sont :
yes
Indique un espacement compact.
no
Indique un espacement étendu.
-dita-use-conref-target
Cf. la section 25.10.1.1. Utilisation de la valeur "-dita-use-conref-target" pour plus d'informations.
(yes | no | -dita-use-conref-target) #IMPLIED non
spectitle L'attribut de titre spécialisé permet aux architectes de types spécialisés de définir un titre fixe ou par défaut pour un élément spécialisé. Non prévu pour une utilisation directe par les auteurs. CDATA #IMPLIED non
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) Un ensemble d'attributs liés, décrit à la section 25.7. %univ-atts; entité paramètre sans objet pour une entité paramètre sans objet
%global-atts; (xtrf, xtrc) Un ensemble d'attributs liés, décrit à la section 25.2. %global-atts; entité paramètre sans objet pour une entité paramètre sans objet
class, outputclass Attributs communs, décrit à la section 25.9. Autres attributs DITA communs