Trailing-Edge
-
PDP-10 Archives
-
BB-M836A-BM
-
tools/dsr/tcx.doc
There is 1 other file named tcx.doc in the archive. Click here to see a list.
Notes for TCX, version 1(35)
January 8, 1981
1.0 INTRODUCTION
TCX is a Runoff-related utility program that is used to help generate a
two-column index.
To generate input for TCX specify the /INDEX switch on the Runoff
command line. See the description of the /INDEX switch that is supplied
with DEC Standard Runoff.
In order to use this version of TCX, you need DEC Standard Runoff
version 1(53) or newer. Other Runoffs cannot generate the input needed
by TCX.
If you want to get running page counters in the index rather than the
usual type of page numbers you also need version 1(101) or newer of DEC
Standard Runoff.
2.0 OPERATION
Use the /INDEX switch of Runoff to generate a binary index for your
document. Then run TCX. When TCX requests the name of your input file,
respond with the name of your .BIX file. TCX assumes a file type of
.BIX, unless you specify otherwise. Output is always written to a file
of type .RNX having the same name as that of the input file.
For example, suppose you said
Runoff ABC/INDEX
Then the binary index file is called ABC.BIX. When TCX asks for the
name of your input specify either just ABC (in which case TCX assumes
.BIX) or you can specify .BIX in addition.
When TCX asks you if you have additional input, respond "Y" or "y" if
there are additional .BIX files to be included in the two-column index.
Otherwise respond in any other way, which is interpreted as no. If you
respond "Y" or "y", TCX prompts you for the name of the file, just as
previously. TCX now reads the specifed .BIX file. This entire sequence
is repeated until you indicate there are no more .BIX files. Note that
this is an alternative method to appending of putting a segmented index
together.
When TCX asks if you want running page counters instead of the usual
page numbers, respond "Y" or "y" if you do. Any other response means
you want normal page numbers. Note that breaks in the list of running
page numbers are done using the same criteria as are applied to lists of
"normal" page numbers. This means, for example that you can expect to
see 1 to 5, 6 to 10 instead of just 1 to 10, if running page 6 starts a
new chapter/appendix, for example.
TCX now generates a one-column index and writes into the file
001RNO.TMP. After generating the one-column index TCX asks how many
index lines per page you want. If you say nothing, by just hitting the
RETURN key, TCX assumes 55 index lines per page; this is exactly right
for a document using the default Runoff .PAGE SIZE of 58 lines, with the
standard page arrangement (.LAYOUT 0). Note that your response is in
terms of the number of indexing lines per page, not a .PAGE SIZE; it is
your responsibility to take account of title lines and lines at the
bottom of the page generated by a different .LAYOUT command. You can't
request more than 80 lines. After validating your response TCX folds
the one-column index, thereby creating the .RNX file. (The one-column
index is not deleted.)
Finally, TCX asks the question: "Specify reserve count for first page:"
If you answer this question with anything except null or 0, a further
prompt is given: "Specify a single line of input for DSR." The
specified line is inserted into the index (that is, into the .RNX file)
before the first index entry. Normally, the single line of input is a
DSR .REQUIRE command, which calls in a preface or other introductory
material at the beginning of the index. The length of the first index
page is reduced by the given reserve count.
3.0 CREATING A MASTER INDEX
TCX allows you to segment your document, Runoff each section separately,
and then generate a master index later. To do this, generate the .BIX
files as usual. Then append the binary index files together in the same
order in which you would arrange the segments of your document. Then
proceed as if you had just a single .BIX file to process.
3.1 Output Processing
TCX generates a file with file type .RNX which is to be processed by
Runoff. You can
1. Process the .RNX file just like an ordinary .RNO file, in which
case Runoff generates a .MEX file, or
2. Use the .REQUIRE command (e.g., .REQUIRE "ABC.RNX") to include
the index in your document.
4.0 RESTRICTIONS
This version of TCX does not have a "standard" command line. Further,
there are no command line switches. And you cannot override the name or
type of the output file generated.
5.0 MISCELLANEOUS
The .RNX file generated includes a .PAGE SIZE ,70 command. If you
choose to .REQUIRE the index back into your document at the end be sure
that you have set up your document so that 58 lines can be accommodated.
This means that if you said .LAYOUT 1,n you must have set a page size of
58+n.
Further, the .RNX file makes sure that certain Runoff flag characters
are set. And it enables recognition of certain flags. See a generated
.RNX file if you are concerned about what effects it may have on your
document.
Like DEC Standard Runoff, TCX generates a temporary file with the name
001RNO.TMP.
6.0 GUARANTEES AND CAVEATS
It is guaranteed that a working version of TCX will be supplied with all
future versions of DEC Standard Runoff.
It is not guaranteed that this particular version of TCX will work with
later/earlier versions of DEC Standard Runoff and/or .BIX files
generated by such Runoffs.
For each system on which DEC Standard Runoff is supported, a copy of TCX
will be supplied.
Eventually the source code for TCX will be supplied. The source code
will serve as a model showing how to generate a two-column index.
Bugs in TCX will be fixed. But they will be fixed "as convenient" and
depending on their severity.
Requests for enhancements to TCX will be evaluated; but there is no
guarantee that any enhancements will be made.
7.0 MESSAGES AND HINTS
TCX contains few error messages. All I/O error messages cause TCX to
terminate. In addition, the message 'CONFUSED' is output if TCX doesn't
like the looks of your BIX file. On TOPS-10, you will almost certainly
get the 'CONFUSED' message if you don't use the /B switch of PIP when
you append a bunch of files together to generate a master index.
In addition, if an entry in the first column of your index is too wide
for the first column, you will get an error message.
TCX also knows whether or not it can understand the .BIX file generated
by your particular version of Runoff. If you get the message
INCOMPATIBLE VERSIONS OF RUNOFF AND TCX
you are trying to get TCX to process a .BIX file that is not in the
desired format; the results are undefined.
[End of TCX.RND]