NAntContrib
Help
Task Reference
<hxreg> |
v0.85-rc1 |
[This is preliminary documentation and subject to change.]
Registers a Microsoft HTML Help 2.0 Collection.
| Attribute | Type | Description | Required |
|---|---|---|---|
| helpfile | file | Help (.HxS) filename. | True |
| alias | string | Alias. | False |
| attrindex | string | Combined attribute index (.HxR) filename. | False |
| collection | string | Collection (.HxC) filename. | False |
| commandfile | string | Filename of a file containing HxReg commands. | False |
| description | string | Description of the namespace. | False |
| index | string | Index (.HxI) filename. | False |
| language | string | Language ID. | False |
| namespace | string | Help collection namespace. | False |
| searchfile | string | Combined full-text search (.HxQ) filename. | False |
| title | string | Title identifier. | False |
| unregister | bool | Unregister a namespace, title, or alias. | False |
| failonerror | bool | Determines if task failure stops the build, or is just reported. The default is true. | False |
| if | bool | If true then the task will be executed; otherwise, skipped. The default is true. | False |
| timeout | int | The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out. | False |
| unless | bool | Opposite of if. If false then the task will be executed; otherwise, skipped. The default is false. |
False |
| verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False |
| Attribute | Type | Description | Required |
|---|---|---|---|
| exename | string | The name of the executable that should be used to launch the external program. | False |
| useruntimeengine | bool | Specifies whether the external program should be executed using a runtime engine, if configured. The default is false. | False |
Contains a collection of Argument elements.
Register a help namespace.
<hxreg namespace="MyProduct.MyHelp" title="MyProductHelp" collection="MyHelp.HxC" helpfile="MyHelp.HxS" />