olifExMonoJavaHelp OLIF - monolingual Example - JavaHelp 44 44 20 Christian Lieske

un

un un christian.lieske@sap.com SAP

Walldorf, Germany

un un christian.lieske@sap.com OLIF - monolingual Example - JavaHelp for OLIF2 Consortium use (includes all of SAP) 20011030T140324Z un region_standard JavaHelp definitions follow that from Kevin Lewis' book 'Creating Effective JavaHelp'

JavaHelp en noun An online help system from SUN Microsystems that has beeen developed in particular for use with the Java programming language. JavaHelp is implemented by means of Java classes that work on content files and configuration files jointly referred to as HelpSet. HelpSet en noun A set of files which jointly implement documentation that is used with the JavaHelp online help system. Two types of files are distinguished: content files (in HTML), and configuration files (in XML). configuration file en noun A file type (in XML format) for the JavaHelp online help system which holds information such as file locations. JavaHelp distinguishes two kinds of configuration files: data files (namely the HelpSet file, and the map file), and navigation files. content file en noun A file type (in HTML format) for the JavaHelp online help system which holds the information that is presented to readers. HelpSet file en noun The top-most/master configuration file (extension hs) in a HelpSet which holds information such as the location of additional configuration files. map file en noun A configuration file (extension jhm) in a HelpSet which holds information about mappings between shorthand names for files, and the corresponding file's physical location (ie. path and filename). navigation file en noun A configuration file which holds information for one of the navigation components of the HelpSet Viewer. navigation component en noun An element of the HelpSet viewer which allows readers to interact with the content files of a HelpSet. The HelpSet Viewer distinguishes three types of navigation components: table of contents, index, and full-textsearch HelpSet Viewer en noun The user interface of the JavaHelp online help system. The HelpSet Viewer presents itself as a browser-like window with a menu bar, a toolbar, a navigation pane, and a content pane. help presentation mode en noun The way in which a HelpSet is presented to readers. JavaHelp distinguishes between two modes: in-process mode, and out-of-process mode. in-process mode en noun In in-process mode, the JavaHelp system runs together with the program whose HelpSet is accessed. out-of-process mode en noun In out-of-process mode, the JavaHelp system runs without any connection to a program. context-sensitive information en noun Content for a specific state-of-affairs in a running program. JavaHelp distinguishes two types of context-sensitive information: screen-level information and field-level information. screen-level information en noun Context-sensitive information that is meant to be presented when a user selects the menu item for help in a particular application screen. field-level information en noun Context-sensitive information that is meant to be presented when a user activates a specific mechanism (for example a 'What's this' button) and then points to a particular part of the user interface (eg. a label) of the application he is running. applet en noun A Java application which runs in a Web browser. Java archive en noun A collection of Java-related files that has been grouped into a single container (similar to a ZIP-file). JavaHelp can access content files and configuration files in a Java archive by means of the JAR-colon protocol. indexing utility en noun A SUN Microsystems utility program for creating the full-text search navigation file. JavaHelp JAR file en noun The Java archive which contains all of the Java code which implements the JavaHelp functionality. online help system en noun Software that allows users of an application to read application-related information online. JavaHelp, HTML Help, and WinHelp are examples of online help systems. JavaHelp API en noun Collection of objects, methods and properties from the Java class files that implement the JavaHelp, and which can be used in other programs. map ID en noun A shorthand name/unique keyword which identifies each content file in a HelpSet. JavaHelp distribution en noun The overall set of files needed to get the JavaHelp online help system running (most notably Java class files and documentation). The JavaHelp distribution does not include a Java runtime environment. hsviewer en noun A utility that allows users to load a specific HelpSet into the HelpSet Viewer. list of hits en noun List of titles of content files which is returned by the full-text search. ranking en noun An element in the list of hits which indicates how lcose a the content of a file is to the search term. search term en noun A text string that is entered by a user for a full-text search. index item en noun A string maintained in the index file which can be displayed in JavaHelp's index. primary index item en noun An index item which is maintained and displayed on the top-most level of an index. secondary index item en noun An index item which is maintained and displayed subordniated to a primary index item. indexing engine en noun Software which creates an index (eg. for full-text search). The JavaHelp distribution contains the indexing engine 'jhindexer'. query engine en noun Software which matches search terms to information in an index. The JavaHelp distribution contains the query engine 'jhsearch'. topic map en noun An XML-based description for a collection of content files. The description includes names of content files and the files' location. multipart name en noun A naming convention which can be used to classify content files (e.g. the prefix 'img' for images). open control en noun An element of JavaHelp's table of contents navigation component. The open control expands the current level to the one below. close control en noun An element of JavaHelp's table of contents navigation component. The close control collapses the current level. table of contents level en noun A subdivision of the table of contents which groups related contents into one single category. jhindexer en noun An indexing engine distributed with JavaHelp. jhsearch en noun A query engine distributed with JavaHelp. Java GUI component en noun An element of a GUI (for example a menubar, an input text field, a check box, a combo box) implemented in Java (eg. by means of Swing GUI components). ActionListener en noun A Java class that monitors specific user actions (eg. selection from a menubar). help activator en noun A way to start an online help system. JavaHelp distinguishes three main types of help activators: menu item, button, and keyboard key (eg. 'F1'). HelpBroker en noun A Java class that handles the communication between an application and the JavaHelp online help system. screen context en noun A screen in a GUI to which a specific JavaHelp content file has been linked.