home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / TextEditors&Viewers / Texteditors / NextStep16.lha / NextStep / ReadMe < prev   
Encoding:
Text File  |  1995-03-16  |  5.2 KB  |  119 lines
  1. PURPOSE
  2.  
  3.   NextStep is an advanced version of the dock client shipped with GoldED;  it
  4.   has  been  inspired  by  the  dock  client found in the GoldDock package of
  5.   Markus Aretz. DICE C source code is included.
  6.  
  7. COPYIGHT
  8.  
  9.   ©1995  Dietmar  Eilert  (e-mail:  DIETMAR@TOMATE.TNG.OCHE.DE).  All  Rights
  10.   Reserved.  Neither  icons nor code may be reused/reproduced without written
  11.   permission of the author.
  12.  
  13.   Dietmar Eilert
  14.   Mies-v-d-Rohe-Str.31, 52074 Aachen, Germany
  15.   E-Mail: DIETMAR@TOMATE.TNG.OCHE.DE
  16.   Tel: +49-(0)241-81665
  17.        +49-(0)2525-7776
  18.   Fax: +49-(0)241-81665
  19.  
  20. INSTALLATION
  21.  
  22.   Just run the install script. This utility requires ToolManager library 2.0;
  23.   ToolManager is ©1990-1994 Stefan Becker.
  24.  
  25. CONFIGURATION (advanced users only)
  26.  
  27.   Experienced users may change looks and functions of this  dock  by  editing
  28.   the  dock's  configuration file "dock.prefs". A dock configuration file may
  29.   consist of empty lines, comments (introduced by a  semicolon)  and  command
  30.   lines.  Five  commands  (PROG,  ICON,  SOUND,  DTOOL & DOCK) are available,
  31.   related to five basic  object  types:  PROG  lines  are  used  to  describe
  32.   actions; usually a program to be executed. ICON lines describe icons. SOUND
  33.   lines describe sounds.  DTOOL  lines  describe  combinations  of  commands,
  34.   sounds  and icons. While DTOOLs are made of PROG/ICON/SOUND, docks are made
  35.   of DTOOLs: All DTOOLs followed by a DOCK statement are linked into a  dock.
  36.   The number of docks is not limited.
  37.   
  38.   Objects are named. The object names are used to set up  the  relations.  If
  39.   you  want  to create a DTOOL object consisting of an ICON object called "A"
  40.   and a PROG object called "B", you would have to specify the symbolic  names
  41.   "A" and "B" after the DTOOL command according to the syntax below:
  42.  
  43.         option        description
  44.   ---------------------------------------------------------------------------
  45.   PROG  NAME/A        symbolic name (STRING)
  46.         COMMAND/K/A   command string (STRING)
  47.         AREXX/S       set event type to AREXX:  COMMAND is sent to ARexx
  48.         CLI/S         set event type to CLI:    COMMAND is run as program
  49.         HOTKEY/S      set event type to HOTKEY: COMMAND is sent as keystroke
  50.         GOLDED/S      set event type to GOLDED: COMMAND is sent to GoldED
  51.         ACTIVATE/S    activate GoldED's window
  52.         DIR/K         current dir
  53.         OUTPUT/K      output device (STRING); e.g. "con:"
  54.         ARGS/S        pass arguments (i.e. selected icons) to executable
  55.         KEY/K         shortcut description (STRING: "<...>")
  56.  
  57.         %GOLDED within COMMAND may be used as symbolic name of GED's port
  58.         %SCREEN within COMMAND may be used as symbolic name of GED's screen
  59.  
  60.   ICON  NAME/A        symbolic name (STRING)
  61.         FILE/A        path of icon file
  62.  
  63.   SOUND NAME/A        symbolic name (STRING)
  64.         COMMAND/K     command to be sent to sound server (STRING)
  65.         PORT/K        port name of command server
  66.  
  67.   DTOOL PROG/K/A      symbolic name of a  PROG  module (STRING)
  68.         ICON/K        symbolic name of an ICON  module (STRING)
  69.         SOUND/K       symbolic name of a  SOUND module (STRING)
  70.  
  71.   DOCK  NAME/A        symbolic name (STRING)
  72.         X/N           x position of dock (UWORD)
  73.         Y/N           y position of dock (UWORD)
  74.         HORIZONTAL/S  horizontal dock
  75.         VERTICAL/S    vertical dock
  76.         COLUMNS/N     number of columns (UWORD)
  77.         LINEAR/S      single column/row dock
  78.         HOTKEY/K      shortcut description (STRING) (without <> brackets)
  79.         TITLE/K       title text (STRING)
  80.         CENTER/S      open dock under mouse pointer
  81.         POPUP/S       dock disappears after selection
  82.         HIDDEN/S      dock in the background (hotkey activation)
  83.         TEXT/S        text dock (use screen's font)
  84.         STICKY/S      dock will remember screen position if closed
  85.         FRONTMOST/S   open on frontmost screen
  86.         PATTERN/S     fill background
  87.  
  88.  
  89. INTERNAl COMMANDS
  90.  
  91.  This utility will add a new internal command to GoldED:
  92.  
  93.         option        description
  94.  --------------------------------------------------------------------------
  95.  DOCK   NAME/A        name of dock to modify (STRING)
  96.         X/N           move dock to this x position (UWORD)
  97.         Y/N           move dock to this y position (UWORD)
  98.         SHOW/S        show dock
  99.         HIDE/S        hide dock
  100.         TOGGLE/S      toggle dock on/off
  101.         HORIZONTAL/S  set dock orientation
  102.         VERTICAL/S    set dock orientation
  103.         ROTATE/S      toggle dock orientation
  104.         LINEAR/S      set single column/row mode
  105.         NEWLOOK/S     toggle text/icon mode
  106.  
  107.  
  108. HOTKEY DEFINITION
  109.  
  110.  You may  assign  hotkeys  (i.e.  shortcuts)  to  docks.  Hidden  docks  (see
  111.  DOCK/HIDDEN/S)  will appear if the hotkey is used. You may assign hotkeys to
  112.  PROG objects as well: the hotkey  is  transmitted  if  the  PROG  object  is
  113.  activated.  If  you make a PROG object transmit a hotkey consumed by another
  114.  DOCK, that dock is toggled on/off by the PROG object.  A  hotkey  definition
  115.  string  consists  of  one  or more qualifiers followed by a KEY description.
  116.  Hotkeys of PROG objects additionaly have to be put into angle brackets (e.g.
  117.  HOTKEY="<shift  ctrl  a>").  Have  a  look  at the "Input Events" section of
  118.  GoldED's manual as far as hotkey definition strings are concerned.
  119.