
XPRISM2(ENVIRONMENT)         Khoros          XPRISM2(ENVIRONMENT)

     THE BROWSER

     The Khoros Browser provides an alternative to typing in
     filenames for input from an InputFile selection.  The Khoros
     Browser can be used in two ways: as a file/directory
     browser, or as a browser for keywords. When used as a file
     browser, one uses the mouse to move about the directory
     structure to find the desired input file;  when used as a
     keyword browser, one uses the mouse to move about the key-
     word structure to find the desired file.

     USING THE FILE BROWSER

     The default mode for the Khoros Browser is to act as a File
     Browser.  The first item in the list of the file browser is
     the word, "-- keywords --".  By selecting this item, you
     change the Khoros browser to the second mode, which is the
     Keyword Browser. The rest of the list is the contents of
     your local directory; to enter an input file that is located
     in your local directory, simply select the desired filename.
     The browser will go away, and the parameter box of the
     InputFile selection from which it originated will be filled
     in with the selected filename.  Using the file browser, you
     may also move about the directory structure by clicking on
     "../" to move up in the directory structure, or by clicking
     on the name of the desired directory to move down in the
     directory structure.

     Alternatively, one may also type the entire directory path
     directory into the text box at the bottom of the file
     browser, following the directory path with a carriage
     return.  The file browser will immediately update the list
     with the contents of the specified directory.  Notice that
     the directory box at the bottom of the file browser continu-
     ally updates to the current pathname, so on always knows
     where the current directory is.

     USING THE KEYWORD BROWSER

     By selecting the first item of the file browser, "-- key-
     words --", you cause the Khoros Browser to change from being
     a file browser to being a keywords browser.  The keywords
     browser provides a convenient shorthand for long pathnames
     to input files;  furthermore,  once the controlling Keywords
     file is set up, one need not remember the location of an
     input file - only it's keyword.

     The keywords used by the Khoros system are determined by the
     Keywords file, located in KHOROS_HOME/repos/Keywords.  Take
     a moment now to look at this file.  Each entry in the Key-
     words file consists of a single line of text:  the keyword
     or keyword set, followed by the path that the shorthand
     represents.  The first entries are single keywords that are
     shorthand notations for very frequently used files. For
     instance, ":example2.0" is a shorthand notation for
     "KHOROS_HOME/data/plot_functions/example2.0". Once this
     entry is established in the Keywords file, one may use
     ":example2.0" anywhere an input file is needed.  For
     instance, one might type:

     % xprism2 -i11 :example2.0

     instead of:

     % xprism2 -i11 KHOROS_HOME/data/plot_functions/example2.0

     Or, on the Input File pane of xprism2, one might enter
     ":example2.0" in the parameter box labeled, "Filename". Note
     that when typed by the user, a single keyword MUST be pre-
     ceded by the ":" mark to distinguish it from an actual file
     in one's local directory. This functionality also works for
     output files.

     Keywords may be sub-divided as desired.  For instance, in
     the KHOROS_HOME/repos/Keywords file, "plot2D:example2.0" is
     defined to be a shorthand for
     KHOROS_HMOE/data/plot_functions/example2.0. Subdividing key-
     words allows us to conceptually group input files as
     desired.  In addition, subdivision of keywords causes the
     Keywords Browser to mimic the operation of the File Browser.

     The meaning of ":" following a keyword in the Keywords
     Browser is equivalent to a " of a file in the File browser;
     ie, when you click on this item, the current list will be
     replaced by a list of those items that are subordinate to
     the first item.  Our Keywords file in
     KHOROS_HOME/repos/Keywords defines that the "plot2D" keyword
     has 5 subordinate keywords: example2.0 - example2.4.  Thus,
     when we click on the "Plot2D:" entry of the Keywords
     Browser, we are presented with a list of those 5 subordinate
     keywords.  Now, clicking on "example2.4" causes the Keyword
     Browser to expand the Keyword "path" to "plot2D:example2.4",
     which in turn is defined as the shorthand representing,
     KHOROS_HOME/data/plot_functions/example2.4.

     The next time the Khoros Browser is used, it "remembers"
     that the last operation was to use the Keywords Browser,
     under the "Plot2D" keyword category, so it goes back to that
     "location" - again, we are presented with the list of exam-
     ple2.0 - example2.4.  By clicking on "<==" (the equivalent
     of "../" in the File Browser) we go "up" to the original
     Keywords list.  We may now choose another keyword ("moon",
     for instance, is the shorthand to
     KHOROS_HOME/data/images/moon.xv) or we may again click on
     "<==".  Since we are now at the "top" level of the Keyword
     Browser, there is no where else to go, except back to the
     File Browser.

     While complicated to explain, the use of Keywords is very
     trivial after only a little practice;  users are encouraged
     to take advantage of this convenient and time-saving short-
     hand.  Furthermore, the Keywords file found in
     KHOROS_HOME/repos is only meant as a model;  the user is
     encouraged to create their own Keywords file, to personalize
     the operation of keywords. When creating your own Keywords
     file, create it in your top directory.  Be sure to follow
     the syntax rules carefully:

     1) all single keywords must be preceded with a ":".
     2) keywords may be subdivided as many times as desired but
     remember: if you subdivide your keywords too much, your
     shorthand is no longer short!
     3) each keyword must be followed by some white space, and
     then its full path definition.
     4) each keyword/path pair must appear on a single line
     5) comments are preceded by a "#" in the first column.

     Now that you have created your Keywords file, you must tell
     the khoros environment to use it.  You do this by going to
     the .khoros_env file in KHOROS_HOME/.khoros_env and changing
     the line that says,

     setenv KHOROS_KEYWORDS          $KHOROS_HOME/repos/Keywords

     to:

     setenv KHOROS_KEYWORDS          $USER/Keywords

     Note that the .khoros_env file must be sourced (source
     .khoros_env) or included in your .login or .cshrc file.
     From now on, you can use your own keywords to your own best
     advantage.

     Copyright 1991, University of New Mexico. All rights
     reserved.

Version: 0                 Release: 1                           1

