Reference

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.

[edit] Example

<reference id="refexample">
 <title>A reference topic/title>
 <refbody>
  <refsyn>Describe command or api syntax here, possibly
  using &lt;synph> or &lt;syntax> markup for explicit 
  definition of syntax or prototype construction.
  </refsyn>

  <section>
   <title>Some section title</title>
  </section>
  <properties>
   <property>

    <proptype>type</proptype>
    <propvalue>value</propvalue>
    <propdesc>description</propdesc>
   </property>

  </properties>
 </refbody>
</reference>

[edit] Contains

[edit] Contained by

[edit] Inheritance:

- topic/topic reference/reference

[edit] Attributes

TOC: Language Specification 1.1
Parent topic: Reference elements
Next topic: refbody