Previous Topic

Next Topic

Book Contents

Book Index

Command Line Parameters (Windows)

Command:

DocumentComposer -license <filename | license_key> -inputdoc <filename> [options]

Parameters/Options

Parameter/Options

Description

Default value

-license <filename | license_key>

specifies the path and filename for the license file or a license key

required input

-inputdoc <filename>

specifies the path and file name for the document to be transformed

required input

-outputdoc <filename>

specifies the path and file name for the transformed document

<inputdoc directory>/inputdoc filename + "_out" + inputdoc suffix

-outputtype <mathml | images>

specifies whether to write out MathML or image tags

mathml

-alttext <true | false>

specifies whether to include the spoken text of an equation as an alttext attribute of the math tag

false

-altimg <true | false>

specifies whether to include an altimg if MathML is used

true

-overwrite <true | false>

specifies whether an existing altimg or alttext is overwritten

true

-imagefolder <dirpath>

specifies the path to a directory that will contain the image files

<input file directory>/inputdoc filename + "_images"

-imagename <filename>

specifies the base file name for the resulting images (e.g. "abc" might result in "abc1.gif")

inputdoc filename + sequence number + "." + imagetype

-imagetype <gif | eps | png>

specifies the format for the images

gif

-breakwidth <int>

sets the width for line wrapping long equations

6in

-pointsize <double>

specifies the base font point size for the equations

12.0

-dpi <int>

specifies the resolution of the resulting images in dots per inch

96

-bg <CSS color name | transparent | #rrggbb>

specifies the background color for the equations

white

-fg <CSS color name | #rrggbb>

specifies the foreground color for the equations

black

-basefont <fontname>

specifies the font to use as the base font for alpha numeric characters

"Times New Roman"

-fontmetrics <true | false>

specifies whether metrics data should be included in the transformed document

true

-fontconfig <filename>

specifies the path and file name of a file that contains a list of font face names

none

-fontinfo <filename>

specifies the path and file name of a file that provides additional font information

none

-fontencodingsdir <dirpath>

specifies the path to a directory with font encoding files

<fontinfo directory>, if fontinfo is specified

-useantialias <true | false | automatic>

specifies whether to use antialiasing if possible, not to use it, or use it if heuristics thinks it helps

none

-scriptsatsameheight <true | false>

specifies if nested msup/msub etc. may have scripts at same height

false

-logfile <filename>

specifies the path and file name for a log file

none

-verbosity <mute | normal | debug>

specifies what processing messages should be displayed; mute - none; normal - any error messages and whether the image was generated successfully; debug - additional processing information

normal

-readoptions <filename>

specifies the path and file name of an XML file for reading in options values

none

-saveoptions <filename>

specifies the path and file name of an XML file for saving out options values

none

-speechrulesdir <dir>

identifies the location of the rules that specify how an expression is spoken

<version>\auxiliary\SpeechRules

-speechlang <lang>

specifies the ISO 639-1 two-letter code for the language to be spoken (e.g., it for Italian, es for Spanish, zh for Chinese)

en

-speechstyle <style>

specifies a named speech style to use for speaking expressions in a given language

Simple Speech

-tts <ttsname>

specifies the text-to-speech (TTS) engine standard to use for speech controls. This is useful if the text is meant to be spoken by a known voices and results in better quality speech (with pauses, pitch, and pronunciation changes). Legal values are "None", "SAPI4" (older voices), "SAPI5" (newer voices), "SSML" (very new voices)

None

-opdict <filename>

specifies the path and file name of the configurable operator dictionary. See Configuring the Operator Dictionary for more information.

None

Previous Topic

Next Topic

Book Contents

Book Index


[Design Science Home]
Copyright © 1996-2016 Design Science, Inc. All rights reserved.