element <reference> | XML Schemas for DITA 1.1

FlexDoc/XML XSDDoc Demo

XML Schemas for DITA 1.1

element <reference>

Namespace:	{no namespace}
Type:	anonymous complexType (extension of reference.class)
Content:	complex, 20 attributes, 12 elements
Defined:	globally in referenceMod.xsd; see XML source
Includes:	declaration of 1 attribute
Referenced:	by 2 locations

Component Diagram

XML Representation Summary

<reference

id	=	xs:ID
conref	=	xs:string
ditaarch:DITAArchVersion	=	xs:string : "1.1"
outputclass	=	xs:string
props	=	xs:string
platform	=	xs:string
product	=	xs:string
audience	=	xs:string
otherprops	=	xs:string
base	=	xs:string
rev	=	xs:string
importance	=	("obsolete" \| "deprecated" \| "optional" \| "default" \| "low" \| "normal" \| "high" \| "recommended" \| "required" \| "urgent" \| "-dita-use-conref-target")
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")
xtrc	=	xs:string
xtrf	=	xs:string
domains	=	xs:string : "(topic ui-d) (topic hi-d) (topic sw-d) (topic pr-d) (topic ut-d) (topic indexing-d)"
class	=	xs:string : "- topic/topic reference/reference "

Content:

</reference>

Attributes:

Attribute	Type / Value	Default	Required?	Declared In	Description
id	xs:ID		yes	reference.class (ver 1)
conref	xs:string		no	reference.class (ver 1)
ditaarch:DITAArchVersion	xs:string	1.1	no	reference.class (ver 1)
outputclass	xs:string		no	reference.class (ver 1)
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
base	xs:string		no	select-atts
rev	xs:string		no	select-atts
importance	importance-atts.class : ("obsolete" \| "deprecated" \| "optional" \| "default" \| "low" \| "normal" \| "high" \| "recommended" \| "required" \| "urgent" \| "-dita-use-conref-target")		no	select-atts
status	status-atts.class : ("new" \| "changed" \| "deleted" \| "unchanged" \| "-dita-use-conref-target")		no	select-atts
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
xtrc	xs:string		no	global-atts
xtrf	xs:string		no	global-atts
domains	xs:string	"(topic ui-d) (topic hi-d) (topic sw-d) (topic pr-d) (topic ut-d) (topic indexing-d)"	no	reference.class (ver 2)
class	xs:string	"- topic/topic reference/reference "	no	this	The class attribute supports specialization. »

Content Element Model:

Component	Type / Value	Occurs	Nillable?	Declared In	Description
SEQUENCE		1..1		reference.class (ver 1)
title	anonymous	1..1	no	title	The <title> element contains a heading or label for the main parts of a document such as <topic>, <section>, and <example> and for the display elements such as figure (<fig>) and <table>.
titlealts	anonymous	0..1	no	titlealts	The alternate title element (<titlealts>) is optional, but can occur after the topic title. »
CHOICE		0..1		reference.class (ver 1)
shortdesc	anonymous	0..1	no	shortdesc	The short description (<shortdesc>) element occurs between the topic title and the topic body, as the initial paragraph-like content of a topic. »
abstract	anonymous	0..1	no	abstract
prolog	anonymous	0..1	no	prolog	The <prolog> element contains information about the topic as an whole (for example, author information or subject category) that is either entered by the author or machine-maintained. »
refbody	anonymous	0..1	no	refbody	The <refbody> element is a container for the main content of the reference topic. »
related-links	anonymous	0..1	no	related-links	The related information links of a topic (<related-links> element) are stored in a special section following the body of the topic. »
CHOICE		0..∞		info-types
topic	anonymous	1..1	no	info-types	The <topic> element is the top-level DITA element for a single-subject topic or article. »
task	anonymous	1..1	no	info-types	The <task> element is the top-level element for a task topic. »
concept	anonymous	1..1	no	info-types	The <concept> element is the top-level element for a topic that answers the question what is? »
reference	anonymous	1..1	no	info-types	The <reference> element defines a top-level container for a reference topic. »
glossentry	anonymous	1..1	no	info-types

Description

The <reference> element defines a top-level container for a reference topic. Reference topics document programming constructs or facts about a product. Examples of reference topics include language elements, class descriptions, commands, functions, statements, protocols, types, declarators, operands, and API information, which provide quick access to facts, but no explanation of concepts or procedures. Reference topics have the same high-level structure as any other topic type, with a title, short description, and body. Within the body, reference topics are typically organized into one or more sections, property lists, and tables. The reference topic type provides general rules that apply to all kinds of reference information, using elements like <refsyn> for syntax or signatures, and <properties> for lists of properties and values.

Related Components

Included in content model of elements (5):

concept, dita, reference, task, topic

Referenced By

In model groups (2):

info-types [ref], reference [ref]

Anonymous Type Detail

Type Derivation Tree

reference.class (ver 1) (redefined by extension)

reference.class (ver 2) (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.