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 >
Wrap
Text File
|
1996-05-01
|
126KB
|
2,899 lines
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒═════════════════════════════════════╕
│ │
│ TXFORM v1.2 │
│ │
│ │
╞═════════════════════════════════════╡
│ │
│ │
│ USER'S GUIDE │
│ │
│ │
╞═════════════════════════════════════╡
│ │
│ Software by SOGY sc │
│ │
│ Copyrights (c) 1995-96 │
│ │
╞═════════════════════════════════════╡
│ │
│ May 1, 96 │
│ │
╘═════════════════════════════════════╛
══════════════════════════════════════════════════════════════════
Page 1
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒════════════════════════════════════════╕
│ │
│ CHAPTER I │
│ │
╞════════════════════════════════════════╡
│ │
│ Introduction │
│ │
╘════════════════════════════════════════╛
This document is the USER'S GUIDE of the Shareware program TXFORM
v1.2, as released on May 1, 96.
TXFORM is SHAREWARE, user supported software. TXFORM is made
available for a free 45 day trial period. If you find the program
of use and wish to continue using it, you are obliged to purchase
a personal license. See the distributed file REGISTER.DOC for
information on how to register this program.
──────────────────────────────────────────────────────────────────
I.1 What TXFORM can make for you
──────────────────────────────────────────────────────────────────
The TXFORM program is intended for those who need to prepare
nicely presented ASCII documentation files, for example to prepare
documentation files to be distributed with shareware.
The file you are reading, as well as other TXFORM documentation
files, have been prepared with TXFORM, and are thus examples of
what you can do with TXFORM.
╒══════════════════════════════════════════════════════════════╕
│ TXFORM reads data contained in an ASCII file that you │
│ prepare, and produces a nicely formatted output file. You do │
│ not care to the details of formatting while preparing the │
│ input file. Instead, you insert control strings that define │
│ the format options, and TXFORM do the job for you. │
╘══════════════════════════════════════════════════════════════╛
Formatting options include:
■ Left, Right and Full text justification
■ Vertical and horizontal margins
■ Framed text
■ Use of macro
══════════════════════════════════════════════════════════════════
Introduction Page 2
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
■ Multiple level inserted files
■ Sections management
■ Table of contents
■ Cross referenced topics
■ ...
TXFORM is particularly easy to use and powerful when you use a
multiple windows editor that allows you to execute a command under
DOS without leaving the editor. See in the appendices of the
"USER'S GUIDE" how I use TXFORM to get a powerful and flexible
ASCII editor.
──────────────────────────────────────────────────────────────────
I.2 About warranties ...
──────────────────────────────────────────────────────────────────
The author of this software is a professional software engineer.
He has put all his efforts on this work to deliver a software that
is stable, secure and easy to use and understand. Because software
is software, this is about the only thing he is in a position to
guarantee to you. For all other related questions, the following
paragraphs are assumed to have been read and understoud by you,
the knowledgeable user:
■ The author makes no warranty of any kind, either expressed or
implied. This includes, but is not limited to, implied
warranties or merchantability, and fitness for any particular
purpose with respect to both the software and the
documentation included in this package.
■ In no event shall the author be liable for any direct,
indirect, consequencial, or incidental damages arising out of
the use or inability to use this product even if the author
has been advised of the possibility of such damages or claim.
So do not tell you didn't know, and, well, make backup copies of
your data, as you always do ...
──────────────────────────────────────────────────────────────────
I.3 Organisation of this document
──────────────────────────────────────────────────────────────────
The content of this document is organized as follows:
■ Section I (this section) describes what TXFORM can make for
you, explains how to install TXFORM, and reminds you of the
shareware nature of TXFORM and what it means for you.
■ Section II outlines the general working principles of TXFORM
══════════════════════════════════════════════════════════════════
Introduction Page 3
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
■ Section III describes the commands available in TXFORM
──────────────────────────────────────────────────────────────────
I.4 TXFORM is SHAREWARE
──────────────────────────────────────────────────────────────────
I.4.A What is Shareware ?
═════ ═══════════════════
"Shareware" is copyrighted software which is distributed by
authors through bulletin boards, on-line services, disk vendors,
and copies passed among friends. It is commercial software which
you are allowed to use and evaluate before paying for it. This
makes shareware the ultimate in money back guarantees.
TXFORM is copyrighted software, and all rights are reserved.
TXFORM may not be changed or modified in any way except by the
author. TXFORM is SHAREWARE, and may be freely distributed without
permission, as long as it remains in its complete form with all
support and documentation files. No files may be added or taken
away from the original Archived form in which TXFORM is
distributed. Regardless of how the copy is obtained, it is
requested that all users comply with the licensing and
registration provisions if they continue to use TXFORM after an
initial 45 days evaluation period.
I.4.B Why should you register this software ?
═════ ═══════════════════════════════════════
The only difference between the shareware and registered versions
is that with the shareware version you must wait five seconds at
the beginning of the program execution. In other words, I am not
limitating the functionnalities of the shareware version in any
way.
So, there is nothing that will force you to register - apart from
making sure there is a place for you in paradise.
However, if you use TXFORM, you will rapidly reach the same
conclusion as the one I have reached: the tool is powerful, of
good quality, and it works. But they are so many other things I
would like it to do for me ...
TXFORM has been first written for my own use. But after a while, I
realized that this software could be useful for others as well,
and I have created this shareware version. It took me a while to
improve the details of the interface, and to write the
documentation, both things that were required to make it possible
for you to use the software.
If you register the software, and send me your comments and ideas
on TXFORM, I intend to improve it.
If you do not register, I will understand that nobody cares, and
══════════════════════════════════════════════════════════════════
Introduction Page 4
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
forget about TXFORM. That's the cyberspace jungle's law ...
I.4.C Registration
═════ ════════════
Registration of TXFORM provides you with the License to continue
using TXFORM after the 45 day Evaluation period. Registration of
the shareware edition costs US$ 10.
See accompanying file REGISTER.DOC for the license agreement, a
registration form and the payment details.
──────────────────────────────────────────────────────────────────
I.5 Installing TXFORM
──────────────────────────────────────────────────────────────────
I.5.A Requirements
═════ ════════════
TXFORM requires an IBM PC or compatible with
■ a few hundreds Kb of base memory.
■ DOS 3.1 or later. This is a must.
I.5.B Printing the documentation
═════ ══════════════════════════
You may print the TXFORM documentation by switching your printer
on, and typing the following command at the dos prompt:
COPY TXFORM.DOC PRN
I.5.C Installation procedure
═════ ══════════════════════
To install TXFORM, follow the following [conditional] steps:
■ If you already own a registered version of TXFORM:
- make a backup copy of your TXFORM.EXE file in some other
directory
- after successful installation of the new version in
accordance with the instructions that follow, consult
the file REGISTER.DOC to see how you can immediately
register your new version of TXFORM
■ If you have a previous version of TXFORM installed in some
directory:
- copy the TXFORM distribution file into that directory
- uncompress the distribution file OVERWRITING all
existing files
══════════════════════════════════════════════════════════════════
Introduction Page 5
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
- see the HISTORY.TXT file that describes the differences
between TXFORM v1.0, v1.1 & v1.2
■ If you do not have a previous version of TXFORM installed:
- create any directory
- copy and uncompress the TXFORM distribution file into
it.
■ You may then run TXFORM from anywhere you like (put the
TXFORM directory in your path if you wish), TXFORM will
always work in the directory that is the current one when you
call it.
■ Note that the only file you need is TXFORM.EXE (plus, of
course, your own input files). All other files are for
documentation, demonstration and registration purposes.
──────────────────────────────────────────────────────────────────
I.6 Running TXFORM
──────────────────────────────────────────────────────────────────
Suppose you have prepared an input file called "DEMO.TXT", and
want to create an output formatted file called "DEMO.OUT". Go in
the directory where the input file is located, and type the
command:
TXFORM DEMO.TXT DEMO.OUT
╒══════════════════════════════════════════════════════════════╕
│ TXFORM will produce an output file called "DEMO.OUT". │
│ │
│ Any existing file with the same name will be │
│ overwritten WITHOUT warning. │
╘══════════════════════════════════════════════════════════════╛
══════════════════════════════════════════════════════════════════
Introduction Page 6
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒════════════════════════════════════════╕
│ │
│ CHAPTER II │
│ │
╞════════════════════════════════════════╡
│ │
│ General Principles │
│ │
╘════════════════════════════════════════╛
──────────────────────────────────────────────────────────────────
II.1 Basic concepts
──────────────────────────────────────────────────────────────────
TXFORM reads the input file line by line, treats it appropriately,
and produces the output file.
The program terminates either when an invalid line is encountered,
or when the input file has been completely read and treated.
If an error occurs, TXFORM set the DOS ERRORLEVEL to 1, displays
the input file name and line where the error did occur, provides a
description of the error, and beeps. The error list can be found
in the appendices of this document.
The way each line is treated is explained in the next section.
For technical reasons, the text formatting is done in three
phases. During the execution of the program, the display shows the
lines that have been read in the input files for each phase.
──────────────────────────────────────────────────────────────────
II.2 The different types of lines
──────────────────────────────────────────────────────────────────
There are three types of line:
■ Lines beginning by a '%' in the first column are comment
lines. They are not used at all.
■ Lines beginning by a '\' in the first column are command
lines. These lines contain commands that tell to TXFORM how
to format the output text. Commands are reviewed into details
in a later section of this document.
■ Other lines are treated as text to be formatted and printed
onto the output file. The way the text is formatted is
══════════════════════════════════════════════════════════════════
General Principles Page 7
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
defined by the commands that have been previously read.
──────────────────────────────────────────────────────────────────
II.3 How the output text is formatted
──────────────────────────────────────────────────────────────────
The way TXFORM works is the following:
■ When the first text line is encountered, TXFORM open a
paragraph block, and store the text of the line in it. TXFORM
then reads the next line
■ what happens then depends on the type of the next line:
- If the next line is a comment line, TXFORM reads an
other line
- If the next line is a text line, TXFORM appends it to
the text of the paragraph block
- If the next line is a command line or a blank line, the
paragraph block is formatted, send to the output file
and cleared. In case of a command line, the command is
then executed.
■ The process is then repeated up to the end of the input file.
When the the paragraph block is send to the output file, a set of
automated operations are carried out.
First, the text in the paragraph is properly formatted. All the
words are aligned each after the other one, with only one blank
character between them. The complete paragraph is decomposed into
lines that fit the page formatting (margins, ...). Each line is
then formatted in accordance with the active text justification
mode, and send to the output file.
Other operations like page jumps, footers and headers formatting,
etc, are carried in the same time, automatically.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
Any text, with blanks
inside, and not formatted wil be formatted
up to
the momment a blank line or other command is encountered.
When several blank lines are entered, only one will be written
on to the output file. If you want
to skip blank lines, use the command \LSK.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
Any text, with blanks inside, and not formatted wil be formatted
up to the momment a blank line or other command is encountered.
══════════════════════════════════════════════════════════════════
General Principles Page 8
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
When several blank lines are entered, only one will be written on
to the output file. If you want to skip blank lines, use the
command \LSK.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
──────────────────────────────────────────────────────────────────
II.4 How the modify the formatting options
──────────────────────────────────────────────────────────────────
To modify the formatting options of a paragraph, you basically
provide a formatting command before the paragraph.
Suppose for example that you want to left justify a paragraph.
This is done with the command \AJL.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
This paragraph will be fully justified,
because at this point of the
document this is the current justification mode. The mode full
justification means that each line of the paragraph begin
at the same column, and finish at the same column.
\AJL
This paragraph will be formatted in such a way as to left
justify the lines of the paragraph. The command \AJF that follows
this paragraph reset the full justification mode on.
\AJF
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
This paragraph will be fully justified, because at this point of
the document this is the current justification mode. The mode full
justification means that each line of the paragraph begin at the
same column, and finish at the same column.
This paragraph will be formatted in such a way as to left justify
the lines of the paragraph. The command \AJF that follows this
paragraph reset the full justification mode on.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
The next section describes the commands and their functions into
details.
══════════════════════════════════════════════════════════════════
General Principles Page 9
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒════════════════════════════════════════╕
│ │
│ CHAPTER III │
│ │
╞════════════════════════════════════════╡
│ │
│ Commands Description │
│ │
╘════════════════════════════════════════╛
──────────────────────────────────────────────────────────────────
III.1 Command Structure
──────────────────────────────────────────────────────────────────
A command line is structured as follows:
\CMD:Arg1:Arg2:Arg3:...
■ '\' identify the line as a command line. This character must
be in column one.
Note that the examples throughout this document show the
commands beginning at column 2. This is because this document
is produced with TXFORM, and therefore if the commands had
been put in column 1, they would have been interpreted and
not shown in this tutorial text.
■ 'CMD' is the command itself. The command is identified by
three characters that are not case sensitive.
■ After the command name, we find an optional list of
parameters that are separated by ':'. The number of
parameters and their meaning depend upon the command.
──────────────────────────────────────────────────────────────────
III.2 Commands Names
──────────────────────────────────────────────────────────────────
The commands availables are grouped into logicaly related
functions.
To help you remembering the name of the functions, each command in
a same group begins with one or two same letters.
══════════════════════════════════════════════════════════════════
Commands Description Page 10
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
This is the list of groups and related letters:
╒══════════════════════════╤═══════════════════════════╕
│ The group of functions │ has commands whose name │
│ related to │ begin with letter(s) │
╞══════════════════════════╪═══════════════════════════╡
│ Page formatting │ P │
├──────────────────────────┼───────────────────────────┤
│ Paragraph formatting │ A │
├──────────────────────────┼───────────────────────────┤
│ Framed paragraphs │ AM │
├──────────────────────────┼───────────────────────────┤
│ Itemized paragraphs │ IT │
├──────────────────────────┼───────────────────────────┤
│ Section numbering │ S │
├──────────────────────────┼───────────────────────────┤
│ Macro definition │ MA │
├──────────────────────────┼───────────────────────────┤
│ Header management │ H │
├──────────────────────────┼───────────────────────────┤
│ Footer management │ F │
├──────────────────────────┼───────────────────────────┤
│ Conditional compile │ CC │
├──────────────────────────┼───────────────────────────┤
│ Various │ ... │
╘══════════════════════════╧═══════════════════════════╛
In the following tables, a '*' show the default options, and the
default values are indicated where applicable.
══════════════════════════════════════════════════════════════════
Commands Description Page 11
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.3 Page formatting options
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ Pxx │ Page Formatting Options │
╞══════════╪═════════════════════════════════════════════════════╡
│ PJU │ Jump to next page │
│ PJC │ Jump to next page is less then Arg1 lines remaining │
├──────────┼─────────────────────────────────────────────────────┤
│ PNB │ Set actual page number to Arg1 │
├──────────┼─────────────────────────────────────────────────────┤
│ PML │ Set Left Margin to Arg1 (Default=5) │
│ PMR │ Set Right Margin to Arg1 (Default=75) │
├──────────┼─────────────────────────────────────────────────────┤
│ PLE │ Set Page Length to Arg1 (Default=62) │
╘══════════╧═════════════════════════════════════════════════════╛
III.3.A PJU = Jump to next page
═══════ ═══════════════════════
A page contains a number of lines that default to 62. This
includes the lines taken by the footer, the header, and the area
reserved for text in between.
TXFORM will write each line after an other. When it begins a new
page, it will first write the header lines. At the end of the
page, it will write the footer lines.
You may force TXFORM to jump to a new page, whatever the current
line is, simply by inserting the command "\PJU".
III.3.B PJC = Jump to next page if less then Arg1 lines
═══════ ═══════════════════════════════════════════════
This command is similar to the previous one, except that it will
jump to the next page only if there are less than Arg1 free lines
on the current page. Note that the number of lines to remain are
the number of lines in the text area, without taking into account
the number of lines required by the footer (TXFORM takes the
footer lines into consideration for you).
For example, if you want to make sure that a title that requires
four lines is on the same page than the beginning of the text that
follows, use the command "\PJC:5"
III.3.C PNB = Set actual page number to Arg1
═══════ ════════════════════════════════════
Each page of the output document is numbered, starting with 1 at
the first page. You may change the current number of a page with
the command \PNB.
Note that you must change the page number before this number is
written. If you have set the page number in the footer, change the
══════════════════════════════════════════════════════════════════
Commands Description Page 12
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
page number when you are in the page with the new number. If you
have put the page number in the header, change the page number on
the previous page.
For example, to put the current page number to 21, use the command
"\PNB:21".
III.3.D PML = Set Left Margin to Arg1
═══════ ═════════════════════════════
Each line of text is written between the left and the right
margins. The margins are expressed in characters from the left
side of the page. The default left margin is 5, and the default
right margin is 75.
You may change the left margin with the command PML.
For example, to put the left margin at 20 characters from the left
of the page, use the command "\PML:20" (see example below).
Note that the left and right margins are characteristics of you
paper. These values are also used for the horizontal alignments of
headers and footers. If you want to move the margins only for the
text formatting, whitout changing anything to the footers and
headers, you should use the commands "\AIL" and "\AIR" that define
the text indents with respect to the margins.
III.3.E PMR = Set Right Margin to Arg1
═══════ ══════════════════════════════
You may change the right margin with the command PMR (see previous
paragraph for more on margins).
For example, to put the right margin at 60 characters from the
left of the page, use the command "\PMR:60", as in the following
example.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\PML:20
\PMR:60
This paragraph will be fully justified between the columns
20 and 60, as defined by the two commands issued hereabove.
To make sure the rest of the text is formatted as above, we
reset the original margins herebelow.
\PML:10
\PMR:75
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
This paragraph will be fully justified
between the columns 20 and 60, as defined
by the two commands issued hereabove. To
make sure the rest of the text is
formatted as above, we reset the original
margins herebelow.
══════════════════════════════════════════════════════════════════
Commands Description Page 13
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
III.3.F PLE = Set Page Length to Arg1
═══════ ═════════════════════════════
You may change the number of lines on one page with the command
PLE.
For example, to set the page length to 60, use the command
"\PLE:60".
Note that the page length includes the lines required for the
footer and the header.
══════════════════════════════════════════════════════════════════
Commands Description Page 14
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.4 Paragraph formatting options
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ Axx │ Paragraph Formatting Options │
╞══════════╪═════════════════════════════════════════════════════╡
│ AC- * │ center text off │
│ AC+ │ center text on │
├──────────┼─────────────────────────────────────────────────────┤
│ AF- │ fill text off │
│ AF+ * │ fill text on │
├──────────┼─────────────────────────────────────────────────────┤
│ AIL │ indent left margin of Arg1 columns (Default=0) │
│ AIR │ indent right margin of Arg1 columns (Default=0) │
├──────────┼─────────────────────────────────────────────────────┤
│ ASL │ set number of blank lines after paragraph to Arg1 │
│ │ (Default=1) │
├──────────┼─────────────────────────────────────────────────────┤
│ AJL * │ left justify text │
│ AJR │ right justify text │
│ AJF │ full justify text │
╘══════════╧═════════════════════════════════════════════════════╛
III.4.A AC- = center text off
═══════ ═════════════════════
By default, the "center text" option is off. This means that the
text will be justified between the left and right margins.
The "\AC-" option is used to reset this option off when it is has
been set on with the command "\AC+" (see below).
III.4.B AC+ = center text on
═══════ ════════════════════
The "center text on" option changes the way the text is formatted
in the following manner:
■ Each line is taken exactly as it is written (with any number
of blank between the words).
■ Each line is centered between the left and right margins.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\AC+
These lines will be centered between the margins.
The blanks between the words will not be modified.
\AC-
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
These lines will be centered between the margins.
The blanks between the words will not be modified.
══════════════════════════════════════════════════════════════════
Commands Description Page 15
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
III.4.C AF- = fill text off
═══════ ═══════════════════
By default, the "Fill text" option is on. This means that the
input text will be modified to make sure that there is only one
blank character between each word. When you put it off with the
"\AF-" command, this will no longer be true, and the intermediary
blank characters will remain unchanged. Also, each line will be
printed separately (no concatenation). Use the "\AF+" to reset the
"Fill text" mode on.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
This line is written with the "fill text" mode on.
\AF-
This line is written with the "fill text" mode off.
\AF+
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
This line is written with the "fill text" mode on.
This line is written with the "fill text" mode off.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
The "Fill text" mode off is useful when you want to force TXFORM
to output the text as you would like it. Note also that the
"Center text" mode will overwrite the "Fill text" mode settings.
III.4.D AF+ = fill text on
═══════ ══════════════════
This command is used to reset the "Fill text" mode on. See
previous paragraph for details and example.
III.4.E AIL = indent left margin of Arg1 columns
═══════ ════════════════════════════════════════
The "\AIL" command allows you to move the left margin of a given
number of characters. There are two main differences between this
command and the margin command "\PML":
■ you do not need to know where the margin is actually
positioned, which can be useful, for example in included
files.
■ the indent acts only on the text margin, not on the header
and footer left and right margins.
You move the left margin to the right by using a positive Arg1
value, and to the left using a negative Arg1 value, as in the next
example:
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
══════════════════════════════════════════════════════════════════
Commands Description Page 16
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
This is text with the current left margin indent of 0.
\AIL:5
This is text with left margin indented of 5 chars right.
After this text, we indent the margin again to the left, to restore
the initial settings.
\AIL:-5
This is text with initial left margin indent setting.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
This is text with the current left margin indent of 0.
This is text with left margin indented of 5 chars right.
After this text, we indent the margin again to the left, to
restore the initial settings.
This is text with initial left margin indent setting.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
III.4.F AIR = indent right margin of Arg1 columns
═══════ ═════════════════════════════════════════
This command is similar to the "\AIL" command, except that it acts
on the right margin.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
This is text with the current right margin indent of 0. We have to
add some text to make sure we reach the right margin, so you
can see what is going on.
\AIR:-10
This is text with right margin indented of 10 chars left.
After this text, we indent the margin again to the right, to restore
the initial settings.
\AIR:+10
This is text with initial right margin indent setting. We have to
add some text to make sure we reach the right margin, so you
can see what is going on.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
This is text with the current right margin indent of 0. We have to
add some text to make sure we reach the right margin, so you can
see what is going on.
This is text with right margin indented of 5 chars left.
After this text, we indent the margin again to the
right, to restore the initial settings.
This is text with initial right margin indent setting. We have to
add some text to make sure we reach the right margin, so you can
see what is going on.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
══════════════════════════════════════════════════════════════════
Commands Description Page 17
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
III.4.G ASL = number of blank lines after paragraph
═══════ ═══════════════════════════════════════════
By default, TXFORM will skip 1 blank line after each paragraph.
You may change this setting by specifying the number of blank
lines to be skipped with the command "\ASL".
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
After this line, one blank line will be skipped
\ASL:2
After this line, two blank lines will be skipped.
\ASL:1
Again, after this line, one blank line will be skipped
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
After this line, one blank line will be skipped
After this line, two blank lines will be skipped.
Again, after this line, one blank line will be skipped
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
III.4.H AJL = left justify text
═══════ ═══════════════════════
This command is used to left justify the text within the margins.
See "Full Justify Text" for example.
III.4.I AJR = right justify text
═══════ ════════════════════════
This command is used to right justify the text within the margins.
See "Full Justify Text" for example.
III.4.J AJF = full justify text
═══════ ═══════════════════════
This command is used to full justify the text within the margins.
Justification is illustrated here below:
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\AJL
Example of left justification. This is just any text that we
use as an example of what justification means. This is still
an other line that is useful to show the results.
\AJR
Example of right justification. This is just any text that we
use as an example of what justification means. This is still
an other line that is useful to show the results.
\AJF
Example of full justification. This is just any text that we
use as an example of what justification means. This is still
an other line that is useful to show the results.
══════════════════════════════════════════════════════════════════
Commands Description Page 18
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
Example of left justification. This is just any text that we use
as an example of what justification means. This is still an other
line that is useful to show the results.
Example of right justification. This is just any text that we use
as an example of what justification means. This is still an other
line that is useful to show the results.
Example of full justification. This is just any text that we use
as an example of what justification means. This is still an other
line that is useful to show the results.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
══════════════════════════════════════════════════════════════════
Commands Description Page 19
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.5 Framed paragraphs
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ AMx │ Framed Paragraph │
╞══════════╪═════════════════════════════════════════════════════╡
│ AM- * │ set frame off │
│ AM+ │ set frame on │
├──────────┼─────────────────────────────────────────────────────┤
│ AML │ left align frame │
│ AMR │ right align frame │
│ AMC * │ center frame │
├──────────┼─────────────────────────────────────────────────────┤
│ AMW │ set frame width (Default=35) │
├──────────┼─────────────────────────────────────────────────────┤
│ AMS │ set frame style to Arg1 (Default=1) │
╘══════════╧═════════════════════════════════════════════════════╛
III.5.A AM- = set frame off
═══════ ═══════════════════
This command is used to terminate the "Frame" mode that has been
set by the command "\AM+". See below for more on this topic.
III.5.B AM+ = set frame on
═══════ ══════════════════
You may create a frame around your text by putting the command
"\AM+" before the text to be framed, and the command "\AM-" after
the text to be framed.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\AM+
By default, the frame is centered, and is 35 characters of width.
\AM-
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
╒═════════════════════════════════════╕
│ By default, the frame is centered, │
│ and is 35 characters of width. │
╘═════════════════════════════════════╛
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
If you put the option "Fill Text" Off, then:
■ Each line will be written as it is entered in the input file
■ The text will be centered
■ The width of the frame will be adapted to fit the text
■ A line that contains only the "-" character will produce an
══════════════════════════════════════════════════════════════════
Commands Description Page 20
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
horizontal line in the frame.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\AF-
\AM+
With the "\AF-" command, the size of
the frame will be adapted to fit the
text in, and the text will be
centered
-
You may add an horizontal line using the "\AF-"
command, and putting only the
character "-" on a line.
\AM-
\AF+
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
╒═════════════════════════════════════════════════╕
│ With the "\AF-" command, the size of │
│ the frame will be adapted to fit the │
│ text in, and the text will be │
│ centered │
╞═════════════════════════════════════════════════╡
│ You may add an horizontal line using the "\AF-" │
│ command, and putting only the │
│ character "-" on a line. │
╘═════════════════════════════════════════════════╛
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
III.5.C AML = left align frame
═══════ ══════════════════════
You may align the frame on the left. See example below.
III.5.D AMR = right align frame
═══════ ═══════════════════════
You may align the frame on the right. See example below.
III.5.E AMC = center frame
═══════ ══════════════════
You may align the frame on the center of the margins.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\AML
\AM+
The frame can be left aligned with the command \AML
\AM-
\AMR
\AM+
The frame can be right aligned with the command \AMR
\AM-
\AMC
══════════════════════════════════════════════════════════════════
Commands Description Page 21
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
\AM+
The frame can be centered with the command \AMC
\AM-
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
╒═════════════════════════════════════╕
│ The frame can be left aligned with │
│ the command \AML │
╘═════════════════════════════════════╛
╒═════════════════════════════════════╕
│ The frame can be right aligned with │
│ the command \AMR │
╘═════════════════════════════════════╛
╒═════════════════════════════════════╕
│ The frame can be centered with the │
│ command \AMC │
╘═════════════════════════════════════╛
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
III.5.F AMW = set frame width
═══════ ═════════════════════
You may change the width of the frame. For example:
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\AMW:45
\AM+
The frame width has been changed to 45 characters,
using the command "\AMW:45"
\AM-
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
╒═══════════════════════════════════════════════╕
│ The frame width has been changed to 45 │
│ characters, using the command "\AMW:45" │
╘═══════════════════════════════════════════════╛
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
III.5.G AMS = set frame style to Arg1
═══════ ═════════════════════════════
By default, the frame style is as shown in the previous examples.
It is called frame style number 1. There are 6 different frame
styles that you may use. They are shown in the following example:
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\AF-
\AMS:1
\AM+
This is frame style number 1, the default one
══════════════════════════════════════════════════════════════════
Commands Description Page 22
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
-
Style One
\AM-
\AMS:2
\AM+
This is frame style number 2
-
Style Two
\AM-
\AMS:3
\AM+
This is frame style number 3
-
Style Three
\AM-
\AMS:4
\AM+
This is frame style number 4
-
Style Four
\AM-
\AMS:5
\AM+
This is frame style number 5
-
Style Five
\AM-
\AMS:6
\AM+
This is frame style number 6 (=No frame)
-
Style Six
\AM-
\AF+
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
╒═══════════════════════════════════════════════╕
│ This is frame style number 1, the default one │
╞═══════════════════════════════════════════════╡
│ Style One │
╘═══════════════════════════════════════════════╛
┌───────────────────────────────────────────────┐
│ This is frame style number 2 │
├───────────────────────────────────────────────┤
│ Style Two │
└───────────────────────────────────────────────┘
╔═══════════════════════════════════════════════╗
║ This is frame style number 3 ║
╠═══════════════════════════════════════════════╣
║ Style Three ║
╚═══════════════════════════════════════════════╝
╓───────────────────────────────────────────────╖
══════════════════════════════════════════════════════════════════
Commands Description Page 23
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
║ This is frame style number 4 ║
╟───────────────────────────────────────────────╢
║ Style Four ║
╙───────────────────────────────────────────────╜
!-----------------------------------------------!
! This is frame style number 5 !
!-----------------------------------------------!
! Style Five !
!-----------------------------------------------!
This is frame style number 6 (=No frame)
Style Six
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
══════════════════════════════════════════════════════════════════
Commands Description Page 24
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.6 Itemizing paragraph
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ ITx │ Itemized Paragraph │
╞══════════╪═════════════════════════════════════════════════════╡
│ ITZ │ start itemized mode with char Arg1 │
│ ITT │ itemized next paragraph │
│ ITS │ stop itemized mode │
╘══════════╧═════════════════════════════════════════════════════╛
"Itemizing" the paragraphs means to use bullets and indentation at
the beginning of each paragraph, as in the example shown below.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\ITZ:■
\ITT
This is the first paragraph of the itemized items.
\ITT
This is the second paragraph of the itemized items.
\ITS
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
■ This is the first paragraph of the itemized items.
■ This is the second paragraph of the itemized items.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
III.6.A ITZ = start itemized mode with char Arg1
═══════ ════════════════════════════════════════
You start the itemization of paragraphs with the command "\ITZ:c"
where "c" is the caracter to be used as a bullet.
III.6.B ITT = itemized next paragraph
═══════ ═════════════════════════════
Each time you want to itemize the next paragraph, you put the
command "\ITT" before it. Note that itemization is not
automatically done for each new paragraph.
III.6.C ITS = stop itemized mode
═══════ ════════════════════════
When Itemization of paragraphs is not longer required, use the
command "\ITS"
III.6.D Nesting itemization
═══════ ═══════════════════
You may nest different itemizations, using different bullets, as
in the following example:
══════════════════════════════════════════════════════════════════
Commands Description Page 25
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\ITZ:■
\ITT
This is first item of level 1
Note that itemization is not automatically done for each
new paragraph.
\ITZ:*
\ITT
This is first item of level 2
\ITT
This is second item of level 2
\ITT
\ITS
\ITT
This is second item of level 1
\ITT
\ITS
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
■ This is first item of level 1
Note that itemization is not automatically done for each new
paragraph.
* This is first item of level 2
* This is second item of level 2
■ This is second item of level 1
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
══════════════════════════════════════════════════════════════════
Commands Description Page 26
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.7 Sections management
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ Sxx │ Section Management │
╞══════════╪═════════════════════════════════════════════════════╡
│ SLV │ set new section level Arg1 with title Arg2 │
├──────────┼─────────────────────────────────────────────────────┤
│ SAP │ set appendix mode │
╘══════════╧═════════════════════════════════════════════════════╛
III.7.A SLV = set new section level Arg1 with title Arg2
═══════ ════════════════════════════════════════════════
Each time you want to start a new section, you use the command
"\SLV:x:title" where
■ "x" is the level of the section
TXFORM can handle four different levels. For each level,
there is a specific layout in the output file. You can not
change this layout. The first level is called "Chapter".
■ "Title" is the title of the section
The sections and their level and title will be automatically
included in the table of contents.
III.7.B SAP = set appendix mode
═══════ ═══════════════════════
Once you issue the command "\SAP", you enter into the Appendice
mode. It is the same as the normal mode, except that level one
sections are called "Appendices".
Once you have set the Appendice mode on, you can not come back to
normal mode.
══════════════════════════════════════════════════════════════════
Commands Description Page 27
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.8 Macros
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ MAx │ Macro Management │
╞══════════╪═════════════════════════════════════════════════════╡
│ MAD │ define macro Arg1 to be replaced by Arg2 │
├──────────┼─────────────────────────────────────────────────────┤
│ MAP │ define macro Arg1 to be replaced by page number │
├──────────┼─────────────────────────────────────────────────────┤
│ MAS │ define macro Arg1 to be replaced by section number │
├──────────┼─────────────────────────────────────────────────────┤
│ MAC │ define macro Arg1 to be replaced by codes of Arg2 │
╘══════════╧═════════════════════════════════════════════════════╛
A macro is a string of characters, called the macro name, that
TXFORM replaces with an other string of characters, called the
macro definition. The replacement is made throughout the text, as
well as in the commands arguments before they are executed.
Note that
■ the macro name can contain any character, and is case
sensitive.
■ the string containing the macro is modified in two steps:
* the macro name is removed from the string
* the macro definition is inserted into the string
■ you can change the macro definition after it has been defined
■ you can use a macro before it has been defined. This is the
reason why TXFORM needs several passes to produce the output
file. However, the macros that are used this way should only
be defined once.
■ there are six macros that are always defined (please do not
consider the blank character between "_" and "#"):
* "_ #d" : the current date; see the command DFR for the
date format that will be used
* "_ #p" : the current page
* "_ #t1" : the title of current section level 1
* "_ #t2" : the title of current section level 2
* "_ #t3" : the title of current section level 3
* "_ #t4" : the title of current section level 4
══════════════════════════════════════════════════════════════════
Commands Description Page 28
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
III.8.A MAD = define macro Arg1 == Arg2
═══════ ═══════════════════════════════
Defines a macro name Arg1 and its corresponding macro definition
Arg2. TXFORM will replace the string "Arg1" by the string "Arg2"
everywhere in the text.
For example, you could define the macro "_macroEx" that has to be
replaced with "My Name", using the command:
\MAD:_macroEx:My Name
If you want to add blank characters to your macro definition, use
a final ':' at the end of the macro definition.
For example, the command "\MAD:_: b :" will replace the string
"m_c" by "m b ".
III.8.B MAP = define macro Arg1 == page number
═══════ ══════════════════════════════════════
This is a short cut that allows you to define a macro that
contains the page number where the macro is defined. This is
useful for cross references.
III.8.C MAS = define macro Arg1 == section number
═══════ ═════════════════════════════════════════
This is a short cut that allows you to define a macro that
contains the current section where the macro is defined. This is
useful for cross references.
III.8.D MAC = define macro Arg1 == codes of Arg2
═══════ ════════════════════════════════════════
This command offers you the possibility to define a macro as the
sequence of ASCII chars. It could be useful when you want to use
special control for the printer.
For example, you could define a macro "_BoldOn" that would put a
printer mode on "Bold", by using the following command (Assuming
that the bold mode is #27 #18; check your printer documentation):
\MAC:_BoldOn:27,18
══════════════════════════════════════════════════════════════════
Commands Description Page 29
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.9 Header management
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ Hxx │ Header Management │
╞══════════╪═════════════════════════════════════════════════════╡
│ HE- │ header off │
│ HE+ * │ header on │
├──────────┼─────────────────────────────────────────────────────┤
│ HTL │ set left text to Arg1 │
│ HTC │ set center text to Arg1 │
│ HTR │ set right text to Arg1 │
├──────────┼─────────────────────────────────────────────────────┤
│ HLB │ set Arg1 blank line before header (Default=0) │
│ HLA │ set Arg1 blank line after header (Default=1) │
├──────────┼─────────────────────────────────────────────────────┤
│ HL+ * │ draw separator line in header │
│ HL- │ do not draw separator line in header │
├──────────┼─────────────────────────────────────────────────────┤
│ HLC │ set char used for header separator line (Def = '═')│
╘══════════╧═════════════════════════════════════════════════════╛
The header is composed of
■ A given number of blank lines before the header. These blank
lines are always printed, even if the Header mode is off.
This is equivalent to defining a top margin to the page. By
default, there are no blank lines.
■ A line with three items of text: one that will be left
justified, a second one that will be centered, and a third
one that will be right justified. This line is printed when
the header mode is on. If all strings are blank, a blank line
is printed.
■ A separator line. This line is printed if both the header
mode and the header draw line mode are on.
■ A given number of blank lines. These lines are printed if the
header mode is on. By default, there is one blank line.
You configure the header with the following commands:
III.9.A HE- = header mode off
═══════ ══════════════════════
Do not produce a header on the output file
III.9.B HE+ = header mode on
═══════ ════════════════════
Produce a header on the output file (default)
══════════════════════════════════════════════════════════════════
Commands Description Page 30
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
III.9.C HTL = set left text to Arg1
═══════ ═══════════════════════════
Define the text that will be left aligned.
Example: put the page number in the left header text with the
command "\HTL:Page _ #p" (the use of macros is permitted; please
do not consider the blank character between "_" and "#").
III.9.D HTC = set center text to Arg1
═══════ ═════════════════════════════
Define the text that will be centered.
III.9.E HTR = set right text to Arg1
═══════ ════════════════════════════
Define the text that will be right aligned.
Example: put the section in the right header text with the command
"\HTL:Section _ #t1" (the use of macros is permitted; please do
not consider the blank character between "_" and "#").
III.9.F HLB = set Arg1 blank line before header
═══════ ═══════════════════════════════════════
Set the number of blank lines to skip before writing the header.
This is equivalent to defining a top margin to the page.
III.9.G HLA = set Arg1 blank line after header
═══════ ══════════════════════════════════════
Set the number of blank lines to skip after writing the header.
III.9.H HL+ = draw separator line in header
═══════ ═══════════════════════════════════
Draw a separator line in the header (default).
III.9.I HL- = do not draw separator line in header
═══════ ══════════════════════════════════════════
Do not draw a separator line in the header.
III.9.J HLC = set char used for header separator line
═══════ ═════════════════════════════════════════════
Change the character used to draw the separator line.
Example: draw a separator line with the character "-" with the
command "\HLC:-"
══════════════════════════════════════════════════════════════════
Commands Description Page 31
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.10 Footer management
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ Fxx │ Footer Management │
╞══════════╪═════════════════════════════════════════════════════╡
│ FO- │ footer off │
│ FO+ * │ footer on │
├──────────┼─────────────────────────────────────────────────────┤
│ FTL │ set left text to Arg1 │
│ FTC │ set center text to Arg1 │
│ FTR │ set right text to Arg1 │
├──────────┼─────────────────────────────────────────────────────┤
│ FLB │ set Arg1 blank line before footer (Default=1) │
│ FLA │ set Arg1 blank line after footer (Default=0) │
├──────────┼─────────────────────────────────────────────────────┤
│ FL+ * │ draw separator line in footer │
│ FL- │ do not draw separator line in footer │
├──────────┼─────────────────────────────────────────────────────┤
│ FLC │ set char used for footer separator line (Def = '═')│
╘══════════╧═════════════════════════════════════════════════════╛
The footer is composed of
■ A given number of blank lines before the footer. These lines
are printed if the footer mode is on. By default, there is
one blank line.
■ A separator line. This line is printed if both the footer
mode and the footer draw line mode are on.
■ A line with three items of text: one that will be left
justified, a second one that will be centered, and a third
one that will be right justified. This line is printed when
the footer mode is on. If all strings are blank, a blank line
is printed.
■ A given number of blank lines. These blank lines are always
printed, even if the Header mode is off. This is equivalent
to defining a bottom margin to the page. By default, there
are no blank lines.
You configure the footer with the following commands:
III.10.A FO- = footer mode off
════════ ══════════════════════
Do not produce a footer on the output file
III.10.B FO+ = footer mode on
════════ ════════════════════
Produce a footer on the output file (default)
══════════════════════════════════════════════════════════════════
Commands Description Page 32
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
III.10.C FTL = set left text to Arg1
════════ ═══════════════════════════
Define the text that will be left aligned.
Example: put the page number in the left footer text with the
command "\FTL:Page _ #p" (the use of macros is permitted; please
do not consider the blank character between "_" and "#").
III.10.D FTC = set center text to Arg1
════════ ═════════════════════════════
Define the text that will be centered.
III.10.E FTR = set right text to Arg1
════════ ════════════════════════════
Define the text that will be right aligned.
Example: put the section in the right footer text with the command
"\FTL:Section _ #t1" (the use of macros is permitted; please do
not consider the blank character between "_" and "#").
III.10.F FLB = set Arg1 blank line before footer
════════ ═══════════════════════════════════════
Set the number of blank lines to skip before writing the footer.
III.10.G FLA = set Arg1 blank line after footer
════════ ══════════════════════════════════════
Set the number of blank lines to skip after writing the footer.
This is equivalent to defining a bottom margin to the page.
III.10.H FL+ = draw separator line in footer
════════ ═══════════════════════════════════
Draw a separator line in the footer.
III.10.I FL- = do not draw separator line in footer
════════ ══════════════════════════════════════════
Do not draw a separator line in the footer.
III.10.J FLC = set char used for footer separator line
════════ ═════════════════════════════════════════════
Change the character used to draw the separator line.
Example: draw a separator line with the character "-" with the
command "\FLC:-"
══════════════════════════════════════════════════════════════════
Commands Description Page 33
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.11 Conditional compile
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ CCx │ Conditional define │
╞══════════╪═════════════════════════════════════════════════════╡
│ CC+ │ Compile next lines if macro Arg1 is defined │
│ CC- │ Cancel action of last CC+ command │
╘══════════╧═════════════════════════════════════════════════════╛
III.11.A CC+ = Compile next lines if macro Arg1 defined
════════ ══════════════════════════════════════════════
This macro will compile all lines that follows only if the macro
Arg1 is defined, until a corresponding "\CC-" command will be
issued.
Note that several conditional compile can be nested.
III.11.B CC- = Cancel action of last CC+ command
════════ ═══════════════════════════════════════
Restore the compile mode on
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
This line is printed
\CC+:_macrotest
These lines will not be printed because
the macro "_macrotest" is not defined:
\CC-
This line is also printed
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
This line is printed
This line is also printed
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
══════════════════════════════════════════════════════════════════
Commands Description Page 34
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
──────────────────────────────────────────────────────────────────
III.12 Various commands
──────────────────────────────────────────────────────────────────
╒══════════╤═════════════════════════════════════════════════════╕
│ │ Various commands │
╞══════════╪═════════════════════════════════════════════════════╡
│ INC │ Include Arg1 file │
├──────────┼─────────────────────────────────────────────────────┤
│ LSK │ Skip Arg1 lines │
├──────────┼─────────────────────────────────────────────────────┤
│ LFI │ Write a full page width line with char Arg1 │
├──────────┼─────────────────────────────────────────────────────┤
│ DFR │ Set Date Format to Arg1 (Default=dd/mm/yy) │
├──────────┼─────────────────────────────────────────────────────┤
│ TC- │ Do not show table of contents │
├──────────┼─────────────────────────────────────────────────────┤
│ CMI │ Change Command Identifier to Arg1 (Default='\') │
│ CMS │ Change Command Separator to Arg1 (Default=':') │
├──────────┼─────────────────────────────────────────────────────┤
│ ZZZ │ End of input file │
╘══════════╧═════════════════════════════════════════════════════╛
III.12.A INC = Include Arg1 file
════════ ═══════════════════════
You may include any other file into your main file.
Include files can be nested to up to 10 levels.
For example, you may include your autoexec file in the file with
the command "\INC:C:\Autoexec.bat"
Note that the "\INC" command is the only command that allows you
to use the character ':' in the argument without it being
interpreted as a delimiter (see also the command "\CMS"
herebelow).
III.12.B LSK = Skip Arg1 lines
════════ ═════════════════════
This command is used to skip several blank lines.
For example, skip 10 blank lines with the command "\LSK:10"
III.12.C LFI = Write a line with char Arg1
════════ ═════════════════════════════════
This command is used to write a line that extend from the left
margin to the right margin, using a given character.
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Example: the following input lines: ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
\LFI:*
≡≡≡≡≡≡≡≡≡≡≡≡≡≡ Will produce the following output text: ≡≡≡≡≡≡≡≡≡≡≡
══════════════════════════════════════════════════════════════════
Commands Description Page 35
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
******************************************************************
≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡ End of example ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡
III.12.D DFR = Set Date Format to Arg1
════════ ═════════════════════════════
This command is used to format the date as you wish.
Arg1 is a string in which some characters are automatically
replaced by others, as described here below:
■ 'm': replaced by the number of the month, padded with '0'
'M': replaced by the number of the month, padded with ' '
■ 'd': replaced by the number of the day, padded with '0'
'D': replaced by the number of the day, padded with ' '
■ 'y': replaced by the number of the year
■ '/': used as separator
■ 'n': replaced by the name of the month, lower case
'N': replaced by the name of the month, upper case
■ 'w': replaced by the name of the day , lower case
'W': replaced by the name of the day, upper case
All other characters are treated as literals.
Examples:
■ This is the date in default format dd/mm/yy: 01/05/96
■ This is the date in format DD/MM/yy: 1/ 5/96
■ This is the date in format wwww-dd-nnn-yy: Wedn-01-May-96
III.12.E TC- = Do not show table of contents
════════ ═══════════════════════════════════
This is used to suppress the creation of the table of contents.
III.12.F CMI = Change Command Identifier to Arg1
════════ ═══════════════════════════════════════
Each command is identified by "\" in the first column of a line.
If you whish, you may change this character by any other one of
your choice (be careful...).
══════════════════════════════════════════════════════════════════
Commands Description Page 36
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
III.12.G CMS = Change Command Separator to Arg1
════════ ══════════════════════════════════════
The various arguments of a command are separated by the special
character ":". If you whish, or if you need for example to have
this character in your section titles, you may change this
character for any other of your choice. Be carefull...
III.12.H ZZZ = End of input file
════════ ═══════════════════════
You may mark the end of your input file with this command. The
rest of the file will be ignored.
It is recommended to use this command, even if you do not need it.
Some special problems related to the formatting of the last
paragraph can be avoided if you do so.
══════════════════════════════════════════════════════════════════
Commands Description Page 37
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒════════════════════════════════════════╕
│ │
│ CHAPTER IV │
│ │
╞════════════════════════════════════════╡
│ │
│ Error Messages │
│ │
╘════════════════════════════════════════╛
This is a list of the error messages:
■ Invalid control char
You are using a control character that is not valid
■ Invalid Command: xxx
The command xxx is not recognized by TXFORM
■ Too Many Nested Input Files
You have too many nested files (limit=10)
■ File xxxx not found
TXFORM can not find the file "xxxx"
■ Invalid registration data
You have not enter the validation data exactly as you have
received it. Registration data is case sensitive.
■ Invalid Argument List
The argument list you have given to TXFORM while running it
is not valid (see running TXFORM)
■ Invalid Frame Type
TXFORM knows only six different frame types : 1..6
■ Output file xxxx Not open !
TXFORM could not open the specified output file
■ Invalid Left Margin
The value specified for the left margin is not valid, or is
══════════════════════════════════════════════════════════════════
Error Messages Page 38
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
not consistent with right margin settings.
■ Invalid Right Margin
The value specified for the right margin is not valid, or is
not consistent with left margin settings.
■ Invalid Range
The value specified for one of the arguments is out-of-range.
This means that you have entered a value that is not accepted
by TXFORM. For example, setting the page length to 1000 will
generate this error.
■ Too many macros
You may not define more than 150 macros.
■ Macro xxx is referencing it self
You have defined a macro that either contain itself, or
contains an other macro that itself contains the first macro.
For example, the following macro definition is not valid:
\MAD:_m1:aa_m1
══════════════════════════════════════════════════════════════════
Error Messages Page 39
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒═══════════════════════════════════════════════╕
│ │
│ APPENDIX A │
│ │
╞═══════════════════════════════════════════════╡
│ │
│ Using TXFORM with Multiple Windows Editor │
│ │
╘═══════════════════════════════════════════════╛
TXFORM is particularly easy to use when you use a multiple windows
editor that allows you to execute a command under DOS without
leaving the editor.
In my case, I use the Borland Turbo Pascal 7.0 editor. In one
window, I see the input file called "X.PAS". In an other window, I
see the output file "X.TMP".
Each time I have modifed the input file, I press "Shift-F9", and
the output file is modified accordingly. Doing so allows me to use
TXFORM as a kind of sophisticated on line editor.
To get the "Shift-F9" key to do the job, I have assigned it to a
Tool with:
■ the program path set to:
"TXFORM.EXE" (note that my copy of TXFORM is in my path)
■ the command line set to:
"$SAVE ALL $NAME($EDNAME).pas $NAME($EDNAME).tmp".
See the Turbo Pascal editor documentation for more explanation on
how to define a tool.
══════════════════════════════════════════════════════════════════
Using TXFORM with Multiple Windows Editor Page 40
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒════════════════════════════════════════╕
│ │
│ APPENDIX B │
│ │
╞════════════════════════════════════════╡
│ │
│ Summary of Commands │
│ │
╘════════════════════════════════════════╛
The commands availables are grouped into logicaly related
functions:
╒══════════════════════════╤═══════════════════════════╕
│ The group of functions │ has commands whose name │
│ related to │ begin with letter(s) │
╞══════════════════════════╪═══════════════════════════╡
│ Page formatting │ P │
├──────────────────────────┼───────────────────────────┤
│ Paragraph formatting │ A │
├──────────────────────────┼───────────────────────────┤
│ Framed paragraphs │ AM │
├──────────────────────────┼───────────────────────────┤
│ Itemized paragraphs │ IT │
├──────────────────────────┼───────────────────────────┤
│ Section numbering │ S │
├──────────────────────────┼───────────────────────────┤
│ Macro definition │ MA │
├──────────────────────────┼───────────────────────────┤
│ Header management │ H │
├──────────────────────────┼───────────────────────────┤
│ Footer management │ F │
├──────────────────────────┼───────────────────────────┤
│ Conditional compile │ CC │
├──────────────────────────┼───────────────────────────┤
│ Various │ ... │
╘══════════════════════════╧═══════════════════════════╛
In the following tables, a '*' show the default options, and the
default values are indicated where applicable.
══════════════════════════════════════════════════════════════════
Summary of Commands Page 41
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒══════════╤═════════════════════════════════════════════════════╕
│ Pxx │ Page Formatting Options │
╞══════════╪═════════════════════════════════════════════════════╡
│ PJU │ Jump to next page │
│ PJC │ Jump to next page is less then Arg1 lines remaining │
├──────────┼─────────────────────────────────────────────────────┤
│ PNB │ Set actual page number to Arg1 │
├──────────┼─────────────────────────────────────────────────────┤
│ PML │ Set Left Margin to Arg1 (Default=5) │
│ PMR │ Set Right Margin to Arg1 (Default=75) │
├──────────┼─────────────────────────────────────────────────────┤
│ PLE │ Set Page Length to Arg1 (Default=62) │
╘══════════╧═════════════════════════════════════════════════════╛
╒══════════╤═════════════════════════════════════════════════════╕
│ Axx │ Paragraph Formatting Options │
╞══════════╪═════════════════════════════════════════════════════╡
│ AC- * │ center text off │
│ AC+ │ center text on │
├──────────┼─────────────────────────────────────────────────────┤
│ AF- │ fill text off │
│ AF+ * │ fill text on │
├──────────┼─────────────────────────────────────────────────────┤
│ AIL │ indent left margin of Arg1 columns (Default=0) │
│ AIR │ indent right margin of Arg1 columns (Default=0) │
├──────────┼─────────────────────────────────────────────────────┤
│ ASL │ set number of blank lines after paragraph to Arg1 │
│ │ (Default=1) │
├──────────┼─────────────────────────────────────────────────────┤
│ AJL * │ left justify text │
│ AJR │ right justify text │
│ AJF │ full justify text │
╘══════════╧═════════════════════════════════════════════════════╛
╒══════════╤═════════════════════════════════════════════════════╕
│ AMx │ Framed Paragraph │
╞══════════╪═════════════════════════════════════════════════════╡
│ AM- * │ set frame off │
│ AM+ │ set frame on │
├──────────┼─────────────────────────────────────────────────────┤
│ AML │ left align frame │
│ AMR │ right align frame │
│ AMC * │ center frame │
├──────────┼─────────────────────────────────────────────────────┤
│ AMW │ set frame width (Default=35) │
├──────────┼─────────────────────────────────────────────────────┤
│ AMS │ set frame style to Arg1 (Default=1) │
╘══════════╧═════════════════════════════════════════════════════╛
══════════════════════════════════════════════════════════════════
Summary of Commands Page 42
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒══════════╤═════════════════════════════════════════════════════╕
│ ITx │ Itemized Paragraph │
╞══════════╪═════════════════════════════════════════════════════╡
│ ITZ │ start itemized mode with char Arg1 │
│ ITT │ itemized next paragraph │
│ ITS │ stop itemized mode │
╘══════════╧═════════════════════════════════════════════════════╛
╒══════════╤═════════════════════════════════════════════════════╕
│ Sxx │ Section Management │
╞══════════╪═════════════════════════════════════════════════════╡
│ SLV │ set new section level Arg1 with title Arg2 │
├──────────┼─────────────────────────────────────────────────────┤
│ SAP │ set appendix mode │
╘══════════╧═════════════════════════════════════════════════════╛
╒══════════╤═════════════════════════════════════════════════════╕
│ MAx │ Macro Management │
╞══════════╪═════════════════════════════════════════════════════╡
│ MAD │ define macro Arg1 to be replaced by Arg2 │
├──────────┼─────────────────────────────────────────────────────┤
│ MAP │ define macro Arg1 to be replaced by page number │
├──────────┼─────────────────────────────────────────────────────┤
│ MAS │ define macro Arg1 to be replaced by section number │
├──────────┼─────────────────────────────────────────────────────┤
│ MAC │ define macro Arg1 to be replaced by codes of Arg2 │
╘══════════╧═════════════════════════════════════════════════════╛
╒══════════╤═════════════════════════════════════════════════════╕
│ Hxx │ Header Management │
╞══════════╪═════════════════════════════════════════════════════╡
│ HE- │ header off │
│ HE+ * │ header on │
├──────────┼─────────────────────────────────────────────────────┤
│ HTL │ set left text to Arg1 │
│ HTC │ set center text to Arg1 │
│ HTR │ set right text to Arg1 │
├──────────┼─────────────────────────────────────────────────────┤
│ HLB │ set Arg1 blank line before header (Default=0) │
│ HLA │ set Arg1 blank line after header (Default=1) │
├──────────┼─────────────────────────────────────────────────────┤
│ HL+ * │ draw separator line in header │
│ HL- │ do not draw separator line in header │
├──────────┼─────────────────────────────────────────────────────┤
│ HLC │ set char used for header separator line (Def = '═')│
╘══════════╧═════════════════════════════════════════════════════╛
══════════════════════════════════════════════════════════════════
Summary of Commands Page 43
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
╒══════════╤═════════════════════════════════════════════════════╕
│ Fxx │ Footer Management │
╞══════════╪═════════════════════════════════════════════════════╡
│ FO- │ footer off │
│ FO+ * │ footer on │
├──────────┼─────────────────────────────────────────────────────┤
│ FTL │ set left text to Arg1 │
│ FTC │ set center text to Arg1 │
│ FTR │ set right text to Arg1 │
├──────────┼─────────────────────────────────────────────────────┤
│ FLB │ set Arg1 blank line before footer (Default=1) │
│ FLA │ set Arg1 blank line after footer (Default=0) │
├──────────┼─────────────────────────────────────────────────────┤
│ FL+ * │ draw separator line in footer │
│ FL- │ do not draw separator line in footer │
├──────────┼─────────────────────────────────────────────────────┤
│ FLC │ set char used for footer separator line (Def = '═')│
╘══════════╧═════════════════════════════════════════════════════╛
╒══════════╤═════════════════════════════════════════════════════╕
│ CCx │ Conditional define │
╞══════════╪═════════════════════════════════════════════════════╡
│ CC+ │ Compile next lines if macro Arg1 is defined │
│ CC- │ Cancel action of last CC+ command │
╘══════════╧═════════════════════════════════════════════════════╛
╒══════════╤═════════════════════════════════════════════════════╕
│ │ Various commands │
╞══════════╪═════════════════════════════════════════════════════╡
│ INC │ Include Arg1 file │
├──────────┼─────────────────────────────────────────────────────┤
│ LSK │ Skip Arg1 lines │
├──────────┼─────────────────────────────────────────────────────┤
│ LFI │ Write a full page width line with char Arg1 │
├──────────┼─────────────────────────────────────────────────────┤
│ DFR │ Set Date Format to Arg1 (Default=dd/mm/yy) │
├──────────┼─────────────────────────────────────────────────────┤
│ TC- │ Do not show table of contents │
├──────────┼─────────────────────────────────────────────────────┤
│ CMI │ Change Command Identifier to Arg1 (Default='\') │
│ CMS │ Change Command Separator to Arg1 (Default=':') │
├──────────┼─────────────────────────────────────────────────────┤
│ ZZZ │ End of input file │
╘══════════╧═════════════════════════════════════════════════════╛
══════════════════════════════════════════════════════════════════
Summary of Commands Page 44
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
TABLE OF CONTENTS
I Introduction ............................................... 2
I.1 What TXFORM can make for you ........................... 2
I.2 About warranties ... ................................... 3
I.3 Organisation of this document .......................... 3
I.4 TXFORM is SHAREWARE .................................... 4
I.4.A What is Shareware ? ................................ 4
I.4.B Why should you register this software ? ............ 4
I.4.C Registration ....................................... 5
I.5 Installing TXFORM ...................................... 5
I.5.A Requirements ....................................... 5
I.5.B Printing the documentation ......................... 5
I.5.C Installation procedure ............................. 5
I.6 Running TXFORM ......................................... 6
II General Principles ........................................ 7
II.1 Basic concepts ........................................ 7
II.2 The different types of lines .......................... 7
II.3 How the output text is formatted ...................... 8
II.4 How the modify the formatting options ................. 9
III Commands Description ..................................... 10
III.1 Command Structure .................................... 10
III.2 Commands Names ....................................... 10
III.3 Page formatting options .............................. 12
III.3.A PJU = Jump to next page .......................... 12
III.3.B PJC = Jump to next page if less then Arg1 lines .. 12
III.3.C PNB = Set actual page number to Arg1 ............. 12
III.3.D PML = Set Left Margin to Arg1 .................... 13
III.3.E PMR = Set Right Margin to Arg1 ................... 13
III.3.F PLE = Set Page Length to Arg1 .................... 14
III.4 Paragraph formatting options ......................... 15
III.4.A AC- = center text off ............................ 15
III.4.B AC+ = center text on ............................. 15
III.4.C AF- = fill text off .............................. 16
III.4.D AF+ = fill text on ............................... 16
III.4.E AIL = indent left margin of Arg1 columns ......... 16
III.4.F AIR = indent right margin of Arg1 columns ........ 17
III.4.G ASL = number of blank lines after paragraph ...... 18
III.4.H AJL = left justify text .......................... 18
III.4.I AJR = right justify text ......................... 18
III.4.J AJF = full justify text .......................... 18
III.5 Framed paragraphs .................................... 20
III.5.A AM- = set frame off .............................. 20
III.5.B AM+ = set frame on ............................... 20
III.5.C AML = left align frame ........................... 21
III.5.D AMR = right align frame .......................... 21
III.5.E AMC = center frame ............................... 21
III.5.F AMW = set frame width ............................ 22
III.5.G AMS = set frame style to Arg1 .................... 22
III.6 Itemizing paragraph .................................. 25
══════════════════════════════════════════════════════════════════
TABLE OF CONTENTS Page 45
TXFORM USER'S GUIDE v1.2
══════════════════════════════════════════════════════════════════
III.6.A ITZ = start itemized mode with char Arg1 ......... 25
III.6.B ITT = itemized next paragraph .................... 25
III.6.C ITS = stop itemized mode ......................... 25
III.6.D Nesting itemization .............................. 25
III.7 Sections management .................................. 27
III.7.A SLV = set new section level Arg1 with title Arg2 . 27
III.7.B SAP = set appendix mode .......................... 27
III.8 Macros ............................................... 28
III.8.A MAD = define macro Arg1 == Arg2 .................. 29
III.8.B MAP = define macro Arg1 == page number ........... 29
III.8.C MAS = define macro Arg1 == section number ........ 29
III.8.D MAC = define macro Arg1 == codes of Arg2 ......... 29
III.9 Header management .................................... 30
III.9.A HE- = header mode off ........................... 30
III.9.B HE+ = header mode on ............................. 30
III.9.C HTL = set left text to Arg1 ...................... 31
III.9.D HTC = set center text to Arg1 .................... 31
III.9.E HTR = set right text to Arg1 ..................... 31
III.9.F HLB = set Arg1 blank line before header .......... 31
III.9.G HLA = set Arg1 blank line after header ........... 31
III.9.H HL+ = draw separator line in header .............. 31
III.9.I HL- = do not draw separator line in header ....... 31
III.9.J HLC = set char used for header separator line .... 31
III.10 Footer management ................................... 32
III.10.A FO- = footer mode off .......................... 32
III.10.B FO+ = footer mode on ............................ 32
III.10.C FTL = set left text to Arg1 ..................... 33
III.10.D FTC = set center text to Arg1 ................... 33
III.10.E FTR = set right text to Arg1 .................... 33
III.10.F FLB = set Arg1 blank line before footer ......... 33
III.10.G FLA = set Arg1 blank line after footer .......... 33
III.10.H FL+ = draw separator line in footer ............. 33
III.10.I FL- = do not draw separator line in footer ...... 33
III.10.J FLC = set char used for footer separator line ... 33
III.11 Conditional compile ................................. 34
III.11.A CC+ = Compile next lines if macro Arg1 defined .. 34
III.11.B CC- = Cancel action of last CC+ command ......... 34
III.12 Various commands .................................... 35
III.12.A INC = Include Arg1 file ......................... 35
III.12.B LSK = Skip Arg1 lines ........................... 35
III.12.C LFI = Write a line with char Arg1 ............... 35
III.12.D DFR = Set Date Format to Arg1 ................... 36
III.12.E TC- = Do not show table of contents ............. 36
III.12.F CMI = Change Command Identifier to Arg1 ......... 36
III.12.G CMS = Change Command Separator to Arg1 .......... 37
III.12.H ZZZ = End of input file ......................... 37
IV Error Messages ............................................ 38
APPENDICES
A Using TXFORM with Multiple Windows Editor .................. 40
B Summary of Commands ........................................ 41
══════════════════════════════════════════════════════════════════
TABLE OF CONTENTS Page 46