1
Copyright © 2006 Nuance Communications, Inc. All rights reserved.
Note: For the latest System Administration information, see
http://support.nuance.com/downloads/
Dragon NaturallySpeaking
Version 9
System Administration Guide
2
Contents
Dragon NaturallySpeaking System Administration Guide ...........................................................10
Overview ........................................................................................................................................ 10
Installation and Upgrade .......................................................................................................11
Recommended System Requirements for Dragon NaturallySpeaking ...................................................... 11
Coexistence with Dragon NaturallySpeaking SDK Client Edition.............................................................. 11
Upgrading from a previous version..................................................................................................... 12
Dragon NaturallySpeaking Installation................................................................................................12
Modifying settings for all users .......................................................................................................... 14
MSI Installation Options....................................................................................................................14
Windows Installer (MSI) options ........................................................................................................ 15
MSI options specific to NaturallySpeaking ...........................................................................................16
InstallShield (setup.exe) options........................................................................................................23
Sample Command line...................................................................................................................... 24
Using the User Upgrade Wizard to upgrade multiple users..................................................................... 25
Upgrading Users with Custom Vocabularies......................................................................................... 28
Version 9 File Structure .................................................................................................................... 29
Cleaning up after uninstalling Dragon NaturallySpeaking....................................................................... 30
Command line interface....................................................................................................................31
Setting up Roaming Users .....................................................................................................32
About the Roaming User feature ........................................................................................................ 32
Setting up the Roaming User feature..................................................................................................33
Roaming User Network Location......................................................................................................... 37
Internet Roaming User Guidelines......................................................................................................38
Creating a Roaming User .................................................................................................................. 40
Using multiple dictation sources with a single user ............................................................................... 42
Running the Acoustic and Language Model Optimizer for Roaming Users.................................................43
Dragon NaturallySpeaking Data Distribution Tool .....................................................................43
Overview ........................................................................................................................................ 43
Using the Data Distribution Tool ........................................................................................................ 44
Data Distribution Tool : Add and removing custom words ..................................................................... 45
Data Distribution Tool : Adding and removing vocabularies ................................................................... 46
Data Distribution Tool: Adding and removing custom commands ...........................................................47
Nsadmin command line..................................................................................................................... 48
Using nsadmin................................................................................................................................. 49
nsadmin: Adding custom words ......................................................................................................... 50
nsadmin: Adding and Deleting Custom Vocabularies............................................................................. 51
nsadmin: Adding Custom Commands .................................................................................................53
Vocabulary Tool ...................................................................................................................54
Dragon Vocabulary Tool (Voctool)......................................................................................................54
Dragon Vocabulary Tool: Overview..................................................................................................... 54
Dragon Vocabulary Tool: Choosing Documents .................................................................................... 55
Dragon Vocabulary Tool: Choosing Word Lists .....................................................................................56
Dragon Vocabulary Tool: Analyzing Settings........................................................................................57
Dragon Vocabulary Tool: Analyzing Files............................................................................................. 58
Dragon Vocabulary Tool: Previewing New Words.................................................................................. 58
Dragon Vocabulary Tool: Training Added Words................................................................................... 59
Dragon Vocabulary Tool: Language Model Building............................................................................... 60
Dragon Vocabulary Tool: Summary Screen ......................................................................................... 61
Using Dragon NaturallySpeaking with Citrix.............................................................................62
Using Dragon NaturallySpeaking in a Citrix environment (overview)....................................................... 62
Installing and publishing Dragon NaturallySpeaking on the Citrix server .................................................62
Creating Policies for Dragon NaturallySpeaking on the Citrix server........................................................ 64
Making Published Applications Work together ......................................................................................65
3
Setting Up the Program Neighborhood on Citrix clients ......................................................................... 66
Starting Dragon NaturallySpeaking from a Citrix client ......................................................................... 67
The Convert XML to DAT tool.................................................................................................69
Using the Convert XML to DAT tool..................................................................................................... 69
Advanced Scripting Commands..............................................................................................70
The MyCommands Editor: Advanced Scripting dialog box...................................................................... 70
Using ActiveX Components................................................................................................................ 72
The Script editing window.................................................................................................................73
The Advanced Scripting menu ...........................................................................................................74
The Advanced Scripting Editor toolbar ................................................................................................ 75
The Immediate window.....................................................................................................................76
The Watch window........................................................................................................................... 77
The Stack window............................................................................................................................ 79
Object and Proc lists......................................................................................................................... 80
The Break bar.................................................................................................................................. 80
The Edit area................................................................................................................................... 81
The Status bar................................................................................................................................. 82
The Object Browser.......................................................................................................................... 82
The References dialog box ................................................................................................................ 83
The UserDialog Editor dialog box........................................................................................................ 84
Advanced Scripting Basic Language.................................................................................................... 86
Objects Overview.............................................................................................................................86
Operators ....................................................................................................................................... 87
All Functions by Groups .................................................................................................................... 88
Assignment Group............................................................................................................................ 89
Constant Group ............................................................................................................................... 90
Conversion Group ............................................................................................................................ 90
Data Type Group ............................................................................................................................. 90
DDE Group...................................................................................................................................... 90
Declaration Group............................................................................................................................90
Dialog Function Group ...................................................................................................................... 90
Error Handling Group........................................................................................................................ 90
File Group.......................................................................................................................................91
Flow Control Group .......................................................................................................................... 91
Math Group.....................................................................................................................................91
Miscellaneous Group......................................................................................................................... 91
Object Group................................................................................................................................... 91
Operator Group ...............................................................................................................................91
Settings Group ................................................................................................................................ 91
String Group ................................................................................................................................... 92
Time/Date Group.............................................................................................................................92
User Dialog Group............................................................................................................................92
User Input Group............................................................................................................................. 92
Variable Info Group.......................................................................................................................... 92
Class Module...................................................................................................................................92
Code Module ................................................................................................................................... 94
Object Module .................................................................................................................................94
Any Data Type.................................................................................................................................95
Boolean Data Type........................................................................................................................... 95
Byte Data Type................................................................................................................................ 96
Currency Data Type .........................................................................................................................96
Date Data Type ...............................................................................................................................96
Decimal Data Type...........................................................................................................................96
Double Data Type ............................................................................................................................ 97
Integer Data Type............................................................................................................................ 97
Long Data Type ............................................................................................................................... 97
Object Data Type............................................................................................................................. 97
PortInt Data Type ............................................................................................................................ 98
Single Data Type ............................................................................................................................. 98
4
String Data Type..............................................................................................................................98
String*n Data Type .......................................................................................................................... 99
UserDialog Data Type....................................................................................................................... 99
Variant Data Type............................................................................................................................ 99
Usertype definition........................................................................................................................... 99
Empty Keyword ...............................................................................................................................99
False Keyword............................................................................................................................... 100
Nothing Keyword ........................................................................................................................... 100
Null Keyword................................................................................................................................. 100
True Keyword................................................................................................................................ 101
Win16 Keyword ............................................................................................................................. 101
Win32 Keyword ............................................................................................................................. 101
Friend Keyword ............................................................................................................................. 101
Main Sub ...................................................................................................................................... 102
Object_Initialize Sub ...................................................................................................................... 102
Object_Terminate Sub.................................................................................................................... 102
Set Instruction .............................................................................................................................. 103
Private Keyword ............................................................................................................................ 103
Public Keyword.............................................................................................................................. 104
AboutWinWrapBasic Instruction....................................................................................................... 104
Abs Function ................................................................................................................................. 104
AppActivate Instruction .................................................................................................................. 105
arglist definition............................................................................................................................. 105
Array Function............................................................................................................................... 106
Array variable definition.................................................................................................................. 106
As [New] type definition ................................................................................................................. 106
Asc Function.................................................................................................................................. 106
As type definition........................................................................................................................... 107
Atn Function.................................................................................................................................. 107
Attribute definition......................................................................................................................... 108
Attribute Definition/Statement......................................................................................................... 108
Beep Instruction ............................................................................................................................ 109
Begin Dialog Definition ................................................................................................................... 109
Big-endian definition ...................................................................................................................... 110
Call Instruction.............................................................................................................................. 111
CallByName Instruction .................................................................................................................. 111
CallersLine Function ....................................................................................................................... 112
CancelButton Dialog Item Definition................................................................................................. 112
CBool Function .............................................................................................................................. 113
CByte Function .............................................................................................................................. 114
CCur Function................................................................................................................................ 114
CDate Function.............................................................................................................................. 114
CDbl Function................................................................................................................................ 115
CDec Function ............................................................................................................................... 115
charlist definition ........................................................................................................................... 116
ChDir Instruction ........................................................................................................................... 116
ChDrive Instruction........................................................................................................................ 117
CheckBox Dialog Item Definition...................................................................................................... 117
Choose Function ............................................................................................................................ 118
Chr$ Function................................................................................................................................ 119
Chr$ Function................................................................................................................................ 119
Chr$ Function................................................................................................................................ 120
CInt Function ................................................................................................................................ 120
Class_Initialize Sub........................................................................................................................ 121
Class_Terminate Sub...................................................................................................................... 121
Class Module................................................................................................................................. 121
Clipboard Instruction/Function......................................................................................................... 123
CLng Function ............................................................................................................................... 123
Close Instruction............................................................................................................................ 124
5
ComboBox Dialog Item Definition..................................................................................................... 124
Command$ Function ...................................................................................................................... 125
condexpr definition ........................................................................................................................ 126
Const Definition............................................................................................................................. 126
Cos Function ................................................................................................................................. 126
CreateObject Function .................................................................................................................... 127
CSng Function ............................................................................................................................... 127
CStr Function ................................................................................................................................ 128
CurDir$ Function............................................................................................................................ 128
CVar Function................................................................................................................................ 129
CVErr Function .............................................................................................................................. 129
Date Function................................................................................................................................ 130
DateAdd Function .......................................................................................................................... 130
DateDiff Function........................................................................................................................... 131
dateexpr definition......................................................................................................................... 132
DatePart Function .......................................................................................................................... 132
DateSerial Function........................................................................................................................ 132
DateValue Function........................................................................................................................ 133
Day Function................................................................................................................................. 133
DDEExecute Instruction.................................................................................................................. 134
DDEInitiate Function ...................................................................................................................... 135
DDEPoke Instruction ...................................................................................................................... 135
DDERequest$ Function ................................................................................................................... 136
DDETerminate Instruction............................................................................................................... 136
DDETerminateAll Instruction ........................................................................................................... 137
Debug Object ................................................................................................................................ 137
Declare Definition .......................................................................................................................... 138
Def Definition ................................................................................................................................ 139
DeleteSetting Instruction ................................................................................................................ 140
dialogfunc definition....................................................................................................................... 141
DialogFunc Prototype...................................................................................................................... 141
Dialog Instruction/Function ............................................................................................................. 142
Dim definition................................................................................................................................ 143
Dim Definition ............................................................................................................................... 143
Dir$ Function................................................................................................................................. 144
DlgControlId Function..................................................................................................................... 145
DlgCount Function.......................................................................................................................... 146
DlgEnd Instruction ......................................................................................................................... 146
DlgEnable Instruction/Function........................................................................................................ 147
DlgFocus Instruction/Function ......................................................................................................... 148
DlgListBoxArray Instruction/Function................................................................................................ 149
DlgName Function.......................................................................................................................... 150
DlgNumber Function....................................................................................................................... 151
DlgSetPicture Instruction ................................................................................................................ 152
DlgText Instruction/Function ........................................................................................................... 153
DlgType Function........................................................................................................................... 154
DlgValue Instruction/Function.......................................................................................................... 154
dlgvar definition............................................................................................................................. 156
DlgVisible Instruction/Function ........................................................................................................ 156
Do Statement................................................................................................................................ 157
DoEvents Instruction...................................................................................................................... 158
DropListBox Dialog Item Definition................................................................................................... 158
End Instruction.............................................................................................................................. 159
Enum Definition............................................................................................................................. 160
Environ Instruction/Function ........................................................................................................... 160
EOF Function................................................................................................................................. 161
Erase Instruction ........................................................................................................................... 161
Err Object ..................................................................................................................................... 162
Error Instruction/Function............................................................................................................... 163
6
Eval Function................................................................................................................................. 164
Exit Instruction.............................................................................................................................. 164
Exp Function ................................................................................................................................. 165
Expr definition............................................................................................................................... 166
Field definition............................................................................................................................... 166
FileAttr Function ............................................................................................................................ 166
FileCopy Instruction ....................................................................................................................... 167
FileDateTime Function .................................................................................................................... 167
FileLen Function............................................................................................................................. 168
Fix Function .................................................................................................................................. 168
For Statement ............................................................................................................................... 169
For Each Statement........................................................................................................................ 169
Format$ Function........................................................................................................................... 170
FreeFile Function............................................................................................................................ 171
Friend Keyword ............................................................................................................................. 171
Function Definition......................................................................................................................... 171
Get Instruction .............................................................................................................................. 172
GetAllSettings Function................................................................................................................... 173
GetAttr Function ............................................................................................................................ 174
GetFilePath$ Function..................................................................................................................... 174
GetObject Function ........................................................................................................................ 175
GetSetting Function........................................................................................................................ 175
Goto Instruction ............................................................................................................................ 176
GroupBox Dialog Item Definition...................................................................................................... 176
Hex$ Function ............................................................................................................................... 177
Hour Function................................................................................................................................ 178
If Statement.................................................................................................................................. 178
IIf Function ................................................................................................................................... 179
Input Instruction............................................................................................................................ 180
Input$ Function ............................................................................................................................. 180
InputBox$ Function........................................................................................................................ 181
InStr Function ............................................................................................................................... 181
InStr Function ............................................................................................................................... 182
InStrRev Function.......................................................................................................................... 182
Instruction definition ...................................................................................................................... 183
Int Function .................................................................................................................................. 183
Is Operator ................................................................................................................................... 184
IsArray Function ............................................................................................................................ 184
IsDate Function ............................................................................................................................. 185
IsEmpty Function........................................................................................................................... 185
IsError Function............................................................................................................................. 186
IsMissing Function.......................................................................................................................... 186
IsNumeric Function ........................................................................................................................ 187
IsNull Function .............................................................................................................................. 188
IsObject Function........................................................................................................................... 188
KeyName Function ......................................................................................................................... 189
Kill Instruction............................................................................................................................... 189
Label definition.............................................................................................................................. 190
LBound Function............................................................................................................................ 190
LCase$ Function ............................................................................................................................ 191
Left$ Function ............................................................................................................................... 191
Left$ Function ............................................................................................................................... 192
Len Function ................................................................................................................................. 192
Len Function ................................................................................................................................. 193
Let Instruction............................................................................................................................... 193
Like Operator ................................................................................................................................ 194
Line Input Instruction..................................................................................................................... 194
Line Input Instruction..................................................................................................................... 195
ListBox Dialog Item Definition ......................................................................................................... 195
7
Little-endian definition.................................................................................................................... 196
Loc Function.................................................................................................................................. 197
Lock Instruction............................................................................................................................. 197
LOF Function ................................................................................................................................. 198
Log Function ................................................................................................................................. 198
LSet Instruction............................................................................................................................. 199
LTrim$ Function............................................................................................................................. 200
Macro definition............................................................................................................................. 200
MacroDir$ Function ........................................................................................................................ 200
MacroRun Instruction ..................................................................................................................... 201
MacroRunThis Instruction................................................................................................................ 201
Me Object ..................................................................................................................................... 202
Method definition........................................................................................................................... 202
Mid$ Function/Assignment .............................................................................................................. 202
Mid$ Function/Assignment .............................................................................................................. 203
Minute Function............................................................................................................................. 204
MkDir Instruction........................................................................................................................... 205
Module definition ........................................................................................................................... 205
Month Function.............................................................................................................................. 205
MonthName Function...................................................................................................................... 206
MsgBox Instruction/Function ........................................................................................................... 206
MultiListBox Dialog Item Definition................................................................................................... 208
Name definition ............................................................................................................................. 209
Name Instruction........................................................................................................................... 209
Now Function ................................................................................................................................ 209
Num definition............................................................................................................................... 210
Numvar definition .......................................................................................................................... 210
Objexpr definition .......................................................................................................................... 210
Objtype definition .......................................................................................................................... 210
Objvar definition............................................................................................................................ 210
Oct$ Function................................................................................................................................ 211
OKButton Dialog Item Definition ...................................................................................................... 211
On Error Instruction ....................................................................................................................... 212
Open Instruction............................................................................................................................ 213
Option Definition............................................................................................................................ 213
OptionButton Dialog Item Definition................................................................................................. 214
OptionGroup Dialog Item Definition.................................................................................................. 215
Param definition ............................................................................................................................ 216
Picture Dialog Item Definition.......................................................................................................... 216
Precedence definition ..................................................................................................................... 217
Print Instruction............................................................................................................................. 217
Private Definition ........................................................................................................................... 218
Procedure definition ....................................................................................................................... 219
Property definition ......................................................................................................................... 219
Property Definition......................................................................................................................... 219
Public Definition............................................................................................................................. 220
PushButton Dialog Item Definition.................................................................................................... 221
Put Instruction............................................................................................................................... 221
QBColor Function ........................................................................................................................... 222
Randomize Instruction.................................................................................................................... 223
ReDim Instruction.......................................................................................................................... 223
Reference Comment....................................................................................................................... 224
Rem Instruction............................................................................................................................. 225
Replace$ Function.......................................................................................................................... 225
Reset Instruction ........................................................................................................................... 226
Resume Instruction........................................................................................................................ 226
RGB Function ................................................................................................................................ 227
Right$ Function ............................................................................................................................. 227
Right$ Function ............................................................................................................................. 228
8
RmDir Instruction .......................................................................................................................... 228
Rnd Function................................................................................................................................. 229
Round Function.............................................................................................................................. 229
RSet Instruction............................................................................................................................. 230
RTrim$ Function ............................................................................................................................ 230
SaveSetting Instruction .................................................................................................................. 231
Second Function ............................................................................................................................ 231
Seek Function................................................................................................................................ 232
Seek Instruction ............................................................................................................................ 232
Select Case Statement ................................................................................................................... 233
Select Case Statement ................................................................................................................... 234
SendKeys Instruction ..................................................................................................................... 235
Set Instruction .............................................................................................................................. 237
SetAttr Instruction ......................................................................................................................... 237
Sgn Function................................................................................................................................. 238
Shell Function................................................................................................................................ 238
ShowPopupMenu Function............................................................................................................... 239
Sin Function.................................................................................................................................. 240
Space$ Function ............................................................................................................................ 240
Sqr Function.................................................................................................................................. 241
Statement definition....................................................................................................................... 241
Static Definition............................................................................................................................. 241
Stop Instruction............................................................................................................................. 242
Str definition ................................................................................................................................. 242
Str$ Function ................................................................................................................................ 243
Strarray definition.......................................................................................................................... 243
StrConv$ Function ......................................................................................................................... 243
String$ Function ............................................................................................................................ 244
StrReverse$ Function ..................................................................................................................... 245
Strvar definition............................................................................................................................. 245
Sub Definition................................................................................................................................ 245
Tan Function ................................................................................................................................. 246
Text Dialog Item Definition ............................................................................................................. 246
TextBox Dialog Item Definition ........................................................................................................ 247
Text Dialog Item Definition ............................................................................................................. 248
Time Function................................................................................................................................ 249
Timer Function .............................................................................................................................. 249
TimeSerial Function........................................................................................................................ 250
TimeValue Function........................................................................................................................ 250
Trim$ Function .............................................................................................................................. 251
Type definition............................................................................................................................... 251
Type Definition .............................................................................................................................. 252
TypeName Function........................................................................................................................ 252
UBound Function............................................................................................................................ 253
UCase$ Function............................................................................................................................ 254
Unlock Instruction.......................................................................................................................... 254
Userenum definition ....................................................................................................................... 255
Usertypevar definition .................................................................................................................... 255
Uses Comment .............................................................................................................................. 256
Val Function.................................................................................................................................. 256
Var definition................................................................................................................................. 257
Variantvar definition....................................................................................................................... 257
VarType Function........................................................................................................................... 257
Wait Instruction............................................................................................................................. 258
Weekday Function.......................................................................................................................... 259
WeekdayName Function.................................................................................................................. 259
While Statement............................................................................................................................ 260
With Statement ............................................................................................................................. 260
WithEvents Definition ..................................................................................................................... 261
9
Write Instruction............................................................................................................................ 261
Year Function ................................................................................................................................ 262
Objects Overview........................................................................................................................... 262
Format Predefined Date.................................................................................................................. 263
Format Predefined Number ............................................................................................................. 263
Format User Defined Date............................................................................................................... 264
Format User Defined Number .......................................................................................................... 265
Format User Defined Text ............................................................................................................... 266
Error List ...................................................................................................................................... 266
Dragon NaturallySpeaking scripting language extensions quick reference.............................................. 268
Guidelines for writing scripts ........................................................................................................... 269
List Variables................................................................................................................................. 269
ActiveControlPick........................................................................................................................... 270
ActiveMenuPick.............................................................................................................................. 271
AppBringUp................................................................................................................................... 272
AppSwapWith................................................................................................................................ 273
Beep ............................................................................................................................................ 274
ButtonClick ................................................................................................................................... 274
ClearDesktop................................................................................................................................. 275
ControlPick.................................................................................................................................... 275
DdeExecute................................................................................................................................... 276
DdePoke....................................................................................................................................... 276
DllCall .......................................................................................................................................... 277
DragToPoint .................................................................................................................................. 278
GetState....................................................................................................................................... 279
GoToSleep .................................................................................................................................... 279
HeardWord.................................................................................................................................... 279
HTMLHelp ..................................................................................................................................... 280
MenuCancel................................................................................................................................... 282
MenuPick ...................................................................................................................................... 282
MouseGrid..................................................................................................................................... 282
MsgBoxConfirm ............................................................................................................................. 283
MyCommandsActiveState................................................................................................................ 284
PlaySound..................................................................................................................................... 285
PromptValue Function..................................................................................................................... 285
RememberPoint ............................................................................................................................. 286
RunScriptFile................................................................................................................................. 287
SendDragonKeys ........................................................................................................................... 287
SendSystemKeys ........................................................................................................................... 288
SetMicrophone............................................................................................................................... 289
SetMousePosition........................................................................................................................... 289
SetNaturalText .............................................................................................................................. 290
SetState ....................................................................................................................................... 291
ShellExecute ................................................................................................................................. 291
TTSPlayString................................................................................................................................ 292
Wait............................................................................................................................................. 293
WaitForWindow.............................................................................................................................. 293
WakeUp........................................................................................................................................ 294
WinHelp........................................................................................................................................ 295
Key names for SendDragonKeys ...................................................................................................... 295
Windows shortcut keys................................................................................................................... 297
Error messages for scripts............................................................................................................... 297
Structured Commands ........................................................................................................298
About Structured Commands........................................................................................................... 298
Structured Commands Samples....................................................................................................... 298
Importing Structured Commands..................................................................................................... 300
10
Dragon NaturallySpeaking System Administration Guide
Overview
Note: For the latest S
y
stem Administration information,
see
http://support.nuance.com/downloads/
The Dragon NaturallySpeaking System Administration Guide contains the following information:
• Installation and upgrade
o System Requirements
o Coexistence with Dragon NaturallySpeaking SDK Client Edition
o Upgrading from a previous version
o Dragon NaturallySpeaking Installation
o Modifying settings for all users
o MSI Installation Options
o Using the User Upgrade Wizard to upgrade multiple users
o Upgrading Users with Custom Vocabularies
o Version 9 File Structure
o Cleaning up after uninstalling Dragon NaturallySpeaking
o Command line interface
• Setting up Roaming Users
o About the Roaming User feature
o Setting up the Roaming User feature
o Roaming User Network Location
o Internet Roaming User Guidelines
o Creating a Roaming User
o Using multiple dictation sources with a single user
o Running the Acoustic and Language Model Optimizer for Roaming Users
• Using the Dragon NaturallySpeaking Data Distribution Tool
• Using the Nsadmin Wizard
• Using the Vocabulary Tool
11
• Using Dragon NaturallySpeaking with Citrix
o Using Dragon NaturallySpeaking in a Citrix environment
o Installing and publishing Dragon NaturallySpeaking on the Citrix server
o Creating Policies for Dragon NaturallySpeaking on the Citrix server
o Making Published Applications Work together
o Setting Up the Program Neighborhood on Citrix clients
o Starting Dragon NaturallySpeaking from a Citrix client
• Using the Convert XML to DAT tool
Installation and Upgrade
Recommended System Requirements for Dragon NaturallySpeaking
CPU speed 1GHz or greater. Recommended: 2.4 GHz
1GB RAM (512 MB free minimum)
Minimum of 500MB of free hard disk space for a custom Installation where you install only the program files
and 1 set of speech files. Installations can range from 800 MB (US English Standard) to 2.5 GB (US English
Medical).
Windows 2000 Service Pack 4 or higher, Windows Server 2003, Windows XP Pro or Windows XP Home (SP1 or
SP2).
Creative Labs® Sound Blaster® 16 or equivalent sound card supporting 16-bit recording
Microsoft® Internet Explorer 5 or higher (free download available at www.microsoft.com)
An internet connection for product activation.
CD-ROM drive (required for installation)
Nuance-approved noise-canceling headset microphone
Speakers (required for playback of recorded speech and text-to-speech features)
Coexistence with Dragon NaturallySpeaking SDK Client Edition
You can install Dragon NaturallySpeaking SDK Client Edition 9 on the same machine where Dragon
NaturallySpeaking 9 is installed.
In addition, Dragon NaturallySpeaking 9 and Dragon NaturallySpeaking SDK Client Edition 9 can share
vocabularies and users.
You can only run one product at the same time. For example, if you are running Dragon NaturallySpeaking you
cannot run any of the SDK Client tools or samples.
12
Notes:
Coexistence with Dragon NaturallySpeaking SDK Client Edition Version 8 is not supported.
Upgrading from a previous version
You can upgrade from Dragon NaturallySpeaking Versions 7 and 8.
During an upgrade, the V9 upgrade procedure will ask you to:
Remove the previous Dragon NaturallySpeaking installation. If you choose not to remove the previous
installation, you cannot continue to upgrade. Removing Version 7 or 8 will not remove your V7 or 8 speech
files and vocabularies.
Migrate your existing user files and vocabularies to Version 9. If you choose not to upgrade your user files and
vocabularies during the upgrade, you can do so at a later time by running the Version 9 Upgrade Tool.
Once V9 is installed, your previous version will no longer be functional.
Note: The user files from previous versions remain untouched in case you decide to later reinstall the previous
version.
Edition considerations
You must upgrade to the same edition or higher and to the same language.
For example, if you started with Version 8 German/English and you upgrade to Version 9 English only, your
Version 8 German users will not be upgraded. Upgrading to Version 9 German/English will upgrade both your
German and English users. After upgrading, you can install other Version 9 languages.
Directory Changes
For information on changes to the directory structure when upgrading from Version 7 or 8, see Version 9 File
Structure.
Dragon NaturallySpeaking Installation
This topic describes the basics steps for installing Dragon NaturallySpeaking on a single machine.
For complete a complete description of installing Dragon NaturallySpeaking on a single machine., please see
the Dragon NaturallySpeaking User's Guide.
Note
You must have Administrator rights to install or uninstall Dragon NaturallySpeaking on Windows 2000 and
Windows XP.
13
For Windows 2000 and Windows XP Professional systems with limited user accounts (users with restricted
privileges), if the administrator wants to create a Dragon NaturallySpeaking user for a limited user, the
administrator must log on as the limited user. If an administrator creates a Dragon NaturallySpeaking user for
a limited user account from an administrator account, the limited user account will not be able to access that
user. Administrator rights are not required to create a user or use the software after installation. These
restrictions also apply for an upgrade installation.
If you decide not to install some Dragon NaturallySpeaking components by selecting Custom installation, you
can install them later by running the Setup program again and choosing Modify.
Installing Dragon NaturallySpeaking on a single machine
To install Dragon NaturallySpeaking:
1. Insert the first Dragon NaturallySpeaking CD into your CD-ROM drive.
If the installation does not start automatically, use the Windows Explorer to find and double-click setup.exe
on the CD.
2. Provide your customer information, including the serial number supplied with your Dragon
NaturallySpeaking installation.
3. Choose your installation directory. If there are no previous versions of Dragon NaturallySpeaking on your
system, the default directory is:
C:\Program Files\Nuance\NaturallySpeaking9
4. Choose your Setup Type (Preferred and higher editions)
Typical/Complete: Installs all options and speech files and requires the most disk space.
Custom: Lets you select which options and speech files to install. Customizing your installation options
can greatly reduce the disk space required for installation.
For the Professional edition, you can modify the following settings during a custom installation. These
settings are applied to all users created with this installation of Dragon NaturallySpeaking, including
users created from Windows XP limited accounts:
"Modify the application's settings for all users" displays the Options dialog box at the end of the
installation. The Options dialog box lets you change Dragon NaturallySpeaking’s standard behavior,
including specifying hot keys, customizing how text is formatted, initial microphone settings, and
setting the how often your user files are backed up.
“Modify the administrative settings” displays the Administrative settings dialog box at the end of
the installation. The Administrative settings dialog box lets you set up the Roaming User feature as
well as well as set the backup location of your user files and restrict users from modifying
commands and vocabularies.
5. Enable the Dragon NaturallySpeaking QuickStart option. (Optional)
6. If you are upgrading from Version 7 or 8, you can select to upgrade your users as part of the Version 9
installation by checking “Upgrade existing speech files to work with this installation.”
7. Continue following the on-screen instructions. The setup program will install the files for Dragon
NaturallySpeaking to your computer.
Activating Dragon NaturallySpeaking
The first time you start Dragon NaturallySpeaking, you will be prompted to activate your copy of Dragon
NaturallySpeaking. If you do not activate the software, Dragon NaturallySpeaking will stop working after
starting the product fives times.
For more information on activation, please see the Dragon NaturallySpeaking User's Guide.
14
Modifying settings for all users
For the Professional, you can modify the following settings during an installation:
"Modify the application's settings for all users" displays the Options dialog box at the end of the installation.
The Options dialog box lets you change Dragon NaturallySpeaking’s standard behavior, including specifying
hot keys, customizing how text is formatted, initial microphone settings, and setting the how often your user
files are backed up.
“Modify the administrative settings” displays the Administrative settings dialog box at the end of the
installation. The Administrative settings dialog box lets you set up the Roaming User feature as well as well as
set the backup location of your user files and restrict users from modifying commands and vocabularies.
These settings are applied to all users created with this installation of Dragon NaturallySpeaking, including
users created from Windows XP limited accounts.
Modifying settings for all users
During an installation on a single computer, you can choose the Setup type :
Typical/Complete: Installs all options and speech files and requires the most disk space.
Custom: Lets you select which options and speech files to install.
Choose custom to select the "Modify the application's settings for all users" and “Modify the administrative
settings” options.
MSI Installation Options
Dragon NaturallySpeaking include a native Windows Installer (MSI) that lets you customize your installations as
well as install across a network to multiple client machines. In addition, you use this service to modify, repair, or
remove an existing NaturallySpeaking installations.
This section describes:
• Command line options specific to the Microsoft Installer Service (msiexec.exe).
• Command line options specific to NaturallySpeaking setup using msiexec.exe
• Command line options specific to how InstallShield Setup (setup.exe) calls msiexec.exe.
• Command line samples
MSI Installer location
The compiled .MSI file is located on your installation CD. The files are named:
• Dragon NaturallySpeaking (all editions): Dragon NaturallySpeaking 9.msi
• SDK Client Edition (DSC): Dragon SDK Client Edition 9.msi
15
• SDK Server Edition (DSS): Dragon SDK Server Edition 9.msi
Installation notes:
Unless otherwise noted
• All command line options are case insensitive and may be combined
• No options require special values based on the values of other options.
In the examples below, user-supplied information is displayed between angle brackets. Do not use angle brackets
(<,>) as part of the command line.
Do not use quotation marks except when specifying a full path name with the -path command.
Windows Installer (MSI) options
The executable program that interprets packages and installs products is the Microsoft Installer Service
(msiexec.exe) or MSI.
All native MSI command line options are supported. All options are documented in the Microsoft MSI
documentation, which can be found on:
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/command_line_options.asp
All Msiexec.exe command-line options must be prefaced with a forward slash (/) only.
The following are the most useful MSI options for installing the Dragon NaturallySpeaking:
Option Description
/q or /qn Quiet (or silent) mode installation.
/L [i|w|e|a|r|u|c|m|o|p|v|x|+|!|*]
Logfile
Specifies the location of an installation logfile and specifies the
nature of the information to be logged:
i - Status messages.
w - Nonfatal warnings.
e - All error messages.
a - Start up of actions.
r - Action-specific records.
u - User requests.
c - Initial UI parameters.
m - Out-of-memory or fatal exit information.
o - Out-of-disk-space messages.
16
p - Terminal properties.
v - Verbose output.
x - Extra debugging information. Only available on Windows Server
2003.
+ - Append to existing file.
! - Flush each line to the log.
"*" - Wildcard, log all information except for the v and x options. To
include the v and x options, specify "/L*vx".
PROPERTY=VALUE Overrides default public property value. For example, setting
"XYZ=ABC" will replace the default property value of XYZ to ABC.
MSI options specific to NaturallySpeaking
This section described the msiexec.exe options specific to Dragon NaturallySpeaking.
The NaturallySpeaking command line options do not need to be prefaced hyphens or slashs.
Note: Launching <msiexec.exe "Dragon SDK Client Edition" XYZ=ABC> automatically sets the property
"XYZ" to the value of "ABC" internally and continues the installation. However, installation through setup.exe will
still require the "/v" command line option in order to pass the property override value on to the MSI service.
The following table documents the supported global property overrides. Unless noted otherwise, all property
values are in UPPERCASE.
Option Description
ADDLOCAL=Feature1,Feature2,...
or
ADDLOCAL=ALL
The value of the ADDLOCAL property is a list of features that
are delimited by commas, and are to be installed locally.
To install all features locally (including the speech files), use
ADDLOCAL=ALL on the command line.
ADVERTISE=Feature1,Feature1,... The value of the ADVERTISE property is a list of features
delimited by commas that are to be advertised.
To install all features as advertised, use ADVERTISE=ALL on
the command line.
The ADVERTISE option overrides the ADDLOCAL option.
The best method for specifying a custom installation is to set
the ADDLOCAL property to ALL and then specify the
ADVERTISE property to match those features you don't want
installed locally. A list of the features that may be set for
installation is listed below.
DEFAULTSINI="c:\xyz.ini" Specifies a "default settings" file, which will allow an installer
to change the default behavior of the product for all users.
17
The specified file contains settings that will be merged into
the nsdefaults.ini file at installation time. Note that this file
must be in an ".ini" file format. In other words, any settings
you want to merge must also have the section notated as well
as the value and data. If only values and data are set in this
file (without the section name encased in brackets), the
settings will not be merged.
For a default installation, the nsdefaults.ini is located in:
C:\Documents and Settings\All Users\Application
Data\Nuance\NaturallySpeaking9
SERIALNUMBER=abcde-fgh-ijkl-mnop-qr The serial number, in the form of "abcde-fgh-ijkl-mnop-qr".
A serial number is required for all installations. If one is not
already built into the ereg.ini file, then a valid one must be
specified on the command line.
Note: Specifying a serial number on the command line does
not bypass the serial number checking within setup.
INSTALLDIR="c:\xyz" The default installation directory.
Long path names need to have their quote strings "escaped"
(\"). If you do not use this option, DSC is installed to the
defualt directory: [PROGRAMFILES]\Nuance\Dragon SDK
Client Edition
If you are upgrading from a previous version, you must set
INSTALLDIR to that versions installation directory.
PRODUCTUPDATEFLAG=0 (or 1 or -1) Sets the default state of the checkbox at the end of
installation to determine if installation will automatically
check the web for product updates.
A value of 0 (zero) will turn the checkbox off by default. A
value of 1 (one) will turn it on by default.
To disable the option entirely (turn the option off and
suppress the display of the checkbox
altogether), set the value to -1.
The default setting is "1" (enable the checkbox and check for
product updates by default).
NOTYPICAL=1 Sets the default choice on the SetupType dialog to "Custom",
rather than "Typical/Complete".
RebootYesNo=No Stops Windows from rebooting, even if the installation will not
be complete until Windows is restarted.
This option will also suppress the prevention of installation
when a reboot is necessary.
Note case: This should not be uppercased.
NOMINIMUM=1 Will override the enforcement of minimum memory/speed
requirements for installation.
18
QUICKSTART=0 (or 1) Set the default state of "Enable QuickStart Mode" checkbox to
enable QuickStart and to create shortcut for "Dragon
NaturallySpeaking"
in the Windows Startup folder.
A value of 0/1 will turn checkbox off/on accordingly.
REINSTALL=Feature1,Feature2,... (or ALL) The value of the REINSTALL property is a list of features
delimited by commas that are to be reinstalled. To reinstall all
features use REINSTALL=ALL on the command line.
If the REINSTALL property is set, the REINSTALLMODE
property should also be set, to indicate the type of reinstall to
be performed. If the REINSTALLMODE property is not set,
then by default all files that are currently installed are
reinstalled, IF the currently installed file is a lesser version (or
is not present). By default, no registry entries are rewritten.
Note that even if REINSTALL is set to ALL, only those features
that were already installed previously are reinstalled. Thus, if
REINSTALL is set for a product that is yet to be installed, no
installation action will take place at all.
For more information, see:
http://msdn.microsoft.com/library/default.asp?url=/library/
en-us/msi/setup/reinstall.asp
REINSTALLMODE={specifying the type of
reinstallation to perform}
The REINSTALLMODE property is a string that contains letters
specifying the type of reinstall to perform. Options are
case-insensitive and order-independent. This property should
normally always be used in conjunction with the REINSTALL
property. However, this property can also be used during
installation, not just reinstall.
If the REINSTALLMODE property is defined without also
defining the REINSTALL property, then the specified
"detection" modes still apply and specify the "overwrite"
mode for a normal installation. The REINSTALLMODE
property only affects those features that are selected
normally for installation. The presence of the
REINSTALLMODE property does not reinstall features. The
reinstallation of features requires the presence of the
REINSTALL property.
For example, to launch a minor upgrade without using
setup.exe, you must set the following properties through the
command line:
REINSTALL=ALL
REINSTALLMODE=vemus
Therefore, to install a minor upgrade through the .msi file,
you'll need to issue the following command line:
msiexec /i "<Dragon_MSI_filename.msi" REINSTALL=ALL
REINSTALLMODE=vemus.
19
For more information on REINSTALLMODE and the reinstall
option codes, see:
http://msdn.microsoft.com/library/default.asp?url=/library/
en-us/msi/setup/reinstallmode.asp
ROAMINGUSERINI="c:\xyz.ini Specifies a "roaming user ini file", which contains settings to
be merged into nssystem.ini at installation time. These are
the same settings as displayed in the Roaming User section of
the Administrative Settings dialog box.
Long path names need to have their quote strings "escaped"
(\").
The default is empty (no .ini file will be used).
For more information on the roaming user ini file
ROAMINGUSEROPTIONS="c:\xyz.ini" Specifies a "roaming user options file", which contains
settings to be merged into nssystem.ini at installation time.
Long path names need to have their quote strings "escaped"
(\").
The default is empty (no .ini file to be merged).
Note that this file must be in an ".ini" file format. In other
words, any settings you want to merge must also have the
section notated as well as the value and data. If only values
and data are set in this file (without the section name encased
in brackets), the settings will not be merged.
SETDEFAULTS=0 (or 1) Sets the default state of "Modify the application's settings for
all users" checkbox to display the Options dialog box at the
end of the installation. The Options dialog box lets you change
Dragon NaturallySpeaking’s standard behavior, including
specifying hot keys, customizing how text is formatted, initial
microphone settings, and setting the how often your user files
are backed up.
A value of 0/1 will turn checkbox off/on accordingly.
SETADMINS=0 (or 1) Set the default state of "Modify the administrative settings"
checkbox to display the Administrative settings dialog box at
the end of the installation. The Administrative settings dialog
box lets you set up the Roaming User feature as well as well
as set the backup location of your user files and restrict users
from modifying commands and vocabularies.
A value of 0/1 will turn checkbox off/on accordingly.
WEBREGISTRATION=1 (or 0) Determines whether or not to launch the on-line product
registration form.
0 disables the product registration.
The default is 1 (enabled).
Feature variables that may set on the command line through the ADDLOCAL or ADVERTISE
property
20
Note the following when specifying features on the command line:
• If a feature doesn't exist in a particular edition or language, overriding it's default property has no effect.
• Some features (For example, the Speech feature) have subfeatures. Setting these features on the
command line will automatically turn on the properties of all subfeatures, unless those subfeatures have an
additional override also specified.
Subfeatures are indented from their parent features, and any information in parentheses is not included in
the feature name.
The following features can be specified from the command line:
Feature Sub-feature Sub-feature Sub-feature
NatSpeak
Note: Must be
included in
ADDLOCAL,
otherwise
installation will
fail
Samples (Sample
Commands files)
TTS
(Text-to-Speech)
TTSDEU (German
Text-to-Speech)
TTSENX (English
Text-to-Speech)
TTSESP (Spanish
Text-to-Speech)
TTSFRA (French
Text-to-Speech)
TTSITA (Italian
Text-to-Speech)
TTSNLD (Dutch
Text-to-Speech)
Tutorial TutDEU (German
Tutorial)
TutENX (English
Tutorial)
TutESP (Spanish
Tutorial)
TutFRA (French
Tutorial)
TutITA (Italian Tutorial)
TutNLD (Dutch Tutorial)
Speech DEU (German) DEUGeneral (German
General)
DEULegal (German
Legal)
ENX (English) AUS (Australian
English)
Sub-features for ENU (US English):
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
Page is loading ...
/
