3.1.1.2.27 param

The parameter (<param>) element specifies a set of values that may be required by an <object> at runtime. Any number of <param> elements may appear in the content of an object in any order, but must be placed at the start of the content of the enclosing object. This element is comparable to the XHMTL <param> element, and its attributes' semantics derive from their HTML definitions. For example, the type attribute differs from the type attribute on many other DITA elements.

Contains

Doctype

Content model

topic, map, concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary

no content

Contained by

Doctype

Content model

topic (base), map (base), topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task (strict), task (general), bookmap, classifyMap, subjectScheme, machineryTask, learningAssessment, learningBookmap, learningContent, learningMap, learningOverview, learningPlan, learningSummary

object

Inheritance

- topic/param

Example

See 3.1.1.2.23 object.

Attributes

Name

Description

Data Type

Default Value

Required?

name

The name of the parameter.

CDATA

#REQUIRED

Yes

value

Specifies the value of a run-time parameter specified by the name attribute.

CDATA

#IMPLIED

No

valuetype

Specifies the type of the value attribute. Allowed values are:

data

A value of data means that the value will be evaluated and passed to the object's implementation as a string.

ref

A value of ref indicates that the value of the value attribute is a URL that designates a resource where run-time values are stored. This allows support tools to identify URLs that are given as parameters.

object

A value of object indicates that the value of valuetype is an identifier that refers to an object declaration in the document. The identifier must be the value of the ID attribute set for the declared object element.

CDATA

#IMPLIED

No

type

This attribute specifies the content type of the resource designated by the value attribute only in the case where valuetype is set to “ref”. This attribute specifies for the user agent the type of values that will be found at the URI designated by value.

CDATA

#IMPLIED (No default type)

No

univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups)

A set of related attributes, described in 3.4.1.3 univ-atts attribute group

     

global-atts attribute group (xtrf, xtrc)

A set of related attributes, described in 3.4.1.2 global-atts attribute group

     

class

A common attribute described in 3.4.1.9 Other common DITA attributes

     

Previous Topic:  3.1.1.2.26 p

Next Topic:  3.1.1.2.28 ph

Parent Topic:  3.1.1.2 Body elements

Sibling Topics:

3.1.1.2.1 alt

3.1.1.2.2 cite

3.1.1.2.3 dd

3.1.1.2.4 desc

3.1.1.2.5 ddhd

3.1.1.2.6 dl

3.1.1.2.7 dlentry

3.1.1.2.8 dlhead

3.1.1.2.9 dt

3.1.1.2.10 draft-comment

3.1.1.2.11 dthd

3.1.1.2.12 example

3.1.1.2.13 fig

3.1.1.2.14 figgroup

3.1.1.2.15 fn

3.1.1.2.16 image

3.1.1.2.17 keyword

3.1.1.2.18 li

3.1.1.2.19 lines

3.1.1.2.20 longdescref

3.1.1.2.21 longquoteref

3.1.1.2.22 lq

3.1.1.2.23 object

3.1.1.2.24 note

3.1.1.2.25 ol

3.1.1.2.26 p

3.1.1.2.28 ph

3.1.1.2.29 pre

3.1.1.2.30 q

3.1.1.2.31 section

3.1.1.2.32 sectiondiv

3.1.1.2.33 sl

3.1.1.2.34 sli

3.1.1.2.35 term

3.1.1.2.36 text

3.1.1.2.37 tm

3.1.1.2.38 ul

3.1.1.2.39 xref