Nuance ScanSoft Dragon NaturallySpeaking - 9.0 Administrator’s Guide
Copyright © 2006 Nuance Communications, Inc. All rights reserved.
Dragon NaturallySpeaking
Version 9
System Administration Guide
Note: For the latest System Administration information, see
http://support.nuance.com/downloads/
1
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
2
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
3
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
4
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/Funct i o n ........................................................................................................... 160
EOF Function................................................................................................................................. 161
Erase Instruction ........................................................................................................................... 161
Err Object ..................................................................................................................................... 162
Error Instruction/Function............................................................................................................... 163
5
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
6
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
7
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
8
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
9
Dragon NaturallySpeaking System Administration Guide
Overview
Note: For the latest System Administration information,
see
http://support.nuance.com/downloads/
The Dragon Natura llySpeaking System Admin istration Guide contain s the following information :
• Installation and upgrade
o System Requirements
o Coexistence with Dra gon NaturallySpeaking SDK Client Edition
o Upgrading from a previous version
o Dragon NaturallySpeaking Installation
o Modifying settings for all users
o MSI Installation O p tions
o Using the User Upgrade Wizard to upgrade mu ltiple 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 f ea ture
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 Natur a llySpeaking Data Distribution Tool
• Using the Nsadmin Wizard
• Using the Vocabulary Tool
10
• Using Dragon NaturallySpeaking with Citrix
o Using Dragon NaturallySpeaking in a Citrix environment
o Installing and publishing Dragon Natura llySpeaking on the Citrix server
o Creating Policies for Dragon NaturallySpeaking on the Citrix server
o Making Published Applicati on s W ork together
o Setting Up the Program Neighborhood on Citrix clients
o Starting Dragon NaturallySpeaking from a Citrix client
• Using the Convert XM L to DAT tool
Installation and Upgrade
Recommended System Requirements for Dragon NaturallySpeakin g
CPU speed 1GHz or greater. Recommended: 2.4 G Hz
1GB RAM (512 MB free minimum)
Minimum of 500MB of free h a rd disk space for a custom Ins tallation where you install only the program files
and 1 set of speech files. Installations can range from 800 MB (US En glis h Standard) to 2.5 GB (US Englis h
Medical).
Windows 2000 Service Pa ck 4 or higher, Windows Server 2003, Window s XP Pro or Window s 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 (requir ed 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 Na turallySpeaking S DK Client Edition 9 on the sa me ma ch ine where Dragon
NaturallySpeaking 9 is installed.
In addition, Dragon N aturallySpeaking 9 and Dragon NaturallyS pea king SDK Client Edition 9 can share
vocabularies and users.
You can only run on e product at the same time. For example, if you are ru nning Dragon NaturallyS pea king you
cannot run any of the SDK Client tools or samples.
11
Notes:
Coexistence with Drag on NaturallySpeaking SDK Client Edition Ver s ion 8 is not supported.
Upgrading from a previous version
You can upgrade from Dragon NaturallyS peak ing Versions 7 and 8.
During an upgrade, the V9 upgrade procedure will ask you to:
Remove the previous Dragon NaturallySpeakin g installation. If you ch oos e not to remove the previous
installation, you cannot continue to u pgr a de. Removing Version 7 or 8 will not remove your V7 or 8 s peec h
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 w ill no longer be functiona l.
Note: The user files f rom previous versions remain untouched in cas e you decide to later reinstall th e 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 u sers will n ot be upgr ade d. Upgr ad ing to V ersion 9 Ger man /Eng lish w ill u pgrade bo th y our
German and English us er s . A fter upgrading, you can install other Version 9 lan guages.
Directory Changes
For information on changes to the directory structure when upgradin g 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 mac hine., please see
the Dragon NaturallySpeaking User's Guide.
Note
You must have Administrator rights to ins tall or uninstall Dragon NaturallySpeaking on Windows 2000 and
Windows XP.
12
For Windows 2000 and Windows X P Pr of es s ional systems with limited user accou nts (users with restricted
privileges), if the a dministrator wants to cr ea te a Dr a gon 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 accoun t from a n admin istrator acc oun t, the lim ited u ser accou nt will not be a ble to access th at
user. Administrator r ights are not required to crea te a user or use the software after installation. These
restrictions also apply for an upgrade installation.
If you decide not to install some Dragon NaturallyS peaking componen ts by selecting Cus tom 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 Natu r a llySpeaking:
1. Insert the first Dragon NaturallySpeaking CD into your CD-ROM drive.
If the installation does n ot sta rt automa tically , us e the Window s Explorer to find an d double-cl ick setu p.exe
on the CD.
2. Provide your customer information, including the serial number s upplied with your Dragon
NaturallySpeak ing installation.
3. Choose your insta lla tion 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 selec t wh ich option s an d speec h f il es to in sta ll. C u stomiz ing y ou r in sta llat ion o pti ons
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 Dra gon NaturallySpeaking, including
users created from Windows XP limited accounts:
"Modify the applicati on's settings for all users" displays the Options dialog box at the end of the
installation. Th e Options dialog box lets you chan ge Dragon NaturallySpeakin g’s standard behavior,
including specifying hot keys, customizin g how text is formatted, initial microphone settings, and
setting the how often your user files are backed up.
“Modify the adminis tr a tive settings” displays the Administrative settings dialog box at th e end of
the installation. T he Administrat ive settings dia log box lets you set up the R oaming User featur e 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 Q uickStart option. ( O ptional)
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 wor k with this installation .”
7. Continue following the on-screen instru ctions. The setup program will install the files f or Dr agon
NaturallySpeaking to your computer.
Activating Dragon NaturallySpeaking
The first time you star t Dr a gon NaturallySpeaking, you will be prompted to activate your copy of Dra g on
NaturallySpeaking. If you do not activate the s of tware, Dragon NaturallySpeaking will stop working after
starting the product fives times.
For more information on activation, please see the Dragon NaturallySpeaking User's Guide.
13
Modifying settings for all users
For the Professional, you can modify the following settings during an installation:
"Modify the applicati on's settings for all users" displays the O ptions dialog box at the end of the installation.
The Options dialog box lets you chan ge Dragon NaturallySpeaking’s standa r d behavior, including sp ec ifying
hot keys, customiz ing how text is form att ed, init ial mi crophon e settin gs, an d settin g the how often your u ser
files are backed up.
“Modify the adminis tr a tive settings” displays the Administrative settings dialog box at th e end of the
installation. Th e Administrative settin gs dialog box lets y ou set up the Roaming User featu re 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, includ ing
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 n a tive Windows Installer ( M SI) that lets you cus tomize your installations as
well as install across a n etwork to mu ltiple clien t mac h ines . In addition , you use this ser vic e to modify , repair , or
remove an existing Na turallySpeaking in s ta llations.
This section describes:
• Command line options specif ic to the Microsoft Installer S e rv ice (msiexec.exe).
• Command line options spec ific to NaturallySpeaking setup using msiexec. exe
• Command line options spec ific to how InstallSh ield S e tup (setup.exe) calls msiexec.exe.
• Command line samples
MSI Installer locat i on
The compiled .MSI file is located on your installation CD. The files are named:
• Dragon NaturallySp ea king (all editions): Dr a gon NaturallySpeaking 9. ms i
• SDK Client Edition (DSC): Dragon SDK Client Ed ition 9.msi
14
• SDK Server Edition (DSS): Dragon SDK Server Edition 9.msi
Installation notes:
Unless otherwise noted
• All command line options are c a s e insensitive and may be combined
• No options require special values based on th e values of other options.
In the examples below, user-su pplied information is displayed between angle b rackets. Do n ot use angle brack ets
(<,>) 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 th a t 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 ( /) on ly .
The following are the most useful MSI options for installing the Dragon NaturallySpeak ing:
Option Description
/q or /qn Quiet (or silent) mode ins tallation.
/L [i|w|e|a|r|u|c|m|o|p|v|x|+|!|*]
Logfile
Specifies the location of an installation logfile and specif ies 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.
15
m - Out-of-memory or fatal exit information .
o - Out-of-disk-space messages.
p - Terminal properties.
v - Verbose output.
x - Extra debugging information. Only available on Windows Serv er
2003.
+ - Append to existing file.
! - Flush each line to the log.
"*" - Wildcard, log all inf ormation except for the v and x opti ons. T o
include the v and x options, specify "/L*vx".
PROPERTY=VALUE Overrides default public property va lu e. For example, setting
"XYZ=ABC" will r epla c e the default property value of XYZ to ABC.
MSI options specific to NaturallySpeaking
This section describe d the msiexec.exe options sp ec ific to Dragon NaturallySpeaking.
The NaturallySpea king 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 valu e of "A BC" in tern ally an d con tinu es the in sta llati on. How eve r, in sta llat ion th rou gh setu p.ex e 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 otherwis e, a ll property
values are in UPPERCASE.
Option Description
ADDLOCAL=Feature1,Feature2,...
or
ADDLOCAL=ALL
ADVERTISE=Feature1,Feature1,... The value of the ADVER TISE property is a list of features
The value of the ADDLOCAL property is a list of f eatures th at
are delimited by commas, and a r e to be installed locally.
To install all features locally (including the speech files), use
ADDLOCAL=ALL on the command line.
delimited by commas that ar e to be a dvertised.
To install all features a s a d vertised, use ADVERTI SE=ALL on
the command line.
The ADVERTISE option overrides the ADDLOC AL option.
The best method for specifying a custom installation is to set
the ADDLOCAL property to A LL a nd then specify the
ADVERTISE property to matc h th ose f eatu res you don't w ant
installed locally. A list of the features that may be set for
installation is listed below.
DEFAULTSINI="c:\xyz.ini" Specifies a "defau lt settin g s" file, whic h will a llow a n insta ller
to change the default behavior of the product f or all users.
16
The specified file contains settings that will be merged into
the nsdefaults.ini file at installati on 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 s et in this
file (without the section name encased in brackets), the
settings will not be merg ed.
For a default installa tion, 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 er eg.ini file, then a v a lid one must be
specified on the comman d line.
Note: Specifyin g a s erial number on the command line does
not bypass the serial number checking within setup.
INSTALLDIR="c:\xyz" The default installa tion directory.
Long path names need to have their quote strings "escaped"
(\"). If you do not use this option, DSC is in stalled 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 th e c heckbox at the end of
installation to determine if installation will automatically
check the web for product updates.
A value of 0 (zero) w ill turn the checkbox of f by default. A
value of 1 (one) will tur n it on by default.
To disable the option en tirely (turn the option off and
suppress the display of the checkbox
altogether), set the v alue to -1.
The default setting is "1" (en able th e chec kbox and c hec k f or
product updates by default).
NOTYPICAL=1 Sets the default choice on the Se tupType dialog to " Custom",
rather than "Typical/Complete".
RebootYesNo=No Stops Windows from reb ooting, even if th e installation will n ot
be complete until Windows is restarted.
This option will also s uppress 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.
17
QUICKSTART=0 (or 1) Set the default state of " Enable QuickStart Mode" c heckbox to
enable QuickStart a nd to create shortcut for "Dragon
NaturallySpeaking"
in the Windows Star tup folder.
A value of 0/1 will turn checkbox off/on accordingly.
REINSTALL=Feature1,Feature2,... (or ALL) The value of the REIN STALL property is a list of features
delimited by commas th at are to be rein stalled. To rein stall all
features use REINSTALL=ALL on the command line.
If the REINSTALL property is set, the REINSTALLM O D E
property should als o be set, to indicate the type of rein stall to
be performed. If the REINSTALLM ODE property is not set,
then by default all files th at are currently in stalled are
reinstalled, IF th e currently ins talled file is a les ser version (or
is not present). By default, no registry entries a r e r ewritten.
Note that even if REINS TALL is set to ALL, only those featur es
that were already insta lled previously are reinstalled. Thus, if
REINSTALL is set for a produ ct that is yet to be installed, no
installation action will take place at a ll.
For more information, see:
http://msdn.microsoft.com/library/default.asp?url=/library/
en-us/msi/setup/reinstall.asp
REINSTALLMODE={specif yin g the type of
reinstallation to perform}
The REINSTALLMODE pr operty is a string that contain s letters
specifying the type of r einstall to perform. Options are
case-insensitive and order-independent. This property shou ld
normally always be used in conjunction with the REINSTALL
property. However, this property can also be used during
installation, n ot just reinstall.
If the REINSTALLMODE property is defined without also
defining the REINST ALL 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 installa tion. The presence of the
REINSTALLMODE property does not rein s tall features. The
reinstallation of f eatures requires the presence of the
REINSTALL property.
For example, to launch a minor upgrade without using
setup.exe, you must set the follow ing proper ti es th roug h the
command line:
REINSTALL=ALL
REINSTALLMODE=vemus
Therefore, to install a minor upgrade through the .msi file,
you'll need to issue the f ollowing command line:
18
msiexec /i "<Dragon_MSI_filename.msi" REINSTALL=ALL
REINSTALLMODE=vemus.
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 "roamin g user ini file", which contains settings to
be merged into nssystem.ini at ins tallat ion time. These are
the same settings as displayed in the Roaming User section of
the Administrative Se ttings dialog box.
Long path names need to have their quote strings "escaped"
(\").
The default is empty (n o .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 form a t. In other
words, any settings you want to merge must also have the
section notated as w ell a s the value and data. If only values
and data are set in th is file (without the s ection name encas ed
in brackets), the s ettings will not be merged.
SETDEFAULTS=0 (or 1) Sets the default state of "Modify the applicati on's settings f or
all users" checkbox to display the Options dialog box at the
end of the installation . The Options dialog box lets you chan ge
Dragon NaturallyS pea king’s standard beha vior, including
specifying hot key s, customiz ing how tex t 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 administra tive settings"
checkbox to display the Administrative settings dialog box at
the end of the instal lati on . Th e A dmin istrativ e se ttin g s dialo g
box lets you set up the Roa m ing 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
19
Note the following wh en 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 subf eatures. Setting these features on the
command line will automatica lly 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)
Tutorial TutDEU (German
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)
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)
20
Sub-features for ENU (US English):
ENG (UK English)
IND (Indian English)
SEA (SouthEast Asian
English)
ENU (US English)
ITA (Italian)
General (US English General)
Teens (US English Teens)
Legal (US English Lega l)
Cardiology (US English Medical
Cardiology)
Emergency (US English Medical
Emergency)
Gastroenterology (US English Medical
Gastroenterology)
GeneralPractice (US English Medical
GeneralPractice)
Medical (US En glish Medical No Specialty )
MentalHealth (US English Medical
MentalHealth)
Neurology (US E nglish Medical
Neurology)
ObGyn (US English Medica l O b G yn)
Oncology (US English Medica l O ncology)
Orthopaedic (US English Medica l
Orthopaedic)
Pathology (US En glish Med ical Path ology)
Pediatrics (US English Medical P ediatrics)
Radiology (US English Medical Radio logy )
Surgery (US English Medical Su r gery)
NLD (Dutch)
FRA (French)
ESP (Spanish) ESC (Castilian
Pronunciations)
ESL (Latin American
Pronunciations)
The Roaming User .ini file
You can create a "roamin g user ini file" to cha nge the roaming user settings at installa tion time. T hese options a re
the same settings that can be set as set with displayed in the RoamingUserOption
DgnEngineControl::RoamingUserOption using the DgnRoamingUserOptionConstants. For more information on the
DgnRoamingUserOptionConstants, see the API Reference Help file.
Option Description
Turns on the Roaming User feature.
Roaming User On=0 (or 1)
Default 0 = Off
Roaming User Master
Directory="existing
directory"
The location of the master roaming user you want to open.
This directory must exist.
Roaming User Local Cache
Directory="existing
directory"
21
The location of the loca l c opy of the roaming user.
The default location is: Documents and Settings\All Users\Application
Roaming User Restrict
Local User Access=1 (or 0)
Roaming User Copy
Dragon Log=0 (or 1)
Roaming User Limited
Network Traffic=0 (or 1)
Roaming User Always
Break Lock=0 (or 1)
Data\Nuance\Dragon SDK Client Edition\Roaming User\.
Permits non-roaming user to be opened when the roaming user featur e is ac tive.
Defaults to "1" which restricts access to roaming user only and prevents dictating
with a non-roaming (local) user by accident.
Copies the Dragon.log file from the local roaming user location to the master
roaming user location at the same time th at the progra m synchroniz es the local and
the master roaming user.
Default 0= Off
Transfers local user changes to the Options dialog box to the master roaming user
when the program synchronizes the local and the master roaming user.
Default 0= Off
Ask before breaking the locks on network users (recommended).
A network lock prevents the opening of a roaming user while that us er is already
open. While this proces s does not take a long time, network problems can c ause a
lock to become "stuck" and not release when the open process is completed. When
this happens, the n ext tim e anyon e tries t o open th at user , they w ill see a mess age
informing them of the lock and give them the option of overriding it.
Default 0 = ask before breaking lock
Roaming User Max
Container Size=500MB
ASW Override=0 (or 1)
Roaming User Do Not Copy
Dra Files=0 (or 1)
Example .ini file:
[Settings]
Roaming User On=1
Controls the maximum size for each container directory in the master user directo ry.
Defaults to 500 MB, max of 10000 MB
Runs a Volume Check and the Microph one Quality Check each time you open a
roaming user.
Turn this option on if your users experience reduced accuracy because of differences
in the microphone, sound card, and ambient sound levels of each roaming user
location.
Default 0 = off
Prevents making the files that contain the ac oustic data from the latest dictation
session available to the Ac oustic Optimizer when the program synchr onizes the local
and the master roaming user.
This prevents the Ac oustic Optimizer from run ning on a local roaming user. If y ou do
not wish to retain th is information, you c an use this option to prevent the transfer.
Roaming User Master Directory=G:\TE M P \user1
Roaming User Restrict Local User Access=0
22
Roaming User Copy Dragon Log=1
Roaming User Limited Network Traffic=1
Roaming User Local Cache Directory=D:\roam
InstallShield (setup.exe) options
Like the Microsoft Ins taller Service (msiexec.exe) , the InstallShield Setup progr a m ( s etup.exe) can accept a
number of command line options and can pass options through setup.exe to the included .msi file.
All setup.exe command-line options must be prefaced with a forward slash ( /) only.
All options are documen ted in the InstallShield documentation:
http://helpnet.installshield.com/robo/projects/helplibdevstudio9/IHelpSetup_EXECmdLine.htm
The following are the most useful command line options for installing DSC :
Option Description
Passes command line and public properties options to the Windows Installer
(msiexec.exe) ins tallation.
/v
/s
/L (followed by the
Windows Language
Code)
If you run setup.exe (rather than msiexec.exe) to install DSC, you can specify any
Windows Insta ller c om m a nd line options usin g the "/v" option.
For example, for MSI quiet mode, you 'll need to run setup.exe /v/qn . To set the public
property of XYZ to "ABC", you would run setup.exe /v"XYZ=ABC".
Formerly "noui"
Runs setup in a "silen t" mode, suppressing the initialization window. However, unless
the MSI installation is also specified as sil ent, the MSI installation will run normally .
In order to run both setup.ex e and msiexec.exe silen tly, you will need to c ombine the /s
and the /v options. Use the following command line: setup. exe /s /v/qn.
Using these options, no dialogs of any kind will be di s pla yed during installation or
uninstallation. All messages are suppress ed or , if a log file is also specified, s e nt to the
MSI log file in the user-specified temp directory.
The "noui" command line flag is no longer support ed.
For Multi-lingua l installation s, specifies the lan guage to use for in stallation an d bypassed
the "Choose Installa tion Language" dialog box .
For example to launch the installation in French, th e command line would be setup.exe
/l1036.
Extracting msi files from single-file installation executables (setup.exe files)
The following options are designed to extract .msi/.mst files from Windows Installer-oriented setup.exe
distribuitions. These options w ill not install a ny files; th ey will only extr act an installa ble set of files into a specif ied
23
directory.
/a
Option Description
Administrative installation option. This instructs setup.exe to perform an
administrative ins ta llation instead of a normal installation. This option is required
when trying to extrac t the .msi files.
/v
/l
(followed by the Windows
Language Code)
EXTRACTFILES="c:\xyz"
Passed arguments to Windows Installer. See above for details. This option is
required when trying to extract the .msi files.
Specifies the langua ge to use for installing Dr a gon NaturallySpeaking . For
example, to launch the installation in French, the command line would be
<setup.exe /l1036>. Th e following language codes are s upported for installing
Dragon NaturallyS peaking:
1031=German
1033=English
1034=Spanish
1036=French
1040=Italian
1043=Dutch
This option creates an MST file for the langu a ge that is specified, for exa m ple,
1036.MST.
The directory to which the .msi/.mst files w ill be extracted. Lon g path names n eed
to have their quote strings "escaped" (\"). The property must be set when trying to
extract the .msi files . If the specified directory doesn't exist, it will be created.
Therefore, a sample extr action of msi files f rom a single f ile execu table might look
like this: setup.exe /a / s /v"EXTRACTFILES=c:\temp\msifiles"
Sample Command line
The following example s ilently installs NaturallySpeaking locally with a specified set of vocabularies:
setup /s /v /qn INSTALLDIR=\"c:\\ns8\" SERIALNUMBER=abcde-fgh-ijkl-mnop-qr ADDLOCAL=ALL
ADVERTISE=Cardiology,Emergency,Gastroenterology,GeneralPractice,MentalHealth,Neurolog
y,ObGyn,Oncology,Orthopaedic,Pathology,Pediatrics,General,Teens /Liwmo!e c:\\Setup.log
The table below describes eac h option:
Option description
/s
24
Runs setup in a "silent" mode, suppressing the
initialization window.
Passes command line and public properties options to the
Windows Installer (msiexec.exe) installation.
In order to run both setup.exe an d msiex ec.exe silently,
you will need to combine th e /s and the /v options. Use the
/v
/qn Quiet (or silent) mode ins tallation.
following command line: setup.exe /s /v/qn.
Using these options, no dialogs of any kind will be
displayed during ins ta llation or uninstallation. All
messages are suppressed or, if a log file is a lso specif ied,
sent to the MSI log file in the user-specified temp
directory.
INSTALLDIR=\"c:\\ns8\"
SERIALNUMBER=abcde-fgh-hij-klmo-pq
ADDLOCAL=ALL
ADVERTISE=Cardiology,Emergency,Gastroentero
logy,
GeneralPractice,MentalHealth,Neurology,ObGyn,
Oncology,Orthopaedic,Pathology,Pediatrics,Gene
ral,Teens
/Liwmo!e c:\\Setup.log
Sets the installation directory to C: \ ns8
The serial number. A serial number is required for all
installations.
ADDLOCAL=ALL installs a ll features locally.
Installs the specif ied vocabularies.
The best method for specifying a custom installation is to
set the ADDLOCAL=ALL and then specify the ADVER TI SE
property to match th ose featu res you don't w ant installed
locally.
/L specifies the loca tion of an installation logfile and
specifies the natur e of the information to be log g ed:
i - Status messages.
w - Nonfatal warnings.
m - Out-of-memory or fatal exit information .
o - Out-of-disk-space messages.
! - Flush each line to the log.
e - All error messages.
c:\\Setup.log - writes out the log file to c:\setup.log
Using the User Upgrade Wizard to upgrade multiple users
Migrate your existing user files an d 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.
Use the Select Users to Upgrade screen to c reate a list of users that you want to upgrade. The wizard starts by
including all the users in the current folder as candidates to upgrade. You add user s to the list by clickin g the
Add button and browsing for additional users in other locations. You remove users from the list by selecting
them and clicking th e Remov e bu tton. On ce y ou hav e adjus ted the lis t of us er f iles to on ly th e ones you wan t
to upgrade, click Next.
Edition considerations
25
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 u sers will n ot be upgr ade d. Upgr ad ing to V ersion 9 Ger man /Eng lish w ill u pgrade bo th y our
German and English us er s . A fter upgrading, you can install other Version 9 lan guages.
User files to upgrade
Lists the location and name of all the users th a t the wizard will upgrade.
Note: The current location of the us er f iles is c alled "Old Location" in this screen.
Number of users to upgrade
Displays the total number of users the wizar d will upgrade.
Add
Opens a Browse for Folder window in which you can locate additional users for the wizard to upgrade.
Remove
Deletes a selected user from the User Upgrade wizard.
User Upgrade Wizard: Choose Users to Upgrade
The User Upgrade Wizard guides you through the process of upgrading user files created in Dragon
NaturallySpeaking version 6 and version 7. The wizard cannot upgrade user files created by versions of Dragon
NaturallySpeaking prior to v ersion 6. Use th e Choose User s to Upgrade screen to select the u ser or users that
you want to upgrade from among the following choices:
User <name> only
Select this option to upgrade the user you selected on the Open User dialog box .
All user files in the same location as <name> (recommended)
Select this option to upgr ade all the users tha t the wizard finds in the location of the selected user at th e same
time.
Custom: choose which users to upgrade:
Opens the Select Users to Upgrade screen where you can further refine the lis t of users to upgrade.
Once you have made a selection, click Next.
User Upgrade Wizard: Choose Destination
26
At the same time that the User Upgrade Wiz ard modifies your user files to w ork with Dragon NaturallySp eaking
version 8, it can move a copy of the upgra ded us er to anoth er locati on wh ile k eeping th e old f iles un touch ed.
This allows you to return to the old user files in cas e you need them again, and it makes the files compatible
with operating systems, like Windows XP, that store all user data in the Documents and Settings folder.
Destination for upgraded user files
Click the Browse button or select a new destination from th e list if you wan t to choose a destination other than
the suggested destination.
Advanced
Click the Advan c ed button to open the Advanced Options screen where you can alter the way that the wizard
upgrades the user.
User Upgrade Wizard: Advanced Options
The Advanced Options screen allows you to make a finer adjustment to how the wizard u pgrades the user than
you are normally can make on the Choose Destination screen
following informa tion and allows you to mak e the following changes:
User to upgrade
. The Advanced Options sc r een contains the
This box contains the following information about each user at the current location:
Old Location
Location of the cu r r ent (not yet upgraded) user f iles.
User
The name of the user.
Vocabulary
The original vocabula r y from which the user wa s crea ted.
New Base Vocabulary
The new new vocabu lary that th e User Upgrade Wiz ard will u se for th e upgraded u ser if the ol d vocbulary is
no longer supported by Dragon NaturallySpeaking. If the current vocabulary is supported, the message
<Unable to upgrade> appears.
New Location
The location that the wizard recommended or that you chose on the Choose destination screen.
New Base Vocabulary
27
If a different base v oc a bulary is available for upgrading the user, you can u s e this lis t to select it.
New Location
If you want to choose a new location for the user, you can use this list to select it.
Upgrading Users with Custom Vocabularies
If you have custom vocabu la r ies , upgrading your V8 users will maintain the customized vocabularies associated
with those users bu t will modify the vocabulary name. If you want to further modify a nd re-distribute that
customized vocabulary to your V9 users, use the procedure outlined below.
When you upgrade a user based on the custom vocabulary, all your customizations will be maintained but the
vocabulary's bas e type will be changed. For example, V 8 users who us ed US English | Large | Nuanc e vocabulary
with a topic ID of 9005 will be u pgraded to use the General - Large vocabulary; that upgraded user's vocabulary
will contain all cus tomizations in the original V8 vocabulary.
Once the user is upgraded, you can continue to modify the vocabulary using the Voctool
.
Step 1: Export any custom words added to the custom vocabulary
If you added any additional custom words to the custom vocabulary, you must first export those words. To export
custom words:
1. Click Words>Export... from the DragonBar. This displays the The Export Custom Words dialog box.
2. Enter the path and name of th e file containing the custom words in your vocabulary that you wan t to create,
or use the Save in list to find a location for the file you want to create.
Step 2: Upgrade a user with a customized vo c ab ulary
To upgrade V8 users with a customized vocabulary:
1. Run the User Upgrade Wizard. To run the wizard, s elec t Dragon NaturallySpeaking 9.0>Dragon
NaturallySpeaking Tools>Upgrade Users.
2. In the User Upgrade Wizard, select a V8 user that uses a cu stomiz ed vocabulary.
3. Click Next and follow the on-screen prompts.
The User Upgrade Wizard will disp lay th e original v ocabu lary f rom which th e user was crea ted and let you choos e
a V9 base vocabulary tha t the User Upgr a de Wizard will use for the u pgr a d ed us er .
Step 3: Import custom words to the upgraded user
If you exported words in Step 1, you know must import those words. To import a word list:
1. Click Words>Import... from the DragonBar. This displays the The Add Words from Word Lists wizard.
2. Click Next to add the file y ou created in Step 1.
28
Step 4: Export the customized vocabulary
You can share vocabularies among different users by first exporting a vocabulary from one user and then importing
it to a new user. Use th e following procedure to export a v ocabu lary . To export a vocabulary:
1. Create a folder in which to save the exported vocabulary files.
2. Open the upgraded V8 user that uses the customized vocabulary.
3. On the NaturallySpeaking menu of the DragonBar, click or say "Manage Voca bularies."
4. On the Manage Vocabularies dialog box, select th e v ocabulary you want to export and then export it.
5. Locate and open the target folder, en ter a name for the exported vocabulary in the File Name box, and then
save it.
6. Click or say "Close" on the Manage Vocabu laries dialog box to save and close it.
Notes
•
Exporting a vocabulary creates a copy of the four files that make up the vocabulary in the new location.
These files can be accessed by the Data Distribution Tool and nsadmin to create new custom base
vocabularies.
Step 5: Use nsadmin or the Data Distribution tool to copy the exported vocabulary
Using the nsadmin command line or the Data Distribution Tool, you can import the vocabulary your created in Step
2 as a base vocabulary on any Dragon NaturallySpeaking installati on.
By adding a base vocabu la r y to a Dragon Naturally Speaking installation, you can then
You can then use the new vocabulary to create new users or add a new a new vocabulary to the an existing user.
When you run nsadmin or the Data Distribution Tool to im port the the exported vocabulary to your Dra g on
NaturallySpeaking installation, ma ke sure to give the new voca bulary the same name and topic ID as the V8
customized vocabulary.
For example, if your V8 customized vocabulary was named US English | Large | Nuance topic ID 9005, you w ould
use nsadmin or the Data Distribu tion Tool to create a new base voc abulary named US English | Large | Nuan ce with
a topic ID of 9005.
Version 9 File Structure
Upgrading from Dragon N atu rally Speak ing V7 or V 8 to V 9 will a utoma tica lly rel oc ate some N atur al lyS peakin g
directories and files.
Note: The following directory structures and file locations assume an installation to a default location.
V7.0 Directory structure for all supported Windows operating systems
The V7.0 directory structure before upgrading to V9:
29
C:\Program Files\ScanSoft\NaturallySpeaking
\Custom
\Data
\Help
\Program
\Results
\Training
\Tutorial (optional installation)
\Users
Note: The \Custom directory is present only if you use nsadmin to create custom words, commands, or
vocabularies. The Dragon NaturallySpeaking V7.3 directory structure is th e s a me as V 8.
V8 Windows 2000/XP Pro/XP Home directory structure
The V8 directory structure before upgrading to V9:
C:\Program Files\ScanSoft\NaturallySpeaking
\Help
\Program
\Tutorial (optional)
C:\Documents and Settings\All Users\Application Data\ScanSoft\NaturallySpeaking\
\Custom
\Data
\Data\Training
\Users
C:\Documents and Settings\<username>\Application Data\ScanSoft\NaturallySpeaking\
\Results
9 Windows 2000/XP Pro/XP Home/Windows Server 2003 directory structure
The Directory structure after installing V9 on Windows 2000/XP Pro/XP Home/Windows 2000 Advan c ed
Server/Windows Server 2003:
C:\Program Files\Nuance\NaturallySpeaking9
\Help
\Program
\Tutorial (optional)
C:\Documents and Settings\All Users\Application Data\Nuance\NaturallySpeaking9\
\Custom
\Data
\Data\Training
\Users
C:\Documents and Settings\<username>\Application Data\Nuance\NaturallySpeaking9\
\Results
Cleaning up after uninstalling Dragon NaturallySp eaking
The following files w ill r emain on your machine after you uninstall Dragon N a turallySpeaking:
30
Loading...