home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 31 / CDASC_31_1996_juillet_aout.iso / vrac / txform12.zip / TXFORM12.EXE / rar / TXFORM.DOC < prev    next >
Text File  |  1996-05-01  |  126KB  |  2,899 lines

  1.          TXFORM USER'S GUIDE                                           v1.2
  2.          ══════════════════════════════════════════════════════════════════
  3.  
  4.          
  5.          
  6.          
  7.          
  8.          
  9.          
  10.          
  11.          
  12.          
  13.          
  14.          
  15.          
  16.          
  17.          
  18.                       ╒═════════════════════════════════════╕              
  19.                       │                                     │              
  20.                       │             TXFORM v1.2             │              
  21.                       │                                     │              
  22.                       │                                     │              
  23.                       ╞═════════════════════════════════════╡              
  24.                       │                                     │              
  25.                       │                                     │              
  26.                       │            USER'S GUIDE             │              
  27.                       │                                     │              
  28.                       │                                     │              
  29.                       ╞═════════════════════════════════════╡              
  30.                       │                                     │              
  31.                       │         Software by SOGY sc         │              
  32.                       │                                     │              
  33.                       │       Copyrights (c) 1995-96        │              
  34.                       │                                     │              
  35.                       ╞═════════════════════════════════════╡              
  36.                       │                                     │              
  37.                       │             May  1, 96              │              
  38.                       │                                     │              
  39.                       ╘═════════════════════════════════════╛              
  40.          
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.          ══════════════════════════════════════════════════════════════════
  62.                                                                      Page 1
  63.  
  64.          TXFORM USER'S GUIDE                                           v1.2
  65.          ══════════════════════════════════════════════════════════════════
  66.  
  67.          
  68.          
  69.          
  70.          
  71.                      ╒════════════════════════════════════════╕            
  72.                      │                                        │            
  73.                      │               CHAPTER I                │            
  74.                      │                                        │            
  75.                      ╞════════════════════════════════════════╡            
  76.                      │                                        │            
  77.                      │              Introduction              │            
  78.                      │                                        │            
  79.                      ╘════════════════════════════════════════╛            
  80.          
  81.          
  82.          
  83.          
  84.          This document  is the USER'S GUIDE of the Shareware program TXFORM
  85.          v1.2, as released on May 1, 96. 
  86.          
  87.          TXFORM  is SHAREWARE,  user  supported  software.  TXFORM  is made
  88.          available for a free 45 day trial period.  If you find the program
  89.          of  use and wish to continue using it, you are obliged to purchase
  90.          a  personal license. See  the  distributed  file  REGISTER.DOC for
  91.          information on how to register this program. 
  92.          
  93.          
  94.          ──────────────────────────────────────────────────────────────────
  95.          I.1 What TXFORM can make for you
  96.          ──────────────────────────────────────────────────────────────────
  97.          
  98.          The TXFORM  program  is  intended for  those  who need  to prepare
  99.          nicely presented ASCII documentation files, for example to prepare
  100.          documentation files to be distributed with shareware. 
  101.          
  102.          The file you are  reading, as well  as  other TXFORM documentation
  103.          files, have been prepared with  TXFORM, and  are thus examples  of
  104.          what you can do with TXFORM. 
  105.          
  106.           ╒══════════════════════════════════════════════════════════════╕ 
  107.           │ TXFORM  reads  data contained  in  an  ASCII file  that  you │ 
  108.           │ prepare, and produces a nicely formatted output file. You do │ 
  109.           │ not care to the details of formatting  while  preparing  the │ 
  110.           │ input file. Instead, you insert control strings  that define │ 
  111.           │ the format options, and TXFORM do the job for you.           │ 
  112.           ╘══════════════════════════════════════════════════════════════╛ 
  113.          
  114.          Formatting options include: 
  115.          
  116.             ■ Left, Right and Full text justification 
  117.          
  118.             ■ Vertical and horizontal margins 
  119.          
  120.             ■ Framed text 
  121.          
  122.             ■ Use of macro 
  123.  
  124.          ══════════════════════════════════════════════════════════════════
  125.          Introduction                                                Page 2
  126.  
  127.          TXFORM USER'S GUIDE                                           v1.2
  128.          ══════════════════════════════════════════════════════════════════
  129.  
  130.          
  131.             ■ Multiple level inserted files 
  132.          
  133.             ■ Sections management 
  134.          
  135.             ■ Table of contents 
  136.          
  137.             ■ Cross referenced topics 
  138.          
  139.             ■ ... 
  140.          
  141.          TXFORM is particularly easy  to  use and powerful when  you use  a
  142.          multiple windows editor that allows you to execute a command under
  143.          DOS  without  leaving  the editor.  See in  the appendices of  the
  144.          "USER'S GUIDE"  how  I use  TXFORM to get a powerful and  flexible
  145.          ASCII editor. 
  146.          
  147.          
  148.          ──────────────────────────────────────────────────────────────────
  149.          I.2 About warranties ...
  150.          ──────────────────────────────────────────────────────────────────
  151.          
  152.          The author  of this software  is a professional software engineer.
  153.          He has put all his efforts on this work to deliver a software that
  154.          is stable, secure and easy to use and understand. Because software
  155.          is software, this is about the only thing he is  in  a position to
  156.          guarantee to you. For  all other related  questions, the following
  157.          paragraphs are  assumed to have  been  read and understoud by you,
  158.          the knowledgeable user: 
  159.          
  160.             ■ The author makes no warranty of any kind, either expressed or
  161.               implied.  This  includes,  but  is  not limited  to,  implied
  162.               warranties or merchantability, and fitness for any particular
  163.               purpose  with  respect   to  both   the   software  and   the
  164.               documentation included in this package. 
  165.          
  166.             ■ In no  event  shall  the  author be  liable for  any  direct,
  167.               indirect, consequencial, or incidental damages arising out of
  168.               the use or inability to  use  this product even if the author
  169.               has been advised of the possibility of such damages or claim. 
  170.          
  171.          So  do not tell you didn't know, and, well, make backup  copies of
  172.          your data, as you always do ... 
  173.          
  174.          
  175.          ──────────────────────────────────────────────────────────────────
  176.          I.3 Organisation of this document
  177.          ──────────────────────────────────────────────────────────────────
  178.          
  179.          The content of this document is organized as follows: 
  180.          
  181.             ■ Section I (this section) describes what TXFORM  can make  for
  182.               you, explains how  to install TXFORM, and reminds you  of the
  183.               shareware nature of TXFORM and what it means for you. 
  184.          
  185.             ■ Section II outlines the general working principles of TXFORM 
  186.  
  187.          ══════════════════════════════════════════════════════════════════
  188.          Introduction                                                Page 3
  189.  
  190.          TXFORM USER'S GUIDE                                           v1.2
  191.          ══════════════════════════════════════════════════════════════════
  192.  
  193.          
  194.             ■ Section III describes the commands available in TXFORM 
  195.          
  196.          
  197.          ──────────────────────────────────────────────────────────────────
  198.          I.4 TXFORM is SHAREWARE
  199.          ──────────────────────────────────────────────────────────────────
  200.          
  201.          I.4.A What is Shareware ?
  202.          ═════ ═══════════════════
  203.          
  204.          "Shareware"  is  copyrighted  software  which  is  distributed  by
  205.          authors  through bulletin boards, on-line  services, disk vendors,
  206.          and  copies passed among friends. It  is commercial software which
  207.          you are allowed to use  and  evaluate before paying  for it.  This
  208.          makes shareware the ultimate in money back guarantees. 
  209.          
  210.          TXFORM  is  copyrighted  software,  and  all rights  are reserved.
  211.          TXFORM may not be  changed  or modified in any  way except  by the
  212.          author. TXFORM is SHAREWARE, and may be freely distributed without
  213.          permission,  as long as it remains  in  its complete form with all
  214.          support  and documentation files.  No files may be added or  taken
  215.          away  from   the  original  Archived  form  in  which   TXFORM  is
  216.          distributed. Regardless  of  how  the  copy  is  obtained,  it  is
  217.          requested   that   all  users  comply  with   the   licensing  and
  218.          registration provisions  if they  continue to use  TXFORM after an
  219.          initial 45 days evaluation period. 
  220.          
  221.          I.4.B Why should you register this software ?
  222.          ═════ ═══════════════════════════════════════
  223.          
  224.          The only difference  between the shareware and registered versions
  225.          is that with the shareware version you must wait  five  seconds at
  226.          the  beginning of the program execution. In other words, I  am not
  227.          limitating the functionnalities of the  shareware version  in  any
  228.          way. 
  229.          
  230.          So, there is nothing  that will force you to register - apart from
  231.          making sure there is a place for you in paradise. 
  232.          
  233.          However,  if  you  use TXFORM, you  will  rapidly  reach the  same
  234.          conclusion  as the one I  have  reached: the tool is  powerful, of
  235.          good quality, and it  works. But they are so  many other  things I
  236.          would like it to do for me ... 
  237.          
  238.          TXFORM has been first written for my own use. But after a while, I
  239.          realized that this  software could be  useful for others as  well,
  240.          and  I have created this shareware version. It took me a while  to
  241.          improve  the  details   of  the   interface,  and  to   write  the
  242.          documentation, both things that were required to make it  possible
  243.          for you to use the software. 
  244.          
  245.          If you register the software,  and send me your comments and ideas
  246.          on TXFORM, I intend to improve it. 
  247.          
  248.          If you do not register,  I will understand that  nobody cares, and
  249.  
  250.          ══════════════════════════════════════════════════════════════════
  251.          Introduction                                                Page 4
  252.  
  253.          TXFORM USER'S GUIDE                                           v1.2
  254.          ══════════════════════════════════════════════════════════════════
  255.  
  256.          forget about TXFORM. That's the cyberspace jungle's law ... 
  257.          
  258.          I.4.C Registration
  259.          ═════ ════════════
  260.          
  261.          Registration of TXFORM  provides you with  the License to continue
  262.          using TXFORM after  the 45 day Evaluation  period. Registration of
  263.          the shareware edition costs US$ 10. 
  264.          
  265.          See accompanying file  REGISTER.DOC for  the license agreement,  a
  266.          registration form and the payment details. 
  267.          
  268.          
  269.          ──────────────────────────────────────────────────────────────────
  270.          I.5 Installing TXFORM
  271.          ──────────────────────────────────────────────────────────────────
  272.          
  273.          I.5.A Requirements
  274.          ═════ ════════════
  275.          
  276.          TXFORM requires an IBM PC or compatible with 
  277.          
  278.             ■ a few hundreds Kb of base memory. 
  279.          
  280.             ■ DOS 3.1 or later. This is a must. 
  281.          
  282.          I.5.B Printing the documentation
  283.          ═════ ══════════════════════════
  284.          
  285.          You may print the  TXFORM documentation by  switching your printer
  286.          on, and typing the following command at the dos prompt: 
  287.          
  288.                                 COPY TXFORM.DOC PRN                        
  289.          
  290.          I.5.C Installation procedure
  291.          ═════ ══════════════════════
  292.          
  293.          To install TXFORM, follow the following [conditional] steps: 
  294.          
  295.             ■ If you already own a registered version of TXFORM: 
  296.          
  297.                  - make a backup copy of your TXFORM.EXE file in some other
  298.                    directory 
  299.          
  300.                  - after  successful  installation  of the  new version  in
  301.                    accordance  with  the instructions  that follow, consult
  302.                    the  file  REGISTER.DOC  to see how you  can immediately
  303.                    register your new version of TXFORM 
  304.          
  305.             ■ If you  have a  previous version  of TXFORM installed in some
  306.               directory: 
  307.          
  308.                  - copy the TXFORM distribution file into that directory 
  309.          
  310.                  - uncompress  the   distribution  file   OVERWRITING   all
  311.                    existing files 
  312.  
  313.          ══════════════════════════════════════════════════════════════════
  314.          Introduction                                                Page 5
  315.  
  316.          TXFORM USER'S GUIDE                                           v1.2
  317.          ══════════════════════════════════════════════════════════════════
  318.  
  319.          
  320.                  - see the HISTORY.TXT file that describes the  differences
  321.                    between TXFORM v1.0, v1.1 & v1.2 
  322.          
  323.             ■ If you do not have a previous version of TXFORM installed: 
  324.          
  325.                  - create any directory 
  326.          
  327.                  - copy and uncompress the TXFORM  distribution  file  into
  328.                    it. 
  329.          
  330.             ■ You may  then  run  TXFORM from anywhere you  like  (put  the
  331.               TXFORM  directory  in  your  path if  you  wish), TXFORM will
  332.               always work in the directory that is the current one when you
  333.               call it. 
  334.          
  335.             ■ Note  that the  only  file  you need is  TXFORM.EXE (plus, of
  336.               course,  your  own  input files). All  other  files  are  for
  337.               documentation, demonstration and registration purposes. 
  338.          
  339.          
  340.          ──────────────────────────────────────────────────────────────────
  341.          I.6 Running TXFORM
  342.          ──────────────────────────────────────────────────────────────────
  343.          
  344.          Suppose  you have  prepared an input file  called "DEMO.TXT",  and
  345.          want to create an  output formatted file called  "DEMO.OUT". Go in
  346.          the  directory  where  the input file is  located,  and  type  the
  347.          command: 
  348.          
  349.          
  350.                    TXFORM  DEMO.TXT DEMO.OUT
  351.          
  352.          
  353.           ╒══════════════════════════════════════════════════════════════╕ 
  354.           │    TXFORM will produce an output file called "DEMO.OUT".     │ 
  355.           │                                                              │ 
  356.           │         Any existing file with the same name will be         │ 
  357.           │                 overwritten WITHOUT warning.                 │ 
  358.           ╘══════════════════════════════════════════════════════════════╛ 
  359.          
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.          ══════════════════════════════════════════════════════════════════
  377.          Introduction                                                Page 6
  378.  
  379.          TXFORM USER'S GUIDE                                           v1.2
  380.          ══════════════════════════════════════════════════════════════════
  381.  
  382.          
  383.          
  384.          
  385.          
  386.                      ╒════════════════════════════════════════╕            
  387.                      │                                        │            
  388.                      │               CHAPTER II               │            
  389.                      │                                        │            
  390.                      ╞════════════════════════════════════════╡            
  391.                      │                                        │            
  392.                      │           General Principles           │            
  393.                      │                                        │            
  394.                      ╘════════════════════════════════════════╛            
  395.          
  396.          
  397.          
  398.          
  399.          
  400.          ──────────────────────────────────────────────────────────────────
  401.          II.1 Basic concepts
  402.          ──────────────────────────────────────────────────────────────────
  403.          
  404.          TXFORM reads the input file line by line, treats it appropriately,
  405.          and produces the output file. 
  406.          
  407.          The program terminates either when an invalid line is encountered,
  408.          or when the input file has been completely read and treated. 
  409.          
  410.          If an error occurs, TXFORM set the DOS  ERRORLEVEL to 1,  displays
  411.          the input file name and line where the error did occur, provides a
  412.          description of the  error, and beeps. The  error list can be found
  413.          in the appendices of this document. 
  414.          
  415.          The way each line is treated is explained in the next section. 
  416.          
  417.          For  technical reasons,  the  text formatting  is  done  in  three
  418.          phases. During the execution of the program, the display shows the
  419.          lines that have been read in the input files for each phase. 
  420.          
  421.          
  422.          ──────────────────────────────────────────────────────────────────
  423.          II.2 The different types of lines
  424.          ──────────────────────────────────────────────────────────────────
  425.          
  426.          There are three types of line: 
  427.          
  428.             ■ Lines  beginning by  a '%' in  the first  column are  comment
  429.               lines. They are not used at all. 
  430.          
  431.             ■ Lines  beginning by  a  '\' in the first column  are  command
  432.               lines. These lines contain commands that tell  to TXFORM  how
  433.               to format the output text. Commands are reviewed into details
  434.               in a later section of this document. 
  435.          
  436.             ■ Other lines are treated as text to  be  formatted and printed
  437.               onto  the  output file. The way  the  text  is  formatted  is
  438.  
  439.          ══════════════════════════════════════════════════════════════════
  440.          General Principles                                          Page 7
  441.  
  442.          TXFORM USER'S GUIDE                                           v1.2
  443.          ══════════════════════════════════════════════════════════════════
  444.  
  445.               defined by the commands that have been previously read. 
  446.          
  447.          
  448.          ──────────────────────────────────────────────────────────────────
  449.          II.3 How the output text is formatted
  450.          ──────────────────────────────────────────────────────────────────
  451.          
  452.          The way TXFORM works is the following: 
  453.          
  454.             ■ When the  first  text  line  is  encountered,  TXFORM  open a
  455.               paragraph block, and store the text of the line in it. TXFORM
  456.               then reads the next line 
  457.          
  458.             ■ what happens then depends on the type of the next line: 
  459.          
  460.                  - If the next line is  a  comment  line, TXFORM  reads  an
  461.                    other line 
  462.          
  463.                  - If the next line  is a text  line, TXFORM appends  it to
  464.                    the text of the paragraph block 
  465.          
  466.                  - If the next line is a command line or  a blank line, the
  467.                    paragraph block  is  formatted, send to  the output file
  468.                    and cleared. In case of  a command  line, the command is
  469.                    then executed. 
  470.          
  471.             ■ The process is then repeated up to the end of the input file. 
  472.          
  473.          When the the paragraph  block is send to the output file, a set of
  474.          automated operations are carried out. 
  475.          
  476.          First, the  text  in the paragraph is properly formatted.  All the
  477.          words are aligned  each after the  other one, with only one  blank
  478.          character between them. The complete  paragraph is decomposed into
  479.          lines that  fit the page  formatting (margins,  ...). Each line is
  480.          then formatted  in accordance  with  the active text justification
  481.          mode, and send to the output file. 
  482.          
  483.          Other operations like page jumps,  footers and headers formatting,
  484.          etc, are carried in the same time, automatically. 
  485.          
  486.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  487.           Any text,      with blanks
  488.                inside, and not formatted wil be formatted
  489.                up to
  490.           the momment a blank line or other command is encountered.
  491.          
  492.          
  493.           When several blank lines are entered, only one will be written
  494.           on to the output file.  If you want
  495.               to         skip blank lines, use the command \LSK.
  496.          
  497.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  498.          
  499.          Any text, with blanks inside, and  not formatted wil be  formatted
  500.          up to the momment a blank line or other command is encountered. 
  501.  
  502.          ══════════════════════════════════════════════════════════════════
  503.          General Principles                                          Page 8
  504.  
  505.          TXFORM USER'S GUIDE                                           v1.2
  506.          ══════════════════════════════════════════════════════════════════
  507.  
  508.          
  509.          When several blank  lines are entered, only one will be written on
  510.          to  the output file. If  you want to skip  blank  lines,  use  the
  511.          command \LSK. 
  512.          
  513.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  514.          
  515.          
  516.          ──────────────────────────────────────────────────────────────────
  517.          II.4 How the modify the formatting options
  518.          ──────────────────────────────────────────────────────────────────
  519.          
  520.          To  modify  the  formatting options  of a paragraph, you basically
  521.          provide a formatting command before the paragraph. 
  522.          
  523.          Suppose  for example  that you want to left  justify  a paragraph.
  524.          This is done with the command \AJL. 
  525.          
  526.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  527.          This paragraph will be fully justified,
  528.          because at this point of the
  529.          document this is the current justification mode.  The mode full
  530.          justification   means that each line of the paragraph begin
  531.          at the same column, and finish at the same column.
  532.          
  533.           \AJL
  534.          This paragraph    will be formatted in such a way as to left
  535.          justify the lines of the paragraph.  The command \AJF that follows
  536.          this paragraph reset the full justification mode on.
  537.           \AJF
  538.          
  539.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  540.          
  541.          This paragraph will  be fully justified,  because at this point of
  542.          the document this is the current justification mode. The mode full
  543.          justification means that  each line of the paragraph begin at  the
  544.          same column, and finish at the same column. 
  545.          
  546.          This paragraph will be formatted in such a way as to left justify 
  547.          the lines of the paragraph. The command \AJF that follows this 
  548.          paragraph reset the full justification mode on. 
  549.          
  550.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  551.          
  552.          The next section  describes the commands and their  functions into
  553.          details. 
  554.          
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.          ══════════════════════════════════════════════════════════════════
  566.          General Principles                                          Page 9
  567.  
  568.          TXFORM USER'S GUIDE                                           v1.2
  569.          ══════════════════════════════════════════════════════════════════
  570.  
  571.          
  572.          
  573.          
  574.          
  575.                      ╒════════════════════════════════════════╕            
  576.                      │                                        │            
  577.                      │              CHAPTER III               │            
  578.                      │                                        │            
  579.                      ╞════════════════════════════════════════╡            
  580.                      │                                        │            
  581.                      │          Commands Description          │            
  582.                      │                                        │            
  583.                      ╘════════════════════════════════════════╛            
  584.          
  585.          
  586.          
  587.          
  588.          
  589.          ──────────────────────────────────────────────────────────────────
  590.          III.1 Command Structure
  591.          ──────────────────────────────────────────────────────────────────
  592.          
  593.          A command line is structured as follows: 
  594.          
  595.                   \CMD:Arg1:Arg2:Arg3:...
  596.          
  597.             ■ '\' identify the line as a command line. This  character must
  598.               be in column one. 
  599.          
  600.               Note  that  the examples throughout  this document  show  the
  601.               commands beginning at column 2. This is because this document
  602.               is produced with  TXFORM, and therefore if  the  commands had
  603.               been  put in column  1, they would have been  interpreted and
  604.               not shown in this tutorial text. 
  605.          
  606.             ■ 'CMD' is  the command itself.  The  command is identified  by
  607.               three characters that are not case sensitive. 
  608.          
  609.             ■ After  the  command  name,  we  find  an  optional  list   of
  610.               parameters  that  are  separated  by  ':'.   The  number   of
  611.               parameters and their meaning depend upon the command. 
  612.          
  613.          
  614.          ──────────────────────────────────────────────────────────────────
  615.          III.2 Commands Names
  616.          ──────────────────────────────────────────────────────────────────
  617.          
  618.          The  commands   availables  are  grouped  into   logicaly  related
  619.          functions. 
  620.          
  621.          To help you remembering the name of the functions, each command in
  622.          a same group begins with one or two same letters. 
  623.          
  624.  
  625.  
  626.  
  627.  
  628.          ══════════════════════════════════════════════════════════════════
  629.          Commands Description                                       Page 10
  630.  
  631.          TXFORM USER'S GUIDE                                           v1.2
  632.          ══════════════════════════════════════════════════════════════════
  633.  
  634.          This is the list of groups and related letters: 
  635.          
  636.               ╒══════════════════════════╤═══════════════════════════╕     
  637.               │  The group of functions  │ has commands whose name   │     
  638.               │       related to         │   begin with letter(s)    │     
  639.               ╞══════════════════════════╪═══════════════════════════╡     
  640.               │ Page formatting          │           P               │     
  641.               ├──────────────────────────┼───────────────────────────┤     
  642.               │ Paragraph formatting     │           A               │     
  643.               ├──────────────────────────┼───────────────────────────┤     
  644.               │ Framed paragraphs        │           AM              │     
  645.               ├──────────────────────────┼───────────────────────────┤     
  646.               │ Itemized paragraphs      │           IT              │     
  647.               ├──────────────────────────┼───────────────────────────┤     
  648.               │ Section numbering        │           S               │     
  649.               ├──────────────────────────┼───────────────────────────┤     
  650.               │ Macro definition         │           MA              │     
  651.               ├──────────────────────────┼───────────────────────────┤     
  652.               │ Header management        │           H               │     
  653.               ├──────────────────────────┼───────────────────────────┤     
  654.               │ Footer management        │           F               │     
  655.               ├──────────────────────────┼───────────────────────────┤     
  656.               │ Conditional compile      │           CC              │     
  657.               ├──────────────────────────┼───────────────────────────┤     
  658.               │ Various                  │           ...             │     
  659.               ╘══════════════════════════╧═══════════════════════════╛     
  660.          
  661.          In the following tables, a '*' show the default  options,  and the
  662.          default values are indicated where applicable. 
  663.          
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.  
  672.  
  673.  
  674.  
  675.  
  676.  
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.  
  688.  
  689.  
  690.  
  691.          ══════════════════════════════════════════════════════════════════
  692.          Commands Description                                       Page 11
  693.  
  694.          TXFORM USER'S GUIDE                                           v1.2
  695.          ══════════════════════════════════════════════════════════════════
  696.  
  697.          
  698.          ──────────────────────────────────────────────────────────────────
  699.          III.3 Page formatting options
  700.          ──────────────────────────────────────────────────────────────────
  701.          
  702.          ╒══════════╤═════════════════════════════════════════════════════╕
  703.          │  Pxx     │ Page Formatting Options                             │
  704.          ╞══════════╪═════════════════════════════════════════════════════╡
  705.          │  PJU     │ Jump to next page                                   │
  706.          │  PJC     │ Jump to next page is less then Arg1 lines remaining │
  707.          ├──────────┼─────────────────────────────────────────────────────┤
  708.          │  PNB     │ Set actual page number to Arg1                      │
  709.          ├──────────┼─────────────────────────────────────────────────────┤
  710.          │  PML     │ Set Left Margin to Arg1 (Default=5)                 │
  711.          │  PMR     │ Set Right Margin to Arg1 (Default=75)               │
  712.          ├──────────┼─────────────────────────────────────────────────────┤
  713.          │  PLE     │ Set Page Length to Arg1  (Default=62)               │
  714.          ╘══════════╧═════════════════════════════════════════════════════╛
  715.          
  716.          III.3.A PJU = Jump to next page
  717.          ═══════ ═══════════════════════
  718.          
  719.          A  page contains  a number  of  lines  that  default  to 62.  This
  720.          includes the lines  taken by the footer, the header, and  the area
  721.          reserved for text in between. 
  722.          
  723.          TXFORM will write each line after  an other. When it  begins a new
  724.          page, it will  first  write  the header lines.  At the end  of the
  725.          page, it will write the footer lines. 
  726.          
  727.          You may  force TXFORM to jump  to a new page, whatever the current
  728.          line is, simply by inserting the command "\PJU". 
  729.          
  730.          III.3.B PJC = Jump to next page if less then Arg1 lines
  731.          ═══════ ═══════════════════════════════════════════════
  732.          
  733.          This  command is similar to the previous  one, except that it will
  734.          jump to the  next page only if there are less than Arg1 free lines
  735.          on the current page.  Note that the number of  lines to remain are
  736.          the number of lines in  the text area, without taking into account
  737.          the number  of lines  required  by  the footer  (TXFORM takes  the
  738.          footer lines into consideration for you). 
  739.          
  740.          For example, if you want to make  sure that a title that  requires
  741.          four lines is on the same page than the beginning of the text that
  742.          follows, use the command "\PJC:5" 
  743.          
  744.          III.3.C PNB = Set actual page number to Arg1
  745.          ═══════ ════════════════════════════════════
  746.          
  747.          Each page of  the output document is numbered, starting with  1 at
  748.          the first page. You may change  the current number of a page  with
  749.          the command \PNB. 
  750.          
  751.          Note that  you  must change  the page number before this number is
  752.          written. If you have set the page number in the footer, change the
  753.  
  754.          ══════════════════════════════════════════════════════════════════
  755.          Commands Description                                       Page 12
  756.  
  757.          TXFORM USER'S GUIDE                                           v1.2
  758.          ══════════════════════════════════════════════════════════════════
  759.  
  760.          page number  when  you are in the page with the new number. If you
  761.          have put the page number in the header, change  the page number on
  762.          the previous page. 
  763.          
  764.          For example, to put the current page number to 21, use the command
  765.          "\PNB:21". 
  766.          
  767.          III.3.D PML = Set Left Margin to Arg1
  768.          ═══════ ═════════════════════════════
  769.          
  770.          Each  line  of  text  is written between  the  left and the  right
  771.          margins. The margins  are  expressed in  characters from the  left
  772.          side  of the page. The default left margin  is 5, and the  default
  773.          right margin is 75. 
  774.          
  775.          You may change the left margin with the command PML. 
  776.          
  777.          For example, to put the left margin at 20 characters from the left
  778.          of the page, use the command "\PML:20" (see example below). 
  779.          
  780.          Note that  the  left and right margins are characteristics of  you
  781.          paper. These values are also used for the horizontal alignments of
  782.          headers and footers. If you want to move  the margins only for the
  783.          text  formatting,  whitout changing anything  to  the  footers and
  784.          headers, you should use the commands "\AIL" and "\AIR" that define
  785.          the text indents with respect to the margins. 
  786.          
  787.          III.3.E PMR = Set Right Margin to Arg1
  788.          ═══════ ══════════════════════════════
  789.          
  790.          You may change the right margin with the command PMR (see previous
  791.          paragraph for more on margins). 
  792.          
  793.          For  example, to  put the  right margin at 60 characters  from the
  794.          left of the page, use the  command  "\PMR:60", as in the following
  795.          example. 
  796.          
  797.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  798.           \PML:20
  799.           \PMR:60
  800.          This paragraph will be fully justified between the columns
  801.          20 and 60, as defined by the two commands issued hereabove.
  802.          To make sure the rest of the text is formatted as above, we
  803.          reset the original margins herebelow.
  804.           \PML:10
  805.           \PMR:75
  806.          
  807.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  808.          
  809.                    This  paragraph will  be fully  justified
  810.                    between the columns 20 and 60, as defined
  811.                    by the two commands  issued hereabove. To
  812.                    make  sure  the  rest  of  the  text   is
  813.                    formatted as above, we reset the original
  814.                    margins herebelow. 
  815.                    
  816.  
  817.          ══════════════════════════════════════════════════════════════════
  818.          Commands Description                                       Page 13
  819.  
  820.          TXFORM USER'S GUIDE                                           v1.2
  821.          ══════════════════════════════════════════════════════════════════
  822.  
  823.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  824.          
  825.          III.3.F PLE = Set Page Length to Arg1
  826.          ═══════ ═════════════════════════════
  827.          
  828.          You may  change the number  of  lines on one page with the command
  829.          PLE. 
  830.          
  831.          For  example,  to  set  the page length  to  60,  use  the command
  832.          "\PLE:60". 
  833.          
  834.          Note that  the page  length includes the  lines required  for  the
  835.          footer and the header. 
  836.          
  837.  
  838.  
  839.  
  840.  
  841.  
  842.  
  843.  
  844.  
  845.  
  846.  
  847.  
  848.  
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.  
  863.  
  864.  
  865.  
  866.  
  867.  
  868.  
  869.  
  870.  
  871.  
  872.  
  873.  
  874.  
  875.  
  876.  
  877.  
  878.  
  879.  
  880.          ══════════════════════════════════════════════════════════════════
  881.          Commands Description                                       Page 14
  882.  
  883.          TXFORM USER'S GUIDE                                           v1.2
  884.          ══════════════════════════════════════════════════════════════════
  885.  
  886.          
  887.          ──────────────────────────────────────────────────────────────────
  888.          III.4 Paragraph formatting options
  889.          ──────────────────────────────────────────────────────────────────
  890.          
  891.          ╒══════════╤═════════════════════════════════════════════════════╕
  892.          │  Axx     │ Paragraph Formatting Options                        │
  893.          ╞══════════╪═════════════════════════════════════════════════════╡
  894.          │  AC-   * │ center text off                                     │
  895.          │  AC+     │ center text on                                      │
  896.          ├──────────┼─────────────────────────────────────────────────────┤
  897.          │  AF-     │ fill text off                                       │
  898.          │  AF+   * │ fill text on                                        │
  899.          ├──────────┼─────────────────────────────────────────────────────┤
  900.          │  AIL     │ indent left margin of Arg1 columns (Default=0)      │
  901.          │  AIR     │ indent right margin of Arg1 columns (Default=0)     │
  902.          ├──────────┼─────────────────────────────────────────────────────┤
  903.          │  ASL     │ set number of blank lines after paragraph to Arg1   │
  904.          │          │ (Default=1)                                         │
  905.          ├──────────┼─────────────────────────────────────────────────────┤
  906.          │  AJL   * │ left justify text                                   │
  907.          │  AJR     │ right justify text                                  │
  908.          │  AJF     │ full justify text                                   │
  909.          ╘══════════╧═════════════════════════════════════════════════════╛
  910.          
  911.          III.4.A AC- = center text off
  912.          ═══════ ═════════════════════
  913.          
  914.          By default, the "center  text" option is off. This means that  the
  915.          text will be justified between the left and right margins. 
  916.          
  917.          The "\AC-" option is used to reset this option off when  it is has
  918.          been set on with the command "\AC+" (see below). 
  919.          
  920.          III.4.B AC+ = center text on
  921.          ═══════ ════════════════════
  922.          
  923.          The "center text on" option changes the  way the text is formatted
  924.          in the following manner: 
  925.          
  926.             ■ Each line is taken exactly as it  is written (with any number
  927.               of blank between the words). 
  928.          
  929.             ■ Each line is centered between the left and right margins. 
  930.          
  931.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  932.           \AC+
  933.             These lines will be centered between the margins.
  934.                 The blanks between the words     will not be modified.
  935.           \AC-
  936.          
  937.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  938.          
  939.                  These lines will be centered between the margins.         
  940.                The blanks between the words     will not be modified.      
  941.          
  942.  
  943.          ══════════════════════════════════════════════════════════════════
  944.          Commands Description                                       Page 15
  945.  
  946.          TXFORM USER'S GUIDE                                           v1.2
  947.          ══════════════════════════════════════════════════════════════════
  948.  
  949.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  950.          
  951.          III.4.C AF- = fill text off
  952.          ═══════ ═══════════════════
  953.          
  954.          By default, the  "Fill  text" option is  on. This means  that  the
  955.          input text will be  modified  to make sure that  there is only one
  956.          blank  character between  each word. When you  put it off with the
  957.          "\AF-" command, this will no longer be true, and  the intermediary
  958.          blank characters will remain unchanged.  Also, each  line will  be
  959.          printed separately (no concatenation). Use the "\AF+" to reset the
  960.          "Fill text" mode on. 
  961.          
  962.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  963.          This line is written   with the   "fill text"   mode   on.
  964.           \AF-
  965.          This line is written   with the   "fill text"   mode   off.
  966.           \AF+
  967.          
  968.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  969.          
  970.          This line is written with the "fill text" mode on. 
  971.          
  972.          This line is written   with the   "fill text"   mode   off.
  973.          
  974.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  975.          
  976.          The "Fill text" mode off is  useful when you want to  force TXFORM
  977.          to output the  text as  you would  like  it.  Note also  that  the
  978.          "Center text" mode will overwrite the "Fill text" mode settings. 
  979.          
  980.          III.4.D AF+ = fill text on
  981.          ═══════ ══════════════════
  982.          
  983.          This  command  is  used to  reset  the "Fill  text" mode  on.  See
  984.          previous paragraph for details and example. 
  985.          
  986.          III.4.E AIL = indent left margin of Arg1 columns
  987.          ═══════ ════════════════════════════════════════
  988.          
  989.          The "\AIL" command allows you to move the left margin of  a  given
  990.          number of characters. There are two main  differences between this
  991.          command and the margin command "\PML": 
  992.          
  993.             ■ you  do  not  need  to  know  where  the  margin is  actually
  994.               positioned,  which  can  be  useful, for  example in included
  995.               files. 
  996.          
  997.             ■ the  indent acts  only on the text margin,  not on the header
  998.               and footer left and right margins. 
  999.          
  1000.          You move the  left  margin to the  right by  using a positive Arg1
  1001.          value, and to the left using a negative Arg1 value, as in the next
  1002.          example: 
  1003.          
  1004.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1005.  
  1006.          ══════════════════════════════════════════════════════════════════
  1007.          Commands Description                                       Page 16
  1008.  
  1009.          TXFORM USER'S GUIDE                                           v1.2
  1010.          ══════════════════════════════════════════════════════════════════
  1011.  
  1012.          This is text with the current left margin indent of 0.
  1013.           \AIL:5
  1014.          This is text with left margin indented of 5 chars right.
  1015.          After this text, we indent the margin again to the left, to restore
  1016.          the initial settings.
  1017.           \AIL:-5
  1018.          This is text with initial left margin indent setting.
  1019.          
  1020.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1021.          
  1022.          This is text with the current left margin indent of 0. 
  1023.          
  1024.               This is text with  left margin  indented of  5  chars  right.
  1025.               After this text, we indent the margin again  to the left,  to
  1026.               restore the initial settings. 
  1027.          
  1028.          This is text with initial left margin indent setting. 
  1029.          
  1030.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1031.          
  1032.          III.4.F AIR = indent right margin of Arg1 columns
  1033.          ═══════ ═════════════════════════════════════════
  1034.          
  1035.          This command is similar to the "\AIL" command, except that it acts
  1036.          on the right margin. 
  1037.          
  1038.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1039.          This is text with the current right margin indent of 0.  We have to
  1040.          add some text to make sure we reach the right margin, so you
  1041.          can see what is going on.
  1042.           \AIR:-10
  1043.          This is text with right margin indented of 10 chars left.
  1044.          After this text, we indent the margin again to the right, to restore
  1045.          the initial settings.
  1046.           \AIR:+10
  1047.          This is text with initial right margin indent setting. We have to
  1048.          add some text to make sure we reach the right margin, so you
  1049.          can see what is going on.
  1050.          
  1051.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1052.          
  1053.          This is text with the current right margin indent of 0. We have to
  1054.          add some text to make  sure we  reach the right margin, so you can
  1055.          see what is going on. 
  1056.          
  1057.          This is text with right margin indented of 5 chars left.
  1058.          After  this text, we indent  the  margin  again  to  the
  1059.          right, to restore the initial settings. 
  1060.          
  1061.          This is text  with initial right margin indent setting. We have to
  1062.          add some text to make sure  we reach the right  margin, so you can
  1063.          see what is going on. 
  1064.          
  1065.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1066.          
  1067.  
  1068.  
  1069.          ══════════════════════════════════════════════════════════════════
  1070.          Commands Description                                       Page 17
  1071.  
  1072.          TXFORM USER'S GUIDE                                           v1.2
  1073.          ══════════════════════════════════════════════════════════════════
  1074.  
  1075.          III.4.G ASL = number of blank lines after paragraph
  1076.          ═══════ ═══════════════════════════════════════════
  1077.          
  1078.          By default, TXFORM will skip 1 blank  line  after each  paragraph.
  1079.          You may  change this setting  by specifying  the number  of  blank
  1080.          lines to be skipped with the command "\ASL". 
  1081.          
  1082.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1083.          After this line, one blank line will be skipped
  1084.           \ASL:2
  1085.          After this line, two blank lines will be skipped.
  1086.           \ASL:1
  1087.          Again, after this line, one blank line will be skipped
  1088.          
  1089.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1090.          
  1091.          After this line, one blank line will be skipped 
  1092.          
  1093.          After this line, two blank lines will be skipped. 
  1094.          
  1095.          
  1096.          Again, after this line, one blank line will be skipped 
  1097.          
  1098.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1099.          
  1100.          III.4.H AJL = left justify text
  1101.          ═══════ ═══════════════════════
  1102.          
  1103.          This command is used to left justify the text within  the margins.
  1104.          See "Full Justify Text" for example. 
  1105.          
  1106.          III.4.I AJR = right justify text
  1107.          ═══════ ════════════════════════
  1108.          
  1109.          This command is used to right justify the text within the margins.
  1110.          See "Full Justify Text" for example. 
  1111.          
  1112.          III.4.J AJF = full justify text
  1113.          ═══════ ═══════════════════════
  1114.          
  1115.          This command is used  to full justify the text within the margins.
  1116.          Justification is illustrated here below: 
  1117.          
  1118.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1119.           \AJL
  1120.          Example of left justification.  This is just any text that we
  1121.          use as an example of what justification means.  This is still
  1122.          an other line that is useful to show the results.
  1123.           \AJR
  1124.          Example of right justification.  This is just any text that we
  1125.          use as an example of what justification means.  This is still
  1126.          an other line that is useful to show the results.
  1127.           \AJF
  1128.          Example of full justification.  This is just any text that we
  1129.          use as an example of what justification means.  This is still
  1130.          an other line that is useful to show the results.
  1131.  
  1132.          ══════════════════════════════════════════════════════════════════
  1133.          Commands Description                                       Page 18
  1134.  
  1135.          TXFORM USER'S GUIDE                                           v1.2
  1136.          ══════════════════════════════════════════════════════════════════
  1137.  
  1138.          
  1139.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1140.          
  1141.          Example of left justification. This is just any text that we use 
  1142.          as an example of what justification means. This is still an other 
  1143.          line that is useful to show the results. 
  1144.          
  1145.           Example of right justification. This is just any text that we use
  1146.           as an example of what justification means. This is still an other
  1147.                                    line that is useful to show the results.
  1148.          
  1149.          Example  of full justification. This is just any text that  we use
  1150.          as an example  of what justification means. This is still an other
  1151.          line that is useful to show the results. 
  1152.          
  1153.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1154.          
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162.  
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.  
  1172.  
  1173.  
  1174.  
  1175.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.          ══════════════════════════════════════════════════════════════════
  1196.          Commands Description                                       Page 19
  1197.  
  1198.          TXFORM USER'S GUIDE                                           v1.2
  1199.          ══════════════════════════════════════════════════════════════════
  1200.  
  1201.          
  1202.          ──────────────────────────────────────────────────────────────────
  1203.          III.5 Framed paragraphs
  1204.          ──────────────────────────────────────────────────────────────────
  1205.          
  1206.          ╒══════════╤═════════════════════════════════════════════════════╕
  1207.          │  AMx     │ Framed Paragraph                                    │
  1208.          ╞══════════╪═════════════════════════════════════════════════════╡
  1209.          │  AM-   * │ set frame off                                       │
  1210.          │  AM+     │ set frame on                                        │
  1211.          ├──────────┼─────────────────────────────────────────────────────┤
  1212.          │  AML     │ left align frame                                    │
  1213.          │  AMR     │ right align frame                                   │
  1214.          │  AMC   * │ center frame                                        │
  1215.          ├──────────┼─────────────────────────────────────────────────────┤
  1216.          │  AMW     │ set frame width (Default=35)                        │
  1217.          ├──────────┼─────────────────────────────────────────────────────┤
  1218.          │  AMS     │ set frame style to Arg1 (Default=1)                 │
  1219.          ╘══════════╧═════════════════════════════════════════════════════╛
  1220.          
  1221.          III.5.A AM- = set frame off
  1222.          ═══════ ═══════════════════
  1223.          
  1224.          This command  is used to terminate the "Frame"  mode that has been
  1225.          set by the command "\AM+". See below for more on this topic. 
  1226.          
  1227.          III.5.B AM+ = set frame on
  1228.          ═══════ ══════════════════
  1229.          
  1230.          You may create a frame around your  text  by putting  the  command
  1231.          "\AM+" before the text to be  framed, and the command "\AM-" after
  1232.          the text to be framed. 
  1233.          
  1234.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1235.           \AM+
  1236.          By default, the frame is centered, and is 35 characters of width.
  1237.           \AM-
  1238.          
  1239.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1240.          
  1241.                       ╒═════════════════════════════════════╕              
  1242.                       │ By default, the frame  is centered, │              
  1243.                       │ and is 35 characters of width.      │              
  1244.                       ╘═════════════════════════════════════╛              
  1245.          
  1246.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1247.          
  1248.          If you put the option "Fill Text" Off, then: 
  1249.          
  1250.             ■ Each line will be written as it is entered in the input file 
  1251.          
  1252.             ■ The text will be centered 
  1253.          
  1254.             ■ The width of the frame will be adapted to fit the text 
  1255.          
  1256.             ■ A line that contains  only the  "-" character will produce an
  1257.  
  1258.          ══════════════════════════════════════════════════════════════════
  1259.          Commands Description                                       Page 20
  1260.  
  1261.          TXFORM USER'S GUIDE                                           v1.2
  1262.          ══════════════════════════════════════════════════════════════════
  1263.  
  1264.               horizontal line in the frame. 
  1265.          
  1266.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1267.           \AF-
  1268.           \AM+
  1269.          With the "\AF-" command, the size of
  1270.          the frame will be adapted to fit the
  1271.          text in, and the text will be
  1272.          centered
  1273.          -
  1274.          You may add an horizontal line using the "\AF-"
  1275.          command, and putting only the
  1276.          character "-" on a line.
  1277.           \AM-
  1278.           \AF+
  1279.          
  1280.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1281.          
  1282.                 ╒═════════════════════════════════════════════════╕        
  1283.                 │      With the "\AF-" command, the size of       │        
  1284.                 │      the frame will be adapted to fit the       │        
  1285.                 │          text in, and the text will be          │        
  1286.                 │                    centered                     │        
  1287.                 ╞═════════════════════════════════════════════════╡        
  1288.                 │ You may add an horizontal line using the "\AF-" │        
  1289.                 │          command, and putting only the          │        
  1290.                 │            character "-" on a line.             │        
  1291.                 ╘═════════════════════════════════════════════════╛        
  1292.          
  1293.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1294.          
  1295.          III.5.C AML = left align frame
  1296.          ═══════ ══════════════════════
  1297.          
  1298.          You may align the frame on the left. See example below. 
  1299.          
  1300.          III.5.D AMR = right align frame
  1301.          ═══════ ═══════════════════════
  1302.          
  1303.          You may align the frame on the right. See example below. 
  1304.          
  1305.          III.5.E AMC = center frame
  1306.          ═══════ ══════════════════
  1307.          
  1308.          You may align the frame on the center of the margins. 
  1309.          
  1310.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1311.           \AML
  1312.           \AM+
  1313.          The frame can be left aligned with the command \AML
  1314.           \AM-
  1315.           \AMR
  1316.           \AM+
  1317.          The frame can be right aligned with the command \AMR
  1318.           \AM-
  1319.           \AMC
  1320.  
  1321.          ══════════════════════════════════════════════════════════════════
  1322.          Commands Description                                       Page 21
  1323.  
  1324.          TXFORM USER'S GUIDE                                           v1.2
  1325.          ══════════════════════════════════════════════════════════════════
  1326.  
  1327.           \AM+
  1328.          The frame can be centered with the command \AMC
  1329.           \AM-
  1330.          
  1331.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1332.          
  1333.          ╒═════════════════════════════════════╕
  1334.          │ The frame  can be left aligned with │
  1335.          │ the command \AML                    │
  1336.          ╘═════════════════════════════════════╛
  1337.          
  1338.                                     ╒═════════════════════════════════════╕
  1339.                                     │ The frame can be right aligned with │
  1340.                                     │ the command \AMR                    │
  1341.                                     ╘═════════════════════════════════════╛
  1342.          
  1343.                       ╒═════════════════════════════════════╕              
  1344.                       │ The frame can be centered with  the │              
  1345.                       │ command \AMC                        │              
  1346.                       ╘═════════════════════════════════════╛              
  1347.          
  1348.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1349.          
  1350.          III.5.F AMW = set frame width
  1351.          ═══════ ═════════════════════
  1352.          
  1353.          You may change the width of the frame. For example: 
  1354.          
  1355.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1356.           \AMW:45
  1357.           \AM+
  1358.          The frame width has been changed to 45 characters,
  1359.          using the command "\AMW:45"
  1360.           \AM-
  1361.          
  1362.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1363.          
  1364.                  ╒═══════════════════════════════════════════════╕         
  1365.                  │ The  frame  width  has  been  changed  to  45 │         
  1366.                  │ characters, using the command "\AMW:45"       │         
  1367.                  ╘═══════════════════════════════════════════════╛         
  1368.          
  1369.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1370.          
  1371.          III.5.G AMS = set frame style to Arg1
  1372.          ═══════ ═════════════════════════════
  1373.          
  1374.          By default, the frame style is as shown in the previous  examples.
  1375.          It is  called frame style  number 1. There  are 6  different frame
  1376.          styles that you may use. They are shown in the following example: 
  1377.          
  1378.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1379.           \AF-
  1380.           \AMS:1
  1381.           \AM+
  1382.          This is frame style number 1, the default one
  1383.  
  1384.          ══════════════════════════════════════════════════════════════════
  1385.          Commands Description                                       Page 22
  1386.  
  1387.          TXFORM USER'S GUIDE                                           v1.2
  1388.          ══════════════════════════════════════════════════════════════════
  1389.  
  1390.          -
  1391.          Style One
  1392.           \AM-
  1393.           \AMS:2
  1394.           \AM+
  1395.          This is frame style number 2
  1396.          -
  1397.          Style Two
  1398.           \AM-
  1399.           \AMS:3
  1400.           \AM+
  1401.          This is frame style number 3
  1402.          -
  1403.          Style Three
  1404.           \AM-
  1405.           \AMS:4
  1406.           \AM+
  1407.          This is frame style number 4
  1408.          -
  1409.          Style Four
  1410.           \AM-
  1411.           \AMS:5
  1412.           \AM+
  1413.          This is frame style number 5
  1414.          -
  1415.          Style Five
  1416.           \AM-
  1417.           \AMS:6
  1418.           \AM+
  1419.          This is frame style number 6 (=No frame)
  1420.          -
  1421.          Style Six
  1422.           \AM-
  1423.           \AF+
  1424.          
  1425.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1426.          
  1427.                  ╒═══════════════════════════════════════════════╕         
  1428.                  │ This is frame style number 1, the default one │         
  1429.                  ╞═══════════════════════════════════════════════╡         
  1430.                  │                   Style One                   │         
  1431.                  ╘═══════════════════════════════════════════════╛         
  1432.          
  1433.                  ┌───────────────────────────────────────────────┐         
  1434.                  │         This is frame style number 2          │         
  1435.                  ├───────────────────────────────────────────────┤         
  1436.                  │                   Style Two                   │         
  1437.                  └───────────────────────────────────────────────┘         
  1438.          
  1439.                  ╔═══════════════════════════════════════════════╗         
  1440.                  ║         This is frame style number 3          ║         
  1441.                  ╠═══════════════════════════════════════════════╣         
  1442.                  ║                  Style Three                  ║         
  1443.                  ╚═══════════════════════════════════════════════╝         
  1444.          
  1445.                  ╓───────────────────────────────────────────────╖         
  1446.  
  1447.          ══════════════════════════════════════════════════════════════════
  1448.          Commands Description                                       Page 23
  1449.  
  1450.          TXFORM USER'S GUIDE                                           v1.2
  1451.          ══════════════════════════════════════════════════════════════════
  1452.  
  1453.                  ║         This is frame style number 4          ║         
  1454.                  ╟───────────────────────────────────────────────╢         
  1455.                  ║                  Style Four                   ║         
  1456.                  ╙───────────────────────────────────────────────╜         
  1457.          
  1458.                  !-----------------------------------------------!         
  1459.                  !         This is frame style number 5          !         
  1460.                  !-----------------------------------------------!         
  1461.                  !                  Style Five                   !         
  1462.                  !-----------------------------------------------!         
  1463.          
  1464.                                                                            
  1465.                      This is frame style number 6 (=No frame)              
  1466.                                                                            
  1467.                                      Style Six                             
  1468.                                                                            
  1469.          
  1470.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1471.          
  1472.  
  1473.  
  1474.  
  1475.  
  1476.  
  1477.  
  1478.  
  1479.  
  1480.  
  1481.  
  1482.  
  1483.  
  1484.  
  1485.  
  1486.  
  1487.  
  1488.  
  1489.  
  1490.  
  1491.  
  1492.  
  1493.  
  1494.  
  1495.  
  1496.  
  1497.  
  1498.  
  1499.  
  1500.  
  1501.  
  1502.  
  1503.  
  1504.  
  1505.  
  1506.  
  1507.  
  1508.  
  1509.  
  1510.          ══════════════════════════════════════════════════════════════════
  1511.          Commands Description                                       Page 24
  1512.  
  1513.          TXFORM USER'S GUIDE                                           v1.2
  1514.          ══════════════════════════════════════════════════════════════════
  1515.  
  1516.          
  1517.          ──────────────────────────────────────────────────────────────────
  1518.          III.6 Itemizing paragraph
  1519.          ──────────────────────────────────────────────────────────────────
  1520.          
  1521.          ╒══════════╤═════════════════════════════════════════════════════╕
  1522.          │  ITx     │ Itemized Paragraph                                  │
  1523.          ╞══════════╪═════════════════════════════════════════════════════╡
  1524.          │  ITZ     │ start itemized mode with char Arg1                  │
  1525.          │  ITT     │ itemized next paragraph                             │
  1526.          │  ITS     │ stop itemized mode                                  │
  1527.          ╘══════════╧═════════════════════════════════════════════════════╛
  1528.          
  1529.          "Itemizing" the paragraphs means to use bullets and indentation at
  1530.          the beginning of each paragraph, as in the example shown below. 
  1531.          
  1532.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1533.           \ITZ:■
  1534.           \ITT
  1535.            This is the first paragraph of the itemized items.
  1536.           \ITT
  1537.            This is the second paragraph of the itemized items.
  1538.           \ITS
  1539.          
  1540.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1541.          
  1542.             ■ This is the first paragraph of the itemized items. 
  1543.          
  1544.             ■ This is the second paragraph of the itemized items. 
  1545.          
  1546.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1547.          
  1548.          III.6.A ITZ = start itemized mode with char Arg1
  1549.          ═══════ ════════════════════════════════════════
  1550.          
  1551.          You start the itemization of  paragraphs with the command "\ITZ:c"
  1552.          where "c" is the caracter to be used as a bullet. 
  1553.          
  1554.          III.6.B ITT = itemized next paragraph
  1555.          ═══════ ═════════════════════════════
  1556.          
  1557.          Each time you want to itemize  the next  paragraph,  you  put  the
  1558.          command   "\ITT"  before   it.  Note  that   itemization  is   not
  1559.          automatically done for each new paragraph. 
  1560.          
  1561.          III.6.C ITS = stop itemized mode
  1562.          ═══════ ════════════════════════
  1563.          
  1564.          When Itemization  of  paragraphs is not  longer required,  use the
  1565.          command "\ITS" 
  1566.          
  1567.          III.6.D Nesting itemization
  1568.          ═══════ ═══════════════════
  1569.          
  1570.          You may nest different  itemizations, using  different bullets, as
  1571.          in the following example: 
  1572.  
  1573.          ══════════════════════════════════════════════════════════════════
  1574.          Commands Description                                       Page 25
  1575.  
  1576.          TXFORM USER'S GUIDE                                           v1.2
  1577.          ══════════════════════════════════════════════════════════════════
  1578.  
  1579.          
  1580.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1581.           \ITZ:■
  1582.           \ITT
  1583.            This is first item of level 1
  1584.          
  1585.            Note that itemization is not automatically done for each
  1586.            new paragraph.
  1587.           \ITZ:*
  1588.           \ITT
  1589.            This is first item of level 2
  1590.           \ITT
  1591.            This is second item of level 2
  1592.           \ITT
  1593.           \ITS
  1594.           \ITT
  1595.            This is second item of level 1
  1596.           \ITT
  1597.           \ITS
  1598.          
  1599.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  1600.          
  1601.             ■ This is first item of level 1 
  1602.          
  1603.               Note that  itemization is not automatically done for each new
  1604.               paragraph. 
  1605.          
  1606.                  * This is first item of level 2 
  1607.          
  1608.                  * This is second item of level 2 
  1609.          
  1610.             ■ This is second item of level 1 
  1611.          
  1612.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  1613.          
  1614.  
  1615.  
  1616.  
  1617.  
  1618.  
  1619.  
  1620.  
  1621.  
  1622.  
  1623.  
  1624.  
  1625.  
  1626.  
  1627.  
  1628.  
  1629.  
  1630.  
  1631.  
  1632.  
  1633.  
  1634.  
  1635.  
  1636.          ══════════════════════════════════════════════════════════════════
  1637.          Commands Description                                       Page 26
  1638.  
  1639.          TXFORM USER'S GUIDE                                           v1.2
  1640.          ══════════════════════════════════════════════════════════════════
  1641.  
  1642.          
  1643.          ──────────────────────────────────────────────────────────────────
  1644.          III.7 Sections management
  1645.          ──────────────────────────────────────────────────────────────────
  1646.          
  1647.          ╒══════════╤═════════════════════════════════════════════════════╕
  1648.          │  Sxx     │ Section Management                                  │
  1649.          ╞══════════╪═════════════════════════════════════════════════════╡
  1650.          │  SLV     │ set new section level Arg1 with title Arg2          │
  1651.          ├──────────┼─────────────────────────────────────────────────────┤
  1652.          │  SAP     │ set appendix mode                                   │
  1653.          ╘══════════╧═════════════════════════════════════════════════════╛
  1654.          
  1655.          III.7.A SLV = set new section level Arg1 with title Arg2
  1656.          ═══════ ════════════════════════════════════════════════
  1657.          
  1658.          Each  time you want  to start a  new section, you use the  command
  1659.          "\SLV:x:title" where 
  1660.          
  1661.             ■ "x" is the level of the section 
  1662.          
  1663.               TXFORM  can handle four  different  levels. For  each  level,
  1664.               there is a specific layout  in the  output file. You can  not
  1665.               change this layout. The first level is called "Chapter". 
  1666.          
  1667.             ■ "Title" is the title of the section 
  1668.          
  1669.          The sections  and  their  level  and  title will be  automatically
  1670.          included in the table of contents. 
  1671.          
  1672.          III.7.B SAP = set appendix mode
  1673.          ═══════ ═══════════════════════
  1674.          
  1675.          Once you  issue the  command "\SAP",  you enter into the Appendice
  1676.          mode. It is the  same as the normal mode,  except  that level  one
  1677.          sections are called "Appendices". 
  1678.          
  1679.          Once you have set the Appendice  mode on, you can not come back to
  1680.          normal mode. 
  1681.          
  1682.  
  1683.  
  1684.  
  1685.  
  1686.  
  1687.  
  1688.  
  1689.  
  1690.  
  1691.  
  1692.  
  1693.  
  1694.  
  1695.  
  1696.  
  1697.  
  1698.  
  1699.          ══════════════════════════════════════════════════════════════════
  1700.          Commands Description                                       Page 27
  1701.  
  1702.          TXFORM USER'S GUIDE                                           v1.2
  1703.          ══════════════════════════════════════════════════════════════════
  1704.  
  1705.          
  1706.          ──────────────────────────────────────────────────────────────────
  1707.          III.8 Macros
  1708.          ──────────────────────────────────────────────────────────────────
  1709.          
  1710.          ╒══════════╤═════════════════════════════════════════════════════╕
  1711.          │  MAx     │ Macro Management                                    │
  1712.          ╞══════════╪═════════════════════════════════════════════════════╡
  1713.          │  MAD     │ define macro Arg1 to be replaced by Arg2            │
  1714.          ├──────────┼─────────────────────────────────────────────────────┤
  1715.          │  MAP     │ define macro Arg1 to be replaced by page number     │
  1716.          ├──────────┼─────────────────────────────────────────────────────┤
  1717.          │  MAS     │ define macro Arg1 to be replaced by section number  │
  1718.          ├──────────┼─────────────────────────────────────────────────────┤
  1719.          │  MAC     │ define macro Arg1 to be replaced by codes of Arg2   │
  1720.          ╘══════════╧═════════════════════════════════════════════════════╛
  1721.          
  1722.          A  macro is  a  string of  characters, called the macro name, that
  1723.          TXFORM replaces  with  an other  string of characters, called  the
  1724.          macro definition. The replacement is made throughout  the text, as
  1725.          well as in the commands arguments before they are executed. 
  1726.          
  1727.          Note that 
  1728.          
  1729.             ■ the  macro  name  can contain  any  character,  and  is  case
  1730.               sensitive. 
  1731.          
  1732.             ■ the string containing the macro is modified in two steps: 
  1733.          
  1734.                  * the macro name is removed from the string 
  1735.          
  1736.                  * the macro definition is inserted into the string 
  1737.          
  1738.             ■ you can change the macro definition after it has been defined 
  1739.          
  1740.             ■ you can use  a macro before it has been defined.  This is the
  1741.               reason why TXFORM needs several  passes to produce the output
  1742.               file. However, the macros that are used this  way should only
  1743.               be defined once. 
  1744.          
  1745.             ■ there are  six macros that are always defined (please  do not
  1746.               consider the blank character between "_" and "#"): 
  1747.          
  1748.                  * "_ #d" : the current date;  see  the command DFR for the
  1749.                    date format that will be used 
  1750.          
  1751.                  * "_ #p" : the current page 
  1752.          
  1753.                  * "_ #t1" : the title of current section level 1 
  1754.          
  1755.                  * "_ #t2" : the title of current section level 2 
  1756.          
  1757.                  * "_ #t3" : the title of current section level 3 
  1758.          
  1759.                  * "_ #t4" : the title of current section level 4 
  1760.          
  1761.  
  1762.          ══════════════════════════════════════════════════════════════════
  1763.          Commands Description                                       Page 28
  1764.  
  1765.          TXFORM USER'S GUIDE                                           v1.2
  1766.          ══════════════════════════════════════════════════════════════════
  1767.  
  1768.          III.8.A MAD = define macro Arg1 == Arg2
  1769.          ═══════ ═══════════════════════════════
  1770.          
  1771.          Defines a  macro name Arg1 and its  corresponding macro definition
  1772.          Arg2. TXFORM will replace the  string "Arg1" by the  string "Arg2"
  1773.          everywhere in the text. 
  1774.          
  1775.          For example, you could define the macro "_macroEx" that has  to be
  1776.          replaced with "My Name", using the command: 
  1777.          
  1778.                  \MAD:_macroEx:My Name
  1779.          
  1780.          If  you want to add blank characters to your macro definition, use
  1781.          a final ':' at the end of the macro definition. 
  1782.          
  1783.          For example, the command "\MAD:_: b  :" will replace the string
  1784.          "m_c" by "m b  ".
  1785.          
  1786.          III.8.B MAP = define macro Arg1 == page number
  1787.          ═══════ ══════════════════════════════════════
  1788.          
  1789.          This  is  a  short cut  that  allows you to define  a  macro  that
  1790.          contains  the  page number  where  the macro is  defined. This  is
  1791.          useful for cross references. 
  1792.          
  1793.          III.8.C MAS = define macro Arg1 == section number
  1794.          ═══════ ═════════════════════════════════════════
  1795.          
  1796.          This is  a  short cut  that  allows you  to  define  a  macro that
  1797.          contains the current  section where the macro  is defined. This is
  1798.          useful for cross references. 
  1799.          
  1800.          III.8.D MAC = define macro Arg1 == codes of Arg2
  1801.          ═══════ ════════════════════════════════════════
  1802.          
  1803.          This command offers you  the possibility to define a macro  as the
  1804.          sequence of ASCII  chars. It could  be useful when you want to use
  1805.          special control for the printer. 
  1806.          
  1807.          For example, you could  define a macro "_BoldOn" that  would put a
  1808.          printer mode on "Bold", by  using  the following command (Assuming
  1809.          that the bold mode is #27 #18; check your printer documentation): 
  1810.          
  1811.                \MAC:_BoldOn:27,18
  1812.          
  1813.  
  1814.  
  1815.  
  1816.  
  1817.  
  1818.  
  1819.  
  1820.  
  1821.  
  1822.  
  1823.  
  1824.  
  1825.          ══════════════════════════════════════════════════════════════════
  1826.          Commands Description                                       Page 29
  1827.  
  1828.          TXFORM USER'S GUIDE                                           v1.2
  1829.          ══════════════════════════════════════════════════════════════════
  1830.  
  1831.          
  1832.          ──────────────────────────────────────────────────────────────────
  1833.          III.9 Header management
  1834.          ──────────────────────────────────────────────────────────────────
  1835.          
  1836.          ╒══════════╤═════════════════════════════════════════════════════╕
  1837.          │  Hxx     │ Header Management                                   │
  1838.          ╞══════════╪═════════════════════════════════════════════════════╡
  1839.          │  HE-     │ header  off                                         │
  1840.          │  HE+   * │ header on                                           │
  1841.          ├──────────┼─────────────────────────────────────────────────────┤
  1842.          │  HTL     │ set left text to Arg1                               │
  1843.          │  HTC     │ set center text to Arg1                             │
  1844.          │  HTR     │ set right text to Arg1                              │
  1845.          ├──────────┼─────────────────────────────────────────────────────┤
  1846.          │  HLB     │ set Arg1 blank line before header (Default=0)       │
  1847.          │  HLA     │ set Arg1 blank line after header  (Default=1)       │
  1848.          ├──────────┼─────────────────────────────────────────────────────┤
  1849.          │  HL+   * │ draw separator line in header                       │
  1850.          │  HL-     │ do not draw separator line in header                │
  1851.          ├──────────┼─────────────────────────────────────────────────────┤
  1852.          │  HLC     │ set char used for header  separator line (Def = '═')│
  1853.          ╘══════════╧═════════════════════════════════════════════════════╛
  1854.          
  1855.          The header is composed of 
  1856.          
  1857.             ■ A given number of blank  lines before the header. These blank
  1858.               lines are always printed,  even if the  Header mode  is  off.
  1859.               This is equivalent to  defining a top  margin to the page. By
  1860.               default, there are no blank lines. 
  1861.          
  1862.             ■ A line  with three  items of text:  one  that  will  be  left
  1863.               justified,  a second one that will be  centered,  and a third
  1864.               one that will be  right justified.  This line is printed when
  1865.               the header mode is on. If all strings are blank, a blank line
  1866.               is printed. 
  1867.          
  1868.             ■ A separator  line.  This line is  printed if both  the header
  1869.               mode and the header draw line mode are on. 
  1870.          
  1871.             ■ A given number of blank lines. These lines are printed if the
  1872.               header mode is on. By default, there is one blank line. 
  1873.          
  1874.          You configure the header with the following commands: 
  1875.          
  1876.          III.9.A HE- = header  mode off
  1877.          ═══════ ══════════════════════
  1878.          
  1879.          Do not produce a header on the output file 
  1880.          
  1881.          III.9.B HE+ = header mode on
  1882.          ═══════ ════════════════════
  1883.          
  1884.          Produce a header on the output file (default) 
  1885.          
  1886.  
  1887.  
  1888.          ══════════════════════════════════════════════════════════════════
  1889.          Commands Description                                       Page 30
  1890.  
  1891.          TXFORM USER'S GUIDE                                           v1.2
  1892.          ══════════════════════════════════════════════════════════════════
  1893.  
  1894.          III.9.C HTL = set left text to Arg1
  1895.          ═══════ ═══════════════════════════
  1896.          
  1897.          Define the text that will be left aligned. 
  1898.          
  1899.          Example: put the page  number  in the  left  header text  with the
  1900.          command "\HTL:Page _ #p" (the use of  macros is  permitted; please
  1901.          do not consider the blank character between "_" and "#"). 
  1902.          
  1903.          III.9.D HTC = set center text to Arg1
  1904.          ═══════ ═════════════════════════════
  1905.          
  1906.          Define the text that will be centered. 
  1907.          
  1908.          III.9.E HTR = set right text to Arg1
  1909.          ═══════ ════════════════════════════
  1910.          
  1911.          Define the text that will be right aligned. 
  1912.          
  1913.          Example: put the section in the right header text with the command
  1914.          "\HTL:Section _  #t1" (the use  of macros is  permitted; please do
  1915.          not consider the blank character between "_" and "#"). 
  1916.          
  1917.          III.9.F HLB = set Arg1 blank line before header
  1918.          ═══════ ═══════════════════════════════════════
  1919.          
  1920.          Set the number  of  blank lines to skip before writing the header.
  1921.          This is equivalent to defining a top margin to the page. 
  1922.          
  1923.          III.9.G HLA = set Arg1 blank line after header
  1924.          ═══════ ══════════════════════════════════════
  1925.          
  1926.          Set the number of blank lines to skip after writing the header. 
  1927.          
  1928.          III.9.H HL+ = draw separator line in header
  1929.          ═══════ ═══════════════════════════════════
  1930.          
  1931.          Draw a separator line in the header (default). 
  1932.          
  1933.          III.9.I HL- = do not draw separator line in header
  1934.          ═══════ ══════════════════════════════════════════
  1935.          
  1936.          Do not draw a separator line in the header. 
  1937.          
  1938.          III.9.J HLC = set char used for header separator line
  1939.          ═══════ ═════════════════════════════════════════════
  1940.          
  1941.          Change the character used to draw the separator line. 
  1942.          
  1943.          Example: draw a  separator  line with  the character "-"  with the
  1944.          command "\HLC:-" 
  1945.          
  1946.  
  1947.  
  1948.  
  1949.  
  1950.  
  1951.          ══════════════════════════════════════════════════════════════════
  1952.          Commands Description                                       Page 31
  1953.  
  1954.          TXFORM USER'S GUIDE                                           v1.2
  1955.          ══════════════════════════════════════════════════════════════════
  1956.  
  1957.          
  1958.          ──────────────────────────────────────────────────────────────────
  1959.          III.10 Footer management
  1960.          ──────────────────────────────────────────────────────────────────
  1961.          
  1962.          ╒══════════╤═════════════════════════════════════════════════════╕
  1963.          │  Fxx     │ Footer Management                                   │
  1964.          ╞══════════╪═════════════════════════════════════════════════════╡
  1965.          │  FO-     │ footer  off                                         │
  1966.          │  FO+   * │ footer on                                           │
  1967.          ├──────────┼─────────────────────────────────────────────────────┤
  1968.          │  FTL     │ set left text to Arg1                               │
  1969.          │  FTC     │ set center text to Arg1                             │
  1970.          │  FTR     │ set right text to Arg1                              │
  1971.          ├──────────┼─────────────────────────────────────────────────────┤
  1972.          │  FLB     │ set Arg1 blank line before footer (Default=1)       │
  1973.          │  FLA     │ set Arg1 blank line after footer  (Default=0)       │
  1974.          ├──────────┼─────────────────────────────────────────────────────┤
  1975.          │  FL+   * │ draw separator line in footer                       │
  1976.          │  FL-     │ do not draw separator line in footer                │
  1977.          ├──────────┼─────────────────────────────────────────────────────┤
  1978.          │  FLC     │ set char used for footer  separator line (Def = '═')│
  1979.          ╘══════════╧═════════════════════════════════════════════════════╛
  1980.          
  1981.          The footer is composed of 
  1982.          
  1983.             ■ A  given number of blank lines before the footer. These lines
  1984.               are printed if the footer  mode is on. By  default, there  is
  1985.               one blank line. 
  1986.          
  1987.             ■ A separator  line.  This  line is printed  if both the footer
  1988.               mode and the footer draw line mode are on. 
  1989.          
  1990.             ■ A line with  three  items  of text:  one that  will  be  left
  1991.               justified, a second one that will  be centered,  and a  third
  1992.               one that will  be right justified. This line  is printed when
  1993.               the footer mode is on. If all strings are blank, a blank line
  1994.               is printed. 
  1995.          
  1996.             ■ A given number of blank lines. These blank lines  are  always
  1997.               printed, even if the Header mode is  off. This is  equivalent
  1998.               to  defining a  bottom margin to the page.  By default, there
  1999.               are no blank lines. 
  2000.          
  2001.          You configure the footer with the following commands: 
  2002.          
  2003.          III.10.A FO- = footer  mode off
  2004.          ════════ ══════════════════════
  2005.          
  2006.          Do not produce a footer on the output file 
  2007.          
  2008.          III.10.B FO+ = footer mode on
  2009.          ════════ ════════════════════
  2010.          
  2011.          Produce a footer on the output file (default) 
  2012.          
  2013.  
  2014.          ══════════════════════════════════════════════════════════════════
  2015.          Commands Description                                       Page 32
  2016.  
  2017.          TXFORM USER'S GUIDE                                           v1.2
  2018.          ══════════════════════════════════════════════════════════════════
  2019.  
  2020.          III.10.C FTL = set left text to Arg1
  2021.          ════════ ═══════════════════════════
  2022.          
  2023.          Define the text that will be left aligned. 
  2024.          
  2025.          Example: put the  page  number in the  left  footer  text with the
  2026.          command "\FTL:Page _ #p" (the use of macros  is  permitted; please
  2027.          do not consider the blank character between "_" and "#"). 
  2028.          
  2029.          III.10.D FTC = set center text to Arg1
  2030.          ════════ ═════════════════════════════
  2031.          
  2032.          Define the text that will be centered. 
  2033.          
  2034.          III.10.E FTR = set right text to Arg1
  2035.          ════════ ════════════════════════════
  2036.          
  2037.          Define the text that will be right aligned. 
  2038.          
  2039.          Example: put the section in the right footer text with the command
  2040.          "\FTL:Section _  #t1"  (the use  of macros is permitted; please do
  2041.          not consider the blank character between "_" and "#"). 
  2042.          
  2043.          III.10.F FLB = set Arg1 blank line before footer
  2044.          ════════ ═══════════════════════════════════════
  2045.          
  2046.          Set the number of blank lines to skip before writing the footer. 
  2047.          
  2048.          III.10.G FLA = set Arg1 blank line after footer
  2049.          ════════ ══════════════════════════════════════
  2050.          
  2051.          Set  the  number of blank lines to skip after writing  the footer.
  2052.          This is equivalent to defining a bottom margin to the page. 
  2053.          
  2054.          III.10.H FL+ = draw separator line in footer
  2055.          ════════ ═══════════════════════════════════
  2056.          
  2057.          Draw a separator line in the footer. 
  2058.          
  2059.          III.10.I FL- = do not draw separator line in footer
  2060.          ════════ ══════════════════════════════════════════
  2061.          
  2062.          Do not draw a separator line in the footer. 
  2063.          
  2064.          III.10.J FLC = set char used for footer separator line
  2065.          ════════ ═════════════════════════════════════════════
  2066.          
  2067.          Change the character used to draw the separator line. 
  2068.          
  2069.          Example:  draw  a  separator line with the character  "-" with the
  2070.          command "\FLC:-" 
  2071.          
  2072.  
  2073.  
  2074.  
  2075.  
  2076.  
  2077.          ══════════════════════════════════════════════════════════════════
  2078.          Commands Description                                       Page 33
  2079.  
  2080.          TXFORM USER'S GUIDE                                           v1.2
  2081.          ══════════════════════════════════════════════════════════════════
  2082.  
  2083.          
  2084.          ──────────────────────────────────────────────────────────────────
  2085.          III.11 Conditional compile
  2086.          ──────────────────────────────────────────────────────────────────
  2087.          
  2088.          ╒══════════╤═════════════════════════════════════════════════════╕
  2089.          │  CCx     │ Conditional define                                  │
  2090.          ╞══════════╪═════════════════════════════════════════════════════╡
  2091.          │  CC+     │ Compile next lines if macro Arg1 is defined         │
  2092.          │  CC-     │ Cancel action of last CC+ command                   │
  2093.          ╘══════════╧═════════════════════════════════════════════════════╛
  2094.          
  2095.          III.11.A CC+ = Compile next lines if macro Arg1 defined
  2096.          ════════ ══════════════════════════════════════════════
  2097.          
  2098.          This  macro  will compile all lines that follows only if the macro
  2099.          Arg1  is  defined, until a corresponding  "\CC-" command  will  be
  2100.          issued. 
  2101.          
  2102.          Note that several conditional compile can be nested. 
  2103.          
  2104.          III.11.B CC- = Cancel action of last CC+ command
  2105.          ════════ ═══════════════════════════════════════
  2106.          
  2107.          Restore the compile mode on 
  2108.          
  2109.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  2110.           This line is printed
  2111.           \CC+:_macrotest
  2112.           These lines will not be printed because
  2113.           the macro "_macrotest" is not defined:
  2114.           \CC-
  2115.           This line is also printed
  2116.          
  2117.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  2118.          
  2119.          This line is printed 
  2120.          
  2121.          This line is also printed 
  2122.          
  2123.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  2124.          
  2125.  
  2126.  
  2127.  
  2128.  
  2129.  
  2130.  
  2131.  
  2132.  
  2133.  
  2134.  
  2135.  
  2136.  
  2137.  
  2138.  
  2139.  
  2140.          ══════════════════════════════════════════════════════════════════
  2141.          Commands Description                                       Page 34
  2142.  
  2143.          TXFORM USER'S GUIDE                                           v1.2
  2144.          ══════════════════════════════════════════════════════════════════
  2145.  
  2146.          
  2147.          ──────────────────────────────────────────────────────────────────
  2148.          III.12 Various commands
  2149.          ──────────────────────────────────────────────────────────────────
  2150.          
  2151.          ╒══════════╤═════════════════════════════════════════════════════╕
  2152.          │          │ Various commands                                    │
  2153.          ╞══════════╪═════════════════════════════════════════════════════╡
  2154.          │  INC     │ Include Arg1 file                                   │
  2155.          ├──────────┼─────────────────────────────────────────────────────┤
  2156.          │  LSK     │ Skip Arg1 lines                                     │
  2157.          ├──────────┼─────────────────────────────────────────────────────┤
  2158.          │  LFI     │ Write a full page width line with char Arg1         │
  2159.          ├──────────┼─────────────────────────────────────────────────────┤
  2160.          │  DFR     │ Set Date Format to Arg1 (Default=dd/mm/yy)          │
  2161.          ├──────────┼─────────────────────────────────────────────────────┤
  2162.          │  TC-     │ Do not show table of contents                       │
  2163.          ├──────────┼─────────────────────────────────────────────────────┤
  2164.          │  CMI     │ Change Command Identifier to Arg1 (Default='\')     │
  2165.          │  CMS     │ Change Command Separator to Arg1  (Default=':')     │
  2166.          ├──────────┼─────────────────────────────────────────────────────┤
  2167.          │  ZZZ     │ End of input file                                   │
  2168.          ╘══════════╧═════════════════════════════════════════════════════╛
  2169.          
  2170.          III.12.A INC = Include Arg1 file
  2171.          ════════ ═══════════════════════
  2172.          
  2173.          You may include any other file into your main file. 
  2174.          
  2175.          Include files can be nested to up to 10 levels. 
  2176.          
  2177.          For example, you may include  your autoexec file in the file  with
  2178.          the command "\INC:C:\Autoexec.bat" 
  2179.          
  2180.          Note that  the "\INC" command is the only command that allows  you
  2181.          to  use  the  character  ':'  in  the  argument  without  it being
  2182.          interpreted  as  a  delimiter  (see   also   the   command  "\CMS"
  2183.          herebelow). 
  2184.          
  2185.          III.12.B LSK = Skip Arg1 lines
  2186.          ════════ ═════════════════════
  2187.          
  2188.          This command is used to skip several blank lines. 
  2189.          
  2190.          For example, skip 10 blank lines with the command "\LSK:10" 
  2191.          
  2192.          III.12.C LFI = Write a line with char Arg1
  2193.          ════════ ═════════════════════════════════
  2194.          
  2195.          This command is used to write a  line that  extend  from the  left
  2196.          margin to the right margin, using a given character. 
  2197.          
  2198.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  2199.           \LFI:*
  2200.          
  2201.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
  2202.  
  2203.          ══════════════════════════════════════════════════════════════════
  2204.          Commands Description                                       Page 35
  2205.  
  2206.          TXFORM USER'S GUIDE                                           v1.2
  2207.          ══════════════════════════════════════════════════════════════════
  2208.  
  2209.          
  2210.          ******************************************************************
  2211.          ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
  2212.          
  2213.          III.12.D DFR = Set Date Format to Arg1
  2214.          ════════ ═════════════════════════════
  2215.          
  2216.          This command is used to format the date as you wish. 
  2217.          
  2218.          Arg1  is a  string  in  which some  characters  are  automatically
  2219.          replaced by others, as described here below: 
  2220.          
  2221.             ■ 'm': replaced by the number of the month, padded with '0' 
  2222.          
  2223.               'M': replaced by the number of the month, padded with ' ' 
  2224.          
  2225.             ■ 'd': replaced by the number of the day, padded with '0' 
  2226.          
  2227.               'D': replaced by the number of the day, padded with ' ' 
  2228.          
  2229.             ■ 'y': replaced by the number of the year 
  2230.          
  2231.             ■ '/': used as separator 
  2232.          
  2233.             ■ 'n': replaced by the name of the month, lower case 
  2234.          
  2235.               'N': replaced by the name of the month, upper case 
  2236.          
  2237.             ■ 'w': replaced by the name of the day , lower case 
  2238.          
  2239.               'W': replaced by the name of the day, upper case 
  2240.          
  2241.          All other characters are treated as literals. 
  2242.          
  2243.          Examples: 
  2244.          
  2245.             ■ This is the date in default format dd/mm/yy: 01/05/96 
  2246.          
  2247.             ■ This is the date in format DD/MM/yy: 1/ 5/96 
  2248.          
  2249.             ■ This is the date in format wwww-dd-nnn-yy: Wedn-01-May-96 
  2250.          
  2251.          III.12.E TC- = Do not show table of contents
  2252.          ════════ ═══════════════════════════════════
  2253.          
  2254.          This is used to suppress the creation of the table of contents. 
  2255.          
  2256.          III.12.F CMI = Change Command Identifier to Arg1
  2257.          ════════ ═══════════════════════════════════════
  2258.          
  2259.          Each command is  identified by "\" in  the first column of a line.
  2260.          If  you  whish,  you may change this character by any other one of
  2261.          your choice (be careful...). 
  2262.          
  2263.  
  2264.  
  2265.  
  2266.          ══════════════════════════════════════════════════════════════════
  2267.          Commands Description                                       Page 36
  2268.  
  2269.          TXFORM USER'S GUIDE                                           v1.2
  2270.          ══════════════════════════════════════════════════════════════════
  2271.  
  2272.          III.12.G CMS = Change Command Separator to Arg1
  2273.          ════════ ══════════════════════════════════════
  2274.          
  2275.          The various  arguments  of  a command are separated by the special
  2276.          character ":". If you  whish,  or if you need  for example to have
  2277.          this  character  in  your  section  titles,  you  may change  this
  2278.          character for any other of your choice. Be carefull... 
  2279.          
  2280.          III.12.H ZZZ = End of input file
  2281.          ════════ ═══════════════════════
  2282.          
  2283.          You may mark the  end of  your  input file with this  command. The
  2284.          rest of the file will be ignored. 
  2285.          
  2286.          It is recommended to use this command, even if you do not need it.
  2287.          Some  special problems  related  to  the  formatting of  the  last
  2288.          paragraph can be avoided if you do so. 
  2289.          
  2290.  
  2291.  
  2292.  
  2293.  
  2294.  
  2295.  
  2296.  
  2297.  
  2298.  
  2299.  
  2300.  
  2301.  
  2302.  
  2303.  
  2304.  
  2305.  
  2306.  
  2307.  
  2308.  
  2309.  
  2310.  
  2311.  
  2312.  
  2313.  
  2314.  
  2315.  
  2316.  
  2317.  
  2318.  
  2319.  
  2320.  
  2321.  
  2322.  
  2323.  
  2324.  
  2325.  
  2326.  
  2327.  
  2328.  
  2329.          ══════════════════════════════════════════════════════════════════
  2330.          Commands Description                                       Page 37
  2331.  
  2332.          TXFORM USER'S GUIDE                                           v1.2
  2333.          ══════════════════════════════════════════════════════════════════
  2334.  
  2335.          
  2336.          
  2337.          
  2338.          
  2339.                      ╒════════════════════════════════════════╕            
  2340.                      │                                        │            
  2341.                      │               CHAPTER IV               │            
  2342.                      │                                        │            
  2343.                      ╞════════════════════════════════════════╡            
  2344.                      │                                        │            
  2345.                      │             Error Messages             │            
  2346.                      │                                        │            
  2347.                      ╘════════════════════════════════════════╛            
  2348.          
  2349.          
  2350.          
  2351.          
  2352.          This is a list of the error messages: 
  2353.          
  2354.             ■ Invalid control char 
  2355.          
  2356.               You are using a control character that is not valid 
  2357.          
  2358.             ■ Invalid Command: xxx 
  2359.          
  2360.               The command xxx is not recognized by TXFORM 
  2361.          
  2362.             ■ Too Many Nested Input Files 
  2363.          
  2364.               You have too many nested files (limit=10) 
  2365.          
  2366.             ■ File xxxx not found 
  2367.          
  2368.               TXFORM can not find the file "xxxx" 
  2369.          
  2370.             ■ Invalid registration data 
  2371.          
  2372.               You have not enter the  validation data exactly as  you  have
  2373.               received it. Registration data is case sensitive. 
  2374.          
  2375.             ■ Invalid Argument List 
  2376.          
  2377.               The argument list you  have given to TXFORM while  running it
  2378.               is not valid (see running TXFORM) 
  2379.          
  2380.             ■ Invalid Frame Type 
  2381.          
  2382.               TXFORM knows only six different frame types : 1..6 
  2383.          
  2384.             ■ Output file xxxx Not open ! 
  2385.          
  2386.               TXFORM could not open the specified output file 
  2387.          
  2388.             ■ Invalid Left Margin 
  2389.          
  2390.               The  value specified for the left margin is not valid,  or is
  2391.  
  2392.          ══════════════════════════════════════════════════════════════════
  2393.          Error Messages                                             Page 38
  2394.  
  2395.          TXFORM USER'S GUIDE                                           v1.2
  2396.          ══════════════════════════════════════════════════════════════════
  2397.  
  2398.               not consistent with right margin settings. 
  2399.          
  2400.             ■ Invalid Right Margin 
  2401.          
  2402.               The value  specified for the right margin is not valid, or is
  2403.               not consistent with left margin settings. 
  2404.          
  2405.             ■ Invalid Range 
  2406.          
  2407.               The value specified for one of the arguments is out-of-range.
  2408.               This means that you have entered a value that is not accepted
  2409.               by TXFORM. For example, setting the page length to 1000  will
  2410.               generate this error. 
  2411.          
  2412.             ■ Too many macros 
  2413.          
  2414.               You may not define more than 150 macros. 
  2415.          
  2416.             ■ Macro xxx is referencing it self 
  2417.          
  2418.               You  have  defined a macro  that  either  contain  itself, or
  2419.               contains an other macro that itself contains the first macro.
  2420.               For example, the following macro definition is not valid: 
  2421.          
  2422.               \MAD:_m1:aa_m1 
  2423.          
  2424.  
  2425.  
  2426.  
  2427.  
  2428.  
  2429.  
  2430.  
  2431.  
  2432.  
  2433.  
  2434.  
  2435.  
  2436.  
  2437.  
  2438.  
  2439.  
  2440.  
  2441.  
  2442.  
  2443.  
  2444.  
  2445.  
  2446.  
  2447.  
  2448.  
  2449.  
  2450.  
  2451.  
  2452.  
  2453.  
  2454.  
  2455.          ══════════════════════════════════════════════════════════════════
  2456.          Error Messages                                             Page 39
  2457.  
  2458.          TXFORM USER'S GUIDE                                           v1.2
  2459.          ══════════════════════════════════════════════════════════════════
  2460.  
  2461.          
  2462.          
  2463.          
  2464.          
  2465.                  ╒═══════════════════════════════════════════════╕         
  2466.                  │                                               │         
  2467.                  │                  APPENDIX A                   │         
  2468.                  │                                               │         
  2469.                  ╞═══════════════════════════════════════════════╡         
  2470.                  │                                               │         
  2471.                  │   Using TXFORM with Multiple Windows Editor   │         
  2472.                  │                                               │         
  2473.                  ╘═══════════════════════════════════════════════╛         
  2474.          
  2475.          
  2476.          
  2477.          
  2478.          TXFORM is particularly easy to use when you use a multiple windows
  2479.          editor that  allows  you to  execute a command under  DOS  without
  2480.          leaving the editor. 
  2481.          
  2482.          In my case,  I use  the  Borland Turbo Pascal  7.0  editor. In one
  2483.          window, I see the input file called "X.PAS". In an other window, I
  2484.          see the output file "X.TMP". 
  2485.          
  2486.          Each  time I have modifed the input file,  I press "Shift-F9", and
  2487.          the output file is modified accordingly. Doing so allows me to use
  2488.          TXFORM as a kind of sophisticated on line editor. 
  2489.          
  2490.          To get  the  "Shift-F9" key to do the job, I have assigned it to a
  2491.          Tool with: 
  2492.          
  2493.             ■ the program path set to: 
  2494.          
  2495.               "TXFORM.EXE" (note that my copy of TXFORM is in my path) 
  2496.          
  2497.             ■ the command line set to: 
  2498.          
  2499.               "$SAVE ALL $NAME($EDNAME).pas $NAME($EDNAME).tmp". 
  2500.          
  2501.          See  the Turbo Pascal editor documentation for more explanation on
  2502.          how to define a tool. 
  2503.          
  2504.  
  2505.  
  2506.  
  2507.  
  2508.  
  2509.  
  2510.  
  2511.  
  2512.  
  2513.  
  2514.  
  2515.  
  2516.  
  2517.  
  2518.          ══════════════════════════════════════════════════════════════════
  2519.          Using TXFORM with Multiple Windows Editor                  Page 40
  2520.  
  2521.          TXFORM USER'S GUIDE                                           v1.2
  2522.          ══════════════════════════════════════════════════════════════════
  2523.  
  2524.          
  2525.          
  2526.          
  2527.          
  2528.                      ╒════════════════════════════════════════╕            
  2529.                      │                                        │            
  2530.                      │               APPENDIX B               │            
  2531.                      │                                        │            
  2532.                      ╞════════════════════════════════════════╡            
  2533.                      │                                        │            
  2534.                      │          Summary of Commands           │            
  2535.                      │                                        │            
  2536.                      ╘════════════════════════════════════════╛            
  2537.          
  2538.          
  2539.          
  2540.          
  2541.          The  commands   availables  are  grouped   into  logicaly  related
  2542.          functions: 
  2543.          
  2544.               ╒══════════════════════════╤═══════════════════════════╕     
  2545.               │  The group of functions  │ has commands whose name   │     
  2546.               │       related to         │   begin with letter(s)    │     
  2547.               ╞══════════════════════════╪═══════════════════════════╡     
  2548.               │ Page formatting          │           P               │     
  2549.               ├──────────────────────────┼───────────────────────────┤     
  2550.               │ Paragraph formatting     │           A               │     
  2551.               ├──────────────────────────┼───────────────────────────┤     
  2552.               │ Framed paragraphs        │           AM              │     
  2553.               ├──────────────────────────┼───────────────────────────┤     
  2554.               │ Itemized paragraphs      │           IT              │     
  2555.               ├──────────────────────────┼───────────────────────────┤     
  2556.               │ Section numbering        │           S               │     
  2557.               ├──────────────────────────┼───────────────────────────┤     
  2558.               │ Macro definition         │           MA              │     
  2559.               ├──────────────────────────┼───────────────────────────┤     
  2560.               │ Header management        │           H               │     
  2561.               ├──────────────────────────┼───────────────────────────┤     
  2562.               │ Footer management        │           F               │     
  2563.               ├──────────────────────────┼───────────────────────────┤     
  2564.               │ Conditional compile      │           CC              │     
  2565.               ├──────────────────────────┼───────────────────────────┤     
  2566.               │ Various                  │           ...             │     
  2567.               ╘══════════════════════════╧═══════════════════════════╛     
  2568.          
  2569.          In the following tables,  a '*' show the default options, and  the
  2570.          default values are indicated where applicable. 
  2571.          
  2572.  
  2573.  
  2574.  
  2575.  
  2576.  
  2577.  
  2578.  
  2579.  
  2580.  
  2581.          ══════════════════════════════════════════════════════════════════
  2582.          Summary of Commands                                        Page 41
  2583.  
  2584.          TXFORM USER'S GUIDE                                           v1.2
  2585.          ══════════════════════════════════════════════════════════════════
  2586.  
  2587.          ╒══════════╤═════════════════════════════════════════════════════╕
  2588.          │  Pxx     │ Page Formatting Options                             │
  2589.          ╞══════════╪═════════════════════════════════════════════════════╡
  2590.          │  PJU     │ Jump to next page                                   │
  2591.          │  PJC     │ Jump to next page is less then Arg1 lines remaining │
  2592.          ├──────────┼─────────────────────────────────────────────────────┤
  2593.          │  PNB     │ Set actual page number to Arg1                      │
  2594.          ├──────────┼─────────────────────────────────────────────────────┤
  2595.          │  PML     │ Set Left Margin to Arg1 (Default=5)                 │
  2596.          │  PMR     │ Set Right Margin to Arg1 (Default=75)               │
  2597.          ├──────────┼─────────────────────────────────────────────────────┤
  2598.          │  PLE     │ Set Page Length to Arg1  (Default=62)               │
  2599.          ╘══════════╧═════════════════════════════════════════════════════╛
  2600.          
  2601.          ╒══════════╤═════════════════════════════════════════════════════╕
  2602.          │  Axx     │ Paragraph Formatting Options                        │
  2603.          ╞══════════╪═════════════════════════════════════════════════════╡
  2604.          │  AC-   * │ center text off                                     │
  2605.          │  AC+     │ center text on                                      │
  2606.          ├──────────┼─────────────────────────────────────────────────────┤
  2607.          │  AF-     │ fill text off                                       │
  2608.          │  AF+   * │ fill text on                                        │
  2609.          ├──────────┼─────────────────────────────────────────────────────┤
  2610.          │  AIL     │ indent left margin of Arg1 columns (Default=0)      │
  2611.          │  AIR     │ indent right margin of Arg1 columns (Default=0)     │
  2612.          ├──────────┼─────────────────────────────────────────────────────┤
  2613.          │  ASL     │ set number of blank lines after paragraph to Arg1   │
  2614.          │          │ (Default=1)                                         │
  2615.          ├──────────┼─────────────────────────────────────────────────────┤
  2616.          │  AJL   * │ left justify text                                   │
  2617.          │  AJR     │ right justify text                                  │
  2618.          │  AJF     │ full justify text                                   │
  2619.          ╘══════════╧═════════════════════════════════════════════════════╛
  2620.          
  2621.          ╒══════════╤═════════════════════════════════════════════════════╕
  2622.          │  AMx     │ Framed Paragraph                                    │
  2623.          ╞══════════╪═════════════════════════════════════════════════════╡
  2624.          │  AM-   * │ set frame off                                       │
  2625.          │  AM+     │ set frame on                                        │
  2626.          ├──────────┼─────────────────────────────────────────────────────┤
  2627.          │  AML     │ left align frame                                    │
  2628.          │  AMR     │ right align frame                                   │
  2629.          │  AMC   * │ center frame                                        │
  2630.          ├──────────┼─────────────────────────────────────────────────────┤
  2631.          │  AMW     │ set frame width (Default=35)                        │
  2632.          ├──────────┼─────────────────────────────────────────────────────┤
  2633.          │  AMS     │ set frame style to Arg1 (Default=1)                 │
  2634.          ╘══════════╧═════════════════════════════════════════════════════╛
  2635.          
  2636.  
  2637.  
  2638.  
  2639.  
  2640.  
  2641.  
  2642.  
  2643.  
  2644.          ══════════════════════════════════════════════════════════════════
  2645.          Summary of Commands                                        Page 42
  2646.  
  2647.          TXFORM USER'S GUIDE                                           v1.2
  2648.          ══════════════════════════════════════════════════════════════════
  2649.  
  2650.          ╒══════════╤═════════════════════════════════════════════════════╕
  2651.          │  ITx     │ Itemized Paragraph                                  │
  2652.          ╞══════════╪═════════════════════════════════════════════════════╡
  2653.          │  ITZ     │ start itemized mode with char Arg1                  │
  2654.          │  ITT     │ itemized next paragraph                             │
  2655.          │  ITS     │ stop itemized mode                                  │
  2656.          ╘══════════╧═════════════════════════════════════════════════════╛
  2657.          
  2658.          ╒══════════╤═════════════════════════════════════════════════════╕
  2659.          │  Sxx     │ Section Management                                  │
  2660.          ╞══════════╪═════════════════════════════════════════════════════╡
  2661.          │  SLV     │ set new section level Arg1 with title Arg2          │
  2662.          ├──────────┼─────────────────────────────────────────────────────┤
  2663.          │  SAP     │ set appendix mode                                   │
  2664.          ╘══════════╧═════════════════════════════════════════════════════╛
  2665.          
  2666.          ╒══════════╤═════════════════════════════════════════════════════╕
  2667.          │  MAx     │ Macro Management                                    │
  2668.          ╞══════════╪═════════════════════════════════════════════════════╡
  2669.          │  MAD     │ define macro Arg1 to be replaced by Arg2            │
  2670.          ├──────────┼─────────────────────────────────────────────────────┤
  2671.          │  MAP     │ define macro Arg1 to be replaced by page number     │
  2672.          ├──────────┼─────────────────────────────────────────────────────┤
  2673.          │  MAS     │ define macro Arg1 to be replaced by section number  │
  2674.          ├──────────┼─────────────────────────────────────────────────────┤
  2675.          │  MAC     │ define macro Arg1 to be replaced by codes of Arg2   │
  2676.          ╘══════════╧═════════════════════════════════════════════════════╛
  2677.          
  2678.          ╒══════════╤═════════════════════════════════════════════════════╕
  2679.          │  Hxx     │ Header Management                                   │
  2680.          ╞══════════╪═════════════════════════════════════════════════════╡
  2681.          │  HE-     │ header  off                                         │
  2682.          │  HE+   * │ header on                                           │
  2683.          ├──────────┼─────────────────────────────────────────────────────┤
  2684.          │  HTL     │ set left text to Arg1                               │
  2685.          │  HTC     │ set center text to Arg1                             │
  2686.          │  HTR     │ set right text to Arg1                              │
  2687.          ├──────────┼─────────────────────────────────────────────────────┤
  2688.          │  HLB     │ set Arg1 blank line before header (Default=0)       │
  2689.          │  HLA     │ set Arg1 blank line after header  (Default=1)       │
  2690.          ├──────────┼─────────────────────────────────────────────────────┤
  2691.          │  HL+   * │ draw separator line in header                       │
  2692.          │  HL-     │ do not draw separator line in header                │
  2693.          ├──────────┼─────────────────────────────────────────────────────┤
  2694.          │  HLC     │ set char used for header  separator line (Def = '═')│
  2695.          ╘══════════╧═════════════════════════════════════════════════════╛
  2696.          
  2697.  
  2698.  
  2699.  
  2700.  
  2701.  
  2702.  
  2703.  
  2704.  
  2705.  
  2706.  
  2707.          ══════════════════════════════════════════════════════════════════
  2708.          Summary of Commands                                        Page 43
  2709.  
  2710.          TXFORM USER'S GUIDE                                           v1.2
  2711.          ══════════════════════════════════════════════════════════════════
  2712.  
  2713.          ╒══════════╤═════════════════════════════════════════════════════╕
  2714.          │  Fxx     │ Footer Management                                   │
  2715.          ╞══════════╪═════════════════════════════════════════════════════╡
  2716.          │  FO-     │ footer  off                                         │
  2717.          │  FO+   * │ footer on                                           │
  2718.          ├──────────┼─────────────────────────────────────────────────────┤
  2719.          │  FTL     │ set left text to Arg1                               │
  2720.          │  FTC     │ set center text to Arg1                             │
  2721.          │  FTR     │ set right text to Arg1                              │
  2722.          ├──────────┼─────────────────────────────────────────────────────┤
  2723.          │  FLB     │ set Arg1 blank line before footer (Default=1)       │
  2724.          │  FLA     │ set Arg1 blank line after footer  (Default=0)       │
  2725.          ├──────────┼─────────────────────────────────────────────────────┤
  2726.          │  FL+   * │ draw separator line in footer                       │
  2727.          │  FL-     │ do not draw separator line in footer                │
  2728.          ├──────────┼─────────────────────────────────────────────────────┤
  2729.          │  FLC     │ set char used for footer  separator line (Def = '═')│
  2730.          ╘══════════╧═════════════════════════════════════════════════════╛
  2731.          
  2732.          ╒══════════╤═════════════════════════════════════════════════════╕
  2733.          │  CCx     │ Conditional define                                  │
  2734.          ╞══════════╪═════════════════════════════════════════════════════╡
  2735.          │  CC+     │ Compile next lines if macro Arg1 is defined         │
  2736.          │  CC-     │ Cancel action of last CC+ command                   │
  2737.          ╘══════════╧═════════════════════════════════════════════════════╛
  2738.          
  2739.          ╒══════════╤═════════════════════════════════════════════════════╕
  2740.          │          │ Various commands                                    │
  2741.          ╞══════════╪═════════════════════════════════════════════════════╡
  2742.          │  INC     │ Include Arg1 file                                   │
  2743.          ├──────────┼─────────────────────────────────────────────────────┤
  2744.          │  LSK     │ Skip Arg1 lines                                     │
  2745.          ├──────────┼─────────────────────────────────────────────────────┤
  2746.          │  LFI     │ Write a full page width line with char Arg1         │
  2747.          ├──────────┼─────────────────────────────────────────────────────┤
  2748.          │  DFR     │ Set Date Format to Arg1 (Default=dd/mm/yy)          │
  2749.          ├──────────┼─────────────────────────────────────────────────────┤
  2750.          │  TC-     │ Do not show table of contents                       │
  2751.          ├──────────┼─────────────────────────────────────────────────────┤
  2752.          │  CMI     │ Change Command Identifier to Arg1 (Default='\')     │
  2753.          │  CMS     │ Change Command Separator to Arg1  (Default=':')     │
  2754.          ├──────────┼─────────────────────────────────────────────────────┤
  2755.          │  ZZZ     │ End of input file                                   │
  2756.          ╘══════════╧═════════════════════════════════════════════════════╛
  2757.          
  2758.  
  2759.  
  2760.  
  2761.  
  2762.  
  2763.  
  2764.  
  2765.  
  2766.  
  2767.  
  2768.  
  2769.  
  2770.          ══════════════════════════════════════════════════════════════════
  2771.          Summary of Commands                                        Page 44
  2772.  
  2773.          TXFORM USER'S GUIDE                                           v1.2
  2774.          ══════════════════════════════════════════════════════════════════
  2775.  
  2776.          
  2777.          
  2778.                                  TABLE OF CONTENTS                         
  2779.          
  2780.          
  2781.          
  2782.          I Introduction ...............................................   2
  2783.            I.1 What TXFORM can make for you ...........................   2
  2784.            I.2 About warranties ... ...................................   3
  2785.            I.3 Organisation of this document ..........................   3
  2786.            I.4 TXFORM is SHAREWARE ....................................   4
  2787.              I.4.A What is Shareware ? ................................   4
  2788.              I.4.B Why should you register this software ? ............   4
  2789.              I.4.C Registration .......................................   5
  2790.            I.5 Installing TXFORM ......................................   5
  2791.              I.5.A Requirements .......................................   5
  2792.              I.5.B Printing the documentation .........................   5
  2793.              I.5.C Installation procedure .............................   5
  2794.            I.6 Running TXFORM .........................................   6
  2795.          
  2796.          II General Principles ........................................   7
  2797.            II.1 Basic concepts ........................................   7
  2798.            II.2 The different types of lines ..........................   7
  2799.            II.3 How the output text is formatted ......................   8
  2800.            II.4 How the modify the formatting options .................   9
  2801.          
  2802.          III Commands Description .....................................  10
  2803.            III.1 Command Structure ....................................  10
  2804.            III.2 Commands Names .......................................  10
  2805.            III.3 Page formatting options ..............................  12
  2806.              III.3.A PJU = Jump to next page ..........................  12
  2807.              III.3.B PJC = Jump to next page if less then Arg1 lines ..  12
  2808.              III.3.C PNB = Set actual page number to Arg1 .............  12
  2809.              III.3.D PML = Set Left Margin to Arg1 ....................  13
  2810.              III.3.E PMR = Set Right Margin to Arg1 ...................  13
  2811.              III.3.F PLE = Set Page Length to Arg1 ....................  14
  2812.            III.4 Paragraph formatting options .........................  15
  2813.              III.4.A AC- = center text off ............................  15
  2814.              III.4.B AC+ = center text on .............................  15
  2815.              III.4.C AF- = fill text off ..............................  16
  2816.              III.4.D AF+ = fill text on ...............................  16
  2817.              III.4.E AIL = indent left margin of Arg1 columns .........  16
  2818.              III.4.F AIR = indent right margin of Arg1 columns ........  17
  2819.              III.4.G ASL = number of blank lines after paragraph ......  18
  2820.              III.4.H AJL = left justify text ..........................  18
  2821.              III.4.I AJR = right justify text .........................  18
  2822.              III.4.J AJF = full justify text ..........................  18
  2823.            III.5 Framed paragraphs ....................................  20
  2824.              III.5.A AM- = set frame off ..............................  20
  2825.              III.5.B AM+ = set frame on ...............................  20
  2826.              III.5.C AML = left align frame ...........................  21
  2827.              III.5.D AMR = right align frame ..........................  21
  2828.              III.5.E AMC = center frame ...............................  21
  2829.              III.5.F AMW = set frame width ............................  22
  2830.              III.5.G AMS = set frame style to Arg1 ....................  22
  2831.            III.6 Itemizing paragraph ..................................  25
  2832.  
  2833.          ══════════════════════════════════════════════════════════════════
  2834.          TABLE OF CONTENTS                                          Page 45
  2835.  
  2836.          TXFORM USER'S GUIDE                                           v1.2
  2837.          ══════════════════════════════════════════════════════════════════
  2838.  
  2839.              III.6.A ITZ = start itemized mode with char Arg1 .........  25
  2840.              III.6.B ITT = itemized next paragraph ....................  25
  2841.              III.6.C ITS = stop itemized mode .........................  25
  2842.              III.6.D Nesting itemization ..............................  25
  2843.            III.7 Sections management ..................................  27
  2844.              III.7.A SLV = set new section level Arg1 with title Arg2 .  27
  2845.              III.7.B SAP = set appendix mode ..........................  27
  2846.            III.8 Macros ...............................................  28
  2847.              III.8.A MAD = define macro Arg1 == Arg2 ..................  29
  2848.              III.8.B MAP = define macro Arg1 == page number ...........  29
  2849.              III.8.C MAS = define macro Arg1 == section number ........  29
  2850.              III.8.D MAC = define macro Arg1 == codes of Arg2 .........  29
  2851.            III.9 Header management ....................................  30
  2852.              III.9.A HE- = header  mode off ...........................  30
  2853.              III.9.B HE+ = header mode on .............................  30
  2854.              III.9.C HTL = set left text to Arg1 ......................  31
  2855.              III.9.D HTC = set center text to Arg1 ....................  31
  2856.              III.9.E HTR = set right text to Arg1 .....................  31
  2857.              III.9.F HLB = set Arg1 blank line before header ..........  31
  2858.              III.9.G HLA = set Arg1 blank line after header ...........  31
  2859.              III.9.H HL+ = draw separator line in header ..............  31
  2860.              III.9.I HL- = do not draw separator line in header .......  31
  2861.              III.9.J HLC = set char used for header separator line ....  31
  2862.            III.10 Footer management ...................................  32
  2863.              III.10.A FO- = footer  mode off ..........................  32
  2864.              III.10.B FO+ = footer mode on ............................  32
  2865.              III.10.C FTL = set left text to Arg1 .....................  33
  2866.              III.10.D FTC = set center text to Arg1 ...................  33
  2867.              III.10.E FTR = set right text to Arg1 ....................  33
  2868.              III.10.F FLB = set Arg1 blank line before footer .........  33
  2869.              III.10.G FLA = set Arg1 blank line after footer ..........  33
  2870.              III.10.H FL+ = draw separator line in footer .............  33
  2871.              III.10.I FL- = do not draw separator line in footer ......  33
  2872.              III.10.J FLC = set char used for footer separator line ...  33
  2873.            III.11 Conditional compile .................................  34
  2874.              III.11.A CC+ = Compile next lines if macro Arg1 defined ..  34
  2875.              III.11.B CC- = Cancel action of last CC+ command .........  34
  2876.            III.12 Various commands ....................................  35
  2877.              III.12.A INC = Include Arg1 file .........................  35
  2878.              III.12.B LSK = Skip Arg1 lines ...........................  35
  2879.              III.12.C LFI = Write a line with char Arg1 ...............  35
  2880.              III.12.D DFR = Set Date Format to Arg1 ...................  36
  2881.              III.12.E TC- = Do not show table of contents .............  36
  2882.              III.12.F CMI = Change Command Identifier to Arg1 .........  36
  2883.              III.12.G CMS = Change Command Separator to Arg1 ..........  37
  2884.              III.12.H ZZZ = End of input file .........................  37
  2885.          
  2886.          IV Error Messages ............................................  38
  2887.          
  2888.          
  2889.                                      APPENDICES                            
  2890.          
  2891.          
  2892.          A Using TXFORM with Multiple Windows Editor ..................  40
  2893.          
  2894.          B Summary of Commands ........................................  41
  2895.  
  2896.          ══════════════════════════════════════════════════════════════════
  2897.          TABLE OF CONTENTS                                          Page 46
  2898.  
  2899.