home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #3 / amigamamagazinepolishissue1998.iso / bazy / aa3_install / manual / addressassist.doc next >
Text File  |  1997-01-29  |  103KB  |  3,296 lines
  1.  
  2.  
  3. *
  4.  
  5.                        A d d r e s s A s s i s t
  6.  
  7.                 Release 3.0 v41.1 (January 29th 1997).
  8.  
  9.    The BEST address database program for the Amiga computer family.
  10.  
  11.       Copyright (C) 1994-97 Quarz Development / Alex H. Schneider
  12.  
  13.                              - Shareware -
  14.  
  15.                                  * * *
  16.  
  17.  *** If you fail to expect the unexpected, the system will crash! ***
  18.  
  19.                         *** Hope, I didn't! ***
  20.  
  21.  
  22. Introduction
  23. *************
  24.  
  25. ADDRESSASSIST (AA) is a database application for address managment. It
  26. sports an easy to use and very nice MUI-driven graphical user interface
  27. and combines lots of extra functions not seen in other applications of
  28. this kind on the Amiga or even on other platforms.
  29.  
  30. The program is distributed as Shareware. See Copyright and Registration,
  31. for details about your rights and the restriction of the freely
  32. distributable version.
  33.  
  34.  
  35. Program features
  36. =================
  37.  
  38. Read the following list to get a short overview over the program's
  39. highlights:
  40.  
  41.    * 16 field address database including 4 user definable text fields,
  42.      a 'group'-field to distinguish up to 10 record groups and two
  43.      additional multi-line remark fields with unlimited field length.
  44.  
  45.    * Intuitive user interface (MUI), including a nice image-button
  46.      toolbar.
  47.  
  48.    * Selections of records. Selected records may be viewed, printed and
  49.      exported separately. Powerful filters (field string match and
  50.      group match filters) are provided. (Record selection)
  51.  
  52.    * Powerful printing: output Address Lists and (multi columned)
  53.      Labels Sheets with flexible text style and format. Ability to Load
  54.      and Save print-setup. (Database print)
  55.  
  56.    * ARexx interface. Most of the functions available through the GUI
  57.      are also supported in ARexx. Freely configurable ARexx menu for
  58.      easy access to AREXX scripts. (ARexx)
  59.  
  60.    * Sports record links: link records to other records. (Record links)
  61.  
  62.    * Easy database navigation through 'QuickAccess'-buttons on the
  63.      toolbar. (Database navigation)
  64.  
  65.    * Extensive use of MUI's Bubble-Help feature! (Help!)
  66.  
  67.    * Record templates for simplified data input. (Record template)
  68.  
  69.    * Powerful database sort feature including multiple sort indices and
  70.      directions. (Database sort)
  71.  
  72.    * Flexible Import/Export filters for ASCII files. Freely definable
  73.      file format. Exchange data with all famous Wordprocessors,
  74.      Spreadsheets and Database applications on the Amiga and all other
  75.      platforms. Ability to Load and Save of ASCII-Transfer setup.
  76.      (Import-Export ASCII)
  77.  
  78.    * Data exchange through AMIGA clipboard.
  79.  
  80.    * Special function for removing identical records.
  81.  
  82.    * Optional: Direct exchange of address data with Casio SF series of
  83.      palmtop computers using a serial link cable (available separately
  84.      at the author).
  85.  
  86.    * Localized under WB2.1 and above. Built-in English language.
  87.      German, French, Italian and Norsk catalog translations and empty
  88.      catalog description file provided. Documentation in english,
  89.      german und french (release 2 only)!.
  90.  
  91.    * Works with WB2.04 and above, needs MUI v3.6 or above
  92.  
  93.  
  94. Magic User Interface (MUI)
  95. ===========================
  96.  
  97. To provide maximal comfort, the user interface of this piece of
  98. software was designed to use MUI extensively. MUI is a separate product
  99. which is copyright by Stefan Stuntz. Based on famous BOOPSI (Basic
  100. Object Oriented Programming System for Intuition), it provides a great
  101. enhancement and possibility of standardisation of the Graphical User
  102. Interface (GUI) mainly for the user. More than that, from the point of
  103. view of the developers, it makes life much easier to provide a
  104. consistent, and so called style guide conform GUI for a software
  105. project. Use MUI in your own software projects to make you programs
  106. even better!!!
  107.  
  108. See `Readme.MUI' for more information about MUI, its distribution and
  109. where to get it from.
  110.  
  111.  
  112. Textfield gadget
  113. =================
  114.  
  115. AA sports two textfields with more than one lines of contents, which
  116. are implemented in separate windows. In order to use these, the
  117. textfield.gadget must be installed on your system. `textfield.gadget'
  118. is a separate product and is Copyright by Mark Thomas. Version 3.1 of
  119. `textfield.gadget' is supplied in the distribution archive and will be
  120. installed by the installation procedure.
  121.  
  122. See `Textfieldgadget.readme' in the `gadgets' drawer for more
  123. information.
  124.  
  125.  
  126. What is new
  127. ************
  128.  
  129. This chapter gives a short introduction into the new features of the
  130. latest program versions. It doesn't give any information about bug
  131. fixes or other internal stuff. See History & Future, for more
  132. information about this.
  133.  
  134.  
  135. Release 3.0 (January 29th 1997)
  136. ================================
  137.  
  138. Image-button toolbar
  139.      Enhanced GUI: the text buttons in the window main window are
  140.      replaced by an all new tool bar with image-buttons, the so called
  141.      Image-button toolbar.
  142.  
  143. Enhanced ASCII transfer
  144.      Added ability to create Merge files to export address data to easy
  145.      use address data in Wordprocessors. Imported records may be
  146.      assigned to groups or added to the record selection during import
  147.      process. See Import-Export ASCII.
  148.  
  149. Enhanced printing
  150.      Printing of multi-columns lists with optional field titles on
  151.      every page and multi-column label sheets is now supported. Ability
  152.      to print headers and footers containing additional information
  153.      (such as database name, date and time, number of records, page
  154.      number) with freely definable text formats and styles added.
  155.      Database print.
  156.  
  157. Online help
  158.      Push the HELP button and there is no longer a big silence when
  159.      nothing happens. Help!. Furthermore, AA makes extensive use of
  160.      MUI's Bubble help feature. Just move the mouse pointer over a
  161.      button, text field or group and wait: you'll be informed, what is
  162.      the use of this control.
  163.  
  164. Added ARexx port
  165.      The long outstanding full featured ARexx Port is finally available
  166.      and provides full control over the database application to ARexx.
  167.      In addition, there is an all new `ARexx menu', where ARexx scripts
  168.      may be executed directly from the GUI. See ARexx, for full
  169.      information about this exciting enhancement.
  170.  
  171. Record links
  172.      Record links are shortcuts to other records, which are linked to a
  173.      specific record. `Record links' introduce a new and very useful
  174.      way to structure your database. (Record links).
  175.  
  176. Enhanced database view
  177.      The format of the `Database listview' is now fully configurable:
  178.      you may choose the record fields displayed yourself. (Preferences
  179.      dialogbox)
  180.  
  181. Enhanced sorting
  182.      Added much faster sorting as well as the ability to sort with
  183.      multiple indices and directions. (Database sort)
  184.  
  185.  
  186. Installation
  187. *************
  188.  
  189. Installation of AA is a pretty easy task: just double-click on one of
  190. the `Install_xxx' icon on the workbench. AA will be installed using
  191. Commodore's Installer program. Just answer the questions mainly
  192. concering the install path.
  193.  
  194. Some of you might want to know, what the `Install' program does. Here
  195. is a description of the files, their function and where they are copied:
  196.  
  197. Most of the files will be copied into the application's drawer.
  198.  
  199. There is a directory called `Prefs/' in the application drawer, where
  200. the preferences files are located by default. (`AddressAssist.prefs' is
  201. the main preferences file, `*.ppref' are specific to print preferences,
  202. `*.xpref' are ASCII Transfer files and `*.scripts' are ARexx Menu
  203. script entries).
  204.  
  205. Furthermore, there is an own 'AddressAssist' directory in the `envarc:'
  206. assignment, where mainly the key-file `AddressAssist.key' and the
  207. default data icon (`def_AddressAssist.info') are located. If you move
  208. the AA's executable out of its drawer, you also have to copy the
  209. following support files to the global locations on the system:
  210.  
  211.    * the contents of the `Prefs/' drawer to `envarc:AddressAssist/'
  212.  
  213.    * the contents of the `Rexx/' drawer to `Rexx:'
  214.  
  215.    * the `printAssist.library' from the `libs/' drawer to `LIBS:'
  216.  
  217.    * and the `catalog/<language>/AddressAssist.catalog' files to
  218.      `LOCALE:'.
  219.  
  220. To change the program's data-icon, just copy an icon to
  221. `envarc:AddressAssist/ def_AddressAssist.info'. Note: A project icon is
  222. stored only if the appropriate switch in the `Preferences dialogbox' is
  223. set.
  224.  
  225.  
  226. Overview
  227. *********
  228.  
  229.  
  230. Program startup
  231. ================
  232.  
  233. To start AA, just double-click on the application's icon (or the icon
  234. of a project file) on the Workbench. From the shell, you may type
  235.  
  236.     AddressAssist [<ProjectFile>]
  237.  
  238. The path of the project file is the only parameter supported when
  239. starting AA. A `Project File' contains all record data of the database
  240. as well as specific data for the database and application setup
  241. (Preferences).
  242.  
  243. If the application doesn't start, some of the needed files may not be
  244. present on your system. Please refer to Installation in this manual in
  245. this case.
  246.  
  247. Note: The program stack must be set to 40000 in order to use AA without
  248. problems.
  249.  
  250.  
  251. Quick Tour
  252. ===========
  253.  
  254. After startup, the `main window' is opened. There you may recognize two
  255. different control groups:
  256.  
  257.    * The Image-button toolbar at the top of the main window provides
  258.      quick access to the most important functions. See Image-button
  259.      toolbar, for a description of the button's use.
  260.  
  261.    * The lower part of the window is covered by the Database View
  262.      Group. There are two types of database views available: The
  263.      Database List view and the Record Form view. See Database view,
  264.      for more information about this important topic.
  265.  
  266. Furthermore, there is a menu strip attached to the main window, which
  267. provides access to *all* available functions in the application (Menu
  268. Reference):
  269.  
  270.    * Project Menu: database related functions.
  271.  
  272.    * View Menu: view related functions.
  273.  
  274.    * Record Menu: record (say address) related functions.
  275.  
  276.    * Selection Menu: database selection related functions.
  277.  
  278.    * Process Menu: special functions like database import/export,
  279.      sorting and the preferences editor.
  280.  
  281.    * ARexx Menu: Configure ARexx interface and execution of ARexx
  282.      scripts.
  283.  
  284. There is a short ARexx based tutorial to AA: just click on the `ARexx
  285. demo' menu item in the `ARexx menu'.
  286.  
  287. To load a database, select Load... from the `Project Menu' and choose
  288. the database filename. If the program starts the first time after
  289. installation, a standard database will be loaded automatically. You may
  290. make a current database to be loaded automatically after startup by the
  291. Save path menu item from the `Project Menu'.
  292.  
  293. After startup, all records in the database are shown in the big list
  294. view. This is the `Database List view'. Use the `Listview format' page
  295. in the Preferences dialogbox to change the format of the list view.
  296.  
  297. Switch to the `Record Form view' by double-click on a record in the
  298. listview or use the menu item in the `View Menu' (Database view).
  299.  
  300. Now you can watch - and edit - the full record data. To edit record
  301. data, just click in a string field, change data and press <Return> or
  302. <TAB> to move to the next field. Save changes to the record, using the
  303. Save record button or the equivalent menu item in the `Record menu'.
  304. You will be asked to save changes, if you forgot!
  305.  
  306. You may change the names of the FreeX fields in the Preferences
  307. dialogbox.
  308.  
  309. Check one of the 10 group checkmarks to assign the current record to
  310. this group. Alternatively you may use the `Groups dialogbox' available
  311. though the `Set/Remove groups...' menu items from the `Record Menu' to
  312. perform this task on several records. The group checkmarks are used to
  313. distinguish up to ten Record groups. The names of the groups may be
  314. changed in the Preferences dialogbox.
  315.  
  316. There are two more text fields available. Implemented in separate
  317. windows, these fields feature multi-line text. Use the menu items in
  318. the `View Menu' to open or close the field windows (The remark fields).
  319.  
  320. You may link other records to this current record: Think about yourself
  321. for good uses of this feature! Just select a link alias from the
  322. `Links:' popup to view the linked record. Add or change record links
  323. with the buttons in the `Links:' popup and the `Record links dialogbox'.
  324. See Record links, for more infos about this extra feature.
  325.  
  326. Switch back to the Database List view by using the second button from
  327. the right on the Image-button bar (beside the Help! button) or the menu
  328. item in the `View menu'.
  329.  
  330. To move to other records of the database, use the cursor keys -
  331. <shifted> to move to the first or last record - or the equivalent
  332. buttons in the Image-button toolbar. You may like to search for a
  333. record by a key. Use the Find... and Find next menu items to enter a
  334. search string and find the record.
  335.  
  336. A very useful feature of AA is the ability to define a Record
  337. selection. Selected records may be printed, exported, edited or viewed
  338. separate from the other, say unselected, records. A record may be
  339. selected just by checking the `checkbox' to the right of the Salutation
  340. field. In the Database List view, selected records are marked with a
  341. star ('*'). You may add or remove multiple records to/from a selection
  342. by using the four buttons in the Database List view: All, None, Toggle
  343. current or by a Filter. The Filter... item opens the Filter dialogbox,
  344. where you may filter records to or from a selection by `text-pattern'
  345. or `group' match.
  346.  
  347. Use the Sort... menu item in the `Process menu' to change sort
  348. directions and sort indices of the database in memory (Database sort).
  349.  
  350. From AA you may print you record data in many different ways: there are
  351. templates available to print columnar record lists or label sheets.
  352. Most of the parameters that define the output may be varied: the most
  353. imortant are the selective record field print and ordering, the output
  354. text styles and formats as well as headers and footers. See Database
  355. print, for further information about this interesting and powerful
  356. feature.
  357.  
  358. AA stores databases to disk by default in so called project files,
  359. which are only readable by AA.
  360.  
  361. If you like to transfer data to other database programs, please take a
  362. look at the powerful Import/Export functions. AA provides a variety of
  363. possibilities to exchange data with other applications. These
  364. possibilities are included in the Import and Export functions. You may
  365. interchange data in plain ASCII files, readable by most other database,
  366. wordprocessors and spreadsheet applications on the AMIGA and on all
  367. other platforms. The format of the transfer files may be changed to
  368. your needs using the Transfer ASCII dialogbox. You may save and reload
  369. a current enchange setup. Some predefined setups are provided.
  370.  
  371. If you ever need a hint how to solve a specific task in AA, just make
  372. use of MUI's bubble hekp feature or the Help key (Help!)
  373.  
  374.  
  375. Help!
  376. ======
  377.  
  378. Help on Help! If you press the `<Help>' key or the equivalent button on
  379. the Image-button toolbar, AA will open this file as Online-Help. If the
  380. application doesn't find the helpfile (`AddressAssist .guide'), it
  381. opens a filerequester window to select the path of the helpfile.
  382.  
  383. To change the help file path, just press `<shift> <Help>': this will
  384. open the filerequester window. The path of the helpfile is saved
  385. automatically.
  386.  
  387. Since MUI 3, AA supports Bubble help! Just move the mouse pointer to a
  388. control (button, text-field, list-field...) or control group, wait and
  389. you'll get infos about the purpose of this control.
  390.  
  391.  
  392. Image-button toolbar
  393. =====================
  394.  
  395. The buttons on the toolbar are structured in 7 groups/individuals. From
  396. the left to the right, the following functions are accessible through
  397. the buttons:
  398.  
  399. * New
  400. * Open
  401. * Save
  402.      Create a new, load and save a database (Project Menu).
  403.  
  404. * Print
  405.      Print database, a selection of records or only the current record
  406.      (Database print).
  407.  
  408. * New record
  409. * Save record
  410. * Duplicate record
  411. * Delete record
  412.      Create a new record, save, duplicate and remove the current record
  413.      (Record edit).
  414.  
  415. * '|<'
  416. * '<'
  417. * '>'
  418. * '>|'
  419.      Move to the first, previous, next or last record (Database
  420.      navigation).
  421.  
  422. * Find...
  423. * Find next
  424.      Search records by key string (Find a record).
  425.  
  426. * Toggle view
  427.      Switch between the Database view types: `Database list view' or
  428.      `Record form view'.
  429.  
  430. * Help!
  431.      Get online Help!.
  432.  
  433.  
  434. Database format
  435. ================
  436.  
  437.  
  438. The record fields
  439. ------------------
  440.  
  441. AA's database consists of 16 record fields. In the context of AA and
  442. this manual, an 'address' is referenced as *record*.
  443.  
  444. `Salutation'
  445.      length: 255 chars; useful for printing address labels
  446.  
  447. `Name'
  448. `Name2'
  449.      length: 255 chars each; first and last name or company name
  450.  
  451. `Phone1'
  452. `Phone2'
  453.      length: 255 chars each; useful for phone and fax numbers
  454.  
  455. `Street1'
  456. `Street2'
  457.      length: 255 chars each; street and number or additional information
  458.  
  459. `Place'
  460.      length: 255 chars each; post code, city and state information
  461.  
  462. `Free1'
  463. `Free2'
  464. `Free3'
  465. `Free4'
  466.      length: 255 chars each; user definable fields, see below.
  467.  
  468. `Code'
  469.      length: 255 chars; useful f.e. to distinguish between several
  470.      classes of addresses by using an appropriate character code for
  471.      each of the different classes. Classes of addresses may be, for
  472.      example, private or business addresses and hotels, restaurants or
  473.      companies.
  474.  
  475. `Group'
  476.      10 Checkbox buttons to distinguish of up to 10 groups of record
  477.      data (Record groups).
  478.  
  479. `Remark1'
  480. `Remark2'
  481.      2 multi-line text fields of unlimited length for use as
  482.      annotations (The remark fields).
  483.  
  484.  
  485. User definable fields
  486. ----------------------
  487.  
  488. Use the four `FreeX' fields to your own desire by name them to your
  489. choice and then use them consequently. The field names may be changed
  490. in the Preferences dialogbox.
  491.  
  492.  
  493. The remark fields
  494. ------------------
  495.  
  496. There are two 2 remark fields with unlimited text length available. The
  497. are implemented in separate windows - the Remark windows - and a text
  498. entry may consist of multiple lines. You may open or close the windows
  499. using the Remark Window x items in the View Menu. Just type text into
  500. the text field of the window, it will be stored to the current record
  501. data in the same way the other fields are.
  502.  
  503. Note: The multi-line remark fields are available only if the Textfield
  504. gadget is installed on your system.
  505.  
  506.  
  507. Database view
  508. ==============
  509.  
  510.  
  511. Database view types
  512. --------------------
  513.  
  514. AA provides two types of database view: The Database List view and the
  515. Record Form view. While the `List view' is used for quick overview and
  516. access to all the records in the database, you may watch and edit
  517. detailed record information in the `Record Form view'.
  518.  
  519. There are several ways to switch between the two views:
  520.    * From `Database List view', the highlighted record may be accessed
  521.      directly by `<Double-Click>' in the list view gadget. You may also
  522.      use the Edit menu item from the `Record menu' to perform the same
  523.      action.
  524.  
  525.    * Use the View button on the Image-button toolbar to toggle the view
  526.      type easily.
  527.  
  528.    * From the `View menu', you may also use the List view or Form view
  529.      menu items or there shortcuts to switch the view type.
  530.  
  531.    * Additionally, the use of the Record edit functions will change the
  532.      view to `Record Form view' automatically.
  533.  
  534. Change the format of the `Database List view' in the `Listview format'
  535. page of the Preferences dialogbox.
  536.  
  537.  
  538. Remark windows
  539. ---------------
  540.  
  541. Each of the two remark windows contain a text field gadget for the
  542. remarks fields (The remark fields). Use Remark window 1 and Remark
  543. window 2 in the `View menu' to toggle availabilty of - open or close -
  544. the remark windows, as you need them. The availability of these windows
  545. will be stored as preferences data in the database project files.
  546.  
  547.  
  548. Selective record view
  549. ----------------------
  550.  
  551. In a database with a huge number of records included, one may easily
  552. fail to overview a set of records needed at the time. Use the View Menu
  553. to change the set of records that should be displayed at a time: View
  554. all records, View only selected and View only unselected and View by
  555. groups.... The later opens the Group dialogbox and lets you select the
  556. records to be displayed by their group assignment. Use the View groups:
  557. checkmark bar in the `List view' for a quick access to this function.
  558. See Record groups, for more information about the use of record groups.
  559.  
  560.  
  561. Database navigation
  562. ====================
  563.  
  564.  
  565. Navigation controls
  566. --------------------
  567.  
  568. The most important controls for navigating the database are accessible
  569. through the Image-button toolbar and through keyboard shortcuts:
  570.  
  571. `'<''
  572.      (Shortcuts: `left' or `down' arrow); moves to the previous record.
  573.  
  574. `'>''
  575.      (Shortcuts: `right' or `up' arrow); moves to the next record.
  576.  
  577. `'|<''
  578.      (Shortcuts: `shift left' or `shift down'); moves to the first
  579.      record of the database.
  580.  
  581. `'>|''
  582.      (Shortcuts: `shift right' or `shift up'); moves to the last record
  583.      of the database.
  584.  
  585. `'Find...' and 'Find next''
  586.      (Shortcuts: `ramiga =', `ramiga f' or `space'); moves to a record
  587.      by entering a key string to find it, see Find a record.
  588.  
  589. From the `Database List view', activate a record by `<double-click>' on
  590. a record in the listview to change to `Record Form view' and to edit
  591. the record's details.
  592.  
  593.  
  594. Find a record
  595. --------------
  596.  
  597. You may find a record in the database by a key string. The program
  598. compares all record fields of the records with the string. Input the
  599. key string through the Find... menu item of the `Record menu'. After
  600. accepting, the database will examined and the first matching record is
  601. returned an made current. The search starts at the current record. Use
  602. Find next to find the next record using the actual key string.
  603.  
  604. There are equivalent buttons for these functions in the Image-button
  605. toolbar.
  606.  
  607.  
  608. Database sort
  609. ==============
  610.  
  611. A database may be sorted in 3 levels by different indices and in both,
  612. `ascending' and `descending', directions. The default primary sort mode
  613. is `ascending' indexed by `Name'. 2nd is `ascending' indexed by `Name2'
  614. and 3rd is `ascending' indexed by `Place'. Change the sort modes in the
  615. Sort dialogbox.
  616.  
  617. The currently active primary sort mode is displayed in the title bar of
  618. the main window.
  619.  
  620.  
  621. Database print
  622. ===============
  623.  
  624. AA sports a powerful print interface which enables you to print your
  625. record data in different ways.
  626.  
  627. These are
  628.    * Several Record lists, with or without field names.
  629.  
  630.    * Label sheets, one or multiple columns
  631.  
  632.    * Columnar Lists, with or without field names as column title
  633.  
  634. Furthermore, all page formatting (including number of record lines per
  635. page, header and footer lines), record field formatting (including
  636. field order, field names) and text style may be changed.
  637.  
  638. All parameters for text printing may be changed in the Print dialogbox.
  639.  See Print dialogbox, for detailed information about setting up the
  640. print parameters. Print setups may be loaded & saved. This way a good
  641. setup may be reused later again.
  642.  
  643. Please, try out the provided example setups to learn about the power of
  644. the printer interface.
  645.  
  646.  
  647. Record edit
  648. ============
  649.  
  650. The Record edit functions include all available commands for working on
  651. and with individual records. All of them are available through the
  652. Record menu. Some have an equivalent button on the toolbar. See Record
  653. Menu, for detailed infos.
  654.  
  655.  
  656. Record groups
  657. ==============
  658.  
  659. Records may be assigned to one or several groups. In AA, up to 10
  660. record groups are distinguished. This adds structural information to
  661. your database. Record groups may be selected and shown separate from
  662. the other records. There are two methods to change the group assignment
  663. of the records. Use the checkboxes in the `Record form view', if you
  664. like to change only the current record. To modify several records, say
  665. assign a set of group to these records, use the Group dialogbox to
  666. simplify this process.
  667.  
  668.  
  669. Record selection
  670. =================
  671.  
  672. A special feature of AA is the capability to create a selection of
  673. records. A selection of records may be treated (print, export, assign
  674. groups) separate to all other records of the database. Whether a record
  675. is selected can be seen from the star `*' preceeding each record in the
  676. listview gadget of the `Database List view' or by the checked checkmark
  677. gadget on the top right of the `Record Form view'.
  678.  
  679. All selection related functions are collected in the Selection Menu.
  680. Use the 4-button bar below the listview gadget in the `Database List
  681. view' to edit record selections.
  682.  
  683.  
  684. Record links
  685. =============
  686.  
  687. Record links are an all new feature brought to database applications on
  688. the AMIGA: A record link is a shortcut (or an alias) to another record,
  689. which is linked to a specific record. As many such record aliases may
  690. be added to one record, `Record links' introduce a new and very useful
  691. way to structure your database. Think about yourself for applications
  692. for this interesting new feature; there are plenty of them.
  693.  
  694. Select a `Record link' entry from the listview on the `Links:' popup to
  695. display linked record data. Switch back to <Original> to view the
  696. original record.
  697.  
  698. Note: Record data diplayed as a link may not be edited for now: it is
  699. read only! This may change in the future.
  700.  
  701. Record links are controled from the `Links:' popup on the formview page:
  702.  
  703. Use the Add button and then select and name a record in the `Links
  704. dialogbox' to create a new record link.
  705.  
  706. Use the Edit button to change the highlighted record link.
  707.  
  708. Use the Remove button to remove the highlighted record link.
  709.  
  710.  
  711. Record template
  712. ================
  713.  
  714. The record template function gives you the possibility to easily add
  715. new records, which have some data in some record fields common. F.e. if
  716. you have a couple of addresses in the same town, country and of the
  717. same type, you can create a record Template with the common data, and
  718. then use the template when you create new records. The template
  719. includes all data of the record text fields, the group field and the
  720. selection field. Data of the remark fields are not saved in the
  721. template.
  722.  
  723. Use the Use Template and the Save current as Template menu items from
  724. the `Record menu' together with the New record function, if you like to
  725. apply templates. See Record menu, for detailed information.
  726.  
  727.  
  728. Import and export
  729. ==================
  730.  
  731.  
  732. Import/Export selection
  733. ------------------------
  734.  
  735. To use only a part of the current database in a second stand-alone
  736. database, export a defined selection by using the Export... function
  737. from the Selection menu. In the same way, other AA database files may
  738. be imported. (Import... function from Selection menu). When importing
  739. from a database file, only the record data will be read from the file;
  740. preferences data of the current database in AA will left untouched.
  741.  
  742. Compared to ASCII Transfer, the main difference when importing a
  743. previously exported selection is that the structural data, such as
  744. record groups and record links will be preserved.
  745.  
  746.  
  747. Import/Export ASCII
  748. --------------------
  749.  
  750. To transfer data of an AA database to or from other databases or
  751. spreadsheet application on the AMIGA (f.e. Superbase, MaxonTwist,
  752. FinalData, FinalCalc) or on other platforms (f.e. MS Access, DBase,
  753. Filemaker or MS Excel), you may do this by using ASCII files.
  754.  
  755. Wordprocessors, such as Wordworth and FinalWriter/Copy on the Amiga and
  756. MS Word or Wordperfect support so called `Merge files' to create f.e.
  757. serial letters, which may be created by AA.
  758.  
  759. In AA, ASCII files may be read or written through the `Transfer ASCII
  760. dialogbox'. In this dialog, there are all controls for defining the
  761. format of the ASCII data files. A format definition may be saved to
  762. disk and restored for later use. See Transfer ASCII dialogbox and ASCII
  763. file format, for detailed information about transfer options.
  764.  
  765.  
  766. ASCII file format
  767. ..................
  768.  
  769. The use of ASCII files is not standardized. However they provide a very
  770. flexible way of exchanging data with many other applications. In AA you
  771. have all possibilities to define the format of ASCII files in a way
  772. that reading or writing of most types of exchange files is easily
  773. possible.
  774.  
  775. In general, the format of ASCII exchange files is as follows. The end
  776. of each record is marked by a special char, the so called `Record
  777. separation char'. The fields within a record are separated by another
  778. specific char, which is called the `Datafield separation char'. In AA,
  779. the default chars are 'LF' (ASCII 10) for record separation and ','
  780. (ASCII 44) for field separation:
  781.  
  782. FieldA_Data1<FS>FieldB_Data1<FS>FieldC_Data1....<FS>FieldM_Data1<RS>
  783. FieldA_Data2<FS>FieldB_Data2<FS>FieldC_Data2....<FS>FieldM_Data1<RS>
  784. .
  785. .
  786. .
  787. FieldA_DataN<FS>FieldN_Data1<FS>FieldB_DataN....<RS>
  788.  
  789. where `<FS>' and `<RS>' are the Field separation and Record separation
  790. chars. `M' is the number of record fields and `N' is the number of
  791. records.
  792.  
  793. For `Merge files', the format is only slightly different. The first
  794. line is reserved for record field names instead of record field data:
  795.  
  796. FieldA_Name<FS>FieldB_Name<FS>FieldC_Name.......<FS>FieldM_Name<RS>
  797. FieldA_Data2<FS>FieldB_Data2<FS>FieldC_Data2....<FS>FieldM_Data1<RS>
  798. .
  799. .
  800. .
  801. FieldA_DataN<FS>FieldN_Data1<FS>FieldB_DataN....<RS>
  802.  
  803. Most important, in AA it is possible to define the record field
  804. ordering easily yourself from within the GUI. This adds enourmous
  805. flexibility on one hand, and comfort in use on the other hand, to the
  806. ASCII transfer feature.
  807.  
  808. If the record entries in imported ASCII file contain less record fields
  809. than AA provides, the missing fields will left blank. On the other
  810. hand, if the imported ASCII datafile contains more record fields per
  811. record, the surplus fields will be ignored.
  812.  
  813.  
  814. Import/Export Casio
  815. --------------------
  816.  
  817. AA supports direct data exchange to Casio FS type palmtop computers
  818. (B.O.S.S. protocol). As not everybody needs this feature, it's
  819. distributed separate to the database application in an extra product:
  820. The Casio Exchange package consists of the software, which is an
  821. external module to this database application, and (optional) the
  822. hardware: a serial link cable.
  823.  
  824. The comfortable and easy to use software allows full control of data
  825. exchange parameters through a MUI based GUI. It supports direct upload
  826. and download to/from the Casio with similar data control features as
  827. available for ASCII transfer.
  828.  
  829. If you are interested, contact the author for more information and
  830. pricing. (Contacting the author)
  831.  
  832.  
  833. Menu Reference
  834. ***************
  835.  
  836.  
  837. Project Menu
  838. =============
  839.  
  840. About shows the program's `Copyright dialogbox' with information about
  841. the current program version and revision as well as registration status
  842. (Copyright and Registration).
  843.  
  844. New clears the current database in memory and you may begin to work on
  845. a new database. You will be prompted to save changes to the old
  846. database if necessary.
  847.  
  848. Load... opens the filerequester window which prompts for the filename
  849. of the address database to be loaded. Then the database will be read
  850. from disk if possible. If there is already a database in memory, it
  851. will be entirely cleared. You will be prompted to save changes to it if
  852. necessary. (`ramiga o')
  853.  
  854. Save... writes the current database to disk with its associated
  855. filename. If there is no associated filename then you will be prompted
  856. to input a filename by the filerequester window. (Shortcut: `ramiga s')
  857.  
  858. Save as... opens the file requester window which prompts for the
  859. filename of the address database to be saved. (Shortcut: `ramiga a')
  860.  
  861. Print... opens the `Print dialogbox', where you set all print related
  862. parameters and print the database or only parts of it. (Print
  863. dialogbox). (Shortcut: `ramiga p')
  864.  
  865. Save path simply saves the path of the current database. After startup,
  866. AA will load this database automatically.
  867.  
  868. Quit just does what it says: Quit the program, but first ask to save
  869. changes to the database if appropriate. (Shortcut: `ramiga q')
  870.  
  871.  
  872. View Menu
  873. ==========
  874.  
  875. The List view and Form view items may be used to switch database view
  876. (Database view).
  877.  
  878. Use Remark window 1 and Remark window 2 to open or close the separate
  879. field windows (Remark windows).
  880.  
  881. View all records displays all records currently available in the
  882. database.
  883.  
  884. View only selected / View only unselected display only records, which
  885. are currently selected / not selected (Selective record view).
  886.  
  887. View by groups... opens the Group dialogbox and lets you select the
  888. records, which should be displayed, by their group assignment. Use the
  889. View groups button-bar in the `List view' for a quick access to this
  890. function (Record groups).
  891.  
  892.  
  893. Record Menu
  894. ============
  895.  
  896. New cleans the display of the current record. If appropriate, you will
  897. be prompted to save changes to the cleaned record, Then the first
  898. string gadget is activated for input of new record data. Check the
  899. `Record template' item to fill the fields with the data of the Record
  900. template (Record template) (Shortcuts: `n' or `ramiga n')
  901.  
  902. Save saves changes to the current record or adds a new record to the
  903. database. You will be prompted automatically for the save function,
  904. either when leaving the last datafield string gadget (`Code') by a
  905. `return' or by selecting a function which would cause the loss of
  906. recently changed data. (Shortcut: `s')
  907.  
  908. Edit activates the first datafield of the current record
  909. (`Salutation'), which is the same action as when clicking with the
  910. mouse on this gadget or another of `current record edit group''s string
  911. gadgets. This is useful, if the program is used only by keyboard.
  912. (Shortcut: `e' or `ramiga e')
  913.  
  914. Duplicate adds a new record to the database using the data of the
  915. current record. You will be prompted by a requester to confirm this
  916. action. (Shortcut: `d' or `ramiga d')
  917.  
  918. Delete removes the current record from memory. You will be prompted by
  919. a requester to confirm this unrecoverable action. (Shortcut: `l' or
  920. `ramiga l')
  921.  
  922. Copy copies the text data of the current record to the AMIGA's
  923. clipboard for exchange with other applications supporting the
  924. clipboard. (Shortcut: `ramiga c')
  925.  
  926. Check the Use Template menu item to fill the record fields of a new
  927. record with the record template data, instead of just clearing the form
  928. view Record template.
  929.  
  930. Use the Save current as Template to save the current record as a record
  931. template. The data of the template will be stored in the database file
  932. and is still available after a restart or reload of the database.
  933.  
  934. Set/remove group... opens the Group dialogbox window, with a cycle
  935. gadget and a set of group checkboxes. The `Apply to...' cycle gadget
  936. lets you change the set of records (`all' or `only selected records',
  937. `current record'), which you would like to assign or remove the
  938. assignment from specific groups. Use the group checkbox gadgets to
  939. indicate which groups have to be assigned to. There are two methods to
  940. change the group assignment of the records. Use the 10 group checkboxes
  941. in the `Record form view', if you like to edit only the current record.
  942. If you like to change similar groups assignments of several records, AA
  943. provides this function to simplify this process:
  944.  
  945. Find... prompts the user to input a key string. After accepting by
  946. clicking `OK', the database will examined for the given key and the
  947. first matching record is made the current one. The search begins with
  948. the first record. (Shortcuts: `=' or `ramiga =')
  949.  
  950. Starting from the current record, Find next finds the next record in
  951. the database that matches the actual key. If there is no actual key,
  952. this command acts like `Find...'.
  953.  
  954.  
  955. Selection Menu
  956. ===============
  957.  
  958. Add all/All selects all records of the database. (Shortcuts: `a' or
  959. `ramiga a')
  960.  
  961. Remove all/None deselects all records of the database. (Shortcuts: `n'
  962. or `ramiga n')
  963.  
  964. Toggle current/Toggle changes the selection state of the current
  965. record. (Shortcuts: `t' or `ramiga t')
  966.  
  967. Filter.../Filter opens the `Filter dialogbox'. (Shortcuts: `?' or
  968. `ramiga ?')
  969.  
  970. Import/Export... provides access to the selection import/export
  971. functions. See also Import-Export selection.
  972.  
  973. Print... opens the Print dialogbox, with the Selection cycle gadget
  974. (`Page setup') set to `previously selected'.
  975.  
  976.  
  977. Process Menu
  978. =============
  979.  
  980. Import ASCII... opens the filerequester window which prompts for the
  981. filename of the ASCII data file to be imported. All records will added
  982. to the current database. Identical records may be deleted later by a
  983. separate function (`Remove redundant records...' from Menu Process), if
  984. desirable.
  985.  
  986. Export ASCII... first opens a dialogbox where you can specify whether
  987. to export all records or only previously selected records (Record
  988. selection) from the current database. Then you will be prompted to
  989. input the filename for the ASCII export data file.
  990.  
  991. Use Transmit to Casio... and Receive from Casio... to access the
  992. optional available Casio Exchange package, which provides direct reads
  993. and writes to Casio SF palmtops through a serial link cable. Contact
  994. the author, for further information about this interesting topic.
  995.  
  996. Sort database... opens the `Sort dialogbox', where you can choose the
  997. `sort direction' and select the appropriate `index'. The current sort
  998. mode is displayed in the title bar of the main window (Sort dialogbox).
  999. (Shortcut: `ramiga r')
  1000.  
  1001. Remove redundant records... examines the database for identical records
  1002. and prompts whether or not to delete found identical records. Specify
  1003. `All' to remove all record in one step without being prompted anymore.
  1004. There will be a message at the end of the operation confirming, that
  1005. there are no more redundant records in the database memory.
  1006.  
  1007. Change Preferences... opens the `Preferences dialogbox', where you can
  1008. set program and database related preferences (Preferences dialogbox).
  1009.  
  1010. Use Change MUI Preferences... to start the MUI preferences editor and
  1011. change the GUI parameters.
  1012.  
  1013.  
  1014. ARexx Menu
  1015. ===========
  1016.  
  1017. Execute ARexx script... opens a dialogbox, where the user is prompted
  1018. for the path of the ARexx script to be executed.
  1019.  
  1020. Set ARexx console... opens a dialogbox, where the console definition
  1021. string for the ARexx console may be changed. Use standard AMIGA-DOS
  1022. keywords for the definition string as used for all AMIGA-DOS shells.
  1023. See `newshell' command documentation.
  1024.  
  1025. Set ARexx scripts... opens the ARexx dialogbox, where the ARexx script
  1026. menu items of the `ARexx menu' are setup.
  1027.  
  1028. The are up to 20 ARexx script entries available in the this menu. The
  1029. entries are dynamically added and removed following the setup in the
  1030. ARexx dialogbox. Use the approptiate menu item to execute an ARexx
  1031. script.
  1032.  
  1033.  
  1034. Dialogbox Reference
  1035. ********************
  1036.  
  1037.  
  1038. Print dialogbox
  1039. ================
  1040.  
  1041. The `Print dialogbox' is accessible through
  1042.  
  1043.    * the Print... menu item in the `Project menu' (Shortcut: `ramiga
  1044.      p'),
  1045.  
  1046.    * the Print... menu item in the `Record menu',
  1047.  
  1048.    * the Print... menu item in the `Selection menu',
  1049.  
  1050.    * and the Print image-button on the `Toolbar'.
  1051.  
  1052. AA provides a powerful print interface which enables you to print your
  1053. records with many different ways. Using so called print templates
  1054. formats, printing of column-titled lists or multi-column label sheets
  1055. is an easy task.
  1056.  
  1057. These are, how many records or record lines in columnar mode should be
  1058. printed on one sheet of paper (very useful for label printing) or
  1059. whether or not to print the record field names. For each datafield, you
  1060. furthermore may specify separately whether or not it should be printed
  1061. at all, which style should be used for printing and how many linefeeds
  1062. should be printed after each field.
  1063.  
  1064. Most of the print defining parameters may be changed by the user in
  1065. this dialogbox. A specific print setup may be saved and reused later.
  1066.  
  1067. This dialogbox consists of four pages, which are described separately:
  1068.  
  1069. To restore standard values for preferences data in this dialogbox, AA
  1070. offers both, global dialogbox (the Default all button) and dialog page
  1071. oriented (Default reset of preferences data..
  1072.  
  1073. Use  `'OK'' to print with the specified setup. The `'Save'' stores
  1074. recently changes to the print parameters without printing. Leave the
  1075. dialogbox forgetting about changes with `'Cancel''.
  1076.  
  1077.  
  1078. Page setup
  1079. -----------
  1080.  
  1081. Selection sets the set of records to be printed: `all records',
  1082. `selected records only' or `only current record'. (Record selection).
  1083.  
  1084. LF before address and LF after address indicate the number of linefeeds
  1085. printed in front of / after a record.
  1086.  
  1087. Records per page controls the number of record, printed on one page (
  1088. <= 0: limited by page size). This makes it very easy to take care of
  1089. not to split a record on two pages. Use this parameter together with
  1090. Page Length from the `Print setup' page. Set to a 0 or <0 to prevent
  1091. checking the number of addresses printed on one sheet of paper.
  1092.  
  1093. Template lets you select a predefined print template. Currently there
  1094. are two templates types available: Address list template and Label
  1095. sheet template. If your desired print format is not supported by these
  1096. templates, use `<No Template>'. If you have a good idea about a new
  1097. template, please drop a mail to the Author (Contacting the author).
  1098.  
  1099. Number of columns sets the number of print columns. This feature is
  1100. used f.e. by the `Label sheet template' to define the number of labels
  1101. printed across the page. It may also be used together with the `<No
  1102. Template>'.
  1103.  
  1104. Use Columns space to set the space between the columns.
  1105.  
  1106. Columns width is calculated automatically from the `Number of columns'
  1107. and `Columns space' variable as well as the `Page Width', `Left and
  1108. Right Margin' parameters (Printer setup page).
  1109.  
  1110. Check Print header or Print footer to print header or footer lines on
  1111. each page. Use the Number of lines control to set the number of lines
  1112. reserved for the header and the footer. In fact, this is a sort of
  1113. spacing between the header / footer texts and the body of the page as
  1114. the header and footer are printed on *one* line only.
  1115.  
  1116.  
  1117. Field options page
  1118. -------------------
  1119.  
  1120. On the top of this page there is a listview with all record fields
  1121. listed in their current print order. In addition the information about
  1122. the print format and style for each field is displayed.
  1123.  
  1124. There are 6 controls available to change the print format and style for
  1125. each field separately:
  1126.  
  1127. The 'Up' and 'Down' button change the print order of the record fields.
  1128.  
  1129. The Checkbox indicates whether or not this field is printed.
  1130. `Double-click' with the mouse on the field in the listview to perform
  1131. the same action.
  1132.  
  1133. The Style Cycle changes the print style of the record field. Choose
  1134. between `Normal', `Bold', `Italic' or `Bold-Italic'.
  1135.  
  1136. The Linefeed Cycle changes the number of linefeeds printed after each
  1137. record field. Select from `no LF' to up to `3 LF'.
  1138.  
  1139. If `no LF' is active, then the Field length text field is used to
  1140. depermine the width of each column. This is used for columns list
  1141. printing. A value of smaller or equal zero ( <=1 ) adds only a single
  1142. `<space>' at the end of the data field text and then continues with
  1143. next field on the same line.
  1144.  
  1145. The controls in the Freeformat fields group may be used to set the
  1146. parameters concering The remark fields: Use the Checkmark to indicate
  1147. whether the field should be printed at all. The Number of lines defines
  1148. how many lines are used to print the field text. If the field data is
  1149. longer than the indicated number of lines, printed text will be
  1150. truncated to the given length.
  1151.  
  1152. The 4 controls of the Fieldnames group are equal to those of the record
  1153. fields in the listview above.
  1154.  
  1155.  
  1156. Header & Footer page
  1157. ---------------------
  1158.  
  1159. On this page the printing of the header and a footer lines are
  1160. controled. This page for headers and footers contains two control
  1161. groups: one for headers one for footer. These control groups themselves
  1162. are separated into three parts to input the left-aligned, centered and
  1163. the right aligned parts of the header/footer line separately. The three
  1164. input controls are as follows:
  1165.  
  1166. The Text input field contains the text with control codes to add
  1167. filename and database information, date or time and page numbers to the
  1168. header/footer line. See Header & Footer control chars about the use of
  1169. control chars.
  1170.  
  1171. Use the Style cycle field change text style: Plain, Bold or Italic.
  1172.  
  1173. The Text preview field shows the resulting text without control chars
  1174. in current text style.
  1175.  
  1176.  
  1177. Header & Footer control chars
  1178. ..............................
  1179.  
  1180.  
  1181. %F    0 (default)    insert filename
  1182.     1        insert full path and filename
  1183.  
  1184. %T    0 (default)    insert print time (hh:mm)
  1185.     1        insert print time (hh:mm:ss)
  1186.  
  1187. %P    -        insert page number
  1188.  
  1189. %D    0 (default)    insert date (ddd mmm dd)
  1190.     1        insert date (dd.mm.yy)
  1191.     2        insert date (mm/dd/yy)
  1192.     3        insert date (dddd, dd.mmmm yyyy)
  1193.  
  1194. %N    0 (default)    insert total number of records
  1195.     1        insert selected number of records
  1196.  
  1197.  
  1198. Printer setup page
  1199. -------------------
  1200.  
  1201. Change printer specific setup on this page.
  1202.  
  1203. The Printer text field shows the currently selected AMIGA preferences
  1204. printer driver. Change the printer driver in the `Printer preferences'
  1205. program of your workbench distribution.
  1206.  
  1207. Page Length indicates the height of the sheet of paper (in number of
  1208. lines) including Top and Bottom margin.
  1209.  
  1210. Page Width indicates the width of the paper sheet (in number of chars)
  1211. including Left and Right margins.
  1212.  
  1213. Toggle  Line Spacing between `six' or `eight lines per inch'.
  1214.  
  1215. Top Margin is counted in number of empty lines on the top of the paper.
  1216.  
  1217. Bottom Margin is counted in number of empty lines on the bottom of the
  1218. paper.
  1219.  
  1220. Left Margin indicates the left margin on the paper in number of
  1221. characters.
  1222.  
  1223. Right Margin indicates the right margin on the paper in characters,
  1224. which is counted from the right side.
  1225.  
  1226. Formfeed print provides the possibility to choose, whether or not to
  1227. send a Formfeed (FF) to the printer after each printed page. Use this
  1228. switch if you have problems like always printing an empty page after
  1229. f.e. label or list print.
  1230.  
  1231. Output to toggles current print output device: `Printer' (PRT:) or text
  1232. `File'.
  1233.  
  1234.  
  1235. Transfer ASCII dialogbox
  1236. =========================
  1237.  
  1238. The `Transfer ASCII dialogbox' is accessible through
  1239.    * the Export ASCII... menu item in the `Process menu'.
  1240.  
  1241.    * and the Import ASCII... menu item in the `Process menu'.
  1242.  
  1243. The body of the dialogbox is available in both export and import mode
  1244. and is used to define the file format of the ASCII transfer file. See
  1245. also ASCII file format.
  1246.  
  1247. The Field order group consist of a listview with the record fields
  1248. listed, and two buttons to manupulate the order of the record fields:
  1249. Use Up or Down to move the highlighted record field.
  1250.  
  1251. The Separation chars may indicated separetely for records (Record
  1252. separation) and for record fields (Field separation). See Import-Export
  1253. ASCII, for detailed information about the format of the ASCII transfer
  1254. files.
  1255.  
  1256. Check Export field names to add the names of the record fields at the
  1257. top of the transfer file: The so called `Merge files' are often used to
  1258. exchange data with Wordprocessors.
  1259.  
  1260. The Preferences group is used to Save current file format to disk, Load
  1261. a previously stored format or return to Default setup.
  1262.  
  1263. The additional contols depend on the mode of the dialog:
  1264.  
  1265. Export mode:
  1266.  
  1267. The Apply to... cycle at the top of the window defines the set of
  1268. records to export: all records, only selected records or only current
  1269. record.
  1270.  
  1271. Import mode:
  1272.  
  1273. Check the Selected checkmark to add imported records to the selection.
  1274.  
  1275. Check the Groups checkmark to assign imported records to a set of
  1276. groups. Indicate the set of groups in the Groups dialogbox appearing
  1277. after pushing the Groups button.
  1278.  
  1279.  
  1280. Group dialogbox
  1281. ================
  1282.  
  1283. The `Group dialogbox' is accessible through
  1284.    * the Set groups... menu item in the `Record menu',
  1285.  
  1286.    * the Remove groups... menu item in the `Record menu',
  1287.  
  1288.    * and the View by groups... item the `View menu',
  1289.  
  1290.    * the Import... item the `Selection menu',
  1291.  
  1292.    * and the Import ASCII dialogbox.
  1293.  
  1294. The `Group dialogbox' is used in two ways.
  1295.  
  1296. If invoked from the `Record menu', you may add or remove the group
  1297. assignments of one or several records. On the other hand the dialogbox
  1298. is used to change to set of groups for the Selective record view, the
  1299. selection and the ASCII import.
  1300.  
  1301. Use the Apply to... cycle at the top of the window to define to which
  1302. selection of records the group assignments should be changed: all, only
  1303. selected or only current record(s).
  1304.  
  1305. The tem Group checkmarks are used to define the set of groups the
  1306. action should be applied to or that should be viewed.
  1307.  
  1308. The name of the groups may be changed in the Preferences dialogbox.
  1309.  
  1310.  
  1311. Filter dialogbox
  1312. =================
  1313.  
  1314. The `Filter dialogbox' is accessible through
  1315.    * the Filter... menu item in the `Selection menu' (Shortcut: `ramiga
  1316.      ?'),
  1317.  
  1318.    * and the Filter button below the record list in the `Database view'
  1319.      (Shortcut: `F').
  1320.  
  1321. The `Filter dialogbox' is used to include or exclude record to or from
  1322. a selection. It consists of two main controls:
  1323.  
  1324. The Action cycle at the top of the window lets you choose, whether to
  1325. include, exclude or toggle matching records to or from the selection.
  1326.  
  1327. Below is the Match page group, which provides access to the controls of
  1328. the two types of record match available:
  1329.  
  1330.  
  1331. Field string match
  1332. -------------------
  1333.  
  1334. The Field string match group consist of a number checkboxes - one for
  1335. each record field - and the actual Match string gadget at the bottom of
  1336. the group for input of the string to match one or several record string
  1337. fields. Use the checkboxes to indicate whether or not the match
  1338. operation should be applied to a record field or not.
  1339.  
  1340. A match would mean that the entire string `TEXT' is used up in matching
  1341. the `PATTERN' and conversely the matched `TEXT' uses up the entire
  1342. `PATTERN'.
  1343.  
  1344. The match function supports the following formats in the match string:
  1345.    * `'*'' matches any sequence of characters (zero or more)
  1346.  
  1347.    * `'?'' matches any character
  1348.  
  1349.    * `'\'' suppresses syntactic significance of a special character
  1350.  
  1351.    * `[SET]' matches any character in the specified set,
  1352.  
  1353.    * `[!SET]' or `[^SET]' matches any character not in the specified
  1354.      set.
  1355.  
  1356. A set is composed of characters or ranges; a range looks like
  1357. 'character hyphen character' (as in 0-9 or A-Z).  `[0-9a-zA-Z_]' is the
  1358. minimal set of characters allowed in the `[..]' pattern construct.
  1359.  
  1360. To suppress the special syntactic significance of any of `'[]*?!^-\'',
  1361. and match the character exactly, precede it with a `'\''.
  1362.  
  1363.  
  1364. Group match
  1365. ------------
  1366.  
  1367. Use the Group checkboxes of the `Group match' controls to indicate
  1368. whether a record should match a group or not. A record matches, if it
  1369. is assigned to a group which is checked in this control group.
  1370.  
  1371.  
  1372. Sort dialogbox
  1373. ===============
  1374.  
  1375. The `Sort dialogbox' is accessible through
  1376.    * the Sort... menu item in the `Process menu' (Shortcut: `ramiga r'),
  1377.  
  1378. In this dialogbox, the three sort modes for the current database may be
  1379. changed. The dialogbox consists of three controls:
  1380.  
  1381. Use the Sort mode cycle to select which sort mode should be changed.
  1382. There are three sort modes available.
  1383.  
  1384. Use the Sort direction cycle to select, whether the current database
  1385. should be sorted in `ascending' and `descending' direction.
  1386.  
  1387. From the Index list, you may select the appropriate `sort index'.
  1388.  
  1389. By pushing the 'OK' button, the database will be resorted in the
  1390. desired way. Use Default to return to the predefined values: ascending
  1391. direction by index Name for the first sort mode, Name 2 and Place as
  1392. second and third modes, each of which in ascending direction. The first
  1393. sort mode is displayed in the title bar of the main window.
  1394.  
  1395.  
  1396. ARexx dialogbox
  1397. ================
  1398.  
  1399. The `ARexx dialogbox' is accessible through
  1400.    * the Set ARexx scripts... menu item in the `ARexx menu'.
  1401.  
  1402. The `ARexx dialogbox' is used to manage the list of ARexx scripts,
  1403. executable directly froom the `ARexx menu'.
  1404.  
  1405. In the Available scripts listview, the ARexx script entries that are
  1406. added to the `ARexx menu' are listed. An ARexx script entry consists of
  1407. an Alias name and the Path name of the ARexx script. It is the Alias,
  1408. which is displayed as a menu item in the `Arexx menu': click on
  1409. appropriate menu item to execute corresponding an ARexx script.
  1410.  
  1411. Use Drag & drop to sort the entries in the list. The maximum number of
  1412. entries is 20.
  1413.  
  1414. The Add and Edit buttons below the listview are used to create / change
  1415. an ARexx script entry in a separate dialogbox. Use Remove to delete the
  1416. highlighted or all ARexx script entries from the list.
  1417.  
  1418. Save as and Load are used to store and restore a specific list of ARexx
  1419. script entries. Use Append to append a stored list to the current one.
  1420.  
  1421. To close dialogbox, use
  1422.  
  1423. Save to write current setup to application preferences (Preferences).
  1424.  
  1425. Use to accept current setup, but do not store it for later use.
  1426.  
  1427. Cancel to forget changes.
  1428.  
  1429.  
  1430. Preferences dialogbox
  1431. ======================
  1432.  
  1433. The `Preferences dialogbox' is accessible through
  1434.    * the Change preferences... menu item in the `Process menu'.
  1435.  
  1436. The preferences items are splitted into four page groups of the
  1437. `Preferences dialogbox':
  1438.  
  1439.    * in the Free field names page, the names if the four user definable
  1440.      (`FreeX') record fields may be changed.
  1441.  
  1442.    * Go to the Group definition page to change the names of the 10
  1443.      groups using the textfields on this page.
  1444.  
  1445.    * The Listview format page consists mainly of two listview field.
  1446.      Drag & Drop the fields you like to view from the Available fields
  1447.      list to the Visible fields list. Sort the visible fields by drag &
  1448.      Drop. In addition, information concerning size of the field and
  1449.      column formatting is provided in this list.
  1450.  
  1451.      Use the Size slider to change the column size in %. Check the Use
  1452.      Tab checkmark to create a new column for the highlighted field.
  1453.      Otherwise this field's data is displayed together with the
  1454.      previous field.
  1455.  
  1456.      Check the Draw vertical border checkmark to separate the columns
  1457.      in the listview by lines.
  1458.  
  1459.    * Use the Application page to change program specific preferences:
  1460.      decide to save project files with an icon or have a 'Save
  1461.      reminding' requester popped up when a record is changed.
  1462.  
  1463. To restore standard values for preferences data in this dialogbox, AA
  1464. offers both, global dialogbox (the Default all button) and dialog page
  1465. oriented (Default reset of preferences data.
  1466.  
  1467. Use Save to write setup to application preferences: the set of
  1468. preferences data is used after startup and in new database
  1469. (Preferences).
  1470.  
  1471. i
  1472.  
  1473.  
  1474. ARexx
  1475. ******
  1476.  
  1477.  
  1478. ARexx Introduction
  1479. ===================
  1480.  
  1481. ARexx is a powerful script language widely spread on the Amiga
  1482. computer. Many applications sport a so called ARexx interface. ARexx
  1483. provides a standard to externally control applications and exchange
  1484. data with these applications.
  1485.  
  1486. In AA, nearly every command accessible in the GUI is also available in
  1487. ARexx scripts. An there are even some more.
  1488.  
  1489. All ARexx interface specific commands in AA are collected in the ARexx
  1490. menu. ARexx Menu in the Menu reference for more details. This way AA
  1491. sports the commodity to start ARexx scripts from a menu: You may put
  1492. favorite scripts into the `ARexx menu', where they may easily executed.
  1493.  
  1494.  
  1495. ARexx commands
  1496. ===============
  1497.  
  1498.  
  1499. Command argument standards
  1500. ---------------------------
  1501.  
  1502. Each command template is given in the standard DOS ReadArg form.  That 
  1503. is  each argument  name is given separated by commas with flags
  1504. specified (separated by a /). Within an `ARexx' script command
  1505. arguments should be separated by space (not commas). The flag
  1506. definitions are as follows:
  1507.  
  1508.      Flag    Definition
  1509.  
  1510.      /K      Keyword required.
  1511.      /A      Argument required.
  1512.      /F      Final argument. The remainder of the line will be set to this argument.
  1513.      /M      Multiple arguments (separated by space).
  1514.      /S      Switch argument.
  1515.  
  1516. Note that some string arguments shown in the examples are surrounded by
  1517. two sets of  quotes  (consisting of a pair of single quotes and a pair
  1518. of double quotes). The general rule of thumb is if the argument is the
  1519. final argument (indicated by a  /F  in  the command template) then only
  1520. a single pair of quotes is necessary. Otherwise, if the string contains
  1521.  spaces  then  the  two  sets  of  quotes  are necessary. The reason
  1522. for this is that `ARexx' tries to interpret every token it encounters.
  1523. If the token is surrounded by quotes then the token  is  interpreted by
  1524. removing the quotes and leaving the enclosed string intact. Likewise,
  1525. the DOS ReadArgs function (used by `MUI' to parse incoming `ARexx'
  1526. command lines) parses arguments  separated  by spaces, therefore,
  1527. strings with spaces must by enclosed by quotes (hence, the need for the
  1528. two sets of quotes). An exception is  if  the argument is designated as
  1529. the final argument in which case the ReadArgs function will set the
  1530. remainder of the command line as the final argument.
  1531.  
  1532.  
  1533. MUI standard commands
  1534. ----------------------
  1535.  
  1536. * quit `FORCE/S'
  1537.      This command will end AA, closing windows and freeing all
  1538.      associated memory.  Note that if a script fails the application
  1539.      may still actually be running.  Use this command to end the
  1540.      process by using an inline `ARexx' command (e.g.  issue `rx
  1541.      "address [portname] quit"' from a shell).
  1542.  
  1543. * hide
  1544.      Hides (iconifies) the application.
  1545.  
  1546. * show
  1547.      Shows (pops up) an iconified application.
  1548.  
  1549. * info `ITEM/A'
  1550.      According to the given parameter the result string is filled with
  1551.      the following contents (or something reasonably close):
  1552.     'title':
  1553.           AddressAssist
  1554.  
  1555.     'author':
  1556.           Alex H. Schneider
  1557.  
  1558.     'copyright':
  1559.           Copyright ©1994-1996, Quarz Development
  1560.  
  1561.     'description':
  1562.           Database application.
  1563.  
  1564.     'version'
  1565.           Current version string.
  1566.  
  1567.     'base':
  1568.           Name of the ARexx port
  1569.  
  1570.     'screen':
  1571.           Name of the public screen
  1572.  
  1573. * help `FILE/A'
  1574.      A list of all `ARexx' commands available for the application is
  1575.      written into the given file.  In addition to the default commands
  1576.      an MUI application can (and of course should) support many
  1577.      application specific commands.  The help list will contain these
  1578.      commands as well.
  1579.  
  1580. Application specific commands
  1581. -----------------------------
  1582.  
  1583.  
  1584. newdatabase
  1585. ............
  1586.  
  1587. SYNTAX
  1588.      NewDatabase     `"Name"'
  1589.  
  1590. FUNCTION
  1591.      This function creates a new database named `Name' and removes the
  1592.      current database from memory.
  1593.  
  1594. PARAMETERS
  1595.     Name:
  1596.           Name of database
  1597.  
  1598. RETURN
  1599.      always RC = 0
  1600.      with RESULT = <name of database>
  1601.  
  1602. SEE ALSO
  1603.      loaddatabase, savedatabase
  1604.  
  1605.  
  1606. loaddatabase
  1607. .............
  1608.  
  1609. SYNTAX
  1610.      LoadDatabase    `"Filename"'
  1611.  
  1612. FUNCTION
  1613.      Reads a database from disk after removing the current database
  1614.      from memory.
  1615.  
  1616. PARAMETERS
  1617.     Filename:
  1618.           Name of Database file to load. Getfilename dialog will open,
  1619.           if not specified.
  1620.  
  1621. RETURN
  1622.      RC = 0, if successful; RC > 0, if failed to load database. with
  1623.      RESULT = <name of database>
  1624.  
  1625. SEE ALSO
  1626.      loaddatabase, savedatabase
  1627.  
  1628.  
  1629. savedatabase
  1630. .............
  1631.  
  1632. SYNTAX
  1633.      SaveDatabase    `"Name"'
  1634.  
  1635. FUNCTION
  1636.      Writes current database to disk.
  1637.  
  1638. PARAMETERS
  1639.     Filename:
  1640.           Name of Database file. If not supplied, this function uses
  1641.           default filename specified in `newdatabase', else opens the
  1642.           Getfilename dialog to request filename from user.
  1643.  
  1644. RETURN
  1645.      RC = 0, if successful; RC > 0, if database not saved. with RESULT
  1646.      = <name of database>
  1647.  
  1648. SEE ALSO
  1649.      loaddatabase, newdatabase
  1650.  
  1651.  
  1652. print
  1653. ......
  1654.  
  1655. NAME
  1656.      Print
  1657.  
  1658. SYNTAX
  1659.      Print
  1660.     
  1661.     
  1662.     
  1663.     
  1664.     
  1665.     
  1666.     
  1667.     
  1668.      'S=SelectedOnly/S,C=CurrentOnly/S,D=Dialog/S,P=PrefsFilename/K,OutFilename'
  1669.  
  1670. FUNCTION
  1671.      Print a set of record. You may use the previously saved print
  1672.      preferences for printing.
  1673.  
  1674. PARAMETERS
  1675.     SelectedOnly:
  1676.           Only selected record will be printed.
  1677.  
  1678.     CurrentOnly:
  1679.           Only the current record will be printed.
  1680.  
  1681.     Dialog:
  1682.           Open Print dialogbox.
  1683.  
  1684.     PrefsFilename:
  1685.           Name of print preferences to use for printing.
  1686.  
  1687.     OutFilename:
  1688.           Name of output file, supply only when printing to a file.
  1689.  
  1690. RETURN
  1691.      always RC = 0
  1692.  
  1693. SEE ALSO
  1694.      Print dialogbox
  1695.  
  1696.  
  1697. newrecord
  1698. ..........
  1699.  
  1700. SYNTAX
  1701.      NewRecord       `T=UseTemplate/S,NameFieldData/F/A'
  1702.  
  1703. FUNCTION
  1704.      This function creates a new record, which is set as the current
  1705.      one. You may and have to specify only the `Name' data of the
  1706.      record. Use `setrecorddata' function to set the new record's other
  1707.      fields.
  1708.  
  1709. PARAMETERS
  1710.     UseTemplate:
  1711.           Switch to create record using Template data instead of empty
  1712.           record.
  1713.  
  1714.     NameFieldData:
  1715.           Record name entry.
  1716.  
  1717. RETURN
  1718.      always RC = 0
  1719.  
  1720. SEE ALSO
  1721.      setrecorddata
  1722.  
  1723.  
  1724. getrecorddata
  1725. ..............
  1726.  
  1727. SYNTAX
  1728.      GetRecordData   `FieldID/N/A,R=Record/K/N,S=Selected/S'
  1729.  
  1730. FUNCTION
  1731.      This is the main function retrieving record data from a specific
  1732.      record entry. Use the numeric argument `FieldID' to access desired
  1733.      record field. memory.
  1734.  
  1735. PARAMETERS
  1736.     FieldID:
  1737.           Record field id, ranging from 0 = Salutation to 14 = Remark
  1738.           2. See above and example scripts for details.
  1739.  
  1740.     Record:
  1741.           Number of record, counted from 0 for the first record in the
  1742.           current sort mode. If `Selected' is switched, only the
  1743.           selected records are counted.         To sepcify the current
  1744.           record, do not supply this keyword.
  1745.  
  1746.     Selected:
  1747.           See `Record'.
  1748.  
  1749. RETURN
  1750.      RESULT = <record field data>, if success (RC = 0)
  1751.      or RESULT = `result', RC > 0
  1752.  
  1753. SEE ALSO
  1754.      setrecorddata, formatrecordstring
  1755.  
  1756.  
  1757. setrecorddata
  1758. ..............
  1759.  
  1760. SYNTAX
  1761.      SetRecordData   `FieldID/N/A,R=Record/K/N,S=Selected/S,Text/F'
  1762.  
  1763. FUNCTION
  1764.      This is the function for changing record data of a specific record
  1765.      entry. Use the numeric argument `FieldID' to access desired record
  1766.      field. memory.
  1767.  
  1768. PARAMETERS
  1769.     FieldID:
  1770.           Record field id, ranging from 0 = Salutation to 14 = Remark
  1771.           2. See above and example scripts for details.
  1772.  
  1773.     Record:
  1774.           Number of record, counted from 0 for the first record in the
  1775.           current sort mode. If `Selected' is switched, only the
  1776.           selected records are counted.         To sepcify the current
  1777.           record, do not supply this keyword.
  1778.  
  1779.     Selected:
  1780.           See `Record'.
  1781.  
  1782.     Text:
  1783.           Text data to assign to the record field. Supply linefeeds
  1784.           (LF) only in the Remark fields.
  1785.  
  1786. RETURN
  1787.      if success (RC = 0), else RC > 0
  1788.  
  1789. SEE ALSO
  1790.      getrecorddata
  1791.  
  1792.  
  1793. duplicaterecord
  1794. ................
  1795.  
  1796. SYNTAX
  1797.      DuplicateRecord `Record/N,S=Selected/S'
  1798.  
  1799. FUNCTION
  1800.      This function duplicates the record specified by the numeric
  1801.      argument `Record' and the `Selected' switch. Give no arguments to
  1802.      duplicate current record.
  1803.  
  1804. PARAMETERS
  1805.     Record:
  1806.           Number of the record; counted from 0, which is the first
  1807.           record, using the current sort mode. If `Selected' is
  1808.           switched, only the selected records are counted.
  1809.  
  1810.     Selected:
  1811.           See `Record'.
  1812.  
  1813. RETURN
  1814.      if success (RC = 0), else RC > 0
  1815.  
  1816. SEE ALSO
  1817.      Record Menu
  1818.  
  1819.  
  1820. removerecord
  1821. .............
  1822.  
  1823. SYNTAX
  1824.      RemoveRecord    `Record/N,S=Selected/S'
  1825.  
  1826. FUNCTION
  1827.      This function removes the record specified by the numeric argument
  1828.      `Record' and the `Selected' switch from database memory. Give no
  1829.      arguments to remove current record.     The record will be removed
  1830.      immediately without any confirmation dialogbox!
  1831.  
  1832. PARAMETERS
  1833.     Record:
  1834.           Number of the record; counted from 0, which is the first
  1835.           record, using the current sort mode. If `Selected' is
  1836.           switched, only the selected records are counted.
  1837.  
  1838.     Selected:
  1839.           See `Record'.
  1840.  
  1841. RETURN
  1842.      if success (RC = 0), else RC > 0
  1843.  
  1844. SEE ALSO
  1845.      Record Menu
  1846.  
  1847.  
  1848. savetemplate
  1849. .............
  1850.  
  1851. SYNTAX
  1852.      SaveTemplate    `Record/N,S=Selected/S'
  1853.  
  1854. FUNCTION
  1855.      This function saves the specified record as `Record template'.
  1856.      Record templates are useful, when creating new records which a
  1857.      similar data. Give no arguments to save current record, or use the
  1858.      numeric argument `Record' and the `Selected' switch to specify the
  1859.      desired record.
  1860.  
  1861. PARAMETERS
  1862.     Record:
  1863.           Number of the record; counted from 0, which is the first
  1864.           record, using the current sort mode. If `Selected' is
  1865.           switched, only the selected records are counted.
  1866.  
  1867.     Selected:
  1868.           See `Record'.
  1869.  
  1870. RETURN
  1871.      if success (RC = 0), or RC > 0 if no record found.
  1872.  
  1873. SEE ALSO
  1874.      Record template
  1875.  
  1876.  
  1877. copytoclip
  1878. ...........
  1879.  
  1880. SYNTAX
  1881.      CopyToClip      `Record/N,S=Selected/S'
  1882.  
  1883. FUNCTION
  1884.      This function copies the data of the specified record to the Amiga
  1885.      clipboard. Give no arguments to save current record, or use the
  1886.      numeric argument `Record' and the `Selected' switch to specify the
  1887.      desired record.
  1888.  
  1889. PARAMETERS
  1890.     Record:
  1891.           Number of the record; counted from 0, which is the first
  1892.           record, using the current sort mode. If `Selected' is
  1893.           switched, only the selected records are counted.
  1894.  
  1895.     Selected:
  1896.           See `Record'.
  1897.  
  1898. RETURN
  1899.      if success (RC = 0), or RC > 0 if no record found.
  1900.  
  1901. SEE ALSO
  1902.      Record Menu
  1903.  
  1904.  
  1905. getrecordgroups
  1906. ................
  1907.  
  1908. SYNTAX
  1909.      GetRecordGroups `R=Record/K/N,S=Selected/S'
  1910.  
  1911. FUNCTION
  1912.      Use this function to retrieve record group data from a specific
  1913.      record entry. Give no arguments to retrieve data from current
  1914.      record, or use the numeric argument `Record' and the `Selected'
  1915.      switch to specify the desired record.
  1916.  
  1917. PARAMETERS
  1918.     Record:
  1919.           Number of the record; counted from 0, which is the first
  1920.           record, using the current sort mode. If `Selected' is
  1921.           switched, only the selected records are counted.
  1922.  
  1923.     Selected:
  1924.           See `Record'.
  1925.  
  1926. RETURN
  1927.      if success (RC = 0), or RC > 0 if no record found.
  1928.  
  1929. SEE ALSO
  1930.      Record groups
  1931.  
  1932.  
  1933. setrecordgroups
  1934. ................
  1935.  
  1936. SYNTAX
  1937.      SetRecordGroups
  1938.     
  1939.     
  1940.     
  1941.     
  1942.     
  1943.     
  1944.      'R=Record/K/N,S=Selected/S,A=AllSelected/S,G1/S,...,G10/S,G=GroupsID/K/N'
  1945.  
  1946. FUNCTION
  1947.      This function changes group data either of the specified or of all
  1948.      selected records. There are two ways to supply the record group
  1949.      data: The easiest way is to use the Gx switches for the groups you
  1950.      like to be assigned to the record. However, this way you get a lot
  1951.      of function parameters. Therefore you may give directly the
  1952.      numeric value `GroupsID', which incorporates all the group data in
  1953.      one value. See below to learn how the `GroupIDs' value is used.
  1954.  
  1955.      If the `Record' / `Selected' and `AllSelected' keywords are not
  1956.      used, this function will change the current record.
  1957.  
  1958. PARAMETERS
  1959.     Record:
  1960.           Number of the record; counted from 0, which is the first
  1961.           record, using the current sort mode. If `Selected' is
  1962.           switched, only the selected records are counted.
  1963.  
  1964.     Selected:
  1965.           See `Record'.
  1966.  
  1967.     AllSelected:
  1968.           Check to edit all selected and not only the current one.
  1969.  
  1970.     G1..Gx...G10:
  1971.           Use the Gx switches to assign a record to one or several
  1972.           groups, where x is the ID of group counting from 1 to 10
  1973.           equal the         number in AA.
  1974.  
  1975.     GroupsID:
  1976.           A numeric value, that incorporates a set of Groups.
  1977.           `GroupsID' is defined as follows. Use 1=G1, 2=G2, 4=G3, say
  1978.           2^(x-1)=Gx as group values and do a simple addition        
  1979.           of the desired group values. Example: G3+G4+G10 = 524 = 2^2 +
  1980.           2^3 + 2^9.
  1981.  
  1982. RETURN
  1983.      if success (RC = 0), or RC > 0 if no record found.
  1984.  
  1985. SEE ALSO
  1986.      Record groups
  1987.  
  1988.  
  1989. removeduplicaterecords
  1990. .......................
  1991.  
  1992. SYNTAX
  1993.      RemoveDuplicateRecords `D=Dialog/S'
  1994.  
  1995. FUNCTION
  1996.      This function removes duplicate (redundant) records from the
  1997.      current database.
  1998.  
  1999. PARAMETERS
  2000.     Dialog:
  2001.           Use this switch get a dialogbox appearing for each record to
  2002.           be removed.  Otherwise all duplicate records will be removed
  2003.           without any confirmation.
  2004.  
  2005. RETURN
  2006.      RC = 0, if there are no more duplicate records in the database.
  2007.      Otherwise RC > 0.
  2008.  
  2009. SEE ALSO
  2010.      Process Menu
  2011.  
  2012.  
  2013. formatrecordstring
  2014. ...................
  2015.  
  2016. SYNTAX
  2017.      FormatRecordString `R=Record/N/K,S=Selected/S,FormatString/F/A'
  2018.  
  2019. FUNCTION
  2020.      This function is useful to retrieve record data formatted in a
  2021.      C-language (sprintf) way. See below for supported shortcuts. Give
  2022.      no arguments to retrieve data from current record, or use the
  2023.      numeric argument `Record' and the `Selected' switch to specify the
  2024.      desired record.
  2025.  
  2026. PARAMETERS
  2027.     Record:
  2028.           Number of the record; counted from 0, which is the first
  2029.           record, using the current sort mode. If `Selected' is
  2030.           switched, only the selected records are counted.
  2031.  
  2032.     Selected:
  2033.           See `Record'.
  2034.  
  2035.     FormatString:
  2036.           Text with control sequences to retrieve record data.
  2037.           Currently only the following control sequence are supported: 
  2038.                  `%fx', where x is the Record field id, ranging from 0
  2039.           = Salutation to 14 = Remark 2.         Example `%f2 %f1,
  2040.           living at %f3 in %f5.\ne-mail is %f8'.
  2041.  
  2042. RETURN
  2043.      if success (RC = 0), or RC > 0 if no record found.
  2044.  
  2045. SEE ALSO
  2046.      Example ARexx scripts.
  2047.  
  2048.  
  2049. selectall
  2050. ..........
  2051.  
  2052. SYNTAX
  2053.      SelectAll
  2054.  
  2055. FUNCTION
  2056.      This function adds all records to the selection.
  2057.  
  2058. PARAMETERS
  2059. RETURN
  2060.      always RC = 0.
  2061.  
  2062. SEE ALSO
  2063.      selectnone, selecttoggle
  2064.      , selectstring, selectgroup
  2065.      Record selection
  2066.  
  2067.  
  2068. selectnone
  2069. ...........
  2070.  
  2071. SYNTAX
  2072.      SelectNone
  2073.  
  2074. FUNCTION
  2075.      This function removes all records from the selection.
  2076.  
  2077. PARAMETERS
  2078. RETURN
  2079.      always RC = 0.
  2080.  
  2081. SEE ALSO
  2082.      selectall, selecttoggle
  2083.      , selectstring, selectgroup
  2084.      Record selection
  2085.  
  2086.  
  2087. selecttoggle
  2088. .............
  2089.  
  2090. SYNTAX
  2091.      SelectToggle
  2092.  
  2093. FUNCTION
  2094.      This function selects or deselects the current record, depending
  2095.      on its selection state.
  2096.  
  2097. PARAMETERS
  2098. RETURN
  2099.      always RC = 0.
  2100.  
  2101. SEE ALSO
  2102.      selectall, selecttoggle
  2103.      , selectstring, selectgroup
  2104.      Record selection
  2105.  
  2106.  
  2107. selectstring
  2108. .............
  2109.  
  2110. SYNTAX
  2111.      SelectString
  2112.      `X=Exclude/S,T=Toggle/S,D=Dialog/S,F=FieldFlags/N/K,MatchString/F'
  2113.  
  2114. FUNCTION
  2115.      Use this function to filter records to or from a selection using
  2116.      the string match filter (Field string match).
  2117.  
  2118. PARAMETERS
  2119.     Exclude:
  2120.     Toggle:
  2121.           Action switches. Use `Exclude' to remove matching records
  2122.           from selection or `Toggle' to switch their selection state.
  2123.           If no action switch is given, matching records will be added
  2124.           to the selection.
  2125.  
  2126.     Dialog:
  2127.           Use this switch to open the Filter dialogbox from ARexx
  2128.           scripts.
  2129.  
  2130.     FieldFlags:
  2131.           This numerical argument is a representation of a set or
  2132.           record fields to match. Ommit this keyword to search in all
  2133.           record fields.
  2134.  
  2135.     MatchString:
  2136.           Match string with control sequences. See Field string match,
  2137.           for match string format.
  2138.  
  2139. RETURN
  2140.      RC = 0 if success, RC > 0 when failing.
  2141.  
  2142. KNOWN BUGS
  2143.      The FieldFlags keyword does not work correct. This will be fixed
  2144.      in the next release.
  2145.  
  2146. SEE ALSO
  2147.      Filter dialogbox
  2148.  
  2149. selectgroup
  2150. ............
  2151.  
  2152. SYNTAX
  2153.      SelectGroup
  2154.     
  2155.     
  2156.     
  2157.     
  2158.     
  2159.     
  2160.     
  2161.     
  2162.     
  2163.     
  2164.     
  2165.     
  2166.     
  2167.     
  2168.     
  2169.     
  2170.     
  2171.     
  2172.     
  2173.     
  2174.     
  2175.     
  2176.     
  2177.     
  2178.     
  2179.     
  2180.     
  2181.     
  2182.     
  2183.     
  2184.     
  2185.     
  2186.     
  2187.     
  2188.      `X=Exclude/S,T=Toggle/S,D=Dialog/S,G1/S,G2/S,G3/S,G4/S,G5/S,G6/S,G7/S,G8/S,G9/S,G10/S,G=GroupsID/K/N'
  2189.  
  2190. FUNCTION
  2191.      Use this function to filter records to or from a selection by
  2192.      their group assignment (Group match). There are two ways to
  2193.      indicate the set of groups: The easiest way is to use the Gx
  2194.      switches for the groups. However, this way you get a lot of
  2195.      function parameters. Therefore you may give directly the numeric
  2196.      value `GroupsID', which incorporates all the groups in one value.
  2197.      See below to learn how the `GroupIDs' value is used.
  2198.  
  2199. PARAMETERS
  2200.     Exclude:
  2201.     Toggle:
  2202.           Action switches. Use `Exclude' to remove matching records
  2203.           from selection or `Toggle' to switch their selection state.
  2204.           If no action switch is given, matching records will be added
  2205.           to the selection.
  2206.  
  2207.     Dialog:
  2208.           Use this switch to open the Filter dialogbox from ARexx
  2209.           scripts.
  2210.  
  2211.     G1..Gx...G10:
  2212.           Use the Gx switches to indicate the set of groups that should
  2213.           match. x is the ID of group counting from 1 to 10 equal the  
  2214.                 number in AA.
  2215.  
  2216.     GroupsID:
  2217.           A numeric value, that incorporates a set of Groups.
  2218.           `GroupsID' is defined as follows. Use 1=G1, 2=G2, 4=G3, say
  2219.           2^(x-1)=Gx as group values and do a simple addition        
  2220.           of the desired group values. Example: G3+G4+G10 = 524 = 2^2 +
  2221.           2^3 + 2^9.
  2222.  
  2223. RETURN
  2224.      RC = 0 if success, RC > 0 when failing.
  2225.  
  2226. SEE ALSO
  2227.      Filter dialogbox
  2228.  
  2229. removeselection
  2230. ................
  2231.  
  2232. SYNTAX
  2233.      RemoveSelection `D=Dialog/S'
  2234.  
  2235. FUNCTION
  2236.      This function removes all selected records from the database.
  2237.  
  2238. PARAMETERS
  2239.     Dialog:
  2240.           Use this switch to open a dialogbox for user prompt.
  2241.  
  2242. RETURN
  2243.      RC = 0 if success, RC > 0 when failing.
  2244.  
  2245. SEE ALSO
  2246.      selectall, selecttoggle
  2247.      , selectstring, selectgroup
  2248.      Record selection
  2249.  
  2250.  
  2251. find
  2252. .....
  2253.  
  2254. SYNTAX
  2255.      Find `Key/A,F=Field/N/K,N=Next/S,S=Selected/S,D=Dialog/S'
  2256.  
  2257. FUNCTION
  2258.      This function performs the string search to find a record.
  2259.  
  2260. PARAMETERS
  2261.     Key:
  2262.           Key string.
  2263.  
  2264.     Field:
  2265.           Numerical value with field ID, indicating the field that
  2266.           should match the key string.
  2267.  
  2268.     Next:
  2269.           Supply this switch to find next record, using current key
  2270.           string.
  2271.  
  2272.     Selected:
  2273.           If this switch is supplied, only the selected records will be
  2274.           searched. The number of the return record applies to the
  2275.           selected records.
  2276.  
  2277.     Dialog:
  2278.           Use this switch to prompt the users for key string.
  2279.  
  2280. RETURN
  2281.      Number of the record found. If `Selected' is switched, then the
  2282.      returned number applies to the selected records.
  2283.  
  2284. SEE ALSO
  2285.      Find a record
  2286.  
  2287.  
  2288. sort
  2289. .....
  2290.  
  2291. SYNTAX
  2292.      Find
  2293.     
  2294.     
  2295.     
  2296.     
  2297.     
  2298.     
  2299.     
  2300.     
  2301.     
  2302.     
  2303.     
  2304.     
  2305.     
  2306.     
  2307.     
  2308.     
  2309.     
  2310.      `Index1/K/N,Descend1/K/S,Index2/K/N,Descend2/K/S,Index3/K/N,Descend3/K/S,D=Dialog/S'
  2311.  
  2312. FUNCTION
  2313.      Use the `Sort' function change sort index and order of the
  2314.      database. You may call this function several times to sort with
  2315.      mulitple indices and directions.
  2316.  
  2317. PARAMETERS
  2318.     IndexX:
  2319.           Numerical representation of the record field to sort for. X
  2320.           is the number of the sort order. The record field value
  2321.           ranges from 0 = Salutation to 14 = Remark 2.
  2322.  
  2323.     DescendX:
  2324.           Use this switch to sort in descending order.
  2325.  
  2326.     Dialog:
  2327.           Use this switch to open the sort dialogbox.
  2328.  
  2329. RETURN
  2330.      RC = 0 if success, RC > 0 when failing.
  2331.  
  2332. SEE ALSO
  2333.      Database sort
  2334.      Sort dialogbox
  2335.  
  2336. next
  2337. .....
  2338.  
  2339. SYNTAX
  2340.      Next
  2341.  
  2342. FUNCTION
  2343.      Function moves to next record in the database and sets it as the
  2344.      current one.
  2345.  
  2346. PARAMETERS
  2347. RETURN
  2348.      always return RC = 0
  2349.  
  2350. SEE ALSO
  2351.      previous, first, last
  2352.  
  2353. previous
  2354. .........
  2355.  
  2356. SYNTAX
  2357.      Previous
  2358.  
  2359. FUNCTION
  2360.      Function moves to the previous record in the database and sets it
  2361.      as the current one.
  2362.  
  2363. PARAMETERS
  2364. RETURN
  2365.      always return RC = 0
  2366.  
  2367. SEE ALSO
  2368.      next, first, last
  2369.  
  2370. first
  2371. ......
  2372.  
  2373. SYNTAX
  2374.      First
  2375.  
  2376. FUNCTION
  2377.      Function moves to the first record in the database and sets it as
  2378.      the current one.
  2379.  
  2380. PARAMETERS
  2381. RETURN
  2382.      always return RC = 0
  2383.  
  2384. SEE ALSO
  2385.      next, previous, last
  2386.  
  2387. last
  2388. .....
  2389.  
  2390. SYNTAX
  2391.      Last
  2392.  
  2393. FUNCTION
  2394.      Function moves to the last record in the database and sets it as
  2395.      the current one.
  2396.  
  2397. PARAMETERS
  2398. RETURN
  2399.      always return RC = 0
  2400.  
  2401. SEE ALSO
  2402.      next, previous, first
  2403.  
  2404. current
  2405. ........
  2406.  
  2407. SYNTAX
  2408.      Current `Record/N,S=Selected/S'
  2409.  
  2410. FUNCTION
  2411.      Function moves to specified record and sets it as the current one.
  2412.  
  2413. PARAMETERS
  2414.     Record:
  2415.           Number of the record; counted from 0, which is the first
  2416.           record, using the current sort mode. If `Selected' is
  2417.           switched, only the selected records are counted.
  2418.  
  2419.     Selected:
  2420.           See `Record'.
  2421.  
  2422. RETURN
  2423.      always RC = 0
  2424.  
  2425. SEE ALSO
  2426.      next, previous
  2427.  
  2428. getgroupname
  2429. .............
  2430.  
  2431. SYNTAX
  2432.      SetGroupname `G1/S,...,G10/S'
  2433.  
  2434. FUNCTION
  2435.      Use this function to retrieve the name of a specific record group.
  2436.  
  2437. PARAMETERS
  2438.     G1..Gx...G10:
  2439.           Use exactly one of the Gx switches to indicate the group;
  2440.           where x is the ID of the group counting from 1 to 10.
  2441.  
  2442. RETURN
  2443.      if success, RC = 0 with RESULT = <name of group>
  2444.      on error, RC > 0
  2445.  
  2446. SEE ALSO
  2447.      Record groups
  2448.  
  2449.  
  2450. setgroupname
  2451. .............
  2452.  
  2453. SYNTAX
  2454.      SetGroupname `G1/S,...,G10/S,Name/F'
  2455.  
  2456. FUNCTION
  2457.      This function changes the name of the record group specified with
  2458.      one `Gx' switch.
  2459.  
  2460. PARAMETERS
  2461.     G1..Gx...G10:
  2462.           Use exactly one of the Gx switches to indicate the group;
  2463.           where x is the ID of the group counting from 1 to 10.
  2464.  
  2465.     Name:
  2466.           Text parameter, containing the new name of the group.
  2467.  
  2468. RETURN
  2469.      if success, RC = 0 else RC > 0
  2470.  
  2471. SEE ALSO
  2472.      Record groups
  2473.  
  2474.  
  2475. getfreename
  2476. ............
  2477.  
  2478. SYNTAX
  2479.      GetFreename `F1/S,...,F4/S'
  2480.  
  2481. FUNCTION
  2482.      Use this function to retrieve the name of a specific FreeX record
  2483.      field.
  2484.  
  2485. PARAMETERS
  2486.     F1/S,...,F4/S:
  2487.           Use exactly one of the Fx switches to indicate the field to
  2488.           be changed; where x is the ID of the FreeX record field
  2489.           counting from 1 to 4.
  2490.  
  2491. RETURN
  2492.      if success, RC = 0 with RESULT = <name of field>
  2493.      on error, RC > 0
  2494.  
  2495. SEE ALSO
  2496.      User definable fields
  2497.  
  2498.  
  2499. setfreename
  2500. ............
  2501.  
  2502. SYNTAX
  2503.      SetFreename `F1/S,...,F4/S,Name/F'
  2504.  
  2505. FUNCTION
  2506.      This function changes the name of the FreeX record field specified
  2507.      with one `Fx' switch.
  2508.  
  2509. PARAMETERS
  2510.     F1/S,...,F4/S:
  2511.           Use exactly one of the Fx switches to indicate the field;
  2512.           where x is the ID of the FreeX record field counting from 1
  2513.           to 4.
  2514.  
  2515.     Name:
  2516.           Text parameter, containing the new name of the field.
  2517.  
  2518. RETURN
  2519.      if success, RC = 0 else RC > 0
  2520.  
  2521. SEE ALSO
  2522.      User definable fields
  2523.  
  2524.  
  2525. getnumofrecords
  2526. ................
  2527.  
  2528. SYNTAX
  2529.      GetNumofRecords `S=Selected/S'
  2530.  
  2531. FUNCTION
  2532.      Use this function to retrieve the number of all or only the
  2533.      selected records.
  2534.  
  2535. PARAMETERS
  2536.     Selected:
  2537.           If the `Selected' switch is supplied, the number of records
  2538.           in the selection is returned. Else the total number of
  2539.           records in the database is returned.
  2540.  
  2541. RETURN
  2542.      always RC = 0 with RESULT = <number of records>
  2543.  
  2544. SEE ALSO
  2545.  
  2546. savepath
  2547. .........
  2548.  
  2549. SYNTAX
  2550.      SavePath
  2551.  
  2552. FUNCTION
  2553.      This function saves the path of the current database as the
  2554.      default startup path, which is equal to using the `Save path' menu
  2555.      item from the `Project Menu'.
  2556.  
  2557. PARAMETERS
  2558. RETURN
  2559.      always RC = 0
  2560.  
  2561. SEE ALSO
  2562.  
  2563. setlistview
  2564. ............
  2565.  
  2566. SYNTAX
  2567.      SetListview
  2568.     
  2569.     
  2570.     
  2571.     
  2572.     
  2573.     
  2574.      `A=All/S,S=SelectedOnly/S,U=UnselectedOnly,G1/S,...,G10/S,G=GroupsID/K/N'
  2575.  
  2576. FUNCTION
  2577.      This function changes the set of records displayed in the Database
  2578.      list view.
  2579.  
  2580. PARAMETERS
  2581.     All:
  2582.           All records will be displayed.
  2583.  
  2584.     SelectedOnly:
  2585.           Only selected records will be displayed.
  2586.  
  2587.     UnselectedOnly:
  2588.           Only records not in the selection will be displayed.
  2589.  
  2590.     G1,...,G10:
  2591.           Use the Gx switches to indicate the set of groups that should
  2592.           match. x is the ID of group counting from 1 to 10 equal the  
  2593.                 number in AA.
  2594.  
  2595.     GroupsID:
  2596.           A numeric value, that incorporates a set of Groups.
  2597.           `GroupsID' is defined as follows. Use 1=G1, 2=G2, 4=G3, say
  2598.           2^(x-1)=Gx as group values and do a simple addition        
  2599.           of the desired group values. Example: G3+G4+G10 = 524 = 2^2 +
  2600.           2^3 + 2^9.
  2601.  
  2602. RETURN
  2603.      always RC = 0
  2604.  
  2605. SEE ALSO
  2606.      Database view
  2607.  
  2608.  
  2609. setview
  2610. ........
  2611.  
  2612. SYNTAX
  2613.      SetView `L=ListView/S,F=FormView/S'
  2614.  
  2615. FUNCTION
  2616.      Use this function to change the Database view type from `List
  2617.      view' to `Form view' or vice versa. Do not supply to any argument
  2618.      to toggle view type. Use the switches to ensure a specific view
  2619.      type.
  2620.  
  2621. PARAMETERS
  2622.     ListView:
  2623.     FormView:
  2624.           Switches the database view to the desired view type.
  2625.  
  2626. RETURN
  2627.      always RC = 0
  2628.  
  2629. SEE ALSO
  2630.      Database view
  2631.  
  2632.  
  2633. remark1window
  2634. ..............
  2635.  
  2636. SYNTAX
  2637.      Remark1Window `O=Open/S,C=Close/S'
  2638.  
  2639. FUNCTION
  2640.      This function opens or close the window containing the `Remark1'
  2641.      field.
  2642.  
  2643. PARAMETERS
  2644.     Open:
  2645.     Close:
  2646.           Action switches.
  2647.  
  2648. RETURN
  2649.      always RC = 0
  2650.  
  2651. SEE ALSO
  2652.      Database view
  2653.  
  2654.  
  2655. remark2window
  2656. ..............
  2657.  
  2658. SYNTAX
  2659.      Remark2Window `O=Open/S,C=Close/S'
  2660.  
  2661. FUNCTION
  2662.      This function opens or close the window containing the `Remark2'
  2663.      field.
  2664.  
  2665. PARAMETERS
  2666.     Open:
  2667.     Close:
  2668.           Action switches.
  2669.  
  2670. RETURN
  2671.      always RC = 0
  2672.  
  2673. SEE ALSO
  2674.      Database view
  2675.  
  2676.  
  2677. exportselection
  2678. ................
  2679.  
  2680. SYNTAX
  2681.      ExportSelection `D=Dialog/S,OutFilename'
  2682.  
  2683. FUNCTION
  2684.      This function exports the currently selected records as an AA
  2685.      database file. You may load these records as an own database
  2686.      project or import the into other database. In contrary to ASCII
  2687.      transfer, all preferences data (Group and FreeX names) as well as
  2688.      Record group information will be preserved.
  2689.  
  2690. PARAMETERS
  2691.     Dialog:
  2692.           Use this switch to open the filename dialogbox.
  2693.  
  2694.     OutFilename:
  2695.           Text argument containing filename of Database selection file.
  2696.  
  2697. RETURN
  2698.      RC = 0, if selection exported, else RC > 0
  2699.  
  2700. SEE ALSO
  2701.      Record selection
  2702.  
  2703.  
  2704. exportascii
  2705. ............
  2706.  
  2707. SYNTAX
  2708.      ExportASCII
  2709.     
  2710.     
  2711.     
  2712.     
  2713.     
  2714.     
  2715.     
  2716.     
  2717.     
  2718.      `S=SelectedOnly/S,C=CurrentOnly/S,D=Dialog/S,P=FormatFilename/K,OutFilename'
  2719.  
  2720. FUNCTION
  2721.      This function exports a set of records as an ASCII text file. Use
  2722.      the name of previously saved Export preferences (`*.xpref') to
  2723.      define the format of the export file.
  2724.  
  2725. PARAMETERS
  2726.     SelectedOnly:
  2727.     CurrentOnly:
  2728.           Use on of these switches to export only a specific set of
  2729.           records: `Selected' or `Current'. Ommit to export all records.
  2730.  
  2731.     Dialog:
  2732.           Use this switch to open the Transfer ASCII dialogbox.
  2733.  
  2734.     FormatFilename:
  2735.           Name of the format file. Supply either full path or only the
  2736.           filename. AA searches first in the current dir, the in the   
  2737.                        local (`Prefs/') and finally in the global
  2738.           (`envarc:AddressAssist/') preferences directory.
  2739.  
  2740.     OutFilename:
  2741.           Text argument containing filename of export file.
  2742.  
  2743. RETURN
  2744.      RC = 0, if selection exported, else RC > 0
  2745.  
  2746. SEE ALSO
  2747.      Record selection
  2748.  
  2749.  
  2750. importselection
  2751. ................
  2752.  
  2753. SYNTAX
  2754.      ImportSelection
  2755.      `S=Select/S,G1/S,...,G10/S,G=GroupsID/K/N,D=Dialog/S,InFilename'
  2756.  
  2757. FUNCTION
  2758.      Use this function to import the contents of an AA database file.
  2759.  
  2760. PARAMETERS
  2761.     Select:
  2762.           Switch to add imported records to the selection. Otherwise
  2763.           the imported records will not be selected.
  2764.  
  2765.     G1,...,G10:
  2766.           Switch a set of Gx switches, to assign the imported records
  2767.           to these groups. Note: The specified set of groups will be
  2768.           superimposed                 to the set of groups already
  2769.           assigned to the imported records. I.e. by ommitting Gx
  2770.           switches, the record groups will be preserved.
  2771.  
  2772.     GroupsID:
  2773.           Numberical value indicating the set of groups to assign to
  2774.           the imported records. This group information will be
  2775.           supoerimposed to the                 existing group
  2776.           assignments.     See also `G1,...,G10'.
  2777.  
  2778.     Dialog:
  2779.           Use this switch to prompt user.
  2780.  
  2781.     InFilename:
  2782.           Text argument containing filename of Database file.
  2783.  
  2784. RETURN
  2785.      RC = 0, if selection exported, else RC > 0
  2786.  
  2787. SEE ALSO
  2788.      Record selection
  2789.  
  2790.  
  2791. importascii
  2792. ............
  2793.  
  2794. SYNTAX
  2795.      ImportASCII
  2796.     
  2797.     
  2798.     
  2799.     
  2800.     
  2801.     
  2802.     
  2803.     
  2804.     
  2805.     
  2806.     
  2807.     
  2808.     
  2809.     
  2810.     
  2811.     
  2812.      `S=Select/S,G1/S,...,G10/S,G=GroupsID/K/N,D=Dialog/S,P=FormatFilename/K,InFilename'
  2813.  
  2814. FUNCTION
  2815.      Use this function to import the contents of an ASCII transfer
  2816.      file. Use the name of previously saved Export preferences
  2817.      (`*.xpref') to define the format of the ASCII transfer file.
  2818.  
  2819. PARAMETERS
  2820.     Select:
  2821.           Switch to add imported records to the selection. Otherwise
  2822.           the imported records will not be selected.
  2823.  
  2824.     G1,...,G10:
  2825.           Switch a set of Gx switches, to assign the imported records
  2826.           to these groups. Note: The specified set of groups will be
  2827.           superimposed                 to the set of groups already
  2828.           assigned to the imported records. I.e. by ommitting Gx
  2829.           switches, the record groups will be preserved.
  2830.  
  2831.     GroupsID:
  2832.           Numberical value indicating the set of groups to assign to
  2833.           the imported records. This group information will be
  2834.           supoerimposed to the                 existing group
  2835.           assignments. See also `G1,...,G10'.
  2836.  
  2837.     Dialog:
  2838.           Use this switch to prompt user.
  2839.  
  2840.     FormatFilename:
  2841.           Name of the format file. Supply either full path or only the
  2842.           filename. AA searches first in the current dir, the in the   
  2843.                        local (`Prefs/') and finally in the global
  2844.           (`envarc:AddressAssist/') preferences directory.
  2845.  
  2846.     InFilename:
  2847.           Text argument containing filename of Database file.
  2848.  
  2849. RETURN
  2850.      RC = 0, if selection exported, else RC > 0
  2851.  
  2852. SEE ALSO
  2853.      Import-Export ASCII
  2854.  
  2855.  
  2856. dialogbox
  2857. ..........
  2858.  
  2859. SYNTAX
  2860.      DialogBox `C=ControlString/K,Message/A/F'
  2861.  
  2862. FUNCTION
  2863.      This function opens a simple dialogbox for user prompt,
  2864.      information or selection. The dialogbox cosists of a Message and a
  2865.      set of control buttons, specified by a control string.
  2866.  
  2867. PARAMETERS
  2868.     ControlString:
  2869.           Text representation of the buttons in the dialogbox. Format:
  2870.           `*But1¦...¦But_X', where `ButX' are the names              
  2871.             of the x buttons in the set. The button marked with a
  2872.           preceeding * is the default button. The char preceeded by    
  2873.                       a underscore (_) in the name will be underlined. 
  2874.                          Example: `*_OK¦_All¦_Cancel' will create 3
  2875.           buttons `¦OK¦All¦Cancel¦'.
  2876.  
  2877.     ControlString:
  2878.           Text string containing dialogbox message.
  2879.  
  2880. RETURN
  2881.      depends on the button used to close the dialogbox: The button to
  2882.      the left side will return RC = 1, the button on the righthand side
  2883.      returns RC = 0. The other buttons return their ID: RC=2 for the
  2884.      second button from left, say RC=i for the i th button from left.
  2885.  
  2886. SEE ALSO
  2887.      Example ARexx scripts.
  2888.  
  2889.  
  2890. getfile
  2891. ........
  2892.  
  2893. SYNTAX
  2894.      GetFilename `I=InitialFilename/K,F=FilterString/K,Title/A/F'
  2895.  
  2896. FUNCTION
  2897.      This function prompts the user to enter a filename.
  2898.  
  2899. PARAMETERS
  2900.     InitialFilename:
  2901.           An initial filename may be supplied with this keyword.
  2902.  
  2903.     FilterString:
  2904.           This is an AMIGA-DOS file pattern string, to filter the files
  2905.           displayed. Default: `#?' display all. Example: `#?.arx'
  2906.           displays only ADDRESSASSIST ARexx scripts.
  2907.  
  2908.     Title:
  2909.           Supplies the title of the file requester.
  2910.  
  2911. RETURN
  2912.      On OK: RC = 0 and RESULT = <path & filename>, else RC > 0
  2913.  
  2914. SEE ALSO
  2915.      Example ARexx scripts.
  2916.  
  2917.  
  2918. Preferences
  2919. ************
  2920.  
  2921. AA is highly configurable. Besides the application and database
  2922. specific configuration, you may change the look and feel of
  2923. ADDRESSASSIST's GUI through MUI's powerful GUI preference program. This
  2924. works only, if you use a registered version of MUI (another reason to
  2925. register this favourable product).
  2926.  
  2927. This section covers only AA and database specific preferences. See in
  2928. the MUI docs for information about the GUI preferences.
  2929.  
  2930. AA distinguishes between application and database preferences, which
  2931. may be configured configured by the user:
  2932.  
  2933. Database (project):
  2934.         * the names of the 4 user definable record fields (Preferences
  2935.           dialogbox)
  2936.  
  2937.         * the names of the 10 groups (Record groups), (Preferences
  2938.           dialogbox)
  2939.  
  2940.         * the format of the Database Listview (Preferences dialogbox)
  2941.  
  2942.         * the stuff in the `Application' page of the preferences editor
  2943.           (Preferences dialogbox)
  2944.  
  2945.         * the Record template specific setup (Record template).
  2946.  
  2947.         * the current sort direction and index (Sort dialogbox)
  2948.  
  2949.         * the name of the actual print setup (Database print),
  2950.  
  2951.         * the name of the actual ASCII transfer setup (Import-Export
  2952.           ASCII).
  2953.  
  2954. Application:
  2955.         * All the Database preferences, used when a new database is
  2956.           created.
  2957.  
  2958.         * the path of the Help file (Help!),
  2959.  
  2960.         * the path of the database, which is automatically reloaded on
  2961.           startup (`Save path' from Project menu)
  2962.  
  2963.         * the ARexx script menu and the ARexx console definition ARexx
  2964.  
  2965.  
  2966. Program history & future developments
  2967. **************************************
  2968.  
  2969. Program history
  2970. ===============
  2971.  
  2972.    * Release 3.0 (29.1.97), version 41.1:
  2973.      - Mayor update: no detailed list available.
  2974.  
  2975.    * Release 2.1 (5.9.95), version 40.17:
  2976.      - Completed english and german documentation.
  2977.      - Added a french translation of the documentation and the
  2978.      catalogs. A big bunch of thanks go to Alexandre Sforza
  2979.      - Added an italian tranlation of the catalog file. Thanks go to
  2980.      Alessandro Basso
  2981.      - Pressing return in the database listview will change to the
  2982.      record view of the current record.
  2983.      - Some bugs fixed and internal optimisations.
  2984.  
  2985.    * Release 2.1 beta 1 (21.6.95), version 40.16:
  2986.      - Added 2 multi-line remark fields in separate so called remark
  2987.      windows.
  2988.      - Enhanced database views: now you can choose the set of record to
  2989.      be viewed.
  2990.      - Added record template function.
  2991.      - Some bugs fixed and internal optimisations.
  2992.  
  2993.    * Release 2 (11.6.95), version 40.15:
  2994.      - German documentation added and English documentation enhanced.
  2995.      - Norwegian catalog translation added (by Eirik Bogsnes)
  2996.      - Many minor bugs fixed and internal optimisations.
  2997.  
  2998.    * Release 2 beta 4 (30.5.95), version 40.14:
  2999.      - Record form view: Field data is now saved without pressing ENTER
  3000.      each time you change a field string.
  3001.      - Record form view: View adjusted to be height flexible
  3002.      - Preferences window: Auto move to next text field added.
  3003.      - Print Preferences: Changed pattern of print prefs files to
  3004.      #?.ppref instead of *.ppref
  3005.      - Key search: now searches a string in all record fields.
  3006.      - General: Check Name AND Name2 field for record addition. Now
  3007.      only one of the Name fields, Name OR Name2, must contain data to
  3008.      add a record to the database.
  3009.      - General: Localized Continue and MUI copyright string in
  3010.      AboutWindow as well as the Title/Status string.
  3011.      - General: Cleanup Config behaviour, separated program/database
  3012.      prefs data
  3013.      - Many minor bugs fixed and internal optimisations.
  3014.  
  3015.    * Release 2 beta 3 (23.5.95), version 40.12:
  3016.      - Preferences dialog: Added Save button to save changed
  3017.      preferences directly
  3018.      - Preferences: Added switch to turn off Record Save dialog.
  3019.      - Printer Interface: Added switch to suppress FormFeeds (FF),
  3020.      ignored when printing to file.
  3021.      - Documentation: updated
  3022.      - Changed preferences file format for future extensions!!
  3023.      - General: Added function to delete selected records.
  3024.      - General: Added Phone1 and Phone2 index for sorting (missing
  3025.      Name2 was a bug!).
  3026.      - General: 'Turbo' version no longer needs FPU. Why should it????
  3027.      - Many bugs fixed
  3028.  
  3029.    * Release 2 beta 2 (15.5.95), version 40.11:
  3030.      - Bug fixed: Selection toggle button/menu no work properly
  3031.      - Bug fixed: List/label print field length bug fixed
  3032.      - Documentation: updated to release 2
  3033.  
  3034.    * Release 2 beta 1 (9.5.95), version 40.10:
  3035.      - General: Added 2 new database-field: Firstname and Group field
  3036.      for 10 different groups
  3037.      - Views: Added view concept by providing 2 different views
  3038.      switchable in one window: database list view and record form view
  3039.      - Printer Interface: Added user definable record field ordering
  3040.      - Printer Interface: Added database field length for line list
  3041.      printing
  3042.      - Printer Interface: Load/Save individual print setup
  3043.      - Printer Interface: Added switch to print only used fields of an
  3044.      address (thanks to A. Becker for its idea)
  3045.      - Selections: Added powerful selection filters: field string match
  3046.      and group match
  3047.      - Some bug fixes
  3048.      - Sorting: Added more all sort index, except for phone fields
  3049.      - General: New preferences file structure, save preferences in
  3050.      address project files. Added support for project icon and WB-Start
  3051.      with project file.
  3052.      - Some bug fixes
  3053.  
  3054.    * Release 1.0 (26.10.94), version 38.15:
  3055.      - First public release.
  3056.  
  3057. Future developments
  3058. ===================
  3059.  
  3060. This is a list of future enhancements for ADDRESSASSIST. Remember, the
  3061. future of this program also depends on you, the user: register
  3062. immediately and make suggestions, bug reports.
  3063.  
  3064.    * Enhance ASCII Import/Export:
  3065.      - Add <IGNORE> fields to the ASCII format definitions.
  3066.  
  3067.    * Enhance printing
  3068.      - Add postscript / graphics printing abilities
  3069.  
  3070.    * Enhance Remark windows to hold external data as well: text,
  3071.      graphics, sound and document links (f.e. foe PageStream)
  3072.  
  3073.    * Add more flexible output format, user definable, f.e.
  3074.      "printf"-format using specific markers
  3075.    * Add string list salutation, place and code fields.
  3076.  
  3077.    * Add datatype to display AA data with tools like Multiview.
  3078.    * Any ideas are welcome.
  3079.  
  3080. Copyright and Registration
  3081. ***************************
  3082.  
  3083. ADDRESSASSIST is copyrighted 1994-96 by Quarz Development / Alex H.
  3084. Schneider. All rights reserved. The program is distributed as Shareware.
  3085.  
  3086. The freely distributable archive contains the unregistered version of
  3087. the program. It is limited to work with only 15 records.
  3088.  
  3089. The freely distributable archive may be freely redistributed, as long
  3090. as no charges other than reasonable copying and handling fees are
  3091. collected. The program may be distributed only as originally released,
  3092. in the complete archived form. No changes of any kind may be made to
  3093. the ADDRESSASSIST binary, documents or archive, and I will not answer
  3094. for any problems that may result from a modified binary.
  3095.  
  3096. The suggested basic registration conditions is listed in the
  3097. `Orderform.txt'. Registration gets you an entry in the users and a
  3098. personal key file. This key file disables the restrictions of 15
  3099. records and will work with all updates of the program that will be
  3100. available on the networks in the future. This key file is *personal*
  3101. and definitely *not* freely distributable. You will receive the
  3102. key-file immediately after I got the registration fee by email or by
  3103. mail.
  3104.  
  3105. Take a look at `Orderform.txt' to register or for more information
  3106. about registering.
  3107.  
  3108. Register now!!!! Thank you for supporting Shareware.
  3109.  
  3110. Trademarks
  3111. ..........
  3112.  
  3113. Amiga, Amiga Workbench and Amiga Kickstart are registered trademarks of
  3114. Commodore-Amiga Inc.
  3115.  
  3116. Installer and Installer project icon are (C) Copyright 1991-93
  3117. Commodore-Amiga, Inc.  All Rights Reserved.
  3118.  
  3119. MUI is (C) Copyright 1993-96 Stefan Stuntz (see `Readme.MUI') for
  3120. details.
  3121.  
  3122. `Textfield.gadget' is (C) Copyright 1995 Mark Thomas (see
  3123. `TextFieldGadget.txt') for details.
  3124.  
  3125. All other named trademarks reference to their appropriate manufactor or
  3126. seller.
  3127.  
  3128.  
  3129. Disclaimer
  3130. ***********
  3131.  
  3132. THERE IS NO WARRANTY  FOR  THE  PROGRAM,  TO  THE  EXTENT  PERMITTED  BY
  3133. APPLICABLE  LAW.  EXCEPT  WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
  3134. HOLDER AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
  3135. OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
  3136. THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR  A  PARTICULAR
  3137. PURPOSE.  THE  ENTIRE  RISK  AS  TO  THE  QUALITY AND PERFORMANCE OF THE
  3138. PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME  THE
  3139. COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  3140.  
  3141. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED  TO  IN  WRITING
  3142. WILL  ANY  COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE
  3143. PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING  ANY
  3144. GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
  3145. USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED  TO  LOSS
  3146. OF  DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
  3147. THIRD PARTIES OR A FAILURE OF THE PROGRAM  TO  OPERATE  WITH  ANY  OTHER
  3148. PROGRAMS),  EVEN  IF  SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
  3149. POSSIBILITY OF SUCH DAMAGES.
  3150.  
  3151.  
  3152. Acknowledgements
  3153. *****************
  3154.  
  3155. Despite all the efforts of me (the author), ADDRESSASSIST would never
  3156. be what it is now without the help of several people and institutions,
  3157. who should be thanked very much for their contribution at this place:
  3158.  
  3159.    * My wife and my little daughter Ramona for their patience.
  3160.  
  3161.    * A very special thanks goes to Arto Becker, Eirik Bogsnes, Kevin
  3162.      Kirk and Alexandre Sforza (in alphabetical order) for their great,
  3163.      critical beta testing and the many suggestions, flames and
  3164.      blames:) !
  3165.  
  3166.    * An extra thanks goes to Alexandre Sforza, who did the great work
  3167.      of translating the catalogs *and* the manual to french. All those
  3168.      who have ever written a GNU-Texinfo file know what I mean! .
  3169.  
  3170.    * Eirik Bogsnes for his Norwegian translation of the catalog file.
  3171.  
  3172.    * Alessandro Basso for his Italian translation of the catalog file.
  3173.  
  3174.    * The SAS Institute for their excellent C/C++ compiler. Hope they
  3175.      will come back!!
  3176.  
  3177.    * Stefan Stuntz for his great Magic User Interface (MUI)
  3178.  
  3179.    * Mark Thomas for his more than only useful `textfield.gadget'.
  3180.  
  3181.    * Escom/AT and Viscorp for buying the AMIGA and last but not least
  3182.      Commodore for ...!
  3183.  
  3184.  
  3185. Contacting the author
  3186. **********************
  3187.  
  3188. For questions, registration, suggestions or bug reports please contact
  3189. me
  3190.  
  3191. by mail:
  3192.  
  3193.     Alex H. Schneider
  3194.     Kruggasse 179
  3195.     CH-5462 Siglistorf
  3196.     Switzerland / Europe
  3197.  
  3198. or by email, internet (no registration):
  3199.  
  3200.     schneider@igt.baum.ethz.ch
  3201.  
  3202. or by phone (no registration):
  3203.  
  3204.     ++41 56 243 18 13 (at home, NEW!!!!!)
  3205.     ++41 1 633 30 40 (at work)
  3206.  
  3207.  
  3208. Index
  3209. ******
  3210.  
  3211.  
  3212.  
  3213.  ARexx commands                         ARexx commands
  3214.  ARexx dialogbox                        ARexx dialogbox
  3215.  ARexx Introduction                     ARexx Introduction
  3216.  ARexx Menu                             ARexx Menu
  3217.  ARexx, Application specific commands   MUI standard commands
  3218.  ARexx, command argument standards      Command argument standards
  3219.  ARexx, commands                        ARexx
  3220.  ARexx, menu                            ARexx
  3221.  ARexx, MUI standard commands           MUI standard commands
  3222.  ASCII exchange file format             ASCII file format
  3223.  Change path of helpfile                Help!
  3224.  Contacting the author                  Contacting the author
  3225.  Copy record                            Record Menu
  3226.  Copyright                              Copyright and Registration
  3227.  Database format                        Database format
  3228.  Database navigation                    Database navigation
  3229.  Database print                         Database print
  3230.  Database sort                          Database sort
  3231.  Database view                          Database view
  3232.  Database view types                    Database view types
  3233.  Dialogbox Reference                    Dialogbox Reference
  3234.  Duplicate record                       Record Menu
  3235.  Edit record                            Record Menu
  3236.  Field string match, selection filter   Field string match
  3237.  Filter dialogbox                       Filter dialogbox
  3238.  Filter, selection                      Filter dialogbox
  3239.  Find a record                          Find a record
  3240.  FreeX fields                           User definable fields
  3241.  Future                                 History & Future
  3242.  Group dialogbox                        Group dialogbox
  3243.  Group match, selection filter          Group match
  3244.  Groups of records                      Record Menu
  3245.  Helpfile                               Help!
  3246.  History                                History & Future
  3247.  Icon, change data icon                 Installation
  3248.  Image-buttons, toolbar                 Image-button toolbar
  3249.  Import and export                      Import and export
  3250.  Import/Export ASCII                    Import-Export ASCII
  3251.  Import/Export Casio                    Import-Export Casio
  3252.  Import/Export selection                Import-Export selection
  3253.  Installation, application              Installation
  3254.  Introduction                           Introduction
  3255.  Menu strip                             Menu Reference
  3256.  MUI, Magic User Interface              Magic User Interface
  3257.  Navigation controls                    Navigation controls
  3258.  New record                             Record Menu
  3259.  Preferences dialogbox                  Preferences dialogbox
  3260.  Preferences window                     Preferences
  3261.  Preferences, database and application  Preferences
  3262.  Print dialogbox                        Print dialogbox
  3263.  Print record                           Record Menu
  3264.  Process Menu                           Process Menu
  3265.  Program startup                        Program startup
  3266.  Project Menu                           Project Menu
  3267.  Quick Tour                             Quick Tour
  3268.  Record edit                            Record edit
  3269.  Record field string match, selection filterField string match
  3270.  Record group match, selection filter   Group match
  3271.  Record groups                          Record groups
  3272.  Record links                           Record links
  3273.  Record Menu                            Record Menu
  3274.  Record selection                       Record selection
  3275.  Record template                        Record template
  3276.  Record templates                       Record Menu
  3277.  Registration                           Copyright and Registration
  3278.  Remark fields, windows                 The remark fields
  3279.  Remark windows                         Remark windows
  3280.  Remove record                          Record Menu
  3281.  Save record                            Record Menu
  3282.  Selection Filter dialog                Filter dialogbox
  3283.  Selection Menu                         Selection Menu
  3284.  Selective record view                  Selective record view
  3285.  Sort dialogbox                         Sort dialogbox
  3286.  Templates, for records                 Record Menu
  3287.  textfield.gadget                       Textfield gadget
  3288.  The remark fields                      The remark fields
  3289.  Toolbar                                Image-button toolbar
  3290.  Transfer ASCII dialogbox               Transfer ASCII dialogbox
  3291.  Tutorial                               Quick Tour
  3292.  user definable fields                  User definable fields
  3293.  View Menu                              View Menu
  3294.  Views, view types                      Database view types
  3295.  
  3296.