home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / comms_networking / maketable / !MakeTable / !Help < prev    next >
Encoding:
Text File  |  1999-03-07  |  7.7 KB  |  215 lines
  1.  
  2.                    !MakeTable V0.08ß
  3.                    ~~~~~~~~~~~~~~~~~
  4.  
  5.   INDEX
  6.  
  7.   1 - Overview
  8.   2 - Use 
  9.   3 - Dialog box
  10.   4 - '<' & '>' conversion
  11.   5 - Future enhancements
  12.   6 - License conditions
  13.   7 - Disclaimer
  14.   8 - Bug reports/contacting me
  15.  
  16.       History
  17.  
  18.  
  19. 1. Overview
  20. ~~~~~~~~~~~
  21.  
  22. !MakeTable is a desktop tool to simplify the generation of HTML tables.
  23.  
  24. It will read CSV files, and text files with a wide range of separators,
  25. including tab (TSV), comma, and semi-colon.
  26.  
  27. The HTML output can be controlled in a number of ways, with the ability
  28. to set tags on a table-wide basis or on each row in the table.
  29.  
  30. Currently, it cannot handle COLSPAN and ROWSPAN parameters, but that
  31. will come when I work out an easy way for the user to specify them.
  32.  
  33. As of version 0.08, it will also read HTML files and convert tables into
  34. CSV or TSV files.
  35.  
  36. 2. Use
  37. ~~~~~~
  38.  
  39. !MakeTable is started in the normal way, simply by double-clicking the
  40. application icon. It does not have any associated filetypes.
  41.  
  42. To a read a text file (&fff) or CSV file (&dfe) or HTML file (&faf),
  43. simply drag it to the iconbar icon.
  44.  
  45. CSV files always use a comma as the cell separator; by default, text
  46. files use a tab separator, but this can be modified with the "Separator"
  47. item on the iconbar menu.
  48.  
  49. If the first character in any cell is a double quote ("), the cell contents
  50. will be treated as a string terminated by another double quote. This is
  51. required if the table cell includes the separator character (for example,
  52. if a cell in a CSV file contains a comma, the entire contents much be
  53. expressed as a quoted string). If you wish to include a double-quote
  54. character in the string, use the BASIC approach of a pair of double-quote
  55. characters (""). If the cell contents are a quoted string, and text between
  56. the closing quote and the next separator will be ignored.
  57.  
  58. When a file has been loaded, a dialog box with a number of controls is
  59. opened, allowing specification of certain HTML tags and other control
  60. parameters.
  61.  
  62.  
  63. 3. HTML Dialog box
  64. ~~~~~~~~~~~~~~~~~~
  65.  
  66. The HTML dialog box will have the leaf name of the source text or CSV file
  67. in the window title bar, together with the number of rows and columns read
  68. from the source file.
  69.  
  70. The dialog box is split into 5 areas.
  71.  
  72.    i) Table tags. This area has controls that allow the align and border
  73.       parameters to be set.
  74.       
  75.   ii) Row tags. This area has controls to set the align and valign params
  76.       to be set. The same tags are set on each row.
  77.       
  78.  iii) Miscellaneous. This area provides fine control as to the HTML that
  79.       is generated:
  80.       
  81.       a) "Upper case tags" will generate the HTML tags in upper case rather
  82.          than lower (eg <TABLE> rather than <table>). This is purely a
  83.          stylistic matter, and has no effect on the final rendering of the
  84.          table by any browser.
  85.          
  86.       b) "First row is header" will generate <th> tags rather than <td>
  87.          tags for the entire first row. This has the effect of emboldening
  88.          the text in those cells.
  89.       
  90.       c) "First col is header" - As above, but the first cell in each row
  91.          will use <th>.
  92.       
  93.       d) "Complete page" will case an entire HTML page (including !DOCTYPE,
  94.          HTML, HEAD and BODY tags) rather than just the table.
  95.          
  96.       e) "Convert '"'" will convert any double-quote characters (") to the
  97.          more correct " form. This is a smart conversion - if you have
  98.          HTML in the text that uses quotes in a tag, they will not be touched
  99.          (eg <img src="tharg.gif"> will remain as is).
  100.          
  101.       f) "Convert '&'" will convert any ampersand characters (&) to the more
  102.          correct & form. This is an intelligent conversion, and will not
  103.          convert the '&' if it is already part of a special character entity.
  104.          (ie if the source file uses ' ' this will be recognised and left
  105.          untouched - only "orphan" & characters will be converted). To the
  106.          best of my knowledge, !MakeTable will recognise all legal special
  107.          characters.
  108.          
  109.       g) "Convert '<' & '>'" - As above, but '<' and '>' characters are
  110.          converted to < and > respectively. This is a smart conversion -
  111.          if MakeTable recognises the text immediately following the '<' as a
  112.          tag (eg <br>) the characters will not be translated.
  113.          
  114.   iv) Generate. This is essentially a "SaveAs" box used to save the completed
  115.       table to a Filer window. A radio box is provided to control whether
  116.       the output is saved as a text file or an HTML file.
  117.       
  118.    v) Special buttons:
  119.    
  120.       a) 'Preview' will start a browser (if one has been seen by the filer)
  121.          and use it to provide a preview of the generated table. This will
  122.          allow the various controls to be refined.
  123.          
  124.       b) 'ReRead' will read the source file again. This allows changes as a
  125.          result of editing the source file to be recognised.
  126.  
  127. When the dialog box is open, the current table can be discarded and a new file
  128. read simply by dragging a text or CSV file to the dialog box or iconbar icon.
  129.  
  130.  
  131. 4. '<' & '>' Conversion
  132. ~~~~~~~~~~~~~~~~~~~~~~~
  133.  
  134. Para 3.iii.g above states that MakeTable performs a smart conversion, and will
  135. not convert recognised tags. There are some limits to this - not all tags are
  136. recognised. It does NOT recognise tags that would be illegal in a table cell,
  137. such as <BODY>, <HTML>, <!DOCTYPE>, <FRAMESET> or <FRAME>, nor does it recognise
  138. comment tags ( <!-- This is a comment --> ). As far as I am aware, it recognises
  139. all the other standard HTML tags, including <APPLET>, <EMBED> etc.
  140.  
  141.  
  142. 5. HTML -> text conversion
  143. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  144.  
  145. When a html file is dragged to the iconbar icon a simple RiscOS SaveAs window
  146. will open. This window will allow the user to specify whether the file should be
  147. saved as TSV or CSV.
  148.  
  149.  
  150. 6. Future Enhancements
  151. ~~~~~~~~~~~~~~~~~~~~~~
  152.  
  153. Currently on the wishlist are:
  154.  
  155.   1) COLSPAN and ROWSPAN handling.
  156.   
  157.  
  158. 7. License Conditions
  159. ~~~~~~~~~~~~~~~~~~~~~
  160.  
  161. !MakeTable is freeware, NOT Public Domain. Copies may be passed on to other
  162. people as long as the following conditions are met:
  163.  
  164.   1) Copies may be passed between private individuals as long as
  165.      this is done free of charge.
  166.  
  167.   2) It may be distributed by public domain libraries, as long as
  168.      no charge is made other than for the media.
  169.  
  170.   3) It may be distributed by remote databases such as FTP sites
  171.      or mail servers on InterNet or bulletin boards, as long as no
  172.      charge is made for downloading it (other than the cost of the
  173.      phone call).
  174.  
  175.   4) The copyright remains with me at all times.
  176.  
  177.   5) It is distributed in its entirety, including these conditions.
  178.  
  179.  
  180. 8. Disclaimer
  181. ~~~~~~~~~~~~~
  182.  
  183. !MakeTable is distributed "as is", and used at your own risk. I accept no
  184. responsibility for damage to your computer or your data.
  185.  
  186.  
  187. 9. Further information & bug reports
  188. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  189.  
  190. If you have any problems with !MakeTable, please contact me at the email
  191. address given below, and I'll try to fix them.
  192.  
  193. Nick Roberts
  194. tigger@argonet.co.uk
  195.  
  196. =====================================================================
  197.  
  198. History:
  199.  
  200.  Version       Description
  201.  
  202.   0.01A        Technology demonstrator.
  203.                Basic set of dialog box controls (tags, and some misc)
  204.                implemented.
  205.   0.02A        Preview function.
  206.   0.03A        Special character conversion, with limited set of entities
  207.                recognised for intelligent '&' handling.
  208.   0.04A        ReRead, complete set of special characters.
  209.   0.05ß        Fixed glyph handling.
  210.                First release for comment.
  211.   0.06ß        Added intelligent '<' & '>' handling.
  212.   0.07ß        No functional changes, but various types/mis-spellings, etc
  213.                corrected (with thanks to John Williams).
  214.   0.08ß        HTML->TSV/CSV conversion added.
  215.