home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / s1 / ss / !ss / !Help < prev    next >
Encoding:
Text File  |  1994-12-02  |  10.6 KB  |  258 lines
  1.  
  2.  
  3.      !SS A simple SHAREWARE experimental cell editor
  4.      ------------------------------------------------
  5.  
  6.      copyright !works 1991,1992,1993,1994,1995
  7.  
  8.  
  9. ======================================================================
  10.  
  11. Please note that this application is
  12.  
  13.  
  14.  SSSS   HH  HH   AAAA   RRRRR   EEEEEE  WW   WW  AAAA   RRRRR   EEEEEE   
  15. SS  SS  HH  HH  AA  AA  RR  RR  EE      WW   WW AA  AA  RR  RR  EE       
  16. SS      HH  HH  AA  AA  RR  RR  EE      WW W WW AA  AA  RR  RR  EE    
  17.  SSSS   HHHHHH  AAAAAA  RRRRR   EEEEE   WW W WW AAAAAA  RRRRR   EEEEE  
  18.     SS  HH  HH  AA  AA  RR RR   EE      WWWWWWW AA  AA  RR RR   EE      
  19. SS  SS  HH  HH  AA  AA  RR  RR  EE      WWW WWW AA  AA  RR  RR  EE      
  20.  SSSS   HH  HH  AA  AA  RR  RR  EEEEEE  WW   WW AA  AA  RR  RR  EEEEEE  
  21.  
  22.  
  23. It is NOT free software.
  24.  
  25. This means that you may use this software for a two week trial period.
  26.  
  27. After the trial period, you decide if you want to continue using the
  28. software. If you want to continue using it, you have to register yourself
  29. as a user, and pay a small registration fee of £12.
  30. If you don't, you must destroy your copy.
  31.  
  32. To register please send £12 to 
  33.  
  34. !works
  35. 4 Shalford Close
  36. Cirencester
  37. Gloucestershire
  38. ENGLAND
  39. GL7 1WG
  40.            
  41. Registered users will automatically receive a disk of goodies which will help them use !ss.
  42. This disk will be available early 1995. 
  43.  
  44. ===========================================================================================
  45.  
  46.  
  47.     !SS provides facilities  to conveniently edit data which is row/column
  48.     based, such as CSV files. It can be used as a front end for your own calculations and 
  49.     it can pass the results "live" to other applications. !ss has been interfaced to
  50.     !Draw, !Edit, !GnuPlot, other graph plotting and contouring applications etc.
  51.  
  52.     !SS does NOT attempt to compete with conventional spreadsheets!
  53.     !SS is intended to complement their use and in fact uses far less memory.
  54.  
  55.      
  56.      !SS provides several very useful functions:
  57.                                       ---------
  58.  
  59.          . Editing of ASCII files with the following separators:
  60.            -------          
  61.                                            Separators
  62.                                            ----------
  63.                       File type:     Input                  Output
  64.                       ----------     ------------------------------------------
  65.                        Text &FFF    <space><tab><comma>     <space> (formatted)
  66.                  OR                 <tab>                   <tab>
  67.  
  68.                        CSV  &DFE    <comma><quotes> *       <comma><quotes>
  69.                  OR                 <comma>                 <comma>
  70.  
  71.                        DXF  &DEA    not required            not required
  72.  
  73.                        Other        <space><tab><comma>     <space>
  74.  
  75.  
  76.            n.b.  (1) all leading blanks are removed at data input time
  77.  
  78.                  (2) &FFF files are automatically formatted for
  79.                      printing/reading by humans.  
  80.                      Leading empty cells are removed on output unless the tab 
  81.                      delimitor option is selected.
  82.  
  83.                  (3) This system works best with smaller files.
  84.                      There is a known bug in export mode for files with more than 
  85.                      744 lines. This is believed to be purely cosmetic.
  86.  
  87.                  (4) There are limitations as to the length of each line in 
  88.                      the file (similar to BASIC), the number and size of
  89.                      elements. The last two of these are set in the
  90.                      !SS Options window.
  91.  
  92.         
  93.          . Modification of file type (but not necessarily content)
  94.  
  95.          . Running the file loaded. This will launch any application, already
  96.            seen by the filer, appropriate to the file type run action.
  97.            If suitably written, that application will then load the file 
  98.            concerned. (n.b. !SS saves the file first.) 
  99.  
  100.          . Broadcasting the file name and type loaded. This will cause any
  101.            already installed desktop application which recognises the file
  102.            type to load the file. (n.b. !ss saves the file first.)
  103.            This action thus permits the use of several applications which
  104.            recognise the same file type. Only an application installed on 
  105.            the icon bar has the chance to respond.
  106.     
  107.          . Responding to double clicks on &FFD Data and &DFE CSV files.
  108.            A null run time action is defined for &FFD. &DFE loads !ss.
  109.            Several concurrently installed versions of !SS will all respond
  110.            to the latter providing the applications are 'free' and have 
  111.            'receive' enabled.
  112.  
  113.          . Drag and Drop editing. Use the Acorn !Help application.
  114.  
  115.          . A spreadsheet type front end for user programmes.
  116.              -----------
  117.               When the Dialog box Calc option is selected, !SS will export
  118.               a file which can be read by user written applications for 
  119.               processing with the results being returned to the cell editor.
  120.               
  121.               For this purpose the following convention has been adopted:
  122.  
  123.               Top row first column: A text datatype identifier. This may 
  124.               be used by another application to determine what action to take.
  125.  
  126.               Top row second column: The leaf name of the programme.
  127.  
  128.               The programmes may be stored in an application  directory 
  129.               !SS.Progs. Other directories may be used
  130.               for the same purpose. They may be selected simply by
  131.               dragging the appropriate directory icon to the dialog box
  132.               window. In principle ANY Archimedes programming language can 
  133.               be used. There should be no restriction other than the
  134.               capabilities of the language in question. !SS thus becomes an
  135.               application front end of very great utility and versatility.
  136.  
  137.               !SS contains a BASIC Library file which contains various 
  138.               utilities required if BASIC is to be used for performing 
  139.               the calculations. Similar functionality will have to be
  140.               provided for other languages although the details may differ.
  141.  
  142.               This file is supplied to registered users only.
  143.               ===============================================
  144.  
  145.               !SS passes a number of important parameters to the subprogramme
  146.               as parameters. These include the amount of memory required
  147.               for the block of memory being transferred, the number of
  148.               rows and columns of the matrix, the cell word length and the 
  149.               channel which the subprogramme is to use for messages it 
  150.               may chose to broadcast. The file name is also passed.
  151.  
  152.               It is thus possible to have:
  153.  
  154.                   a. a spreadsheet application which draws upon a real 
  155.                      programming language rather than some pseudo language.
  156.                      There is therefore no limit in principle to the
  157.                      complexity of the calculations to be performed and no
  158.                      limits to file access etc.
  159.  
  160.                   b. direct output of data for printing (change the file 
  161.                      type to &FFF and drag to a suitable printer application... 
  162.                      but watch for lost leading blanks.)
  163.  
  164.                   c. messages broadcast from both the main cell editor and
  165.                      also from the subprogramme. For example the
  166.                      subprogramme may be used to: solve a differential 
  167.                      equation between boundary conditions defined around a
  168.                      2-D region in the cell editor, writing intermediate 
  169.                      statistics to an !Edit file in the process and 
  170.                      broadcasting the file name and type before terminating.
  171.                      !Edit if installed will then display those results for
  172.                      perusal. The final solution will appear in the cell
  173.                      edit window and can itself be broadcast to ,say, a 
  174.                      contouring application.
  175.  
  176.                      Subprogrammes have been successfully interfaced to gnuplot.
  177.                      (save the file before clicking on 'calc')
  178.  
  179.                    d. applications which can selectively receive or ignore
  180.                       messages depending upon the state of some 
  181.                       predetermined flag (see the icon bar menu of !SS).
  182.  
  183.  
  184.  
  185.      N.B. !SS needs !Scrap
  186.      ---------------------
  187.  
  188.      Use the Acorn !Help application to learn more about !SS.
  189.      ------------------------------------------------------  
  190.  
  191.      Set the path for this in the file !ss.SysVars
  192.  
  193.      No attempt is made here to document the Library BASIC PROCs.
  194.      In this version it is assumed that the user will have sufficient
  195.      knowledge to sort these out for himself. They are in fact very simple
  196.      to use. Note that the output is subject to the formatting of @%.
  197.      This should be defined/redefined as needs may be.
  198.  
  199.  
  200.      See the REMs in !SS.Celllib.lib and look at the examples. 
  201.      Note that the example programmes are written BASIC.
  202.     
  203.      Note that the cell vector is numbered from top to bottom and right
  204.      to left. i.e cell_number=(row_number+(column_number-1)*number_of_rows))
  205.      The numbering starts at 1 and ends at number_of_rows*number_of_columns.
  206.  
  207.     
  208.  
  209.      Typical option file contents are:
  210.      ---------------------------------
  211.  
  212.      !Cell -rows 20 -cols 4 -word 10 -cell 6 -channel 0
  213.  
  214.      Where:
  215.  
  216.      -rows    = number of rows
  217.      -cols    = number of columns
  218.      -word    = max size of cell entry
  219.      -cell    = min visible size of cell
  220.      -channel = NOT USED
  221.  
  222.       Calculate
  223.       ---------
  224.  
  225.       This option passes writes a scrap file containing the cell data
  226.       and executes a subprogramme to which is passed a string of parameters.
  227.  
  228.       The size of the memory block is (word*rows*cols*)+word.
  229.  
  230.       Offset 0 contains the filetype.
  231.  
  232.       The parameters passed are:
  233.  
  234.       bytes%= size of block
  235.       rows% = number of rows
  236.       cols% = number of columns
  237.       word% = size of each cell (n.b includes allowance for terminator)
  238.       chan% = NOT USED
  239.       datafile$ = filename
  240.  
  241.       Subprogrammes
  242.       -------------
  243.  
  244.      .  May be single tasking (need not be tasks at all.).
  245.      .  Should not attempt to multitask.
  246.      .  May send messages (but not receive) if a task is initialised.
  247.         ...see Programmers Reference Manual.
  248.       
  249.  
  250.        Limitations:
  251.        ------------
  252.  
  253.        Among many others.... the behavior of !SS is unpredictable if the 
  254.        file loaded contains 'unprintable' characters. 
  255.    
  256.        Please report bugs! Yes they do exist!!
  257.  
  258.