Documentation Settings
Documentation Settings
Documentation Settings provide the following options:
The DocSetName option value is used to provide a filtering mechanism in Microsoft® H2 and SandCastle help documentation. The following tag is automatically generated by spy.doc:
<MSHelp:Attr Name="DocSet" Value="spy.doc" />,
and placed in the HTML XML (within the
<xml>...</xml>) tag. The value of 'Value' is specified by this option.
The default value is spy.doc, but the field can contain any valid, non-empty string value.
The OutputFolderPath Option specifies the folder in which the documentation intermediate, temporary and output files are placed as they are generated. The folder is always displayed as an absolute filepath, but spy.doc always attempts to save the file path relative to the project file path. The folder can be browsed and selected by clicking on the button at the right end of the option text field (labeled with an ellipsis '...').
The OutputFolderPath should refer to a local computer or UNC filepath, that has both read and write access rights for the executing user.
The SchemafilePath Option specifies the schema file path of the XML-schema to
document. This is also referred to as the target-schema, if it contains xs:import
or xs:include constructs that import or include, respectively, other schemas.
The file is always displayed as an absolute filepath, but spy.doc always
attempts to save the file path relative to the project file path. The file path can
be browsed and selected by clicking on the button at the right end of the option
text field (labeled with an ellipsis '...').
The SchemaFolderPath should refer to a local computer or UNC filepath, that has read access rights for the executing user.