Frequently Asked Questions (FAQ)

How do I make documentation using the command line application?

·        Setup your solution, take a snapshot from inside the Pragmatic Workbench’s UI, and resolve any issues that may arise (such as invalid permissions, missing files,and server connection errors).  Then arrange the solution items into the layout as desired before creating the documentation request file.

·        To create a snapshot using the command line, ensure that your solution has all of the desired solution items added to the list.

·        Then click the “Create snapshot request file” button at the bottom right and select a location to place the file.  This request file is a simple xml file that contains the solution item references.

·        From the command prompt, you must run the executable “DOCxpress.exe” and specify the request file as well.  Your entire command should appear as:

C:\ProgramFiles(x86)\Pragmatic Works\PragmaticWorkbench 5.0.20>DOCxPress.exe“C:\directoryname\snapshotrequest.xml”

·        After the execution has run, your snapshot should be updated.

·        Once a snapshot of your solution has been created, you may generate documentation.  To do this from the command line, you must first create a Documentation Request file.  Set your layout in the DOC xPress UI, and then click the “Create documentation request file” button at the bottom right.

·        You will be prompted to select a type of output (or multiple types if you prefer)and set the location that the output will be stored.

·        Once you have set the output type and location, click “OK” and select a directory for the documentation request file.

·       Next,as with the snapshot generation, run the “DocxPress.exe” executable from the command prompt and specify the documentation request file.  Your entire command should appear as:

C:\ProgramFiles(x86)\Pragmatic Works\PragmaticWorkbench 5.0.20>DOCxPress.exe“C:\directoryname\documentationrequest.xml”

·        After the execution has run, your documentation will be output into the directory you specified in the step above.

Some of our clients