home *** CD-ROM | disk | FTP | other *** search
/ Programming Tool Box / SIMS_2.iso / vb_demos / spin_vb / readme.txt < prev    next >
Text File  |  1993-11-12  |  7KB  |  170 lines
  1. Welcome to the SpinList demonstration program for Visual Basic.
  2.  
  3. SpinList is a DLL (dynamic link library) that allows you to lay out 
  4. reports in your word processor of choice: 
  5.  
  6.     Word for Windows
  7.     AmiPro
  8.     Wordperfect for Windows
  9.     Ventura Publisher 
  10.  
  11. or any other Word processor that can read and write report
  12. files in RTF (Rich Text Format) file format.
  13.  
  14. (SpinList also contains a set of functions designed to allow you to
  15. print reports requiring no graphic formatting quickly and easily, without
  16. going through a word processor. An example of this is also in the
  17. PowerBuilder demonstration program.)
  18.  
  19. ---------- GETTING STARTED ----------
  20.  
  21. To get started quickly, copy all the files from the diskette to a
  22. directory on your hard disk, and place a copy of SPINLIST.INI in your
  23. Windows directory. Be sure that SPINLIST.DLL and BWCC.DLL are in your path.
  24.  
  25. SPINLIST.INI defines your default word processor. If it is not
  26. Word for Windows, run SPINDEMO.EXE and from the File menu,
  27. choose Set Word Processor and follow the instructions.
  28.  
  29. Then start Visual Basic, open FRMMAIN.FRM and run it. 
  30.  
  31. In the main screen, in the section "Word Processor Report Demonstrations",
  32. you can click on buttons 1 through 5 to run 5 different sample reports.
  33. Report 6 does not work with the demonstration version of SpinList, because
  34. the demonstration version is limited to 500 variable substitutions.
  35.  
  36. Report 7 illustrates usage of a report data file that contains not just data,
  37. but also the name of the report template and the name of the output file to
  38. be created. (SpinList allows you to create a report data file that can
  39. be transmitted to another system on which the report template is located.
  40. The data file can be used to create the graphically formatted report file 
  41. by executing a function call that requires no information other than the name
  42. of the data file). Before running Report 7, you must specify the correct path
  43. to the demonstration file 7INI.INI in the single-line edit provided.
  44.  
  45. Tip: If using Word for Windows, start Word, select Options from the
  46. Tools menu, and in the General options Category, be sure that 
  47. Confirm File Conversions is not checked.
  48.  
  49. Use of SpinList requires only three files:
  50.    
  51.    SPINLIST.DLL   (must be in your path)
  52.    BWCC.DLL
  53.    SPINLIST.INI   (this last file must be in your Windows directory)
  54.  
  55.  
  56. ---------- Laying Out A Report ----------
  57.  
  58. To lay out a report that SpinList can feed data to, do the following:
  59.  
  60.   1. Design the report in your word processor.
  61.  
  62.   2. Define variables where needed with names starting with &, e.g.,
  63.      &LastName.
  64.  
  65.   3. Define the beginning of a repeating line group with a variable
  66.      that starts with &&, e.g., &&Item. Define the end of a repeating group
  67.      with the symbol &&&. A report may contain multiple and even nested
  68.      repeating groups.
  69.  
  70.   4. Save the report template in RTF file format. We suggest using the
  71.      suffix .RTF for a report template.
  72.  
  73. SpinList functions can then feed data to the report template one variable
  74. at a time, or you can create an ASCII file defining variable substitutions
  75. such as &LastName=Jones. To define multiple instances of a report in a
  76. document, e.g., to start a second invoice, send SpinList the reserved 
  77. variable &&&&.
  78.  
  79. Look at the layouts and test data files that are included with this
  80. demonstration for examples of how to send data to SpinList. For instance,
  81. to look at how report 1 was laid out, open file 1DEMO.RTF in your
  82. word processor. To see how data was sent to it, open file 1DEMO.TXT.
  83.  
  84.  
  85. ---------- Testing Your Report Layout ----------
  86.  
  87. The program SPINDEMO.EXE allows you to test your report layout, but you
  88. must first build an ASCII file with test data defining the variable
  89. substitutions. We suggest using the suffix .TXT for the ASCII file.
  90.  
  91. After building your ASCII text file with test data, start SPINDEMO.EXE.
  92. From the File menu in SPINDEMO.EXE, choose Prompt for RTF files.
  93.  
  94. Specify the Input file name, Output file name and Template file name,
  95. then click on Create to create the report.
  96.  
  97. The most common problem when first starting with SpinList is a message
  98. stating "Variable ... not found". If SpinList indicates that it cannot
  99. find a variable named &LastName, even though you can see it in your report
  100. template, it is because formatting information was inserted into the
  101. middle of the &LastName string while the template was being designed.
  102. This will not happen very often, and as you get used to building
  103. SpinList report templates it will happen less and less.
  104. If you open the RTF file as a text file and look for the &LastName string,
  105. you will find that it contains some extra formatting commands. For instance,
  106. it might contain "&Last\b\fs32 Name". Remove the extra information, i.e.,
  107. the "\b\fs32 ", so that the variable name appears correctly as &LastName,
  108. and test the template again. Removing the embedded RTF markup will not
  109. affect the report.
  110.  
  111. In fact, RTF markup can be used within variables sent to SpinList.
  112. The most common RTF markup you may wish to experiment with is the following:
  113.  
  114.    \b     Turn boldface on
  115.    \b0    Turn boldface off
  116.    \fs32  Set font size to 16 (double the font size number)
  117.    \ul    Turn underline on
  118.    \ul0   Turn underline off
  119.  
  120. For instance, to print the last name in boldface in the string
  121.  
  122.      &Name=Mary Jones
  123.  
  124. just send
  125.  
  126.      &Name=Mary \b Jones\b0
  127.  
  128.  
  129. ---------- Word Processors Other than Word for Windows ----------
  130.  
  131. SpinList has been tested with AmiPro 3.0 , WordPerfect 5.2 for Windows
  132. and Ventura Publisher. It does not work with WordPerfect 5.1
  133. because of bugs in that program's RTF filter.
  134.  
  135. The demos on this disk have been designed for Word for Windows and
  136. may not all work perfectly with each of the other word processors
  137. due to minor differences in their RTF filters. However, a report
  138. laid out in AmiPro for SpinList will always run successfully with
  139. SpinList, and ditto for the other word processors. A report designed
  140. for one word processor may, however, not work with another.
  141.  
  142. ---------- Limitations ---------------
  143.  
  144. 1. The maximum length of the contents of a variable is 2K bytes.
  145.  
  146. 2. To optimize performance, SpinList allocates memory in contiguous
  147.    64K blocks. This may cause a problem on heavily loaded machines
  148.    with only 4M of main memory and a small swap file. Your comments
  149.    on this will be appreciated, because we can easily adjust this.
  150.  
  151. 3. This version of SpinList requires that grids (tables) be laid out
  152.    in your word processor in advance. The next version, which is
  153.    already in alpha test and due out in January or February of 1994
  154.    will provide full support for dynamic grids, i.e., reports defined
  155.    at runtime and not laid out in advance.
  156.  
  157.  
  158.  
  159. ---------- Order Information ----------
  160.  
  161. To order SpinList, use the order form that came with the demo or call
  162.   
  163.    OSoft Development Corporation
  164.    2964 Peachtree Road
  165.    Suite 350
  166.    Atlanta, Georgia 30305
  167.    Tel: (404) 233-1392
  168.    Fax: (404) 237-0706
  169.  
  170. This demo disk may be duplicated and distributed freely.