element <macroArgument>
Namespace:
Type:
embedded (extension of xsd:string)
Content:
simple, 4 attributes
Defined:
globally within component.xsd, see XML source
Used:
XML Representation Summary
<macroArgument
   
default
 = 
xsd:string
   
help
 = 
xsd:string
   
name
 = 
xsd:string
   
optional
 = 
xsd:boolean
   
>
   
Content: 
{ xsd:string }
</macroArgument>
May be included in elements (1):
Known Usage Locations
Annotation
Added post 1.1.
Defines an argument for use with the macro.
The default value may be specified in the 'default' attribute or in the text of the element.
The text supercedes the attribute.
Embedded Type Detail
Type Derivation Summary
xsd:string
  complexType
Derivation:
extension of xsd:string
XML Source
<xsd:element name="macroArgument">
<xsd:annotation>
<xsd:documentation>
Added post 1.1.
Defines an argument for use with the macro.
The default value may be specified in the 'default' attribute or in the text of the element.
The text supercedes the attribute.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base="xsd:string">
<xsd:attribute name="name" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
The name of the argument. This must be a legal Javascript identifier
and unique within the macro.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="optional" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Tells whether the argument may be omitted from an expandMacro use.
If true, and no default is provided, the variable's value is null.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="default" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
The default value of the argument if unspecified. Alternately, the
text of this element may be supplied as the default, if formatting
or newlines are used.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="help" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Help/usage text for a documentation generating tool.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
Attribute Detail
default
The default value of the argument if unspecified. Alternately, the
text of this element may be supplied as the default, if formatting
or newlines are used.
Type:
xsd:string
Use:
optional
Defined:
locally, within this element
XML Source
<xsd:attribute name="default" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
The default value of the argument if unspecified. Alternately, the
text of this element may be supplied as the default, if formatting
or newlines are used.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

help
Help/usage text for a documentation generating tool.
Type:
xsd:string
Use:
optional
Defined:
locally, within this element
XML Source
<xsd:attribute name="help" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
Help/usage text for a documentation generating tool.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

name
The name of the argument. This must be a legal Javascript identifier
and unique within the macro.
Type:
xsd:string
Use:
required
Defined:
locally, within this element
XML Source
<xsd:attribute name="name" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>
The name of the argument. This must be a legal Javascript identifier
and unique within the macro.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

optional
Tells whether the argument may be omitted from an expandMacro use.
If true, and no default is provided, the variable's value is null.
Type:
xsd:boolean
Use:
optional
Defined:
locally, within this element
XML Source
<xsd:attribute name="optional" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Tells whether the argument may be omitted from an expandMacro use.
If true, and no default is provided, the variable's value is null.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>