gtk-web r775 - trunk/gtk-doc
- From: stefkost svn gnome org
- To: svn-commits-list gnome org
- Subject: gtk-web r775 - trunk/gtk-doc
- Date: Mon, 20 Oct 2008 19:05:18 +0000 (UTC)
Author: stefkost
Date: Mon Oct 20 19:05:17 2008
New Revision: 775
URL: http://svn.gnome.org/viewvc/gtk-web?rev=775&view=rev
Log:
* devhelp2.xsd.html (added):
Add devhelp2 fileformat docs.
* index.html:
Add link to devhelp2 docs and gtk-doc manual on lgo.
Added:
trunk/gtk-doc/devhelp2.xsd.html
Modified:
trunk/gtk-doc/ChangeLog
trunk/gtk-doc/index.html
Added: trunk/gtk-doc/devhelp2.xsd.html
==============================================================================
--- (empty file)
+++ trunk/gtk-doc/devhelp2.xsd.html Mon Oct 20 19:05:17 2008
@@ -0,0 +1,1786 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+ <head>
+ <title>XML Schema Documentation</title>
+ <meta http-equiv="Content-Type" content="text/xml; charset=iso-8859-1" />
+ <style type="text/css">
+/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
+/* More-configurable styles */
+
+/******** General ********/
+
+/* Document body */
+body {
+ color: Black;
+ background-color: White;
+ font-family: Arial, sans-serif;
+ font-size: 10pt;
+}
+/* Horizontal rules */
+hr {
+ color: black;
+}
+/* Document title */
+h1 {
+ font-size: 18pt;
+ letter-spacing: 2px;
+ border-bottom: 1px #ccc solid;
+ padding-top: 5px;
+ padding-bottom: 5px;
+}
+/* Main section headers */
+h2 {
+ font-size: 14pt;
+ letter-spacing: 1px;
+}
+/* Sub-section headers */
+h3, h3 a, h3 span {
+ font-size: 12pt;
+ font-weight: bold;
+ color: black;
+}
+/* Table displaying the properties of the schema components or the
+ schema document itself */
+table.properties th, table.properties th a {
+ color: black;
+ background-color: #F99; /* Pink */
+}
+table.properties td {
+ background-color: #eee; /* Gray */
+}
+
+
+/******** Table of Contents Section ********/
+
+/* Controls for switching between printing and viewing modes */
+div#printerControls {
+ color: #963; /* Orange-brown */
+}
+/* Controls that can collapse or expand all XML Instance
+ Representation and Schema Component Representation boxes */
+div#globalControls {
+ border: 2px solid #999;
+}
+
+
+/******** Schema Document Properties Section ********/
+
+/* Table displaying the namespaces declared in the schema */
+table.namespaces th {
+ background-color: #ccc;
+}
+table.namespaces td {
+ background-color: #eee;
+}
+/* Target namespace of the schema */
+span.targetNS {
+ color: #06C;
+ font-weight: bold;
+}
+
+
+/******** Schema Components' Sections ********/
+
+/* Name of schema component */
+.name {
+ color: #F93; /* Orange */
+}
+
+/* Hierarchy table */
+table.hierarchy {
+ border: 2px solid #999; /* Gray */
+}
+
+/* XML Instance Representation table */
+div.sample div.contents {
+ border: 2px dashed black;
+}
+
+/* Schema Component Representation table */
+div.schemaComponent div.contents {
+ border: 2px black solid;
+}
+
+
+/******** Glossary Section ********/
+
+/* Glossary Terms */
+.glossaryTerm {
+ color: #036; /* Blue */
+}
+
+
+/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
+/* Printer-version styles */
+
+ media print {
+
+/* Ensures that controls are hidden when printing */
+div#printerControls {
+ visibility: hidden;
+}
+div#globalControls {
+ visibility: hidden;
+}
+#legend {
+ display: none;
+}
+#legendTOC {
+ display: none;
+}
+#glossary {
+ display: none;
+}
+#glossaryTOC {
+ display: none;
+}
+
+}
+
+/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ */
+/* Base styles */
+
+/******** General ********/
+
+/* Unordered lists */
+ul {
+ margin-left: 1.5em;
+ margin-bottom: 0em;
+}
+/* Tables */
+table {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ margin-left: 2px;
+ margin-right: 2px;
+}
+table th, table td {
+ font-size: 10pt;
+ vertical-align: top;
+ padding-top: 3px;
+ padding-bottom: 3px;
+ padding-left: 10px;
+ padding-right: 10px;
+}
+table th {
+ font-weight: bold;
+ text-align: left;
+}
+/* Table displaying the properties of the schema components or the
+ schema document itself */
+table.properties {
+ width: 90%;
+}
+table.properties th {
+ width: 30%;
+}
+/* Boxes that can make its content appear and disappear*/
+div.box {
+ margin: 1em;
+}
+ /* Box caption */
+div.box span.caption {
+ font-weight: bold;
+}
+ /* Button to open and close the box */
+div.box input.control {
+ width: 1.4em;
+ height: 1.4em;
+ text-align: center;
+ vertical-align: middle;
+ font-size: 11pt;
+}
+ /* Box contents */
+div.box div.contents {
+ margin-top: 3px;
+}
+
+
+/******** Table of Contents Section ********/
+
+/* Controls for switching between printing and viewing modes */
+div#printerControls {
+ white-space: nowrap;
+ font-weight: bold;
+ padding: 5px;
+ margin: 5px;
+}
+/* Controls that can collapse or expand all XML Instance
+ Representation and Schema Component Representation boxes */
+div#globalControls {
+ padding: 10px;
+ margin: 5px;
+}
+
+
+/******** Schema Document Properties Section ********/
+
+/* Table displaying the namespaces declared in the schema */
+table.namespaces th {
+}
+table.namespaces td {
+}
+/* Target namespace of the schema */
+span.targetNS {
+}
+
+
+/******** Schema Components' Sections ********/
+
+/* Name of schema component */
+.name {
+}
+
+/* Hierarchy table */
+table.hierarchy {
+ width: 90%;
+}
+table.hierarchy th {
+ font-weight: normal;
+ font-style: italic;
+ width: 20%;
+}
+table.hierarchy th, table.hierarchy td {
+ padding: 5px;
+}
+
+/* XML Instance Representation table */
+div.sample {
+ width: 90%;
+}
+div.sample div.contents {
+ padding: 5px;
+ font-family: Courier New, sans-serif;
+ font-size: 10pt;
+}
+ /* Normal elements and attributes */
+div.sample div.contents, div.sample div.contents a {
+ color: black;
+}
+ /* Group Headers */
+div.sample div.contents .group, div.sample div.contents .group a {
+ color: #999; /* Light gray */
+}
+ /* Type Information */
+div.sample div.contents .type, div.sample div.contents .type a {
+ color: #999; /* Light gray */
+}
+ /* Occurrence Information */
+div.sample div.contents .occurs, div.sample div.contents .occurs a {
+ color: #999; /* Light gray */
+}
+ /* Fixed values */
+div.sample div.contents .fixed {
+ color: #063; /* Green */
+ font-weight: bold;
+}
+ /* Simple type constraints */
+div.sample div.contents .constraint, div.sample div.contents .constraint a {
+ color: #999; /* Light gray */
+}
+ /* Elements and attributes inherited from base type */
+div.sample div.contents .inherited, div.sample div.contents .inherited a {
+ color: #666; /* Dark gray */
+}
+ /* Elements and attributes added to or changed from base type */
+div.sample div.contents .newFields {
+ font-weight: bold;
+}
+ /* Other type of information */
+div.sample div.contents .other, div.sample div.contents .other a {
+ color: #369; /* Blue */
+ font-style: italic;
+}
+ /* Link to open up window displaying documentation */
+div.sample div.contents a.documentation {
+ text-decoration: none;
+ padding-left: 3px;
+ padding-right: 3px;
+ padding-top: 0px;
+ padding-bottom: 0px;
+ font-weight: bold;
+ font-size: 11pt;
+ background-color: #FFD;
+ color: #069;
+}
+ /* Invert colors when hovering over link to open up window
+ displaying documentation */
+div.sample div.contents a.documentation:hover {
+ color: #FFD;
+ background-color: #069;
+}
+
+/* Schema Component Representation table */
+div.schemaComponent {
+ width: 90%;
+}
+div.schemaComponent div.contents {
+ font-family: Courier New, sans-serif;
+ font-size: 10pt;
+ padding: 5px;
+}
+ /* Syntax characters */
+div.schemaComponent div.contents {
+ color: #00f; /* blue */
+}
+ /* Element and attribute tags */
+div.schemaComponent div.contents .scTag {
+ color: #933; /* maroon */
+}
+ /* Element and attribute content */
+div.schemaComponent div.contents .scContent, div.schemaComponent div.contents .scContent a {
+ color: black;
+ font-weight: bold;
+}
+ /* Comments */
+div.schemaComponent div.contents .comment {
+ color: #999; /* Light gray */
+}
+
+/******** Legend Section ********/
+
+div#legend table, div#legend div {
+ margin-bottom: 3px;
+}
+div#legend div.hint {
+ color: #999; /* Light gray */
+ width: 90%;
+ margin-left: 1em;
+ margin-bottom: 2em;
+}
+
+
+/******** Glossary Section ********/
+
+/* Glossary Terms */
+.glossaryTerm {
+ font-weight: bold;
+}
+
+
+/******** Footer ********/
+
+.footer {
+ font-size: 8pt;
+}
+</style>
+ <script type="text/javascript">
+<!--
+/* IDs of XML Instance Representation boxes */
+var xiBoxes = new Array('type_keyword-type_xibox', 'type_language-type_xibox', 'attribute_title_xibox', 'attribute_link_xibox', 'attribute_author_xibox', 'attribute_name_xibox', 'attribute_version_xibox', 'attribute_language_xibox', 'attribute_type_xibox', 'attribute_since_xibox', 'attribute_deprecated_xibox', 'element_sub_xibox', 'element_chapters_xibox', 'element_keyword_xibox', 'element_functions_xibox', 'element_book_xibox');
+/* IDs of Schema Component Representation boxes */
+var scBoxes = new Array('schema_scbox', 'type_keyword-type_scbox', 'type_language-type_scbox', 'attribute_title_scbox', 'attribute_link_scbox', 'attribute_author_scbox', 'attribute_name_scbox', 'attribute_version_scbox', 'attribute_language_scbox', 'attribute_type_scbox', 'attribute_since_scbox', 'attribute_deprecated_scbox', 'element_sub_scbox', 'element_chapters_scbox', 'element_keyword_scbox', 'element_functions_scbox', 'element_book_scbox');
+
+/**
+ * Can get the ID of the button controlling
+ * a collapseable box by concatenating
+ * this string onto the ID of the box itself.
+ */
+var B_SFIX = "_button";
+
+/**
+ * Counter of documentation windows
+ * Used to give each window a unique name
+ */
+var windowCount = 0;
+
+/**
+ * Returns an element in the current HTML document.
+ *
+ * @param elementID Identifier of HTML element
+ * @return HTML element object
+ */
+function getElementObject(elementID) {
+ var elemObj = null;
+ if (document.getElementById) {
+ elemObj = document.getElementById(elementID);
+ }
+ return elemObj;
+}
+
+/**
+ * Closes a collapseable box.
+ *
+ * @param boxObj Collapseable box
+ * @param buttonObj Button controlling box
+ */
+function closeBox(boxObj, buttonObj) {
+ if (boxObj == null || buttonObj == null) {
+ // Box or button not found
+ } else {
+ // Change 'display' CSS property of box
+ boxObj.style.display="none";
+
+ // Change text of button
+ if (boxObj.style.display=="none") {
+ buttonObj.value=" + ";
+ }
+ }
+}
+
+/**
+ * Opens a collapseable box.
+ *
+ * @param boxObj Collapseable box
+ * @param buttonObj Button controlling box
+ */
+function openBox(boxObj, buttonObj) {
+ if (boxObj == null || buttonObj == null) {
+ // Box or button not found
+ } else {
+ // Change 'display' CSS property of box
+ boxObj.style.display="block";
+
+ // Change text of button
+ if (boxObj.style.display=="block") {
+ buttonObj.value=" - ";
+ }
+ }
+}
+
+/**
+ * Sets the state of a collapseable box.
+ *
+ * @param boxID Identifier of box
+ * @param open If true, box is "opened",
+ * Otherwise, box is "closed".
+ */
+function setState(boxID, open) {
+ var boxObj = getElementObject(boxID);
+ var buttonObj = getElementObject(boxID+B_SFIX);
+ if (boxObj == null || buttonObj == null) {
+ // Box or button not found
+ } else if (open) {
+ openBox(boxObj, buttonObj);
+ // Make button visible
+ buttonObj.style.display="inline";
+ } else {
+ closeBox(boxObj, buttonObj);
+ // Make button visible
+ buttonObj.style.display="inline";
+ }
+}
+
+/**
+ * Switches the state of a collapseable box, e.g.
+ * if it's opened, it'll be closed, and vice versa.
+ *
+ * @param boxID Identifier of box
+ */
+function switchState(boxID) {
+ var boxObj = getElementObject(boxID);
+ var buttonObj = getElementObject(boxID+B_SFIX);
+ if (boxObj == null || buttonObj == null) {
+ // Box or button not found
+ } else if (boxObj.style.display=="none") {
+ // Box is closed, so open it
+ openBox(boxObj, buttonObj);
+ } else if (boxObj.style.display=="block") {
+ // Box is opened, so close it
+ closeBox(boxObj, buttonObj);
+ }
+}
+
+/**
+ * Closes all boxes in a given list.
+ *
+ * @param boxList Array of box IDs
+ */
+function collapseAll(boxList) {
+ var idx;
+ for (idx = 0; idx < boxList.length; idx++) {
+ var boxObj = getElementObject(boxList[idx]);
+ var buttonObj = getElementObject(boxList[idx]+B_SFIX);
+ closeBox(boxObj, buttonObj);
+ }
+}
+
+/**
+ * Open all boxes in a given list.
+ *
+ * @param boxList Array of box IDs
+ */
+function expandAll(boxList) {
+ var idx;
+ for (idx = 0; idx < boxList.length; idx++) {
+ var boxObj = getElementObject(boxList[idx]);
+ var buttonObj = getElementObject(boxList[idx]+B_SFIX);
+ openBox(boxObj, buttonObj);
+ }
+}
+
+/**
+ * Makes all the control buttons of boxes appear.
+ *
+ * @param boxList Array of box IDs
+ */
+function viewControlButtons(boxList) {
+ var idx;
+ for (idx = 0; idx < boxList.length; idx++) {
+ buttonObj = getElementObject(boxList[idx]+B_SFIX);
+ if (buttonObj != null) {
+ buttonObj.style.display = "inline";
+ }
+ }
+}
+
+/**
+ * Makes all the control buttons of boxes disappear.
+ *
+ * @param boxList Array of box IDs
+ */
+function hideControlButtons(boxList) {
+ var idx;
+ for (idx = 0; idx < boxList.length; idx++) {
+ buttonObj = getElementObject(boxList[idx]+B_SFIX);
+ if (buttonObj != null) {
+ buttonObj.style.display = "none";
+ }
+ }
+}
+
+/**
+ * Sets the page for either printing mode
+ * or viewing mode. In printing mode, the page
+ * is made to be more readable when printing it out.
+ * In viewing mode, the page is more browsable.
+ *
+ * @param isPrinterVersion If true, display in
+ * printing mode; otherwise,
+ * in viewing mode
+ */
+function displayMode(isPrinterVersion) {
+ var obj;
+ if (isPrinterVersion) {
+ // Hide global control buttons
+ obj = getElementObject("globalControls");
+ if (obj != null) {
+ obj.style.visibility = "hidden";
+ }
+ // Hide Legend
+ obj = getElementObject("legend");
+ if (obj != null) {
+ obj.style.display = "none";
+ }
+ obj = getElementObject("legendTOC");
+ if (obj != null) {
+ obj.style.display = "none";
+ }
+ // Hide Glossary
+ obj = getElementObject("glossary");
+ if (obj != null) {
+ obj.style.display = "none";
+ }
+ obj = getElementObject("glossaryTOC");
+ if (obj != null) {
+ obj.style.display = "none";
+ }
+
+ // Expand all XML Instance Representation tables
+ expandAll(xiBoxes);
+ // Expand all Schema Component Representation tables
+ expandAll(scBoxes);
+
+ // Hide Control buttons
+ hideControlButtons(xiBoxes);
+ hideControlButtons(scBoxes);
+ } else {
+ // View global control buttons
+ obj = getElementObject("globalControls");
+ if (obj != null) {
+ obj.style.visibility = "visible";
+ }
+ // View Legend
+ obj = getElementObject("legend");
+ if (obj != null) {
+ obj.style.display = "block";
+ }
+ obj = getElementObject("legendTOC");
+ if (obj != null) {
+ obj.style.display = "block";
+ }
+ // View Glossary
+ obj = getElementObject("glossary");
+ if (obj != null) {
+ obj.style.display = "block";
+ }
+ obj = getElementObject("glossaryTOC");
+ if (obj != null) {
+ obj.style.display = "block";
+ }
+
+ // Expand all XML Instance Representation tables
+ expandAll(xiBoxes);
+ // Collapse all Schema Component Representation tables
+ collapseAll(scBoxes);
+
+ // View Control buttons
+ viewControlButtons(xiBoxes);
+ viewControlButtons(scBoxes);
+ }
+}
+
+/**
+ * Opens up a window displaying the documentation
+ * of a schema component in the XML Instance
+ * Representation table.
+ *
+ * @param compDesc Description of schema component
+ * @param compName Name of schema component
+ * @param docTextArray Array containing the paragraphs
+ * of the new document
+ */
+function viewDocumentation(compDesc, compName, docTextArray) {
+ var width = 400;
+ var height = 200;
+ var locX = 100;
+ var locY = 200;
+
+ /* Generate content */
+ var actualText = "<html>";
+ actualText += "<head><title>";
+ actualText += compDesc;
+ if (compName != '') {
+ actualText += ": " + compName;
+ }
+ actualText += "</title></head>";
+ actualText += "<body bgcolor=\"#FFFFEE\">";
+ // Title
+ actualText += "<p style=\"font-family: Arial, sans-serif; font-size: 12pt; font-weight: bold; letter-spacing:1px;\">";
+ actualText += compDesc;
+ if (compName != '') {
+ actualText += ": <span style=\"color:#006699\">" + compName + "</span>";
+ }
+ actualText += "</p>";
+ // Documentation
+ var idx;
+ for (idx = 0; idx < docTextArray.length; idx++) {
+ actualText += "<p style=\"font-family: Arial, sans-serif; font-size: 10pt;\">" + docTextArray[idx] + "</p>";
+ }
+ // Link to close window
+ actualText += "<a href=\"javascript:void(0)\" onclick=\"window.close();\" style=\"font-family: Arial, sans-serif; font-size: 8pt;\">Close</a>";
+ actualText += "</body></html>";
+
+ /* Display window */
+ windowCount++;
+ var docWindow = window.open("", "documentation"+windowCount, "toolbar=no,location=no,status=no,menubar=no,scrollbars=yes,resizable,alwaysRaised,dependent,titlebar=no,width="+width+",height="+height+",screenX="+locX+",left="+locX+",screenY="+locY+",top="+locY);
+ docWindow.document.write(actualText);
+}
+
+// -->
+</script>
+ </head>
+ <body>
+ <h1>
+ <a name="top" id="top">XML Schema Documentation</a>
+ </h1>
+ <div style="float: right;">
+ <div id="printerControls" style="display:none;"><input type="checkbox" onclick="displayMode(this.checked)" />Printer-friendly Version</div>
+ <script type="text/javascript">
+<!--
+
+var pc = getElementObject("printerControls");
+if (pc != null) {
+ pc.style.display="block";
+}
+
+// -->
+</script>
+ <div id="globalControls" style="display:none">
+ <strong>XML Instance Representation:</strong>
+ <br />
+ <span style="margin-left: 1em; white-space: nowrap">[ <a href="javascript:void(0)" onclick="expandAll(xiBoxes)">Expand All</a> | <a href="javascript:void(0)" onclick="collapseAll(xiBoxes)">Collapse All</a> ]</span>
+ <br />
+ <br />
+ <strong>Schema Component Representation:</strong>
+ <br />
+ <span style="margin-left: 1em; white-space: nowrap">[ <a href="javascript:void(0)" onclick="expandAll(scBoxes)">Expand All</a> | <a href="javascript:void(0)" onclick="collapseAll(scBoxes)">Collapse All</a> ]</span>
+ </div>
+ <script type="text/javascript">
+<!--
+
+var gc = getElementObject("globalControls");
+if (gc != null) {
+ gc.style.display="block";
+}
+
+// -->
+</script>
+ </div>
+ <h2>Table of Contents</h2>
+ <ul>
+ <li>
+ <a href="#SchemaProperties">Schema Document Properties</a>
+ </li>
+ <li>
+ <a href="#SchemaDeclarations">Global Declarations</a>
+ <ul>
+ <li>
+ <a href="#attribute_author">Attribute: <strong>author</strong></a>
+ </li>
+ <li>
+ <a href="#attribute_deprecated">Attribute: <strong>deprecated</strong></a>
+ </li>
+ <li>
+ <a href="#attribute_language">Attribute: <strong>language</strong></a>
+ </li>
+ <li>
+ <a href="#attribute_link">Attribute: <strong>link</strong></a>
+ </li>
+ <li>
+ <a href="#attribute_name">Attribute: <strong>name</strong></a>
+ </li>
+ <li>
+ <a href="#attribute_since">Attribute: <strong>since</strong></a>
+ </li>
+ <li>
+ <a href="#attribute_title">Attribute: <strong>title</strong></a>
+ </li>
+ <li>
+ <a href="#attribute_type">Attribute: <strong>type</strong></a>
+ </li>
+ <li>
+ <a href="#attribute_version">Attribute: <strong>version</strong></a>
+ </li>
+ <li>
+ <a href="#element_book">Element: <strong>book</strong></a>
+ </li>
+ <li>
+ <a href="#element_chapters">Element: <strong>chapters</strong></a>
+ </li>
+ <li>
+ <a href="#element_functions">Element: <strong>functions</strong></a>
+ </li>
+ <li>
+ <a href="#element_keyword">Element: <strong>keyword</strong></a>
+ </li>
+ <li>
+ <a href="#element_sub">Element: <strong>sub</strong></a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ <a href="#SchemaDefinitions">Global Definitions</a>
+ <ul>
+ <li>
+ <a href="#type_keyword-type">Simple Type: <strong>keyword-type</strong></a>
+ </li>
+ <li>
+ <a href="#type_language-type">Simple Type: <strong>language-type</strong></a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <ul id="legendTOC" style="margin-top: 0em">
+ <li>
+ <a href="#Legend">Legend</a>
+ </li>
+ </ul>
+ <ul id="glossaryTOC" style="margin-top: 0em">
+ <li>
+ <a href="#Glossary">Glossary</a>
+ </li>
+ </ul>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h2>
+ <a name="SchemaProperties" id="SchemaProperties">Schema Document Properties</a>
+ </h2>
+ <table class="properties">
+ <tr>
+ <th>
+ <a title="Look up 'Target Namespace' in glossary" href="#term_TargetNS">Target Namespace</a>
+ </th>
+ <td>
+ <span class="targetNS">urn:devhelp</span>
+ </td>
+ </tr>
+ <tr>
+ <th>Element and Attribute Namespaces</th>
+ <td>
+ <ul>
+ <li>Global element and attribute declarations belong to this schema's target namespace.</li>
+ <li>By default, local element declarations belong to this schema's target namespace.</li>
+ <li>By default, local attribute declarations have no namespace.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Devhelp2 files are use in the 'devhelp' documentation browser.
+ </td>
+ </tr>
+ </table>
+ <h3>Declared Namespaces</h3>
+ <table class="namespaces">
+ <tr>
+ <th>Prefix</th>
+ <th>Namespace</th>
+ </tr>
+ <tr>
+ <td>
+ <a name="ns_" id="ns_">Default namespace</a>
+ </td>
+ <td>
+ <span class="targetNS">urn:devhelp</span>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a name="ns_xml" id="ns_xml">xml</a>
+ </td>
+ <td>http://www.w3.org/XML/1998/namespace</td>
+ </tr>
+ <tr>
+ <td>
+ <a name="ns_xsd" id="ns_xsd">xsd</a>
+ </td>
+ <td>http://www.w3.org/2001/XMLSchema</td>
+ </tr>
+ </table>
+ <div class="schemaComponent box">
+ <div><input type="button" id="schema_scbox_button" class="control" onclick="switchState('schema_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="schema_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:schema</span> <span class="scTag">targetNamespace</span>="<span class="scContent">urn:devhelp</span>" <span class="scTag">elementFormDefault</span>="<span class="scContent">qualified</span>"><div class="scContent" style="margin-left: 1.5em">...</div></<span class="scTag">xsd:schema</span>></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('schema_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h2>
+ <a name="SchemaDeclarations" id="SchemaDeclarations">Global Declarations</a>
+ </h2>
+ <h3>Attribute: <a name="attribute_author" class="name" id="attribute_author">author</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>author</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>
+ <span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Author of the document. Multiple authors are separated by ','.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="attribute_author_xibox_button" class="control" onclick="switchState('attribute_author_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="attribute_author_xibox" class="contents">
+ <span style="margin-left: 0em"> author="<span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>"</span>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_author_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="attribute_author_scbox_button" class="control" onclick="switchState('attribute_author_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="attribute_author_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:attribute</span> <span class="scTag">name</span>="<span class="scContent">author</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span></span>"/></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_author_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Attribute: <a name="attribute_deprecated" class="name" id="attribute_deprecated">deprecated</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>deprecated</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>
+ <span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:boolean</span>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Marks the keyword as deprecated.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="attribute_deprecated_xibox_button" class="control" onclick="switchState('attribute_deprecated_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="attribute_deprecated_xibox" class="contents">
+ <span style="margin-left: 0em"> deprecated="<span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:boolean</span>"</span>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_deprecated_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="attribute_deprecated_scbox_button" class="control" onclick="switchState('attribute_deprecated_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="attribute_deprecated_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:attribute</span> <span class="scTag">name</span>="<span class="scContent">deprecated</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:boolean</span></span>"/></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_deprecated_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Attribute: <a name="attribute_language" class="name" id="attribute_language">language</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>language</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>
+ <span class="type">
+ <a title="Jump to "language-type" type definition." href="#type_language-type">language-type</a>
+ </span>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Programing language this manual refers to.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="attribute_language_xibox_button" class="control" onclick="switchState('attribute_language_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="attribute_language_xibox" class="contents">
+ <span style="margin-left: 0em"> language="<span class="type"><a title="Jump to "language-type" type definition." href="#type_language-type">language-type</a></span>"</span>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_language_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="attribute_language_scbox_button" class="control" onclick="switchState('attribute_language_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="attribute_language_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:attribute</span> <span class="scTag">name</span>="<span class="scContent">language</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type"><a title="Jump to "language-type" type definition." href="#type_language-type">language-type</a></span></span>"/></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_language_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Attribute: <a name="attribute_link" class="name" id="attribute_link">link</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>link</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>
+ <span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Entry point to the manual. Can be given as a relative path to the
+ location of the devhelp2 file..
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="attribute_link_xibox_button" class="control" onclick="switchState('attribute_link_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="attribute_link_xibox" class="contents">
+ <span style="margin-left: 0em"> link="<span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>"</span>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_link_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="attribute_link_scbox_button" class="control" onclick="switchState('attribute_link_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="attribute_link_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:attribute</span> <span class="scTag">name</span>="<span class="scContent">link</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span></span>"/></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_link_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Attribute: <a name="attribute_name" class="name" id="attribute_name">name</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>name</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>
+ <span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Short name of the manual.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="attribute_name_xibox_button" class="control" onclick="switchState('attribute_name_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="attribute_name_xibox" class="contents">
+ <span style="margin-left: 0em"> name="<span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>"</span>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_name_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="attribute_name_scbox_button" class="control" onclick="switchState('attribute_name_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="attribute_name_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:attribute</span> <span class="scTag">name</span>="<span class="scContent">name</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span></span>"/></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_name_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Attribute: <a name="attribute_since" class="name" id="attribute_since">since</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>since</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>
+ <span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Version since that the keyword is part of the API.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="attribute_since_xibox_button" class="control" onclick="switchState('attribute_since_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="attribute_since_xibox" class="contents">
+ <span style="margin-left: 0em"> since="<span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>"</span>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_since_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="attribute_since_scbox_button" class="control" onclick="switchState('attribute_since_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="attribute_since_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:attribute</span> <span class="scTag">name</span>="<span class="scContent">since</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span></span>"/></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_since_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Attribute: <a name="attribute_title" class="name" id="attribute_title">title</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>title</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>
+ <span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Title of the reference manual.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="attribute_title_xibox_button" class="control" onclick="switchState('attribute_title_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="attribute_title_xibox" class="contents">
+ <span style="margin-left: 0em"> title="<span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span>"</span>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_title_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="attribute_title_scbox_button" class="control" onclick="switchState('attribute_title_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="attribute_title_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:attribute</span> <span class="scTag">name</span>="<span class="scContent">title</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span></span>"/></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_title_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Attribute: <a name="attribute_type" class="name" id="attribute_type">type</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>type</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>
+ <span class="type">
+ <a title="Jump to "keyword-type" type definition." href="#type_keyword-type">keyword-type</a>
+ </span>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Type of the keyword.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="attribute_type_xibox_button" class="control" onclick="switchState('attribute_type_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="attribute_type_xibox" class="contents">
+ <span style="margin-left: 0em"> type="<span class="type"><a title="Jump to "keyword-type" type definition." href="#type_keyword-type">keyword-type</a></span>"</span>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_type_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="attribute_type_scbox_button" class="control" onclick="switchState('attribute_type_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="attribute_type_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:attribute</span> <span class="scTag">name</span>="<span class="scContent">type</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type"><a title="Jump to "keyword-type" type definition." href="#type_keyword-type">keyword-type</a></span></span>"/></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_type_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Attribute: <a name="attribute_version" class="name" id="attribute_version">version</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>version</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>
+ <span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:integer</span>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Version of the devhelp xml specification (2).
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="attribute_version_xibox_button" class="control" onclick="switchState('attribute_version_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="attribute_version_xibox" class="contents">
+ <span style="margin-left: 0em"> version="<span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:integer</span>"</span>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_version_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="attribute_version_scbox_button" class="control" onclick="switchState('attribute_version_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="attribute_version_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:attribute</span> <span class="scTag">name</span>="<span class="scContent">version</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:integer</span></span>"/></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('attribute_version_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Element: <a name="element_book" class="name" id="element_book">book</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>book</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>Locally-defined complex type</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Nillable' in glossary" href="#term_Nillable">Nillable</a>
+ </th>
+ <td>no</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Abstract' in glossary" href="#term_Abstract">Abstract</a>
+ </th>
+ <td>no</td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Toplevel element of a devhelp book. A devhelp book list the structure of
+ a developer manual together with development related metadata.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="element_book_xibox_button" class="control" onclick="switchState('element_book_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="element_book_xibox" class="contents">
+ <div style="margin-left: 0em"><book<br /><span style="margin-left: 0.5em"> <a title="Jump to "title" attribute declaration." href="#attribute_title">title</a>="<span class="occurs">[1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "link" attribute declaration." href="#attribute_link">link</a>="<span class="occurs">[1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "author" attribute declaration." href="#attribute_author">author</a>="<span class="occurs">[1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "name" attribute declaration." href="#attribute_name">name</a>="<span class="occurs">[1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "version" attribute declaration." href="#attribute_version">version</a>="<span class="occurs">[1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "langua
ge" attribute declaration." href="#attribute_language">language</a>="<span class="occurs">[0..1]</span>"</span>> <br /><div style="margin-left: 1.5em"><<a title="Jump to "chapters" element declaration." href="#element_chapters">chapters</a>> ... </<a title="Jump to "chapters" element declaration." href="#element_chapters">chapters</a>> <span class="occurs">[1]</span></div><div style="margin-left: 1.5em"><<a title="Jump to "functions" element declaration." href="#element_functions">functions</a>> ... </<a title="Jump to "functions" element declaration." href="#element_functions">functions</a>> <span class="occurs">[1]</span></div></book></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_book_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="element_book_scbox_button" class="control" onclick="switchState('element_book_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="element_book_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:element</span> <span class="scTag">name</span>="<span class="scContent">book</span>"><div style="margin-left: 1.5em"><<span class="scTag">xsd:complexType</span>><div style="margin-left: 1.5em"><<span class="scTag">xsd:sequence</span>><div style="margin-left: 1.5em"><<span class="scTag">xsd:element</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "chapters" element declaration." href="#element_chapters">chapters</a></span>" <span class="scTag">minOccurs</span>="<span class="scContent">1</span>" <span class="scTag">maxOccurs</span>="<span class="scContent">1</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:element</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "functions" element declaration." href="#element_functions">functions</a></span>" <span class="scTag">minOccurs</span>="<sp
an class="scContent">1</span>" <span class="scTag">maxOccurs</span>="<span class="scContent">1</span>"/></div></<span class="scTag">xsd:sequence</span>></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "title" attribute declaration." href="#attribute_title">title</a></span>" <span class="scTag">use</span>="<span class="scContent">required</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "link" attribute declaration." href="#attribute_link">link</a></span>" <span class="scTag">use</span>="<span class="scContent">required</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "author" attribute declarati
on." href="#attribute_author">author</a></span>" <span class="scTag">use</span>="<span class="scContent">required</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "name" attribute declaration." href="#attribute_name">name</a></span>" <span class="scTag">use</span>="<span class="scContent">required</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "version" attribute declaration." href="#attribute_version">version</a></span>" <span class="scTag">use</span>="<span class="scContent">required</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "language" attribute declaration." href="#attribute_langu
age">language</a></span>"/></div></<span class="scTag">xsd:complexType</span>></div></<span class="scTag">xsd:element</span>></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_book_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Element: <a name="element_chapters" class="name" id="element_chapters">chapters</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>chapters</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>Locally-defined complex type</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Nillable' in glossary" href="#term_Nillable">Nillable</a>
+ </th>
+ <td>no</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Abstract' in glossary" href="#term_Abstract">Abstract</a>
+ </th>
+ <td>no</td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ The chapters tag encloses the structure of the reference manual. Each
+ sub unit is represented by a sub tag.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="element_chapters_xibox_button" class="control" onclick="switchState('element_chapters_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="element_chapters_xibox" class="contents">
+ <div style="margin-left: 0em"><chapters> <br /><div style="margin-left: 1.5em"><<a title="Jump to "sub" element declaration." href="#element_sub">sub</a>> ... </<a title="Jump to "sub" element declaration." href="#element_sub">sub</a>> <span class="occurs">[0..*]</span></div></chapters></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_chapters_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="element_chapters_scbox_button" class="control" onclick="switchState('element_chapters_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="element_chapters_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:element</span> <span class="scTag">name</span>="<span class="scContent">chapters</span>"><div style="margin-left: 1.5em"><<span class="scTag">xsd:complexType</span>><div style="margin-left: 1.5em"><<span class="scTag">xsd:sequence</span>><div style="margin-left: 1.5em"><<span class="scTag">xsd:element</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "sub" element declaration." href="#element_sub">sub</a></span>" <span class="scTag">minOccurs</span>="<span class="scContent">0</span>" <span class="scTag">maxOccurs</span>="<span class="scContent">unbounded</span>"/></div></<span class="scTag">xsd:sequence</span>></div></<span class="scTag">xsd:complexType</span>></div></<span class="scTag">xsd:element</span>></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_chapters_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Element: <a name="element_functions" class="name" id="element_functions">functions</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>functions</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>Locally-defined complex type</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Nillable' in glossary" href="#term_Nillable">Nillable</a>
+ </th>
+ <td>no</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Abstract' in glossary" href="#term_Abstract">Abstract</a>
+ </th>
+ <td>no</td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="element_functions_xibox_button" class="control" onclick="switchState('element_functions_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="element_functions_xibox" class="contents">
+ <div style="margin-left: 0em"><functions> <br /><div style="margin-left: 1.5em"><<a title="Jump to "keyword" element declaration." href="#element_keyword">keyword</a>> ... </<a title="Jump to "keyword" element declaration." href="#element_keyword">keyword</a>> <span class="occurs">[0..*]</span></div></functions></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_functions_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="element_functions_scbox_button" class="control" onclick="switchState('element_functions_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="element_functions_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:element</span> <span class="scTag">name</span>="<span class="scContent">functions</span>"><div style="margin-left: 1.5em"><<span class="scTag">xsd:complexType</span>><div style="margin-left: 1.5em"><<span class="scTag">xsd:sequence</span>><div style="margin-left: 1.5em"><<span class="scTag">xsd:element</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "keyword" element declaration." href="#element_keyword">keyword</a></span>" <span class="scTag">minOccurs</span>="<span class="scContent">0</span>" <span class="scTag">maxOccurs</span>="<span class="scContent">unbounded</span>"/></div></<span class="scTag">xsd:sequence</span>></div></<span class="scTag">xsd:complexType</span>></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:documentation</span>><div class="scContent" style="margin-left: 1.5em">
+ The functions tag encloses all api symbols of the reference manual. Each
+ sub unit is represented by a keyword tag.
+ </div></<span class="scTag">xsd:documentation</span>></div></<span class="scTag">xsd:element</span>></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_functions_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Element: <a name="element_keyword" class="name" id="element_keyword">keyword</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>keyword</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>Locally-defined complex type</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Nillable' in glossary" href="#term_Nillable">Nillable</a>
+ </th>
+ <td>no</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Abstract' in glossary" href="#term_Abstract">Abstract</a>
+ </th>
+ <td>no</td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="element_keyword_xibox_button" class="control" onclick="switchState('element_keyword_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="element_keyword_xibox" class="contents">
+ <div style="margin-left: 0em"><keyword<br /><span style="margin-left: 0.5em"> <a title="Jump to "type" attribute declaration." href="#attribute_type">type</a>="<span class="occurs">[1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "name" attribute declaration." href="#attribute_name">name</a>="<span class="occurs">[1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "link" attribute declaration." href="#attribute_link">link</a>="<span class="occurs">[1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "since" attribute declaration." href="#attribute_since">since</a>="<span class="occurs">[0..1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "deprecated" attribute declaration." href="#attribute_deprecated">deprecated</a>="<span class="occurs">[0..1]</span>"</span>/> </div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_keyword_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="element_keyword_scbox_button" class="control" onclick="switchState('element_keyword_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="element_keyword_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:element</span> <span class="scTag">name</span>="<span class="scContent">keyword</span>"><div style="margin-left: 1.5em"><<span class="scTag">xsd:complexType</span>><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "type" attribute declaration." href="#attribute_type">type</a></span>" <span class="scTag">use</span>="<span class="scContent">required</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "name" attribute declaration." href="#attribute_name">name</a></span>" <span class="scTag">use</span>="<span class="scContent">required</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class
="scContent"><a title="Jump to "link" attribute declaration." href="#attribute_link">link</a></span>" <span class="scTag">use</span>="<span class="scContent">required</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "since" attribute declaration." href="#attribute_since">since</a></span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "deprecated" attribute declaration." href="#attribute_deprecated">deprecated</a></span>"/></div></<span class="scTag">xsd:complexType</span>></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:documentation</span>><div class="scContent" style="margin-left: 1.5em">
+ The keyword tag points to the documentation of a api symbol.
+ </div></<span class="scTag">xsd:documentation</span>></div></<span class="scTag">xsd:element</span>></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_keyword_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Element: <a name="element_sub" class="name" id="element_sub">sub</a></h3>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>sub</td>
+ </tr>
+ <tr>
+ <th>Type</th>
+ <td>Locally-defined complex type</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Nillable' in glossary" href="#term_Nillable">Nillable</a>
+ </th>
+ <td>no</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Abstract' in glossary" href="#term_Abstract">Abstract</a>
+ </th>
+ <td>no</td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Sub tags for the hierachy of the chapters and parts.
+ </td>
+ </tr>
+ </table>
+ <div class="sample box">
+ <div><input type="button" id="element_sub_xibox_button" class="control" onclick="switchState('element_sub_xibox'); return false;" style="display: none" /> <span class="caption">XML Instance Representation</span></div>
+ <div id="element_sub_xibox" class="contents">
+ <div style="margin-left: 0em"><sub<br /><span style="margin-left: 0.5em"> <a title="Jump to "name" attribute declaration." href="#attribute_name">name</a>="<span class="occurs">[1]</span>"</span><br /><span style="margin-left: 0.5em"> <a title="Jump to "link" attribute declaration." href="#attribute_link">link</a>="<span class="occurs">[1]</span>"</span>> <br /><div style="margin-left: 1.5em"><<a title="Jump to "sub" element declaration." href="#element_sub">sub</a>> ... </<a title="Jump to "sub" element declaration." href="#element_sub">sub</a>> <span class="occurs">[0..*]</span></div></sub></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_sub_xibox', true);
+// -->
+</script>
+ </div>
+ <div class="schemaComponent box">
+ <div><input type="button" id="element_sub_scbox_button" class="control" onclick="switchState('element_sub_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="element_sub_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:element</span> <span class="scTag">name</span>="<span class="scContent">sub</span>"><div style="margin-left: 1.5em"><<span class="scTag">xsd:complexType</span>><div style="margin-left: 1.5em"><<span class="scTag">xsd:sequence</span>><div style="margin-left: 1.5em"><<span class="scTag">xsd:element</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "sub" element declaration." href="#element_sub">sub</a></span>" <span class="scTag">minOccurs</span>="<span class="scContent">0</span>" <span class="scTag">maxOccurs</span>="<span class="scContent">unbounded</span>"/></div></<span class="scTag">xsd:sequence</span>></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "name" attribute declaration." href="#attribute_name">name</a></span>" <spa
n class="scTag">use</span>="<span class="scContent">required</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:attribute</span> <span class="scTag">ref</span>="<span class="scContent"><a title="Jump to "link" attribute declaration." href="#attribute_link">link</a></span>" <span class="scTag">use</span>="<span class="scContent">required</span>"/></div></<span class="scTag">xsd:complexType</span>></div></<span class="scTag">xsd:element</span>></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('element_sub_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h2>
+ <a name="SchemaDefinitions" id="SchemaDefinitions">Global Definitions</a>
+ </h2>
+ <h3>Simple Type: <a name="type_keyword-type" class="name" id="type_keyword-type">keyword-type</a></h3>
+ <table class="hierarchy">
+ <tr>
+ <th>Super-types:</th>
+ <td><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span> < <strong>keyword-type</strong> (by restriction)</td>
+ </tr>
+ <tr>
+ <th>Sub-types:</th>
+ <td>None</td>
+ </tr>
+ </table>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>keyword-type</td>
+ </tr>
+ <tr>
+ <th>Content</th>
+ <td>
+ <ul>
+ <li>Base XSD Type: string</li>
+ </ul>
+ <ul>
+ <li><em>value</em> comes from list: {'constant'|'enum'|'function'|'macro'|'property'|'signal'|'struct'|'typedef'|'union'|'variable'}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Known keyword types.
+ </td>
+ </tr>
+ </table>
+ <div class="schemaComponent box">
+ <div><input type="button" id="type_keyword-type_scbox_button" class="control" onclick="switchState('type_keyword-type_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="type_keyword-type_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:simpleType</span> <span class="scTag">name</span>="<span class="scContent">keyword-type</span>"><div style="margin-left: 1.5em"><<span class="scTag">xsd:restriction</span> <span class="scTag">base</span>="<span class="scContent"><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span></span>"><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">constant</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">enum</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">function</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span cl
ass="scTag">value</span>="<span class="scContent">macro</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">property</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">signal</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">struct</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">typedef</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">union</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">valu
e</span>="<span class="scContent">variable</span>"/></div></<span class="scTag">xsd:restriction</span>></div></<span class="scTag">xsd:simpleType</span>></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('type_keyword-type_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <h3>Simple Type: <a name="type_language-type" class="name" id="type_language-type">language-type</a></h3>
+ <table class="hierarchy">
+ <tr>
+ <th>Super-types:</th>
+ <td><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span> < <strong>language-type</strong> (by restriction)</td>
+ </tr>
+ <tr>
+ <th>Sub-types:</th>
+ <td>None</td>
+ </tr>
+ </table>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>language-type</td>
+ </tr>
+ <tr>
+ <th>Content</th>
+ <td>
+ <ul>
+ <li>Base XSD Type: string</li>
+ </ul>
+ <ul>
+ <li><em>value</em> comes from list: {'c'|'c++'|'c#'|'java'|'javascript'|'perl'|'python'|'vala'}</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <th>Documentation</th>
+ <td>
+ Known programing languages.
+ </td>
+ </tr>
+ </table>
+ <div class="schemaComponent box">
+ <div><input type="button" id="type_language-type_scbox_button" class="control" onclick="switchState('type_language-type_scbox'); return false;" style="display: none" /> <span class="caption">Schema Component Representation</span></div>
+ <div id="type_language-type_scbox" class="contents">
+ <div style="margin-left: 0em"><<span class="scTag">xsd:simpleType</span> <span class="scTag">name</span>="<span class="scContent">language-type</span>"><div style="margin-left: 1.5em"><<span class="scTag">xsd:restriction</span> <span class="scTag">base</span>="<span class="scContent"><span class="type"><a href="#ns_xsd" title="Find out namespace of 'xsd' prefix">xsd</a>:string</span></span>"><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">c</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">c++</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">c#</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">v
alue</span>="<span class="scContent">java</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">javascript</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">perl</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">python</span>"/></div><div style="margin-left: 1.5em"><<span class="scTag">xsd:enumeration</span> <span class="scTag">value</span>="<span class="scContent">vala</span>"/></div></<span class="scTag">xsd:restriction</span>></div></<span class="scTag">xsd:simpleType</span>></div>
+ </div>
+ <script type="text/javascript">
+<!--
+setState('type_language-type_scbox', false);
+// -->
+</script>
+ </div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ <div id="legend">
+ <h2>
+ <a name="Legend" id="Legend">Legend</a>
+ </h2>
+ <div style="float: left; width: 15em;">
+ <h3 style="margin-bottom: 0px;">Complex Type:</h3>
+ <div class="hint" style="margin-left: 0em;">Schema Component Type</div>
+ </div>
+ <div style="float: left; width: 15em;">
+ <h3 style="margin-bottom: 0px;">
+ <span class="name">AusAddress</span>
+ </h3>
+ <div class="hint" style="margin-left: 0em;">Schema Component Name</div>
+ </div>
+ <table class="hierarchy" style="clear : both">
+ <tr>
+ <th>Super-types:</th>
+ <td><span class="type" style="color: #0000FF; text-decoration:underline;">Address</span> < <span class="current">AusAddress</span> (by extension)</td>
+ </tr>
+ <tr>
+ <th>Sub-types:</th>
+ <td>
+ <ul>
+ <li><span class="type" style="color: #0000FF; text-decoration:underline;">QLDAddress</span> (by restriction)</li>
+ </ul>
+ </td>
+ </tr>
+ </table>
+ <div class="hint">If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.</div>
+ <table class="properties">
+ <tr>
+ <th>Name</th>
+ <td>AusAddress</td>
+ </tr>
+ <tr>
+ <th>
+ <a title="Look up 'Abstract' in glossary" href="#term_Abstract">Abstract</a>
+ </th>
+ <td>no</td>
+ </tr>
+ </table>
+ <div class="hint">The table above displays the properties of this schema component.</div>
+ <div class="sample box">
+ <div>
+ <span class="caption">XML Instance Representation</span>
+ </div>
+ <div class="contents"><span style="margin-left: 0em"><...</span><span class="newFields"><span> country="<span class="fixed">Australia</span>"</span></span>> <br /><span style="margin-left: 1.5em" class="inherited"><unitNo> <span class="type">string</span> </unitNo> <span class="occurs">[0..1]</span></span><br /><span style="margin-left: 1.5em" class="inherited"><houseNo> <span class="type">string</span> </houseNo> <span class="occurs">[1]</span></span><br /><span style="margin-left: 1.5em" class="inherited"><street> <span class="type">string</span> </street> <span class="occurs">[1]</span></span><br /><span class="group" style="margin-left: 1.5em">Start <a title="Look up 'Choice' in glossary" href="#term_Choice">Choice</a><span class="occurs">[1]</span></span><br /><span style="margin-left: 3em" class="inherited"><city> <span class="type">string</span> </city> <span class="occurs">[1]</span></span><br /><span styl
e="margin-left: 3em" class="inherited"><town> <span class="type">string</span> </town> <span class="occurs">[1]</span></span><br /><span class="group" style="margin-left: 1.5em">End Choice</span><br /><span class="newFields"><span style="margin-left: 1.5em"><state> <span class="type" style="text-decoration:underline;">AusStates</span> </state> <span class="occurs">[1]</span></span><br /><span style="margin-left: 1.5em"><postcode> <span class="constraint">string <<<em>pattern</em> = [1-9][0-9]{3}>></span> </postcode> <span class="occurs">[1]</span><a href="javascript:void(0)" title="View Documentation" class="documentation" onclick="docArray = new Array('Post code must be a four-digit number.'); viewDocumentation('Element', 'postcode', docArray);">?</a></span><br /></span><span style="margin-left: 0em"></...></span><br /></div>
+ </div>
+ <div class="hint">
+ <p>The XML Instance Representation table above shows the schema component's content as an XML instance.</p>
+ <ul>
+ <li>The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].</li>
+ <li>Model group information are shown in gray, e.g. Start Choice ... End Choice.</li>
+ <li>For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in <span style="font-weight: bold">bold</span>.</li>
+ <li>If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".</li>
+ <li>Otherwise, the type of the element/attribute is displayed.
+ <ul><li>If the element/attribute's type is in the schema, a link is provided to it.</li><li>For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<<em>pattern</em> = [1-9][0-9]{3}>>.</li></ul></li>
+ <li>If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.</li>
+ </ul>
+ </div>
+ <div class="schemaComponent box">
+ <div>
+ <span class="caption">Schema Component Representation</span>
+ </div>
+ <div class="contents">
+ <span style="margin-left: 0em"><<span class="scTag">complexType</span><span class="scTag">name</span>="<span class="scContent">AusAddress</span>"></span>
+ <br />
+ <span style="margin-left: 1.5em"><<span class="scTag">complexContent</span>></span>
+ <br />
+ <span style="margin-left: 3em"><<span class="scTag">extension</span><span class="scTag">base</span>="<span class="scContent"><span class="type" style="text-decoration:underline;">Address</span></span>"></span>
+ <br />
+ <span style="margin-left: 4.5em"><<span class="scTag">sequence</span>></span>
+ <br />
+ <span style="margin-left: 6em"><<span class="scTag">element</span><span class="scTag">name</span>="<span class="scContent">state</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type" style="text-decoration:underline;">AusStates</span></span>"/></span>
+ <br />
+ <span style="margin-left: 6em"><<span class="scTag">element</span><span class="scTag">name</span>="<span class="scContent">postcode</span>"></span>
+ <br />
+ <span style="margin-left: 7.5em"><<span class="scTag">simpleType</span>></span>
+ <br />
+ <span style="margin-left: 9em"><<span class="scTag">restriction</span><span class="scTag">base</span>="<span class="scContent"><span class="type">string</span></span>"></span>
+ <br />
+ <span style="margin-left: 10.5em"><<span class="scTag">pattern</span><span class="scTag">value</span>="<span class="scContent">[1-9][0-9]{3}</span>"/></span>
+ <br />
+ <span style="margin-left: 9em"></<span class="scTag">restriction</span>></span>
+ <br />
+ <span style="margin-left: 7.5em"></<span class="scTag">simpleType</span>></span>
+ <br />
+ <span style="margin-left: 6em"></<span class="scTag">element</span>></span>
+ <br />
+ <span style="margin-left: 4.5em"></<span class="scTag">sequence</span>></span>
+ <br />
+ <span style="margin-left: 4.5em"><<span class="scTag">attribute</span><span class="scTag">name</span>="<span class="scContent">country</span>" <span class="scTag">type</span>="<span class="scContent"><span class="type">string</span></span>" <span class="scTag">fixed</span>="<span class="scContent">Australia</span>"/></span>
+ <br />
+ <span style="margin-left: 3em"></<span class="scTag">extension</span>></span>
+ <br />
+ <span style="margin-left: 1.5em"></<span class="scTag">complexContent</span>></span>
+ <br />
+ <span style="margin-left: 0em"></<span class="scTag">complexType</span>></span>
+ <br />
+ </div>
+ </div>
+ <div class="hint">The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)</div>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ </div>
+ <div id="glossary">
+ <h2>
+ <a name="Glossary" id="Glossary">Glossary</a>
+ </h2>
+ <p><span class="glossaryTerm"><a name="term_Abstract" id="term_Abstract">Abstract</a> </span>(Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.</p>
+ <p><span class="glossaryTerm"><a name="term_All" id="term_All">All Model Group</a> </span>Child elements can be provided <em>in any order</em> in instances. See: <a title="http://www.w3.org/TR/xmlschema-1/#element-all"; href="http://www.w3.org/TR/xmlschema-1/#element-all";>http://www.w3.org/TR/xmlschema-1/#element-all</a>.</p>
+ <p><span class="glossaryTerm"><a name="term_Choice" id="term_Choice">Choice Model Group</a> </span><em>Only one</em> from the list of child elements and model groups can be provided in instances. See: <a title="http://www.w3.org/TR/xmlschema-1/#element-choice"; href="http://www.w3.org/TR/xmlschema-1/#element-choice";>http://www.w3.org/TR/xmlschema-1/#element-choice</a>.</p>
+ <p><span class="glossaryTerm"><a name="term_CollapseWS" id="term_CollapseWS">Collapse Whitespace Policy</a> </span>Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.</p>
+ <p><span class="glossaryTerm"><a name="term_ElemBlock" id="term_ElemBlock">Disallowed Substitutions</a> </span>(Applies to element declarations). If <em>substitution</em> is specified, then <a title="Look up 'substitution group' in glossary" href="#term_SubGroup">substitution group</a> members cannot be used in place of the given element declaration to validate element instances. If <em>derivation methods</em>, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an <code>xsi:type</code> attribute.</p>
+ <p><span class="glossaryTerm"><a name="term_Key" id="term_Key">Key Constraint</a> </span>Like <a title="Look up 'Uniqueness Constraint' in glossary" href="#term_Unique">Uniqueness Constraint</a>, but additionally requires that the specified value(s) must be provided. See: <a title="http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions"; href="http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions";>http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions</a>.</p>
+ <p><span class="glossaryTerm"><a name="term_KeyRef" id="term_KeyRef">Key Reference Constraint</a> </span>Ensures that the specified value(s) must match value(s) from a <a title="Look up 'Key Constraint' in glossary" href="#term_Key">Key Constraint</a> or <a title="Look up 'Uniqueness Constraint' in glossary" href="#term_Unique">Uniqueness Constraint</a>. See: <a title="http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions"; href="http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions";>http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions</a>.</p>
+ <p><span class="glossaryTerm"><a name="term_ModelGroup" id="term_ModelGroup">Model Group</a> </span>Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: <a title="http://www.w3.org/TR/xmlschema-1/#Model_Groups"; href="http://www.w3.org/TR/xmlschema-1/#Model_Groups";>http://www.w3.org/TR/xmlschema-1/#Model_Groups</a>.</p>
+ <p><span class="glossaryTerm"><a name="term_Nillable" id="term_Nillable">Nillable</a> </span>(Applies to element declarations). If an element declaration is nillable, instances can use the <code>xsi:nil</code> attribute. The <code>xsi:nil</code> attribute is the boolean attribute, <em>nil</em>, from the <em>http://www.w3.org/2001/XMLSchema-instance</em> namespace. If an element instance has an <code>xsi:nil</code> attribute set to true, it can be left empty, even though its element declaration may have required content.</p>
+ <p><span class="glossaryTerm"><a name="term_Notation" id="term_Notation">Notation</a> </span>A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: <a title="http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations"; href="http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations";>http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations</a>.</p>
+ <p><span class="glossaryTerm"><a name="term_PreserveWS" id="term_PreserveWS">Preserve Whitespace Policy</a> </span>Preserve whitespaces exactly as they appear in instances.</p>
+ <p><span class="glossaryTerm"><a name="term_TypeFinal" id="term_TypeFinal">Prohibited Derivations</a> </span>(Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.</p>
+ <p><span class="glossaryTerm"><a name="term_TypeBlock" id="term_TypeBlock">Prohibited Substitutions</a> </span>(Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.</p>
+ <p><span class="glossaryTerm"><a name="term_ReplaceWS" id="term_ReplaceWS">Replace Whitespace Policy</a> </span>Replace tab, line feed, and carriage return characters with space character (Unicode character 32).</p>
+ <p><span class="glossaryTerm"><a name="term_Sequence" id="term_Sequence">Sequence Model Group</a> </span>Child elements and model groups must be provided <em>in the specified order</em> in instances. See: <a title="http://www.w3.org/TR/xmlschema-1/#element-sequence"; href="http://www.w3.org/TR/xmlschema-1/#element-sequence";>http://www.w3.org/TR/xmlschema-1/#element-sequence</a>.</p>
+ <p><span class="glossaryTerm"><a name="term_SubGroup" id="term_SubGroup">Substitution Group</a> </span>Elements that are <em>members</em> of a substitution group can be used wherever the <em>head</em> element of the substitution group is referenced.</p>
+ <p><span class="glossaryTerm"><a name="term_ElemFinal" id="term_ElemFinal">Substitution Group Exclusions</a> </span>(Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.</p>
+ <p><span class="glossaryTerm"><a name="term_TargetNS" id="term_TargetNS">Target Namespace</a> </span>The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.</p>
+ <p><span class="glossaryTerm"><a name="term_Unique" id="term_Unique">Uniqueness Constraint</a> </span>Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: <a title="http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions"; href="http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions";>http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions</a>.</p>
+ <div style="text-align: right; clear: both;">
+ <a href="#top">top</a>
+ </div>
+ <hr />
+ </div>
+ <p class="footer">Generated by <a href="http://xml.fiforms.org/xs3p/";>xs3p</a> (<a href="http://titanium.dstc.edu.au/xml/xs3p";>old link</a>)
+ . Last modified: <script type="text/javascript">
+<!--
+document.write(document.lastModified);
+// -->
+</script></p>
+ </body>
+</html>
Modified: trunk/gtk-doc/index.html
==============================================================================
--- trunk/gtk-doc/index.html (original)
+++ trunk/gtk-doc/index.html Mon Oct 20 19:05:17 2008
@@ -76,8 +76,11 @@
<p>The generated HTML documentation can be browsed in an
ordinary web browser or by using the
special <a href="http://developer.imendio.com/projects/devhelp/";>Devhelp
- API browser</a>.
- </p>
+ API browser</a>. Devhelp uses a <a href="devhelp2.xsd.html">special index</a>
+ file to locate and present the manuals.</p>
+ <p>For full details have a look at the
+ <a href="http://library.gnome.org/devel/gtk-doc-manual/stable/";>GTK-Doc user manual</a>.</p>
+
<h2>Examples</h2>
<p>Visit
@@ -86,7 +89,9 @@
there to see the final result of using GTK-Doc. For examples
on how to make use of GTK-Doc in your
project, <a href="http://www.gtk.org/download.html";>download
- GTK+</a> and see how it is added to the source files.</p>
+ GTK+</a> and see how it is added to the source files. GTK-Doc itself
+ has a test suite as well that can be used as examples.
+ </p>
</div> <!-- content -->
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
