Options - General - Custom Document Wizards

Use the Custom Document Wizards page to specify information about a document wizard that you define. After you define a custom document wizard here, Stylus Studio adds an entry for your wizard to its Document Wizards dialog box. You can select your document wizard from the Stylus Studio menu bar. Select File > Document Wizards and then your wizard.

To display the Options dialog box, select Tools > Options from the Stylus Studio menu bar.

Fields

Document type

From the drop-down menu, select the type of document that will be imported by Stylus Studio. This is the output of your document wizard and it can be any of the types listed in the Stylus Studio File > New menu. Required.

The value you specify here determines the Document Wizards tab on which the icon for your application appears and the editor Stylus Studio uses to open the output file.

Icon bitmap

Specify the path for the file that contains the bitmap to be used as the icon in the Document Wizards dialog box. If you do not specify a location, Stylus Studio displays a default bitmap for your wizard. Click to browse for the file you want to specify or to insert the ${StylusDir} macro. This macro indicates that the path you specify is relative to the Stylus Studio installation directory.

Command

Specify a command line template that Stylus Studio can use to generate the command that starts your application. This should be the same as the command that starts your application except that it has variables in place of actual arguments.

Click to display a menu that provides shortcuts that help you specify the command line. From this menu you can

It is often easier to define arguments and then specify the command line.

The variables must be in the form ${name}. For example:

The variables can appear anywhere in the command. There must be a one-to-one correspondence between these variables and the list of arguments that you specify for the executable when you click Arguments.

This property is required. You must at least specify ${OutputFile} even if the command line has no arguments. Stylus Studio generates the value for the ${OutputFile} argument, which is the name of the file that is opened in Stylus Studio.

For example:

This starts the specified Java class with a command line that includes the QuoteChar, InputFile, and then OutputFile arguments. To specify properties for the QuoteChar and InputFile arguments, click Arguments.

Initial directory

Specify the directory that you want Stylus Studio to set as the current directory when starting your application. Click to browse for the file you want to specify or to insert the ${StylusDir} macro. This macro indicates that the path you specify is relative to the Stylus Studio installation directory.

Path

Define any paths required to execute your application. You do not need to specify paths that are already in your PATH environment variable. If you specify more than one path, separate them with semicolons. Click to display a menu that provides shortcuts that help you specify the PATH field. From this menu you can

Trace execution

Boolean value that indicates whether you want Stylus Studio to display tracing information about the selection and execution of the document wizard in the Output Window. This is meant to be used during the development of the custom document wizard and not during normal use of the wizard. This is an optional property. By default, it is false.

Buttons

Arguments

Specify any arguments required by your document wizard.

Define a new custom document wizard. Stylus Studio displays a field for the new wizard's name. Specify the text that you want to appear below the custom document wizard's icon in Stylus Studio's Document Wizards dialog box. For example, Proprietary to XML.

Delete the selected custom document wizard.

Move the selected custom document wizard one place up in the list of custom document wizards. The order of the wizards here determines the order of the selections in the Stylus Studio Document Wizards dialog box.

Move the selected custom document wizard one place down in the list of custom tools.

Displays a pop-up list of alternatives that help you specify the corresponding field.

For More Information