element <reference> (global)
Namespace: |
|
Type: |
|
Content: |
|
Defined: |
|
Includes: |
|
Used: |
|
XML Representation Summary |
<reference |
|
|
= |
xs:ID |
|
= |
xs:string |
|
= |
xs:string : "1.1" |
|
= |
xs:string |
|
= |
xs:string |
|
= |
xs:string |
|
= |
xs:string |
|
= |
xs:string |
|
= |
xs:string |
|
= |
xs:string |
|
= |
xs:string |
|
= |
("obsolete" | "deprecated" | "optional" | "default" | "low" | "normal" | "high" | "recommended" | "required" | "urgent" | "-dita-use-conref-target") |
|
= |
("new" | "changed" | "deleted" | "unchanged" | "-dita-use-conref-target") |
|
= |
("yes" | "no" | "-dita-use-conref-target") |
|
= |
xs:language |
|
= |
("ltr" | "rtl" | "lro" | "rlo" | "-dita-use-conref-target") |
|
= |
xs:string |
|
= |
xs:string |
|
= |
xs:string : "(topic ui-d) (topic hi-d) (topic sw-d) (topic pr-d) (topic ut-d) (topic indexing-d)" |
|
= |
xs:string : "- topic/topic reference/reference " |
|
|
> |
|
|
</reference> |
Included in content model of elements (5):
-
Annotation
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.
Type Derivation Tree
complexType
|
XML Source (w/o annotations (1); see within schema source)
<xs:complexType>
<xs:complexContent>
<xs:extension base="reference.class">
<xs:attribute default="- topic/topic reference/reference " ref="class"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
</xs:element>
|
Attribute Detail (all declarations; defined within this component only; 1/20)
-
Type: |
xs:string, predefined
|
Use: |
optional |
Attribute Value
Default: |
"- topic/topic reference/reference " |
XML Source (see within schema source)
<xs:attribute default="- topic/topic reference/reference " ref="class"/>
|