home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / WordProcessors / 976-fwtc.lzx / FW_Tables1.1 / Create_Table.doc < prev    next >
Encoding:
Text File  |  1995-12-30  |  11.7 KB  |  320 lines
  1. --------------------------------------------------------------------
  2.                        User- Document
  3.  
  4.                             for 
  5.             
  6.                       Create_Table v1.1
  7.                 (by Carsten Labinsky, 29.12.95)
  8. --------------------------------------------------------------------
  9.  
  10. NOTE: Nothing of this doc has been changed since v1.0 (except
  11.       for the history, of course ;)
  12.  
  13. Contents:
  14.  
  15.     1. Introduction
  16.     2. Legal notice
  17.     3. Requirements
  18.     4. Installation
  19.     5. Usage
  20.     6. Settings
  21.     7. History
  22.  
  23. (For information about how to reach the author, read the file
  24.  register.doc [You should have read it, anyway])
  25.  
  26. ===============================================================
  27. =                                                             =
  28. = IMPORTANT BUG-NOTICE:                                       =
  29. =                                                             =
  30. = At least the german version of FinalWriter v4.01 does not   =
  31. = handle text-object-coordinates correctly.                   =
  32. = The TOP-value contains in fact the y-coordinate for the     =
  33. = text's BASELINE (which is approximately 0.7 * HEIGHT below)!=
  34. =                                                             =
  35. = Create_Table provides a WORK-AROUND which is ENABLED by     =
  36. = default. If you use a different version of FinalWriter      =
  37. = and find the text-objects scattered in y-direction, set     =
  38. = FW4_BUGFIX to FALSE (see 6:Expert-User-Settings).           =
  39. =                                                             =
  40. ===============================================================
  41.  
  42.  
  43.  
  44. 1. Introduction
  45. ===============
  46.  
  47. This is a powerful AREXX-Macro for FinalWriter.  It supports the
  48. creation of auto-sized tables of variable widths and heights.
  49. Since table-handling is not supported in FinalWriter, this macro
  50. may save you a lot of time and frustration while creating them
  51. by hand.
  52.  
  53. It will ask you for the table-data using FW's requesters and
  54. create a table through the use of FW's standard objects like
  55. lines, boxes and text-objects. Layout processing is done auto-
  56. matically, based on your settings.
  57.  
  58. The result is a grouped object, that can be sized, copied and
  59. placed just like any other graphic-object.
  60.  
  61. Features include:
  62.   - variable table dimensions
  63.   - customizable line widths for grid-box
  64.   - round or normal grid-box corners
  65.   - equally balanced line and column widths
  66.   - vertical and/or horizontal header entries
  67.   - multiple lines of text as table entries
  68.   - centered or left-justified text entries
  69.   - individual text-style support
  70.   - optional title-text
  71.   - customizable text-flow
  72.  
  73. A FW-Document with examples of created tables is included into
  74. the archive to demonstrate all of its features.
  75.  
  76.  
  77. 2. Legal notice
  78. ===============
  79.  
  80. This archive is distributed as SHAREWARE (fee is 15 DM or $15
  81. US-DOLLARS).  
  82.  
  83. IF DISTRIBUTED, NO CHANGES MUST BE MADE TO THIS PACKAGE.
  84. DISTRIBUTION FOR COMMERCIAL PURPOSES ARE PROHIBITED.
  85.  
  86. YOU MAY USE THIS SOFTWARE FOR 4 WEEKS WITHOUT REGISTRATION.
  87. Please read the file register.doc for further info.
  88.     
  89.  
  90. 3. Requirements
  91. ===============
  92.  
  93. The Create_Table-Macro does not require any additional libraries or
  94. programs (except FinalWriter and AREXX, of course ;).
  95.  
  96. It was developed for FinalWriter V4, but should work with earlier
  97. versions also. I tried it with V1, and it seems to function.
  98.  
  99.  
  100. 4. Installation
  101. ===============
  102.  
  103. First, copy the file "Create_Table" to the
  104.     [your path]/FinalWriter/FWMacros/
  105. drawer. 
  106.  
  107. Start FinalWriter and add the macro to the user-menu (look at your 
  108. FinalWriter manual for further details on how to add items to the 
  109. user-menu).
  110.  
  111.  
  112. 5. Usage
  113. ========
  114.  
  115. A table-layout done with Create_Table looks similar to this:
  116.  
  117.            [Col1]       [Col2]     [Col3]    [Col4]    [ColN]
  118.  
  119.         ----------------------------------------------------------
  120.         |          ||            |   ***   |       |   *** ***   |    horiz.
  121. [Line1] |  ******  ||  ********  |  *****  | ** ** | ****** **** | <= Header
  122.         |          ||            |   ***   |       |   ***** *   |
  123.         |----------++------------+---------+-------+-------------| < doubled hor.
  124.         |----------++------------+---------+-------+-------------| < headerline
  125.         | *** **** ||            |         |       |             |
  126. [Line2] |  ******  ||  ***** *** |  ** **  |       |  *** ****   |
  127.         | *** **** ||            |         |       |             |
  128.         |----------++------------+---------+-------+-------------|
  129.         |          ||            |         | ** ** |             |
  130.         |   ****   || *** ** *** |         |  ***  |    ****     |
  131. [LineM] |  ** ***  || ******* ** |  *****  | ***** |   ** ****   |
  132.         |   ****   ||  *** ***   |         | ** ** |    ****     |
  133.         |          ||            |         | ***** |             |
  134.         ----------------------------------------------------------
  135.             ^      ^^         >Titlestring<
  136.    vert.    |    doubled
  137.    header---+    vertical
  138.                 headerline
  139.  
  140.  
  141. Before we start, a note on requesters in general: If you hit the
  142. "Abort"-Button, the creation process will be canceled and all your
  143. inputs are lost.
  144.  
  145. Ok, you were warned, so now we can have a look at how to create a table
  146. in a step-by-step manner. Step numbers in brackets (e.g. '(9)' are
  147. optional. See settings section):
  148.  
  149.     1. Invoke the Makro.
  150.  
  151.     2. The Shareware-Requester pops up. You have to wait 15 secs,
  152.        before you may proceed.
  153.  
  154.     3. You are requested for the number of lines and columns.
  155.        Enter values greater than 1.
  156.  
  157.     4. Select a method for text-justification:
  158.        Options are: "Center" or "Left"
  159.  
  160.    (5). You are asked, if you want a doubled horizontal line
  161.        as a seperator between Line1 and Line2.
  162.        Hit "H-Hdr" or "No". (Remember: "Abort" cancels the table)
  163.  
  164.    (6). Same as above, but for vertical line between Col1 and Col2.
  165.  
  166.     7. You are asked, if you want all Lines to have the same
  167.        Height (according to the maximum height of all matrix-cells).
  168.        "Equal" selects this feature.
  169.        "No"    sizes all lines individually (to max. height of the
  170.                maxtrix-cells in the line)
  171.  
  172.     8. Same as above, but for Column-Widths.
  173.  
  174.    (9). You are asked for the title-string. This may begin with
  175.        an optional text-style-def (see 10. for a full explanation).       
  176.        
  177.        Input-format:
  178.        {text-style}Titletext
  179.  
  180.        Note: Titletext may be no longer than 37 chars and MUST NOT
  181.              countain any quote-chars ('"').
  182.        Examples:
  183.        a) My really boring table title
  184.        b) {B I}My interesting bolditalic title
  185.  
  186.    10. You are requested for the texts to be placed in the table,
  187.        starting from Line1/Col1, Line1/Col2, etc.
  188.        E.g., if you selected 5 lines and 4 columns, you will have
  189.        to enter 20 strings now.
  190.  
  191.        Don't get shy by the following: It looks cryptic at first,
  192.        but offers interesting features for expert-users. (You want
  193.        to become one, don't you?)
  194.        If you want a quick-start, you may skip to now and read
  195.        about multiple-lines and text-styles later.
  196.  
  197.        You can enter multiple lines per matrix-cell by using the
  198.        line-seperator-character (default: #).
  199.  
  200.        Each line can begin with an optional type-style-def that
  201.        is surrounded by '{' and '}'. If you don't define any
  202.        style-defs, your preferences-settings for textobjects will
  203.        be used.
  204.  
  205.        The input-format is:
  206.  
  207.        {text-style}Textline1# ... #{text-style}TextlineN
  208.  
  209.        - Textline1..N can be any strings with a max. of 37 characters
  210.          (this is a limitation in FW's TextObjects). NO quote-chars
  211.          are allowed ('"')!
  212.          If you don't enter a string, the matrix-cell will stay empty.
  213.  
  214.        - text-style can be one or multiple of the following options:
  215.             B        sets BOLD-flag
  216.             I        sets ITALIC-flag
  217.             S:<num>  sets FONTSIZE to <num> points, e.g. 12.
  218.             W:<num>  sets FONTWIDTH to <num> in % , e.g. 120
  219.             F:<name> sets FONTNAME to <name>, e.g. Courier
  220.          each of these style-opts must be seperated by a space-char.
  221.  
  222.         This may look a bit complicated, but it offers a lot of
  223.         flexibility. And you don't HAVE to use it. ;)
  224.  
  225.         Input-Examples:
  226.         a) {B S:18 F:Times}My Bold Header
  227.         b) Just#a#couple#of#six#lines
  228.         c) {S:14 F:Courier}I really#{B I W:150}LIKE#Styles
  229.  
  230.  
  231.    11. Sit back and watch as Create_Table in fact creates your
  232.        table. This may take a while.
  233.        You'll be notified by a Pop-Up-Message when your table
  234.        is ready.
  235.  
  236.  
  237. 6. Settings
  238. ===========
  239.  
  240. You can change Create_Table's behaviour in many ways, by editing
  241. the user-definable part its sourcecode. The source is loaded
  242. with comments to make this as easy as possible.
  243.  
  244. I decided to do it this way, because
  245. a) I assume you have a prefered layout-style and don't want
  246.    to enter the same values every time you create a table.
  247. b) There are already too many PopUps/Requesters anyway
  248.    (but I didn't want to build my own GUI).
  249.  
  250. Since the variables are documented well enough in the source-
  251. file and you need the info's there and not here, I'll give just
  252. a short overview of them:
  253.  
  254. Line- and Box-Style settings:
  255.  
  256. - LINE_WIDTH            Set the line-width to <num> dots.
  257. - BOX_LINE_WIDTH        Same as above, but for outer framebox
  258. - ROUND_BOX_CORNERS     Selects round or normal framebox-corners
  259.  
  260. General Table-Layout Settings:
  261.  
  262. - DblHLineOffset        Distance between Doubled Horizontal Lines
  263. - DblVLineOffset        Distance between Doubled Vertical Lines
  264.                         (if set to 0, no doubled lines and requesters
  265.                          are switched off)
  266.  
  267. - EQ_LSPACING           (De)select defaults for equal line spacing
  268. - EQ_CSPACING           (De)select defaults for equal column spacing
  269.                         (Requesters will appear in each case, but
  270.                          the corresponding default-button is enabled)
  271.  
  272. - ColSpacing            Defines distance between text and vert. lines
  273. - LineSpacing           Defines distance between text and horiz. lines
  274.  
  275. Text-Placement Settings:
  276.  
  277. - TITLE                 Don't ask for a titlestring
  278. - TITLE_CENTERED        Title will be centered/left-justified
  279. - TITLE_BELOW           Title will be placed below/above
  280. - TITLE_OFFSET          Distance between title and table-borders
  281.  
  282. - TEXT_CENTERED         Defaults for text-justification-requester
  283.                         Options are: Center, Left.
  284.  
  285. - TEXT_FLOW             Defines textflow-method around the table
  286. - FLOW_DIST             Defines textflow-distance
  287.  
  288. Expert-User Settings:
  289.  
  290. - SEP_CHAR              Character that is used as a line-separator
  291.                         during text-input (default: '#')
  292.  
  293. - L_BRACKET             Char indicates beginning of a text-style
  294.                         definition (default: '}')
  295. - R_BRACKET             Char indicates end of a text-style-definition
  296.                         (default: '}')
  297. - FW4_BUGFIX            (De)selects work-around for FW4's TextObj-BUG
  298.                         (see the BUG-NOTICE on top of this file)
  299. - DEBUG                 (De)selects Script-Debug-Mode
  300.  
  301.  
  302.  
  303. 7. History
  304. ==========
  305.  
  306. V1.0    (18.12.95)  First public release.
  307.  
  308. V1.1    (29.12.95)  Fixed a bug that occured when the decimal-character
  309.                     in global prefs was set to comma instead of
  310.                     point. This caused an "Arithmetic Conversion Error"
  311.                     (AREXX-Error 47, Returncode 10). Now the prefs
  312.                     will be temporarily changed to point-notation
  313.                     while the macro is running.
  314.                     (Thanks to the unknown caller whose name I forgot!)
  315.                    
  316.                     Fixed another bug that caused to make text
  317.                     invisible, if Fill-Style for boxes was set to
  318.                     solid. This happened because the box was the 
  319.                     frontmost object.
  320.