Difference between revisions of "User Manual"

From ISBoxer
Jump to: navigation, search
Line 21: Line 21:
 
# Help
 
# Help
  
[[File:Copy to clipboard.png|250px|thumb|right|ISBoxer provides security controls when you use Copy to Clipboard]]
+
[[File:Copy to clipboard.png|250px|thumb|right|ISBoxer provides security controls when you use Copy to Clipboard. See [[Configuration Sharing]]]]
The '''File''' menu provides ways to Clear, Open or Save your ISBoxer profile, and also to [[Export to Inner Space]] or copy the profile to the Windows clipboard. Selecting the Clear option will pop up a confirmation box to help ensure that you do not accidentally lose work. Saving your ISBoxer profile with "Save As" will continue editing -- and saving to -- the selected filename. Export to Inner Space is used to finalize your configuration for actual use -- this lets you make changes or view other profiles without immediately affecting your working configuration. The Copy to Clipboard option is used to share your configuration with others, and will pop up a privacy selection box to allow you to censor your account names and/or [[Character]] names if desired (default is to hide account names, but not Character names); you should '''never share your account information with anyone''' for your own security, the option is there to allow you to easily copy the complete profile for your own use.
+
The '''File''' menu provides ways to Clear, Open or Save your ISBoxer profile, and also to [[Export to Inner Space]] or copy the profile to the Windows clipboard. Selecting the Clear option will pop up a confirmation box to help ensure that you do not accidentally lose work. Saving your ISBoxer profile with "Save As" will continue editing -- and saving to -- the selected filename. Export to Inner Space is used to finalize your configuration for actual use -- this lets you make changes or view other profiles without immediately affecting your working configuration. The Copy to Clipboard option is used to [[Configuration Sharing|share your configuration with others]], and will pop up a privacy selection box to allow you to censor your account names and/or [[Character]] names if desired (default is to hide account names, but not Character names); you should '''never share your account information with anyone''' for your own security, the option is there to allow you to easily copy the complete profile for your own use.
  
 
The '''Wizards''' menu provides access to the [[Quick Setup Wizard]], and probably other wizards in the future. The Quick Setup Wizard can also be accessed from the right click context menu on '''Character Sets''' in the top tree.
 
The '''Wizards''' menu provides access to the [[Quick Setup Wizard]], and probably other wizards in the future. The Quick Setup Wizard can also be accessed from the right click context menu on '''Character Sets''' in the top tree.

Revision as of 16:00, 10 February 2011

The ISBoxer interface

The (1) Top tree, (2) Left tree, and (3) Right panel

Layout

The ISBoxer interface is comprised of three basic areas:

  1. Top tree
  2. (bottom) Left tree
  3. (bottom) Right panel

The top tree provides a general overview of your ISBoxer configuration. Elements in this tree typically have 3 special behaviors: they can be highlighted to view details or make changes, they can be right clicked to pull up a context menu, and many can be dragged into the left tree or into controls in the right panel to form an association.

The left tree provides a view of the selected item in the top tree. Selecting an element in the left tree will in turn show details (if applicable) in the right panel. For example, a Character Set may be selected in the top tree, and a Slot may be selected in the left tree, showing configuration for that Slot in the right panel. Many elements in the left tree can also be right clicked to pull up a context menu. Items in the left tree cannot be dragged to form associations like the ones from the top tree.

The right panel provides details of the selected item in the left tree. Changes made in the right panel do not take effect immediately, and can be undone if necessary. To undo a mistake, right click an empty area of the right panel to bring up a special context menu with Undo and Apply options. Navigating away from the page will automatically apply the changes. Similarly, selecting a different top tree item will apply any changes to the previously selected item.

Menus

ISBoxer has three menus at the top of the interface:

  1. File
  2. Wizards
  3. Help
ISBoxer provides security controls when you use Copy to Clipboard. See Configuration Sharing

The File menu provides ways to Clear, Open or Save your ISBoxer profile, and also to Export to Inner Space or copy the profile to the Windows clipboard. Selecting the Clear option will pop up a confirmation box to help ensure that you do not accidentally lose work. Saving your ISBoxer profile with "Save As" will continue editing -- and saving to -- the selected filename. Export to Inner Space is used to finalize your configuration for actual use -- this lets you make changes or view other profiles without immediately affecting your working configuration. The Copy to Clipboard option is used to share your configuration with others, and will pop up a privacy selection box to allow you to censor your account names and/or Character names if desired (default is to hide account names, but not Character names); you should never share your account information with anyone for your own security, the option is there to allow you to easily copy the complete profile for your own use.

The Wizards menu provides access to the Quick Setup Wizard, and probably other wizards in the future. The Quick Setup Wizard can also be accessed from the right click context menu on Character Sets in the top tree.

The Help menu provides access to various guides, as well as some other helpful areas of the ISBoxer web site including the ISBoxer Chat Room.

Concepts of ISBoxer

Basic concepts

Advanced concepts

  • A Virtual File causes the game to use a given file in place of another, for example to maintain a different configuration file per Character while only using a single copy of the game (using multiple installs of the game incurs a performance hit)
  • A Virtual Mapped Key allows a given Mapped Key to be used in place of another under certain circumstances