Professional IronPython

Interacting with the Environment
 
❘
 
207
FIgURE 10-5: 
The application help screen is simple, but helpful.
To break the help screens up, you might want to include layered help. Typing 
MyApp /?
might display 
an overview, while 
MyApp /MySwitch /?
provides detailed information. Microsoft uses this approach 
with several of its utilities. If you use layered help, make sure you mention it on the overview help 
screen, or most users will think that the overview is all they get in the way of useful information.
Special settings require a section as well. For example, 
IPY.EXE
provides access to some application 
features through environment variables. These environment variables appear in a separate section of 
the help screen.
Applications that could damage application data or the system as a whole in some way require 
warnings. Too few command line applications provide warnings, so command line applications have 
gotten a reputation for being dangerous — only experts need apply. The fact is that many of these 
applications would be quite easy to use with the proper warning information. However, don’t go 
too far in protecting the user by providing messages that request the user confirm a particular task. 
Using confirmations would reduce the ability of developers to use the command line applications for 
batch processing and automation needs.
Given that your application might inadvertently damage something when the user misuses it, you might 
also want to include fixes and workarounds as part of your help. Unfortunately, it’s the nature of com-
mand line utilities that the actions they perform are one-way — once done, you can’t undo them.
INTERACTINg WITH THE ENvIRoNmENT
The application environment consists of a number of elements. Of course, you need to consider 
whether the application uses a character mode interface or a graphical interface. The platform on 
which the application runs is also a consideration. Depending on the application’s purpose, you may 
548592c10.indd 207
2/24/10 12:48:31 PM
www.finebook.ir

---