TechWriter supports a command line interface that can be used to automate the process of generating documentation.  This command line interface can be integrated with a variety of different build tools such as MSBuild, Ant and NAnt or any other tool that provides a mechanism for calling command line utilities.

Location of Command Line Utility

The command line interface for TechWriter is supported by the following utility located in the TechWriter installation folder:

TechWriter2009Console.exe

Command Line Syntax

The TechWriter2009Console program has the following command line syntax:

TechWriter2009Console projectFile [/build:outputType] [/refresh]

where:

projectFile is your TechWriter project file.

/build:outputType specifies that the output named outputType be generated, otherwise all outputs in the project will be generated.

/refresh will cause TechWriter to reload all of the websites before generating the output.

A non-zero exit code will indicate that the build failed while a zero exit code will indicate that the build was successful.

 

 

---

© 2005-2009 Adivo Ltd. All rights reserved.