The present Help documentation can be accessed by selecting VisualText™ Help from the Help Menu.
The Help documentation is also available as a stand-alone application, from the Windows Start button > Programs > VisualText > Help. The executable is located by default in the installation directory:
The VisualText Help documentation is built using RoboHelp®, which is layered on top of HTML Help. The Help system appears in a separate Help Viewer window and is used to navigate the help topics. The Help Viewer tabs include: Contents, Index, Search, and Glossary. Each of these tabs is described below:
Contents: The Contents tab displays the sections and pages of the Help System. To view the contents of a section or page, click on the item and the related topic is displayed in the Help Viewer. The major divisions are:
Text Analysis International: About Text Analysis International
Introduction: Brief introduction to VisualText
Getting Help: Introduction to Help
Getting Started: Installation procedures and Programming Notes
VisualText Basics: Overview of the components of VisualText
VisualText Interface: Detailed description of the VisualText interface
Using VisualText: Step-by-step instructions for using VisualText
NLP++: Detailed description of the NLP++™ programming language
Tutorials: Tutorials that go through the basics of using VisualText
Sample Analyzers: Step-by-step explanation of working analyzers
Index: The Index tab contains a list of keywords and subkeywords that are linked to topics in the Help system. To view topics linked to index items, click on the keyword and select Display. You can also hit the return key and the related topic will appear in the Help Viewer. When more than one topic is linked to a keyword, a Topics Found dialog opens. From the list of topics, you can select the topic you want to view.
Search: The Search tab allows you to search for instances of specified words in the Help system. When a word is found, the topics containing the word are listed. To view the results, select the topic from the list and click Display.
Glossary: The Glossary tab displays an alphabetical listing of technical terms related to VisualText. Definitions for selected terms are displayed in the lower pane of the Glossary Tab.
See Also Links: In addition to navigating the Help topics using the four Help Viewer tabs, you can also get to topics through See Also links provided on individual topics. The See Also links refer to topics relevant to the current topic or to topics that can provide other cross-reference information.
Context-Sensitive Help: Context-Sensitive Help allows you to get information about toolbar icons. To learn about a toolbar icon, select Help > Context Help and click on the toolbar icon. The Help Viewer will pop up and display the relevant topic.
F1 Help: F1 Help allows you to get help for NLP++ terms. F1 Help can be accessed by selecting an NLP++ term in a pass or text file and hitting the F1 key on the keyboard. Help topics will also be launched for an unselected word under the cursor.
Right-Click Menus: Many of the VisualText right-click menus provide access to the Help documentation. The right-click menu for pass files in particular allows you to get to descriptions of NLP++ code. To access documentation for NLP++ functions and other names, highlight the text in the pass file and select Help on Selection from the right-click menu.
Please send suggestions about our Help documentation to firstname.lastname@example.org. This address is for documentation issues only. For technical questions or comments, please send email to email@example.com.
Note: To see product information and version number, select Help > About VisualText.