Retired Document
Important: This document may not represent best practices for current development. Links to downloads and other resources may no longer be valid.
Documentation-Set Nodes Schema Reference
This chapter describes the element structure of the Nodes.xml
(nodes) file used in documentation sets.
The schema for the nodes file, NodesSchema.rng
, is located in the DocSetAccess framework in <Xcode>/Library/PrivateFrameworks/DocSetAccess.framework
.
Listing C-1 lists the topology of the elements of a nodes file.
Listing C-1 Nodes.xml element topology
DocSetNodes |
TOC |
Node |
Name |
URL |
Path |
File |
Anchor |
Subnodes |
Node |
NodeRef |
NodeRef |
Subnodes |
Library |
Node |
DocSetNodes
Root element of the nodes file.
DocSetNodes [version] |
TOC |
Library |
Attributes
Name | Type | Description |
---|---|---|
| Decimal | The version number of the |
Subelements
TOC
Defines the document hierarchy.
TOC [] |
Node|NodeRef |
Attributes
None.
Subelements
Cardinality | Element | Usage |
---|---|---|
| Although this element must contain a The documentation set name is displayed in the Home pop-up menu in the Documentation window. |
Node
Represents a single node in the document hierarchy.
Node [ id,type,isPrimaryTOCNode,noindex] |
Name |
URL |
Path |
File |
Anchor |
Subnodes |
A node represents a file or a group of files within the documentation set. A node is associated with a location in the HTML files, specified by a combination of its URL
, Path
, File
and Anchor
subelements.
See Specifying Subnodes for usage details.
Attributes
Name | Type | Description |
---|---|---|
| Integer | Optional. This unique—within the documentation set—identifier allows the node to be referenced elsewhere in the |
| String | Optional. Specifies the node type. Values: |
| Boolean | Optional. Indicates whether the node represents the primary TOC location of the document the node represents. This is relevant only if this node appears in the node hierarchy multiple times. Default: |
| Boolean | Optional. Species whether the node is excluded from the documentation set’s indexes and from any searches. Default: |
Subelements
Cardinality | Element | Usage |
---|---|---|
| Specifies the node’s name, which appears in the Documentation window. | |
| Specifies the location of the files the node represents. | |
| Specifies the location of the files the node represents. | |
| Specifies the name of the file the node represents. | |
| Specifies a scroll-to location within the node’s landing page. | |
| Defines a group of subnodes. |
Name
Specifies a name.
Name [] {string} |
Attributes
None.
Content
String.
Subnodes
Defines a list of nodes.
Subnodes [] |
Node,NodeRef |
Attributes
None.
Subelements
NodeRef
Refers to a node defined elsewhere in the nodes file.
NodeRef [refid, isPrimaryTOCNode] |
Subnodes |
You can also use this element in tokens files to associate a symbol with a documentation node. This is useful when a Node
element describing the symbol’s reference documentation already exists.
When it appears within a Subnodes
or TOC
element, a NodeRef
is treated as if the Node
element it references was itself listed there. This allows a document to be listed multiple times in the document hierarchy of the documentation set.
Attributes
Name | Type | Description |
---|---|---|
| Integer | Specifies the |
| Boolean | Optional. Indicates whether the node represents the primary TOC location of the document the node represents. Default: |
Subelements
Cardinality | Element | Usage |
---|---|---|
| Defines a group of subnodes. These subnodes are used only when the node identified by the |
URL
Specifies the base location of the node’s documentation as a URL.
URL [] {URL} |
When used alone, the URL
element is interpreted as the full path to the file to load when the user selects the node. See Specifying the Location of a Documentation Node for details about using this element with other Node
subelements.
Attributes
None.
Content
URL.
Path
Specifies the path to the file or directory associated with a node.
Path [] {filepath} |
The Path element can specify:
The relative path to the node’s landing page.
A subpath to the directory containing the node’s landing page.
See Specifying the Location of a Documentation Node for details about using this element with other Node
subelements.
Attributes
None.
Content
Filepath.
File
Specifies a filename.
File [] {normalizedString} |
See Specifying the Location of a Documentation Node for details about using this element with other Node
subelements.
Attributes
None.
Content
Normalized string.
Anchor
Identifies a scroll-to-here location within a node's landing page.
Anchor [] {normalizedString} |
See Specifying the Location of a Documentation Node for details about using this element with other Node
subelements.
Attributes
None.
Content
Normalized string.
Library
Defines a library of nodes.
Library [] |
Node |
See Creating a Library of Node Definitions for usage details.
Attributes
None.
Subelements
Cardinality | Element |
---|---|
|
Copyright © 2009 Apple Inc. All Rights Reserved. Terms of Use | Privacy Policy | Updated: 2009-05-05