element <var> | XML Schemas for DITA 1.1

FlexDoc/XML XSDDoc Demo

XML Schemas for DITA 1.1

element <var>

Namespace:	{no namespace}
Type:	anonymous complexType (extension of var.class)
Content:	mixed, 18 attributes, 13 elements
Defined:	globally in programmingDomain.xsd; see XML source
Includes:	declaration of 1 attribute
Referenced:	by 2 locations

Component Diagram

XML Representation Summary

<var

outputclass	=	xs:string
importance	=	("optional" \| "required" \| "default" \| "-dita-use-conref-target")
xtrc	=	xs:string
xtrf	=	xs:string
id	=	xs:NMTOKEN
conref	=	xs:string
base	=	xs:string
rev	=	xs:string
status	=	("new" \| "changed" \| "deleted" \| "unchanged" \| "-dita-use-conref-target")
translate	=	("yes" \| "no" \| "-dita-use-conref-target")
xml:lang	=	xs:language
dir	=	("ltr" \| "rtl" \| "lro" \| "rlo" \| "-dita-use-conref-target")
props	=	xs:string
platform	=	xs:string
product	=	xs:string
audience	=	xs:string
otherprops	=	xs:string
class	=	xs:string : "+ topic/ph pr-d/var "

Content:

{text} × (keyword | option | parmname | apiname | wintitle | msgnum | varname | cmdname | term | data | data-about | foreign | unknown)*

</var>

Attributes:

Attribute	Type / Value	Default	Required?	Declared In	Description
outputclass	xs:string		no	var.class
importance	importance-att-progdom.class : ("optional" \| "required" \| "default" \| "-dita-use-conref-target")		no	var.class
xtrc	xs:string		no	global-atts
xtrf	xs:string		no	global-atts
id	xs:NMTOKEN		no	id-atts
conref	xs:string		no	id-atts
base	xs:string		no	univ-atts-no-importance
rev	xs:string		no	univ-atts-no-importance
status	status-atts.class : ("new" \| "changed" \| "deleted" \| "unchanged" \| "-dita-use-conref-target")		no	univ-atts-no-importance
translate	yesno-att.class : ("yes" \| "no" \| "-dita-use-conref-target")		no	localization-atts
xml:lang	xs:language		no	localization-atts	In due course, we should install the relevant ISO 2- and 3-letter codes as the enumerated possible values . . .
dir	dir-atts.class : ("ltr" \| "rtl" \| "lro" \| "rlo" \| "-dita-use-conref-target")		no	localization-atts
props	xs:string		no	filter-atts
platform	xs:string		no	filter-atts
product	xs:string		no	filter-atts
audience	xs:string		no	filter-atts
otherprops	xs:string		no	filter-atts
class	xs:string	"+ topic/ph pr-d/var "	no	this	The class attribute supports specialization. »

Content Element Model:

Component	Type / Value	Occurs	Nillable?	Declared In	Description
{text} ×	character data				may appear between child elements
CHOICE		0..∞		words.cnt
keyword	anonymous	1..1	no	keyword (ver 1)	The <keyword> element identifies a keyword or token, such as a single value from an enumerated list, the name of a command or parameter, or a lookup key for a message (contrast with term).
option	anonymous	1..1	no	pr-d-keyword	The <option> element describes an option that can be used to modify a command (or something else, like a configuration). »
parmname	anonymous	1..1	no	pr-d-keyword	When referencing the name of an application programming interface parameter within the text flow of your topic, use the parameter name (<parmname>) element to markup the parameter. »
apiname	anonymous	1..1	no	pr-d-keyword	The <apiname> element provides the name of an application programming interface (API) such as a Java class name or method name. »
wintitle	anonymous	1..1	no	ui-d-keyword	The window title <wintitle> element represents the title text that appears at the top of a window or dialog, and applies to wizard titles, wizard page titles, and pane titles. »
msgnum	anonymous	1..1	no	sw-d-keyword	The message number (<msgnum>) element contains the number of a message produced by an application or program. »
varname	anonymous	1..1	no	sw-d-keyword	The variable name (<varname>) element defines a variable that must be supplied to a software application. »
cmdname	anonymous	1..1	no	sw-d-keyword	The command name (<cmdname>) element specifies the name of a command when it is part of a software discussion. »
term	anonymous	1..1	no	term	The <term> element identifies words that represent extended definitions or explanations. »
data	anonymous	1..1	no	data	The <data> element represents a property within a DITA topic or map. »
data-about	anonymous	1..1	no	data-about	The <data-about> element identifies the subject of a property when the subject isn't associated with the context in which the property is specified. »
foreign	anonymous	1..1	no	foreign	The <foreign> element is an open extension that allows information architects to incorporate existing standard vocabularies for non-textual content. like MathML and SVG, as inline objects. »
unknown	anonymous	1..1	no	unknown	The <unknown> element is an open extension that allows information architects to incorporate xml fragments that does not necessarily fit into an exisitng DITA use case. »

Description

Within a syntax definition, the <var> element defines a variable for which the user must supply content, such as their user name or password. It is represented in output in an italic font. This element is part of the DITA programming domain, a special set of DITA elements designed to document programming tasks, concepts and reference information.

Related Components

Included in content model of elements (4):

groupchoice, groupcomp, groupseq, synph

Referenced By

In global complexTypes (1):

synph.class [ref]
In model groups (1):

syntaxdiagramprog.grp [ref]

Anonymous Type Detail

Type Derivation Tree

var.class (extension)

complexType

Overview All Components NS-Bindings

FRAMES NO FRAMES

XML schema documentation generated with FlexDoc/XML 1.15 using FlexDoc/XML XSDDoc 3.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.