OutputInfoProvider protocol reference

OutputInfoProvider.h

Overview

The OutputInfoProvider protocol defines methods that objects which need to provide information about their output must implement.

The main argument for this interface is to decouple concrete OutputGenerator classes from their dependent output generators. For example documentation set generator needs to know the names and extensions used by the XHTML output generator. However to allow arbitrary HTML output generator to be used with documentation set, the documentation set output generator needs any object that conforms to OutputInfoProvider so that it can get all required information it needs.

Tasks

Output information providing

Instance methods

outputObjectFilenameForObject:

Returns the given object file name.

- (NSString *)outputObjectFilenameForObject:(NSDictionary *) objectData
Parameters
objectData

The NSDictionary from main database representing the object data.

Return value

Returns the given object file name, including relative path from the base directory and extension.

See also
Declared in
OutputInfoProvider.h

outputIndexFilename

Returns the index file name.

- (NSString *)outputIndexFilename
Return value

Returns the index file name, including relative path from the base directory and extension.

See also
Declared in
OutputInfoProvider.h

outputHierarchyFilename

Returns the hierarchy file name.

- (NSString *)outputHierarchyFilename
Return value

Returns the hierarchy file name, including relative path from the base directory and extension.

See also
Declared in
OutputInfoProvider.h

outputFilesExtension

Returns the output files extension.

- (NSString *)outputFilesExtension
Return value

Returns the output files extension.

Discussion

Output file extension is added to all generated output files.

See also
Declared in
OutputInfoProvider.h

outputReferencesExtension

Returns the output references extension.

- (NSString *)outputReferencesExtension
Return value

Returns the references files extension.

Discussion

References extension is used while generating the references inside output files. In] most cases this should be the same as - outputFilesExtension.

See also
Declared in
OutputInfoProvider.h

outputBasePath

Returns the base path where output files are generated.

- (NSString *)outputBasePath
Return value

Returns the base path where output files are generated.

Discussion

This is full path to the base directory under which all files are generated.

See also
Declared in
OutputInfoProvider.h

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