home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 December / simtel1292_SIMTEL_1292_Walnut_Creek.iso / msdos / hypertxt / hs25.arc / HSBASE.LZH / HSQREF.DOC < prev    next >
Text File  |  1989-05-13  |  12KB  |  375 lines
  1.         HyperShell Hypertext control system Version 2.5
  2.  
  3.                   Quick Reference Guide
  4.  
  5.              Copyright (c) 1988,1989 Text Technology
  6.  
  7.     File format
  8.  
  9.     .REMARK
  10.     (text)
  11.     .CHECK settings
  12.  
  13.     .NOTE name
  14.     (text with formatting and references)
  15.     .MENU name
  16.     (options)
  17.     .SCRIPT name
  18.     (actions)
  19.     .SCRIPT SETUP
  20.     (limited actions)
  21.     .HEADER
  22.     (text with formatting and references)
  23.     .FOOTER
  24.     (text with formatting and references)
  25.     .INDEX
  26.  
  27.     .FRAME name
  28.     .TITLE title text
  29.     (text with formatting and references)
  30.     .MENU name
  31.     (options)
  32.     .NOTE name
  33.     (text with formatting and references)
  34.     .SCRIPT name
  35.     (actions)
  36.     .END
  37.  
  38.     References
  39.  
  40.     Curly braces indicate optional parameters.
  41.  
  42.     ~Fframename{~Paction}{~Kx}~E
  43.     ~fframename{~Paction}{~Kx}~E
  44.     ~nlocalnote{~Paction}{~Kx}~E
  45.     ~Nglobalnote{~Paction}{~Kx}~E
  46.     ~tfilenote{~Paction}{~Kx}~E
  47.     ~mlocalmenu{~Paction}{~Kx}~E
  48.     ~Mglobalmenu{~Paction}{~Kx}~E
  49.     ~slocalscript{~Paction}{~Kx}~E
  50.     ~Sglobalscript{~Paction}{~Kx}~E
  51.     ~Aname~Paction{~Kx}~E
  52.     ~Ientry area~Paction pattern{~Kx}~E
  53.  
  54.     Formatting
  55.  
  56.     ~Ln     (nn = 1 to 23)                Line
  57.     ~Cn     (nn = 1 to 80)                Column
  58.     ~Wn     (nn = 1 to 72)                Field width
  59.     ~G                           Screen break
  60.     ~Tc     (c= K,B,G,C,R,M,Y,W,k,b,g,c,r,m,y,w)  Text color
  61.     ~Bc     (c= K,B,G,C,R,M,Y,W)               Background color
  62.     ~Vi     (i= L,N,H)     Low, Normal, High Video (for mono displays)
  63.     ~Dstb     (s=A to Z;t,b as for ~T,~B)           Colour scheme
  64.     ~On     (n=0,1,2 etc) - prints ON or OFF      Option setting
  65.     ~H                           Hidden line
  66.     ~Q                           Immediate reference
  67.  
  68.     Menu format
  69.  
  70.     In a menu, choices can have an action specification appended :-
  71.  
  72.     choice 1  |action
  73.     choice 2  |action
  74.     etc      |action
  75.  
  76.     Variables
  77.  
  78.     System variables - these cannot be set, but can be expanded.
  79.  
  80.     $0    full path name of current HyperShell program
  81.     $1    current frame name
  82.     $2    current frame title
  83.     $3    current file name
  84.     $4    current date
  85.     $5    current time
  86.     $6    backtrack list depth
  87.     $7    current directory
  88.     $8    original directory
  89.     $9    HyperShell name and version
  90.     $?    Error status of last error
  91.     $@    Remaining memory
  92.     $_    File prompt (becomes null string when viewing file)
  93.     $^    Numeric exit code from command executed via X/x action.
  94.  
  95.     These can be set
  96.  
  97.     $:    Exclusion list of file extensions
  98.     $<    Filename from directory display
  99.     $>    File extension from directory display
  100.  
  101.     Application variables - these are set by an application hyperfile,
  102.     and can be expanded.
  103.  
  104.     $A to $Z      application variables
  105.     $a to $z      application variables
  106.     $(xxxxxx)     named application variable
  107.  
  108.     Variables are expanded in each line in text before it is displayed
  109.     and in each action string before it is executed.
  110.  
  111.     Actions
  112.  
  113.     Axxxxx           do action xxxxx
  114.     acxxxxx        do action xxxxx if condition c is set
  115.     B           backtrack one frame
  116.     bn           backtrack to depth n
  117.     C           Change drive/directory
  118.     D{command line}    Dos shell command
  119.     d{command line}    Dos shell command (don't wait when finished)
  120.     E           Execute command with no return (Chain)
  121.     evsabc...       Expand (split) v on s to a,b,c etc.
  122.     F{name{^file}}       Go to frame (first) {in file} (stack backtrack)
  123.     f{name{^file}}       Go to frame (first) {in file} (replace backtrack)
  124.     H           Add note to notepad
  125.     h           Remove note from notepad
  126.     I           Select next input field
  127.     Jnn           Unconditional jump (in script)
  128.     jxnn           Conditional jump (in script)
  129.     Kkkaction       Map key kk to action
  130.                kk = F1-F0,S1-S0,A1-A0,C1-C0,=x
  131.     Lname           Label name - in script. No action otherwise.
  132.     lvnamed        Load variable v into named variable 'named'
  133.     Mname           Global menu
  134.     mname           local menu
  135.     Nname           Global note
  136.     nname           local note
  137.     Oos           Set run flag o(1=menusym,2=backtrack,3=savescr,
  138.                4=autoref,7=tracing) to s(0=off,1=on)
  139.                Set colour option o(A-Z - See below)
  140.     ostring        Output to printer or other output device
  141.     Pstring        Pop message with string in it
  142.     pstring        Display message with string in it (no wait)
  143.     Q           Quit to DOS
  144.     q           Quit script
  145.     R           Read file (formatted)
  146.     rfilename       Open file for reading (close if no param)
  147.     Sname           Global script
  148.     sname           local script
  149.     Tfilename       Type file
  150.     tfilename       Display file as popup note
  151.     Vxvalue        Set variable x to value
  152.     vxvalue        Test variable x
  153.     Wstring        Write string to file
  154.     wfilename       Open file for writing (close if no param)
  155.     Xcomm args       Execute command with arguments
  156.     xcomm args       Execute command with arguments (no wait)
  157.     Y           Reset error status to zero
  158.     yx           Refresh frame display (if param, display next page)
  159.  
  160.     Action modifiers
  161.  
  162.     In place of direct values (if second letter not modifier, tries third)
  163.     on actions.
  164.  
  165.     ?prompt        Issue prompt, get string and pass back as
  166.                parameter to action
  167.  
  168.     %envvar        Use value of environment variable as action parameter
  169.  
  170.     &funcspec       Use resulting string from function evaluation
  171.  
  172.     @menuspec       Use chosen value/action from menu display
  173.  
  174.     +           'Next' frame in current file
  175.  
  176.     !{F/L/R}{key}       next line from input file / noted references
  177.  
  178.     =           integer arithmetic expression (involving variables)
  179.  
  180.     Action modifier can be followed by '|pattern' where pattern contains
  181.     instances of '%s' to replace with result of modifier. e.g.
  182.  
  183.              xxxxxx %s yyyyy %s zzzzz %s hhhhhh
  184.  
  185.     A maximum of three '%s' is allowed in the pattern.
  186.  
  187.     Function codes
  188.  
  189.     The available function codes are as follows:-
  190.  
  191.     L  -  Length of arg
  192.     A  -  ASCII value of first char of arg
  193.     C  -  character with ASCII value arg
  194.     Nn -  nth character in arg
  195.     Sn -  substring starting at nth character of arg
  196.     T  -  Title of frame with name arg
  197.     Mk -  string mapped to key 'k'
  198.     Uc -  substring of arg up to, but not including character 'c'
  199.     Fc -  substring of arg from character 'c' inclusive
  200.     Ic -  index of character 'c' in arg, or 0 if not found
  201.     K  -  character typed in response to arg as popup message
  202.  
  203.     Dynamic menus
  204.  
  205.     These are available via the @ action modifier, and replace
  206.     the 'menuspec'.
  207.  
  208.     B           Backtrack list as menu (returning level number)
  209.     C           Current Hyperfile contents list as menu
  210.     Dwildspec      Directory listing (extension stripped)
  211.     dwildspec      Directory listing (with extension)
  212.     Ewildspec      Directory listing (directories only)
  213.     Ffilename      Contents of file as popup menu
  214.     Lwildspec      Extended directory display
  215.     lwildspec      Extended directory display with actions added
  216.     M(or m)name    Global/local menu
  217.     N(n or t)name  Global/local/file note
  218.     R           Notepad paged display
  219.     Sstring        Search for string in titles of current file
  220.     sstring        Search for string in titles of open files
  221.     Xstring        Search for string in titles and texts of current file
  222.     xstring        Search for string in titles and texts of open files
  223.  
  224.     Option codes
  225.  
  226.     Showing option code, command line flag, and default setting.
  227.  
  228.           0 -n    Notepad file creation (off)
  229.           1 -f    Symbols on menus (on)
  230.           2 -b    Backtrack recording (on)
  231.           3 -x    Notepad reference extension (on)
  232.           4 -a    Auto reference (off)
  233.           5 -p    Enable printer (off)
  234.           6 -r    Display remaining space on exit (off)
  235.           7 -t    Script label tracing (off)
  236.           8 -w    Give warning of unavailable references (on)
  237.           9 -k,-l    Verbatim 'T' listing
  238.  
  239.     Colours
  240.  
  241.     Option names for colour settings (with defaults) are:-
  242.  
  243.          A        wB        Action reference
  244.          B        WK(bl)  (Blink)
  245.          C        yB        Menu choice
  246.          D        KW        Default title
  247.          E        yK        Frame reference (replace)
  248.          F        wK        Frame reference (stack)
  249.          G        KK        (Ghost)
  250.          H        KR        Menu heading
  251.          I        yY        Input field
  252.          J        KG        Note heading and border
  253.          K        yG        Note
  254.          L        RK        (Low intensity)
  255.          M        KW        Menu reference
  256.          N        gK        Note reference
  257.          O        KY        Menu selection
  258.          P        yR(bl)  Popup message
  259.          Q        wR(bl)  (Quick)
  260.          R        KW        Request / message
  261.          S        yG        Script reference
  262.          T        WK        Frame text
  263.          U        YK        (User 1)
  264.          V        MK        (User 2)
  265.          W        GK        (User 3)
  266.          X        RK        (User 4)
  267.          Y        BK        (User 5)
  268.          Z        rK        (User 6)
  269.  
  270.     Colour codes
  271.  
  272.          K        Black
  273.          B        Blue
  274.          G        Green
  275.          C        Cyan
  276.          R        Red
  277.          M        Magenta
  278.          Y        Yellow (brown)
  279.          W        White (light grey)
  280.          k        Dark grey         (Foreground only)
  281.          b        Light blue         (Foreground only)
  282.          g        Light green      (Foreground only)
  283.          c        Light Cyan         (Foreground only)
  284.          r        Light red         (Foreground only)
  285.          m        Light magenta    (Foreground only)
  286.          y        Light yellow     (Foreground only)
  287.          w        Bright white     (Foreground only)
  288.  
  289.     Error codes
  290.  
  291.     The following error codes are set in variable '?'. The variable is
  292.     only reset on command (by the 'Y' action).
  293.  
  294.  
  295.          0        Success - (after status cleared)
  296.          1        Operation cancelled
  297.          2        No choice from menu
  298.          3        End of file when reading
  299.          4        Cannot open file
  300.          5        File is not open
  301.          6        File is already open
  302.          7        File has changed
  303.          8        At start of backtrack
  304.          9        Divide by 0 in expression
  305.          10     Value not expected in expression
  306.          11     Value expected in expression
  307.          12     Undefined opcode in expression
  308.          13     Unmatched parenthesis in expression
  309.          14     Syntax error in expression
  310.          15     Script not available
  311.          16     Menu not available
  312.          17     Note not available
  313.          18     Frame not available
  314.          19     Key not defined
  315.          20     Invalid key code
  316.          21     Local reference - cannot be noted
  317.          22     Not at reference when key pressed
  318.          23     Key not mapped
  319.          24     No action or action disabled
  320.          25     Invalid action code
  321.          26     No command present
  322.          27     Environment variable not defined
  323.          28     Invalid dynamic menu
  324.          29     Line too wide for screen
  325.          30     String too long
  326.          31     Too many lines in frame
  327.          32     Maximum script size reached
  328.          33     Maximum menu size reached
  329.  
  330.     Conditions
  331.  
  332.     The following condition codes are used in the 'a' and 'j' action.
  333.  
  334.          e        variable equals string (lexical or numeric)
  335.          n        variable not equal to string
  336.          g        variable greater than string (lexical or numeric)
  337.          l        variable less than string (lexical or numeric)
  338.          d        variable is defined
  339.          u        variable is undefined
  340.          c        variable contains string
  341.          w        variable is contained within string
  342.          s        jump if error status set
  343.          o        jump if error status O.K.
  344.  
  345.     Reserved characters
  346.  
  347.     The following characters cannot appear within the second (or
  348.     third if the second is not one of them) position of an action
  349.     specification, apart from for their stated purpose.
  350.  
  351.          @        Dynamic menu
  352.          &        String function
  353.          !        Read record
  354.          +        Next framename
  355.          =        Expression evaluation
  356.          %        Environment variable
  357.          ?        Prompted input
  358.  
  359.     The following characters cannot appear in the body of an action
  360.     specification, apart from for their stated purpose.
  361.  
  362.          $        Variable expansion token
  363.          |        Action modifier pattern specification
  364.          ^        (Within frame names) Hyperfile separator
  365.          ;        Multiple action separator
  366.  
  367.     The following characters cannot appear within frame text, apart from
  368.     for their stated purpose.
  369.  
  370.          ~        Reference and formatting directive flag
  371.          $        Variable expansion token
  372.          .        (At beginning of line) Section flag
  373.  
  374.     -------------------------------------------------------------------
  375.