DocSetOutputGenerator class reference

OutputGenerator : NSObject
DocSetOutputGenerator.h

Overview

Defines a concrete OutputGenerator which generates documentation set.

The generator depends on XMLOutputGenerator and XHTMLOutputGenerator output. It generates the documentation set source plist, index and nodes XML source files, invokes indexing through the docsetutils command line utility and installs the documentation set to the Xcode documentation window.

Since the DocSetOutputGenerator doesn't generate the actual content files itself, it must be given the locations, names and extensions of the source files. This should be set through the documentationFilesInfoProvider property before generation starts. If the clients forget to set this property, generation will fail immediately.

Tasks

Properties

Documentation set handling

Instance methods

createDocSetSourcePlistFile

Creates the DocSet source plist file.

- (void)createDocSetSourcePlistFile
Exceptions
NSException

Thrown if creating the plist file fails.

Discussion

This file is used when creating the documentation set. The file is only created if it doesn't exist yet. If it exists, this method will exit without doing anything. This allows the user to change the data in the file as he see fit after it was created.

This message is automatically sent from -[OutputGenerator generateSpecificOutput] in the proper order. It is not designed to be sent manually from the clients.

See also
Declared in
DocSetOutputGenerator.h

createDocSetNodesFile

Creates DocSet Nodes.xml file.

- (void)createDocSetNodesFile
Exceptions
NSException

Thrown if creation fails.

Discussion

The Nodes.xml file describes the structure of the documentation set and is used to create a table of contents that users see in the Xcode documentation window. This file is required when compiling the documentation set.

This message is automatically sent from -[OutputGenerator generateSpecificOutput] in the proper order. It is not designed to be sent manually from the clients.

See also
Declared in
DocSetOutputGenerator.h

createDocSetTokesFile

Creates DocSet Tokens.xml file.

- (void)createDocSetTokesFile
Exceptions
NSException

Thrown if creation fails.

Discussion

The Tokens.xml file associate symbol names with locations in the documentation files. This file is used for creating the symbol index for the documentation set.

This message is automatically sent from -[OutputGenerator generateSpecificOutput] in the proper order. It is not designed to be sent manually from the clients.

See also
Declared in
DocSetOutputGenerator.h

createDocSetBundle

Creates DocSet bundle.

- (void)createDocSetBundle
Exceptions
NSException

Thrown if creation fails.

Discussion

This message should be sent after all source files required for documentation set creation have been created. It will copy all html files found at path returned from documentationFilesInfoProvider to the documentation set output directory and will invoke the indexing of the files with the help of nodes and tokes files.

This message is automatically sent from -[OutputGenerator generateSpecificOutput] in the proper order. It is not designed to be sent manually from the clients.

See also
Declared in
DocSetOutputGenerator.h

addDocSetNodeToElement:fromHierarchyData:

Adds a new DocSet node as the child of the given parent element.

- (void)addDocSetNodeToElement:(NSXMLElement *) parent fromHierarchyData:(NSDictionary *) data
Parameters
parent

The Nodes.xml element to which to add new node.

data

The hierarchy object data that describes the node.

Exceptions
NSException

Thrown if adding fails.

Discussion

The given hierarchy data contains the description of the node to add. The added node is either of the type folder if it contains children or it is a leaf otherwise. The methods will recursively add all subnodes as well.

See also
Declared in
DocSetOutputGenerator.h

Properties

documentationFilesInfoProvider

Sets or returns the OutputInfoProvider conformer that provides information about documentation files which should be included in the documentation set.

@property id documentationFilesInfoProvider
Discussion

This value is used to determine the path to the documentation HTML files so that they can be copied to the documentation set.

Clients need to set this before starting output generation. If they fail to provide a valid object, generation immediately fails with an exception.

Declared in
DocSetOutputGenerator.h

outputContentsPath

Returns the temporary documentation set contents path.

@property NSString *outputContentsPath
See also
Declared in
DocSetOutputGenerator.h

outputResourcesPath

Returns the temporary documentation set resources path.

@property NSString *outputResourcesPath
See also
Declared in
DocSetOutputGenerator.h

outputDocumentsPath

Returns the temporary documentation set documents path.

@property NSString *outputDocumentsPath
See also
Declared in
DocSetOutputGenerator.h

© 2008-2009 Tomaz Kragelj. All rights reserved. (Last updated: 2009-08-24)
Back to index / hierarchy.