The SlickEdit Core documentation only covers the features contributed by the SlickEdit Core plug-in. For information about working with Eclipse, including setting up workspaces, doing builds, and integrating with source control; refer to the documentation provided by Eclipse.
Documentation for SlickEdit® Core consists of:
A built-in Help system. See The Help System for more information.
The SlickEdit® Core User Guide, which provides the same information as the Help system in PDF format for viewing and printing as a manual.
Emulation charts in PDF format for the following editors: BBEdit, Brief, CodeWarrior™, CodeWright®, CUA (SlickEdit Core's default emulation), Epsilon, GNU Emacs, ISPF, SlickEdit (Text Mode edition), Vim, Visual C++® 6, Visual Studio® default, Xcode®, and Eclipse.
Slick-C® reference material in PDF format, which includes the Slick-C Macro Programming Guide and Slick-C Macro Conventions and Best Practices for End Users.
After SlickEdit Core is installed on your computer, these documents are located in the docs subdirectory of [EclipseInstallDir]/plugins/com.slickedit.windows.libs_[VERSION]/slickedit.
Documentation for SlickEdit Core is also available on the SlickEdit Web site at www.slickedit.com/products/slickedit-core/product-documentation.
In-product documentation is current as of the build date of the product. Revisions to the product documentation are made regularly with the most current version being made available on the SlickEdit Web site (www.slickedit.com).
We welcome your comments and suggestions regarding the documentation. Please send feedback to docs@slickedit.com.
The following additional resources are available:
The SlickEdit Community Forums - Learn more about SlickEdit products and interact with other users at http://community.slickedit.com.
"Hello World"'the SlickEdit Developer Blog - Read thoughts, tips, and tricks from the developers at SlickEdit at http://blog.slickedit.com.
The SlickEdit® book - After years of developing code with SlickEdit, expert John Hurst brings his wealth of knowledge to readers in Professional SlickEdit (Indianapolis, Wiley Publishing, 2005, ISBN - 978-0470122150).
CUA is the default editor emulation mode. Therefore, key bindings and shortcuts listed in the documentation follow the CUA emulation. Key sequences and mouse clicks are described using the actions performed on a typical Windows or Linux computer.
Platform-specific notes appear throughout the documentation and are included for Microsoft Windows, UNIX® (which includes Linux®), and Mac OS® X.
Instructions for navigating to items accessed from the main menu are written in the form: MainMenuItem → SubMenuItem.
For example, the text "click File → Open " indicates that you should first select File from the main menu, then select Open from the submenu. Brackets are used to indicate that the menu item is a variable. Some menu paths include tree nodes in dialogs. For example, Window → SlickEdit Preferences → Languages → [Language Category] → [Language] → Indent is a quick way to write "select Window → SlickEdit Preferences from the main menu, then in the Options tree, expand the Languages node, the category for the language you want and the language you're using, then select the Indent node".
Instructions for using the product make up the bulk of our documentation, while listings of dialog boxes and options can be found in the Menus, Dialogs, and Views chapter. Buttons on dialogs, such as OK, Close, and Help, are not usually documented since the meaning is obvious.
Commands, switches, keywords, properties, operators, options, variables, and text to be typed by the user are shown in bold type.
User-input variables and placeholders are shown in bold italic type.
Code samples and file names are displayed in a monospaced font.
File extensions and environment variables are written with an UPPERCASE font.
SlickEdit® Core commands that contain two or more words are written with underscore separators: for example, cursor_down. Note that in the user interface, however, these commands are displayed with hyphen separators: for example, cursor-down. Both of these forms work in SlickEdit Core, so you can use whichever style you prefer.
A searchable Help system is integrated into the Eclipse Help for SlickEdit® Core. To display the Help, from the main menu, click Help → Help Contents. SlickEdit Core Help appears at the bottom of the Contents list. You can use the Eclipse Search Scope feature to create a new scope, so that only matches in the SlickEdit Core Help are displayed when searching.