home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / simtel / sigm / vols000 / vol081 / systp.tex < prev    next >
Text File  |  1984-04-29  |  46KB  |  1,039 lines
  1. \ec ~
  2. ~ch Text Processing
  3. The program TP accepts a file containing text and commands and creates
  4. a file containing formatted text.
  5. TP accepts a file that contains text and "embedded" commands and creates
  6. a new file containing formatted text.
  7. TP relieves you of the chore of selecting appropriate places for
  8. line breaks and page breaks and it has a number of other features
  9. that simplify the task of text preparation.
  10.  
  11. ~se Invoking TP
  12. TP is invoked from the operating system by a command of the form
  13. ~bd TP name ~ed
  14. in which "name" is a file name.
  15. TP will read text from a file called "name.TEX" and will write to a file
  16. called "name.DOC".
  17. For this reason, it is simplest to call your text files "name.TEX".
  18. If your text file has an extension other than "TEX", then type the
  19. command
  20. ~bd TP name.ext ~ed
  21. where "ext" is the extension of your file.
  22. ~pa TP will also accept two file names that denote the input and output files
  23. respectively.
  24. For example, the command
  25. ~bd TP MANUAL B:MANUAL ~ed
  26. will read from the file MANUAL.TEX on the current system disk and write to the
  27. file B:MANUAL.DOC.
  28.  
  29. ~pa After TP has finished, you will have two files:
  30. "name.TEX" contains your original text and "name.DOC" contains the formatted
  31. text.
  32. These files are referred to as the "source text" and the "formatted document"
  33. in this manual.
  34.  
  35. ~pa TP may also create other files.
  36. If you have requested a table of contents, there will be a file called
  37. "name.CON" containing it.
  38. If you have made cross-references, there will be a file called "name.REF"
  39. containing them.
  40. Do not delete this file: it will be used next time TP is run to correct
  41. forward references.
  42.  
  43. ~se Printing the Formatted Text
  44. There are two ways of printing a file created by TP.
  45. First, you can use the command
  46. ~bd PRINT name.DOC T ~ed
  47. to print the entire file, or the command
  48. ~bd PRINT name.DOC Tm,n ~ed
  49. to print pages m through n inclusive.
  50. Unfortunately there is a bug in PRINT and this command does not work;
  51. therefore use the command
  52. ~bd PIP LST:=name.DOC ~ed
  53. Make sure that the printer is switched on before entering this command.
  54.  
  55. ~se TP Conventions
  56. The output file generated by TP will differ from the input file that you
  57. created in the following respects.
  58. ~mr list
  59. ~si
  60. ~li Line breaks will be adjusted so that all lines are as close as
  61. possible to 78 characters long.
  62. The paper is 8.5 inches wide and 78 characters at 12 characters per inch
  63. occupy 6.5 inches; thus there is a 1 inch margin to the left and right
  64. of the text.
  65. ~sp 2
  66. (The line length of 78 characters and the pitch of 12 characters per
  67. inch are parameters which may be adjusted to your particular
  68. requirements. 
  69. See Section ~rr s lay for further details.)
  70. ~li Page breaks will be inserted so that there is a 1 inch margin at
  71. the top and bottom of each page.
  72. TP can also print running headers and footers
  73. and a page number at any position in a header or a footer. 
  74. ~li An extra blank will be inserted at the end of each sentence if necessary,
  75. so that sentences are separated by two blanks.
  76. ~li Embedded layout commands will have disappeared and the format of the
  77. text will have been changed accordingly.
  78. ~li This manual frequently refers to "blank lines" in the output file.
  79. In all cases, blank lines are counted by the number of <RETURNS> required
  80. to create them.
  81. One <RETURN> creates zero blank lines, two <RETURN>s create one blank line,
  82. etc.
  83. ~el
  84. ~pa Most of the embedded commands are of the form
  85. ~bd \ letter letter ~ed
  86. For example, \PA is used to start a paragraph and \SE to start a
  87. section.
  88. The "\" must be preceded by a blank.
  89. If it is not followed by two letters TP assumes that a command was not
  90. intended and copies the string containing "\" to the output file without
  91. changing it.
  92.  
  93. ~pa Embedded commands can occur anywhere in the text, provided that
  94. they are either placed at the beginning of a line or are preceded
  95. by a blank.
  96. The way in which a command is terminated depends on the particular
  97. command.
  98. Although the rules may seem complicated, common sense will usually give
  99. the correct answer.
  100. ~si
  101. ~li Many commands have no parameters and require no particular termination,
  102. although it is best to follow them with one or more blanks for readability.
  103. These commands are: 
  104. \BD, \BF, \BK, \ED, \EF, \EK, \EL, \EP, \LI, \PA, \RB, \SB, \ZR.
  105. ~li Some commands may be followed by one or more numbers.
  106. The numbers should be separated by blanks, _not commas.
  107. If the numbers are omitted, TP assumes that zero is intended.
  108. If the symbol "=" is used instead of a number, TP uses the default value of
  109. the parameter.
  110. If a number is preceded by "+" or "-", TP adds or subtracts its value from the
  111. default value.
  112. For example, the command "\SM`10" sets the left margin to 10 columns; the
  113. command "\SM`+5" sets the margin to its default value plus five.
  114. ~sp 2 One precaution should be observed with these commands: if no number is
  115. given, but the next text symbol on the line is a number, TP will read that
  116. number as a parameter.
  117. The best way to avoid this problem is to play safe and follow all commands
  118. with a line break.
  119. The commands that may be followed by one number are:
  120. \GP, \LS, \SI, \SM, \SP, \TS.
  121. The commands that may be followed by several numbers are:
  122. \CC, \DL, \HL, \IL, \MV, \PL, \SL, \VL.
  123. ~li Some commands are followed by a string of text which may be a title, a
  124. comment, or a filename.
  125. When it encounters one of these commands, TP will continue reading text
  126. until the end of the line.
  127. The text must not contain embedded commands, but it can contain the editing
  128. characters grave accent and underscore, explained below.
  129. The commands that may be followed by text are: 
  130. \CE, \CH, \CO, \FL, \IC, \NU, \SE, \SS, \SU, \TC, \TL, \UL.
  131. ~li The remaining commands are followed by text of specified length, and so
  132. TP knows exactly where the command ends.
  133. These commands need no termination, and in some cases must not be terminated.
  134. For example, if you use the cross-reference feature at the end of a sentence,
  135. you will want to see something like "... see page 97." in the text, with no
  136. space between the page number and the period.
  137. You can achieve this by leaving no space between the cross-reference command
  138. \RR and the period: your source text would contain "... 
  139. see page \rr p ref.".
  140. The commands in this category are: \EC, \MR, \OV, \RM, \RR.
  141. ~el
  142.  
  143. ~pa Although all embedded commands quoted in the manual are written in
  144. upper case letters, TP will accept commands in either upper or lower case
  145. letters.
  146.  
  147. ~pa Certain characters have a special effect.
  148. The grave accent is used to provide extra spaces, "-" (hyphen) is
  149. used to concatenate words, and "_" is used for underlining.
  150. These are described below: see Sections ~rr s hblk, ~rr s conc, and ~rr s us.
  151.  
  152. ~pa Section ~rr s lay below describes general methods for controlling layout.
  153. Section ~rr s misc on page ~rr p misc describes methods for obtaining various
  154. effects.
  155. Section ~rr s prin on page ~rr p prin explains how TP can embed special 
  156. printer control codes in formatted documents.
  157. Section ~rr s all on page ~rr p all describes each TP command in detail.
  158.  
  159. ~se Layout Control
  160. ~mr lay
  161. ~ss Horizontal Layout
  162. Horizontal layout is controlled by the command \HL, which must be followed
  163. by two numbers.
  164.  
  165. ~pa The first number determines the amount of space between the left side of
  166. the paper and the beginning of the text.
  167. Its default value is 6, meaning 6 characters or 0.5" at 12 characters per
  168. inch.
  169. The leftmost position of the printer is about half an inch from the left
  170. edge of the paper, and so a margin of 6 ensures that the text will begin
  171. one inch from the edge of the paper.
  172.  
  173. ~pa The second number defines the largest number of characters that can be
  174. printed on one line.
  175. Its default value is 78, which is 6.5" at 12 characters per inch.
  176.  
  177. ~pa For example, the command ~bd \HL 5 65 ~ed
  178. would set the left margin to 5 characters and the line length to 65
  179. characters -- suitable values for 10 characters per inch printing.
  180.  
  181. ~pa Either of these numbers may be replaced by "=", meaning "use the default
  182. value" or preceded by "+" or "-" to give a relative value.
  183. For example, the command
  184. ~bd \HL +5 = ~ed
  185. adds 5 to the current value of the first margin and sets the line width
  186. to its default value.
  187. ~pa Do not confuse the "first margin" established by this command with
  188. the subsequent indentation produced by the "set margin" command \SM.
  189. ~pa There are also specialized commands for defining horizontal layout
  190. parameters separately.
  191. See the commands \DL, \IL, \PL, and \SL.
  192.  
  193. ~ss Vertical Layout
  194. Vertical layout is controlled by the command \VL, which must be followed
  195. by four numbers.
  196. ~pa The first number determines the number of blank lines between the
  197. heading at the top of the page and the first line of text; its default
  198. value is 3.
  199. ~pa The second number determines the number of lines on a page; its default
  200. value is 52.
  201. Note that the "number of lines" is not the number of lines of text: if the
  202. number of lines is 52 and the line spacing is 2, then at most 26 lines of text
  203. will be printed on a page.
  204. ~pa The third number determines the position of the footer (if any) with 
  205. respect to the first line of text; its default value is 55.
  206. ~pa The fourth and last number determines the number of blank lines before the
  207. first line of a chapter; its default value is 20.
  208. ~pa Any of these numbers may be replaced by "=", meaning "use the default
  209. value" or preceded by "+" or "-" to give a relative value.
  210. For example, the command
  211. ~bd \VL +3 = = 10 ~ed
  212. adds 3 to the current value of the first parameter, sets the second and
  213. third parameters to their default values, and sets the last parameter to 10.
  214. ~pa The command \LS controls line spacing; it must be followed by a single
  215. number, and the value of this number must be 1, 2, or 3.
  216. The default value is 2 (double spacing).
  217. This command also changes the spacing between paragraphs,
  218. the spacing of section and subsection headings, the spacing before and
  219. after displayed text, and the spacing of numbered lists.
  220.  
  221. ~pa There are also specialized commands for defining vertical layout
  222. parameters separately.
  223. See the commands \DL, \IL, \PL, and \SL.
  224.  
  225. ~ss Arbitrary Layouts
  226. TP does most of the work of formatting the text for you.
  227. There will inevitably be occasions, however, in which the format that it
  228. chooses is unsuitable.
  229. You can produce arbitrary layouts by switching TP into "retain blank" mode.
  230.  
  231. ~pa TP normally runs in "suppress blank" mode.
  232. When it is in this mode you do not have much control over the layout
  233. of the formatted text because TP is doing most of the work for you.
  234. If you want to do the layout yourself, you can switch TP into
  235. "retain blank" mode.
  236. In this mode, each blank and line break that you enter will be copied
  237. to the formatted text and consequently the layout of your input
  238. will be precisely maintained.
  239.  
  240. ~pa The command \RB switches TP into "retain blank" mode and the
  241. command \SB switches it back into "suppress blank" mode.
  242. Use these commands as follows.
  243. ~bd \RB ...`text in which layout is to be maintained ...`\SB ~ed
  244. There is no limit to the amount of text that can appear in
  245. "retain blank" mode.
  246. If you do not want a block of text entered in retain blank mode
  247. to be split between pages, you can use the "keep" commands described below.
  248. ~mr hblk
  249.  
  250. ~pa In its usual "suppress blank" mode, TP will reduce multiple blanks and
  251. tabs to a single blank, except at the end of a sentence.
  252. It may also insert a line break wherever there is a blank in the input text.
  253. Both of these effects may be over-ridden by judicious use of the grave accent.
  254. The grave accent acts as a "hard blank" character in TP input files.
  255.  
  256. ~pa For a reason that will soon be apparent, it is impossible to print
  257. a grave accent with TP, and in this section the character "'" 
  258. (apostrophe) will be used to denote the grave accent.
  259.  
  260. ~pa A grave accent in the input file is processed by TP in the same
  261. way as any other character, but it is converted to a blank before
  262. being written to the output file.
  263. This fact can be exploited in three ways.
  264. ~si
  265. ~li To create white space in the formatted text, type a row of grave
  266. accents of the required length.
  267. ~li Consider the formatting of "Dr.`Pepper".
  268. TP sees the "." after "Dr" and assumes that it denotes the end of a
  269. sentence: thus it will leave two blanks after "Dr.", which is not
  270. what you want.
  271. If, however, you write "Dr.'Pepper", TP will not process the "."
  272. because it does not occur at the end of a word; the "'" is converted
  273. to a blank, and "Dr.`Pepper" is formatted correctly.
  274. ~li Sometimes you do not want TP to break a line at a particular
  275. place.
  276. For example, you might want to write an equation such as "X`=`Y"
  277. in the text without a line break.
  278. To achieve this, use a grave accent instead of a space on each side of
  279. "=", thus: "X'='Y".
  280. Since TP processes the grave accents as non-blank characters, it will
  281. not introduce a line break within the equation.
  282. ~el
  283.  
  284. ~se Achieving Other Effects
  285. ~mr misc
  286. This section is organized by topic.
  287. That is, it tells you which TP commands are applicable for the various things
  288. that you might want to do.
  289. The commands are not specified in detail here: for detailed specifications,
  290. see Section ~rr s all on page ~rr p all.
  291.  
  292. ~ss Pagination
  293. TP paginates automatically but you do have a certain amount of control
  294. over paging.
  295. To end the current page, use the command \EP.
  296. ~pa To change or set the number of the current page, use the command
  297. \GP.
  298. This command has two forms.
  299. ~bd \GP <number> ~ed
  300. sets the number of the current page to the value of <number>.
  301. ~bd \GP ? ~ed
  302. causes TP to ask you for the page number during text processing,
  303. unless the page number is already known, in which case the command
  304. has no effect.
  305.  
  306. ~pa The number of the current page may be printed in either the
  307. running header or the running footer: simply insert the character
  308. "#" in either the header or the footer, and it will be translated
  309. into the current page number during processing.
  310.  
  311. ~ss Headers and Footers
  312. A "running header" is printed at the top of each page of text, and a
  313. "running footer" is printed at the bottom of each page.
  314. Use \TL followed by the text of the header, or \FL followed
  315. by the text of the footer to obtain these.
  316. For example:
  317. ~bd
  318. \TL Oh!`What a Useless Manual
  319. ~sp
  320. \FL Copyright Jungle Enterprises 1982``````````````````#
  321. ~ed
  322. The symbol "#" in the footer in this example will appear in the
  323. processed document as the page number.
  324.  
  325. ~pa There are no default headers and footers; if you do not specify a header
  326. or a footer, TP will leave the corresponding areas blank.
  327.  
  328. ~ss Chapters
  329. Use the command ~bd \CH <title> ~ed to start a chapter.
  330. TP will start the chapter on a new page, increment the chapter number,
  331. and make <title> the running title.
  332. The first line of the chapter will be preceded by some extra blank lines:
  333. see \VL.
  334. It is not necessary to use the chapter command if your text is not
  335. divided into chapters.
  336.  
  337. ~ss Starting a Section
  338. Use the command ~bd \SE section title ~ed to start a section.
  339. The effect of this command is to insert some blank lines, print the
  340. section number and title, leave some more blank lines, and then start
  341. a new paragraph.
  342. The number of blank lines before and after the title is controlled by
  343. the command \SL.
  344. For example the command
  345. ~bd \SL 6 4 ~ed
  346. tells TP to put 6 blank lines before a section title and 4 blank lines
  347. after it.
  348. These values may subsequently be changed by the command \LS which changes
  349. line spacing.
  350.  
  351. ~pa If TP has almost completed formatting a page when it encounters
  352. an \SE or \SS command, it moves to the top of the next page before
  353. printing the section title.
  354.  
  355. ~pa Use the command ~bd \SS subsection title ~ed to start a subsection.
  356. The effect of this command is the same as for the command SE,
  357. the only difference being in the numbering.
  358. The number of a section is C.X, where C is the current chapter number
  359. and X is the current section number.
  360. The number of a subsection is C.X.Y, where Y is the current subsection
  361. number.
  362. TP does the numbering itself; thus you can re-order sections without
  363. having to re-number them.
  364.  
  365. ~pa If you do not want numbered sections, use the command \SU; for example:
  366. ~bd \SU This is an Unnumbered Section Title ~ed
  367.  
  368. ~ss Paragraphing
  369. Use the command ~bd \PA ~ed at the beginning of a paragraph.
  370. The effect of this command is to insert some blank lines and indent
  371. the first line of the paragraph.
  372. The number of blank lines between paragraphs
  373. and the amount of indentation are controlled by the command \PL.
  374.  
  375. ~pa TP will start a paragraph at the top of a page if this is necessary
  376. to avoid a "widow" line.
  377. It always starts chapters, sections, and subsections with a new paragraph.
  378.  
  379. ~ss Underlining
  380. ~mr us
  381. If you type "_" immediately before a word, the word will be underlined
  382. in the formatted text.
  383.  
  384. ~pa TP usually underlines all characters except the punctuation symbols
  385. ",", ".", ";", ":", "?", "!", and "-".
  386. The command \UL, followed by a list of characters, tells TP that
  387. these characters, in addition to the characters listed above, are
  388. to be underlined.
  389. For example, if you want punctuation marks to be underlined, use the command
  390. ~bd \UL .,:;?!- ~ed
  391. The command \NU, followed by a list of characters,
  392. tells TP not to underline these characters.
  393. For example, if you do not want "&" underlined, use the command
  394. ~bd \NU & ~ed
  395. ~nu "
  396. ~pa If you want TP to underline the blanks between words, use the grave
  397. accent: the text "_underlined'words" produces the output _"underlined`words".
  398. If you want to underline part of a word, use the concatenation character "-":
  399. the text "under-`_lined" produces the output "under- _lined".
  400.  
  401. ~pa Underlining does not work properly with proportionally spaced printing.
  402.  
  403. ~ss Concatenation
  404. ~mr conc
  405. If a word ends with a hyphen, TP will concatenate this word and the next word.
  406. For example, "hyp-`hen" is formatted as "hyphen".
  407. This can be used, for example, to underline part of a word, as above.
  408.  
  409. ~ss Tabs
  410. The effect of tab characters is unpredictable in TP's normal "suppress
  411. blank" (\SB) mode and it is probably best not to use tabs.
  412. In "retain blank" (\RB) mode tabs are set at every eighth column by default.
  413. Use the command \TS to alter the tab spacing.
  414. For example ~bd \TS 10 ~ed sets the tab spacing to 10.
  415.  
  416. ~pa The tab spacing used by the editor ED is normally at 8 character
  417. positions; thus the effect of this command is not visible during
  418. editing.
  419. You can change the editor's tab settings if you want to: see the editor
  420. command ET on page ~rr p tabs.
  421.  
  422. ~ss Centered Lines
  423. Use the command
  424. ~bd \CE <text> ~ed
  425. to print a line of text centered between the left and right margins.
  426. For example, the command
  427. ~bd \CE This line is centered ~ed
  428. produces the following in the output file:
  429. ~sp 2 ~ce This line is centered
  430.  
  431. ~ss Displays
  432. ~mr disp
  433. A "display" is a block of indented text; displays are typically used for
  434. quotations, examples, programs, etc.
  435. Use the commands \BD (begin display) and \ED (end display) as follows:
  436. ~bd \BD ...`displayed text ...`\ED ~ed
  437. There can be any number of lines of displayed text.
  438. ~pa The layout of displays is controlled by the commands \LS and \DL.
  439.  
  440. ~ss Keeps
  441. ~mr keep
  442. A "keep" is a block of text that must not be split between pages.
  443. Use the commands \BK (begin keep) and \EK (end keep) as follows:
  444. ~bd \BK ...`text to be "kept" ...`\EK ~ed
  445. To prevent TP splitting a display between two pages, use the commands:
  446. ~bd \BD \BK ...`displayed text ...`\EK \ED ~ed
  447.  
  448. ~pa A "floating keep" is similar to a keep except that the contents
  449. of a floating keep are stored if there is not sufficient space on
  450. the current page for them, and normal text processing continues.
  451. Use \BF to start a floating keep and \EF to end it.
  452. The floating keep may appear either earlier or later in the formatted 
  453. document than it does in the source text.
  454. There are three possibilities.
  455. ~si
  456. ~li When the \BF command is encountered, the line buffer used by TP will
  457. not usually be full.
  458. If there is room for the floating keep, it will be inserted immediately,
  459. and the half empty line will be filled from text following the keep and
  460. then printed; in this case the keep will appear in the formatted document
  461. _before it is called, but never more than one line before.
  462. ~li If the line buffer is full when \BF is encountered, the floating keep
  463. will be inserted exactly where you expect it.
  464. ~li If there is not enough room on the page for the text of the keep, it
  465. will be inserted at the top of the next page.
  466. ~el
  467. ~pa The text of floating keeps is stored in memory until there is sufficient
  468. space on the page to print them.
  469. TP may run out of memory space if several large floating keeps must be
  470. stored simultaneously.
  471. You can avoid this problem by including the text of floating keeps as close
  472. as possible to the place where you think that they should be printed.
  473. Do not put a whole lot of large floating keeps at the beginning of the
  474. file in the hope that TP will put one at the top of each page: it is more
  475. likely to run out of space.
  476. Each line of text requires 248 bytes of dynamic storage; this amount can be
  477. reduced by changing the value of the constant _maxlinelen and recompiling TP.
  478.  
  479. ~ss Lists of Numbered Items
  480. ~mr item
  481. Itemized lists occur in several places in this manual.
  482. They are generated by the commands \SI (set item number), \LI (list
  483. item), and \EL (end list).
  484. ~bd
  485. \SI
  486. ~sp \LI ...`text of first item ...
  487. ~sp \LI ...`text of second item ...
  488. ~sp ...
  489. ~sp \LI ...`text of last item ...
  490. ~sp \EL
  491. ~sp
  492. ~ed
  493. The effect that this produces can be seen in several parts of this Manual:
  494. see for example Section ~rr s list on page ~rr p list.
  495.  
  496. ~ss Overlaying Characters
  497. Two characters can be superimposed using the command \OV.
  498. For example, the command ~bd \OV /= ~ed
  499. may produce something that looks like a "not equal" sign.
  500. This command will not work in proportionally spaced text.
  501.  
  502. ~ss Table of Contents
  503.  
  504. TP will write a table of contents to a file called "name.COM" if
  505. you include the command \TC near the beginning of the file.
  506. This command has two forms.
  507. The effect of ~bd \TC <title> ~ed
  508. is to create a table of contents file with the page heading <title>.
  509. Entries in the table of contents do not have page numbers.
  510. The command ~bd \TC # <title> ~ed has the same effect except that each entry 
  511. in the table of contents has a page number beside it.
  512.  
  513. ~pa Titles, chapter names, section headers, and subsection headers
  514. are listed in the table of contents; footers are not listed.
  515.  
  516. ~ss Including Files
  517. The command
  518. ~bd \IC <filename> ~ed
  519. tells TP to read from the named file.
  520. The file may contain embedded commands and is processed in exactly the same
  521. way as the file named in the TP invocation.
  522. The included file may also contain \IC commands, and so in general TP can
  523. process a tree-structured document.
  524. It is often convenient to split up a long document into sections or chapters
  525. and to read each chapter in turn from a "top-level" file; this manual is
  526. organized in this way.
  527.  
  528. ~ss Cross Referencing
  529. ~mr xref
  530. TP can make cross-references both forwards and backwards.
  531. Your formatted document can include references such as "Section ~rr s xref
  532. begins on page ~rr p xref" although you do not know the number of the
  533. section referred or the page number on which it will appear when you are
  534. creating the source text.
  535. Chapter numbers, section numbers, subsection numbers, item numbers,
  536. and page numbers can all be cross-referenced.
  537.  
  538. ~pa Use the command \MR to create the reference.
  539. This command has the form
  540. ~bd \MR <mnemonic> ~ed
  541. in which <mnemonic> is a string of up to 4 letters and digits.
  542. The mnemonic should uniquely identify the topic to be cross-referenced.
  543. ~pa Use the command \RR to retrieve the cross-reference.
  544. This command has the form
  545. ~bd \RR <letter> <mnemonic> ~ed
  546. where <letter> is one of "C" (chapter), "I" (item), "P" (page), 
  547. or "S" (section).
  548. For example, to cross-reference the word "elephant" you would include this
  549. in the text:
  550. ~bd ... elephant \MR elep ... ~ed ~rm (1)
  551. At the point where you wanted to refer to "elephant" you would include
  552. this in the text:
  553. ~bd ...`big animals (see page \RR P elep) ... ~ed ~rm (2)
  554. In the formatted text, (1) would not be visible (the word "elephant" would
  555. be there, of course), but at (2) you would see:
  556. ~bd ... big animals (see page 97) ... ~ed
  557. The page number was printed because \RR" was followed by "P"; you could
  558. refer to the chapter, section, etc., using one of the other letters.
  559.  
  560. ~pa The first thing that TP does when it is invoked is to look for a file
  561. of cross-references.
  562. As it is reading the source text, it refers to and updates this file, and
  563. at the end of the source text it writes a new version on the disk.
  564. If you process the source text once only, backward references will appear
  565. correctly, but forward references will all be of the form "see page 0".
  566. You can correct them by processing the text again.
  567. It is usually unnecessary to run TP twice, however, because most files
  568. will be processed several times during revision cycles, and if the last
  569. set of revisions is not too drastic you can assume that all the
  570. cross-references will be correct.
  571.  
  572. ~pa You can examine the cross-reference file if you want to.
  573. If the name of your source text file is "name.TEX", the name of the
  574. cross-reference file will be "name.REF".
  575. Each line of "name.REF" contains the mnemonic; the current value of the page 
  576. number, chapter number, section number, subsection number, and item number;
  577. and the number of times the entry was referenced.
  578. Some of these numbers may be zero, in which case they will not be printed
  579. in the formatted document.
  580. If the reference count is zero, the mnemonic is useless and may be removed
  581. from the source text.
  582. ~pa Cross-referencing does not work for multi-file texts.
  583. It does work provided that TP processes one file only; that file may
  584. contain \IC commands including other files, and the included files
  585. may themselves contain \IC commands, to any depth.
  586.  
  587. ~se Printer Control
  588. ~mr prin
  589. TP is a device independent program: the formatted documents that it generates
  590. can be sent to any device that recognizes carriage return, line feed, and
  591. form feed characters.
  592. TP will, however, insert special printer codes into the formatted document
  593. if you want it to do so.
  594. The command \CC, followed by a list of numbers, will insert the corresponding
  595. ASCII codes into the output file.
  596. The codes are inserted into the output file as soon as \CC is used; they are
  597. not put into the line buffer.
  598. Consequently \CC can be used only to control global effects, such as
  599. "use boldface throughout", but it cannot be used for local effects
  600. such as "put this word in boldface".
  601. ~pa The descriptions that follow apply to the I.D.S.`460 "Paper Tiger"
  602. printer.
  603.  
  604. ~pa Printer pitch (the number of characters per inch) is controlled as
  605. follows:
  606. ~bk ~bd ~rb
  607. 29              10 c.p.i.
  608. 30              12 c.p.i.
  609. 31              16.5 c.p.i.
  610. ~ed ~ek ~sb
  611. Note that TP does not understand the effect of these commands and will not
  612. automatically change the line length to suit the pitch.
  613. When you use one of the above commands, use \HL to select suitable layout
  614. parameters.
  615.  
  616. ~pa The codes 1, 2, 6, and 16 select bold face, normal weight, fixed spacing, 
  617. and proportional spacing, respectively.
  618.  
  619. ~pa The printer normally prints 6 lines per inch.
  620. The spacing can be changed by a \CC command of the form: ~bd \CC 27 66 n ~ed
  621. where n is the vertical advance required in units of 1/48".
  622. For example, the command
  623. ~bd \CC 27 66 6 ~ed
  624. sets the line spacing to 6/48" (8 lines per inch).
  625.  
  626. ~pa See Chapter ~rr c prcd (page ~rr p prcd) for a complete 
  627. description of the printer codes.
  628.  
  629. ~se Summary of TP Commands
  630. ~mr all
  631. In the explanations below, imperative verbs refer to what TP does
  632. automatically, not what you have to do for it.
  633.  
  634. ~bk ~sp 3 \BD: Begin a display
  635. ~bd
  636. End the current line; leave some blank lines; and
  637. start indenting by 10 characters.
  638. The display is ended by the command \ED.
  639. The commands \BD and \ED act as brackets around the displayed text.
  640. ~sp 2 Displays may be nested:
  641. ~bd \BD ...`\BD ...`\ED ...`\ED ~ed
  642.  
  643. ~sp 2 If you do not want a display split between pages, use the command 
  644. sequence ~bd \BD \BK ...`displayed text ...`\EK \ED ~ed
  645. ~sp 2 See \DL and \LS.
  646.  
  647. ~ek ~bk ~ed \BF: Begin a floating keep
  648. ~bd
  649. End the current line; ensure that all text between \BF and the 
  650. subsequent \EF is on the same page.
  651. The floating keep is ended by the command \EF.
  652. The commands \BF and \EF act as brackets around the "floating" text.
  653.  
  654. ~sp 2 TP will store the the text between \BF and \EF until there is
  655. enough space to print it contiguously.
  656. The kept text will appear either at the point
  657. where the commands are used, or at the top of the next page.
  658.  
  659. ~ek ~bk ~ed  \BK: Begin a keep
  660. ~bd
  661. End the current line.  Ensure that all text between \BK and
  662. the subsequent \EK is on the same page.
  663. The keep is ended by \EK.
  664. The commands \BK and \EK act as brackets around the "kept" text.
  665.  
  666. ~ek ~bk ~ed \CC: Control codes for the printer
  667. ~bd
  668. Send the numbers following \CC directly to the printer.
  669. Source files that contain \CC commands are device dependent; TP warns you
  670. of this fact by displaying a message when it has processed the source text.
  671. See Section ~rr s prin on page ~rr p prin for a complete explanation
  672. of this command and its use with the I.D.S.`460 "Paper Tiger" printer,
  673. and see Chapter ~rr c prcd on page ~rr p prcd for a complete list of
  674. printer control codes.
  675.  
  676. ~ek ~bk ~ed \CE <text>: Print one line centered between the margins
  677. ~bd
  678.  
  679. ~ek ~bk ~ed \CH <title>: Start chapter
  680. ~bd End the current page; increment the chapter number; write the chapter
  681. title at the top of the new page.
  682. ~sp 2 The text of the title is copied into the running title buffer, and
  683. will appear at the top of each page.
  684. The same buffer is used by the command \TL, and consequently these
  685. two commands cannot be used in conjunction.
  686. ~sp 2 The text of <title> must not contain embedded commands but it may
  687. contain the editing characters grave accent and underscore.
  688. ~sp 2 The chapter title will be written to the table of contents
  689. file if there is one.
  690. ~sp2 See \TL.
  691.  
  692. ~ek ~bk ~ed \CO <comment>: Comment
  693. ~bd
  694. This command is entirely ignored by TP.
  695. It is used for incorporating remarks that should not appear in the
  696. formatted text, such as date, author, purpose, etc.
  697.  
  698. ~ek ~bk ~ed \DL <before> <after> <spacing> <indent> <width>: 
  699. Set display layout
  700. ~bd A "display" is a block of indented text, used for equations, quotations,
  701. etc.
  702. The five numeric parameters of this command determine: the number of blank 
  703. lines <before> the display (default = 3); the number of blank lines <after> 
  704. the display (default = 3); the line spacing within the display (default = 
  705. the current line spacing); the number of columns by which the display is 
  706. <indent>ed (default = 10 spaces); and the width of the displayed text, 
  707. measured from the left margin (default = current line width).
  708. ~sp 2 Nested displays have the same layout as top level displays.
  709.  
  710. ~ek ~bk ~ed \EC <char>: Set escape character
  711. ~bd The "escape character" is the character used in front of a TP command.
  712. It is usually \", but it can be changed to an arbitrary character by
  713. this command.
  714. For example, if you wanted to use "@" as the escape character, you would
  715. enter the command
  716. ~bd \- EC @ ~ed
  717.  
  718. ~ek ~bk ~ed \ED: End a display ~bd See \BD.
  719.  
  720. ~ek ~bk ~ed \EF: End a floating keep ~bd See \BF.
  721.  
  722. ~ek ~bk ~ed \EK: End a keep ~bd See \BK.
  723.  
  724. ~ek ~bk ~ed \EL: End a list of numbered items ~bd See \SI and \LI.
  725.  
  726. ~ek ~bk ~ed \EP: End current page
  727. ~bd Text following this command will be printed at the beginning of the
  728. next page.
  729. TP ignores this command if it occurs inside a keep or a floating keep.
  730.  
  731. ~ek ~bk ~ed \FL <footer>: Set a running footer
  732. ~bd Text following \FL on the same line  will be printed at the bottom of 
  733. each page of the document.
  734. "#" will be replaced by the number of the current page.
  735. ~sp 2 The text of <footer> must not contain embedded commands but it may
  736. contain the editing characters grave accent and underscore.
  737. ~sp 2 Footers are not written to the table of contents.
  738.  
  739. ~ek ~bk ~ed \GP <number> or \GP ?: Get page number
  740. ~bd Set the page number to <number>.
  741. ~sp 2 Large documents should be stored in several small files.
  742. If these files are formatted separately, the page numbers will be
  743. wrong unless they are explicitly set using this command.
  744. ~sp 2 If you do not know the number of the first page of a document, use
  745. the form \GP ?.
  746. When TP encounters this command it displays "Enter page number" on the
  747. screen, and you can type the number that you want to appear on the
  748. first page.
  749. ~sp 2 If the page number has already been set, the command will be
  750. ignored.
  751. Thus you can format a book consisting of several chapters one
  752. chapter at a time (in which case you specify the first page of each
  753. chapter as it is formatted) or all at once (in which case TP numbers
  754. the pages automatically).
  755.  
  756. ~ed ~ek ~bk \HL <margin> <width>: Set horizontal layout parameters
  757. ~bd \HL must be followed by two numbers.
  758. The numbers define the width of the left margin and the width of the
  759. text respectively.
  760. In each case the unit is one character position.
  761. The default values are <margin>`=`6 and <width>`=`78.
  762. ~sp 2 See \VL.
  763.  
  764. ~ed ~ek ~bk \IC <filename>: Include a file
  765. ~bd TP will process the text in the named file and then return and continue
  766. processing from the current file.
  767. The file of included text may itself contain \IC commands.
  768. All parameters (e.g.`blank suppression, indentation, margin settings)
  769. are global and affect the text in the included file.
  770.  
  771. ~ed ~ek ~bk \IL <before> <after> <indent> <increment> : Set numbered list
  772. layout
  773. ~bd This command defines the layout of a numbered list.
  774. The four parameters determine the number of blank lines <before> an item,
  775. the number of blank lines <after> an item, the <indent>ation of the item
  776. number, and the <increment>al indentation for the item.
  777. The numbered list in Section ~rr s list uses the default values, which are
  778. those that would be set by the command
  779. ~bd \- IL 3 3 5 6 ~ed
  780.  
  781. ~ed ~ek ~bk \IM <margin>: Set immediate margin
  782. ~bd Set the left margin to <margin> and tab to this position, starting a new
  783. line if necessary.
  784. This command is useful for "hanging indentations".
  785. It cannot be used within a display.
  786. ~sp 2 See \SM.
  787.  
  788. ~ed ~ek ~bk \LI: Start a list item
  789. ~bd A "list" is a collection of indented and numbered items.
  790. TP performs the indentation and numbering automatically.
  791. Introduce a list with the command \SI; this sets the number
  792. of the first item and the indentation.
  793. Introduce each item, including the first, with \LI.
  794. After the last item, terminate the list with \EL.
  795. ~sp 2 The margin setting used by these commands is also used by the commands
  796. \IM and \SM; thus \LI, \IM, and \SM cannot be used in conjunction.
  797. ~sp 2 See \EL, \IL, and \SI.
  798.  
  799. ~ed ~ek ~bk \LS <number>: Set line spacing
  800. ~bd Set the line spacing to the value of <number>.
  801. The default value is 2 (double spacing).
  802. The largest permitted value is 3.
  803. ~sp 2 This command also sets other vertical spacing parameters as follows.
  804. ~sp 2 ~rb
  805. ```````````````````````````Line`spacing`=`1````Line`spacing`=`2
  806.  
  807. In text:
  808. Lines between paragraphs````````2```````````````````4
  809. Lines before heading````````````3```````````````````6
  810. Lines after heading`````````````2```````````````````4
  811. Lines before display````````````2```````````````````3
  812. Lines after display`````````````2```````````````````3
  813. Lines before item in list```````2```````````````````3
  814. Lines after an item in list`````2```````````````````3
  815. `
  816. In table of contents:
  817. Lines between chapter headings``2```````````````````4
  818. Lines between section headings``1```````````````````2
  819. ~sb
  820.  
  821. ~ed ~ek ~bk \MR <mnemonic> : Make a cross-reference
  822. ~bd This records the position in the text of an item that is to be
  823. cross-referenced.
  824. The mnemonic consists of up to four letters and digits.
  825. Cross-referencing is described in Section ~rr s xref on page ~rr p xref.
  826.  
  827. ~ed ~ek ~bk \MV <para> <subsec> <sec>: Set minumum values
  828. ~bd If TP encounters the command \PA and the number of lines remaining
  829. on the page is less than or equal to the current value of <para>,
  830. TP will start a new page.
  831. The same applies to the commands \SS and \SE and the values of <subsec>
  832. and <sec>.
  833. These values are initially set to 4, 8, and 8 respectively.
  834. The command \MV can be used to change them.
  835. For example, after
  836. ~bd \MV = = 12 ~ed
  837. TP would start a new page before a section if otherwise the section
  838. would start within 12 lines of the bottom of the page.
  839.  
  840. ~ed ~ek ~bk \NU <string>: Remove characters from underline set
  841. ~bd The command \NU is followed by a string of characters which
  842. will not subsequently be underlined.
  843. The string is terminated by the end of the line containing the command.
  844. ~sp 2 See \UL.
  845.  
  846. ~ed ~ek ~bk \OV <char> <char>: Overlay the next two characters
  847. ~bd The two characters following \OV are superimposed.
  848. This command does not work reliably in proportionally spaced text.
  849.  
  850. ~ed ~ek ~bk \PA: Start paragrpah
  851. ~bd Leave some blank lines and indent the next line.
  852. ~sp 2 See \PL.
  853.  
  854. ~ed ~ek ~bk \PL <spacing> <indent> : Set paragraph layout
  855. ~bd This command controls the <spacing> between paragraphs and the
  856. amount of <indent>ation at the beginning of each paragraph.
  857. The default values are <spacing>`=`4 and <indent>`=`5.
  858.  
  859. ~ed ~ek ~bk \RB: Set retain blank mode
  860. ~bd Following this command, each space and line break that you enter will
  861. be copied to the output file.
  862. Use retain blank mode for preserving exact layout where this is simpler than
  863. using formatting commands.
  864. ~sp 2 See \SB.
  865.  
  866. ~ed ~ek ~bk \RM: Right margin
  867. ~bd
  868. Put the next word flush right.
  869. This command can only be used for a single word, and it is used
  870. for equation numbers, etc.
  871. Note that words linked by grave accents are considered by TP to be
  872. single words.
  873.  
  874. ~ed ~ek ~bk \RR <letter> <mnemonic> : Retrieve cross-reference
  875. ~bd When TP encounters this command, it inserts in the text the position
  876. of the \MR command that defined the mnemonic.
  877. The <letter> determines the way in which the position is displayed:
  878. "C" gives a chapetr number, "I" gives an item number, "P" gives a page
  879. number, and "S" gives a section number.
  880. Cross-referencing is described in Section ~rr s xref on page ~rr p xref.
  881.  
  882. ~ed ~ek ~bk \SB: Set suppress blank mode
  883. ~bd This is the default mode for TP.
  884. In this mode TP may replace a blank by several blanks or a line
  885. break, and it will reduce strings of blanks and tabs to a single blank.
  886. ~sp 2 See \RB.
  887.  
  888. ~ed ~ek ~bk \SE <section title>: Start a new section
  889. ~bd TP will write the chapter number unless it is zero, the section number,
  890. and the section title.
  891. The section heading will be preceded and followed by white space.
  892. All numbering is automatic.
  893. TP starts a section with a new paragraph.
  894. The section heading is written to the contents file if there is one.
  895. Example: ~bd \SE Introduction to Text Processing ~ed
  896. ~sp 2 See \SL.
  897.  
  898. ~ed ~ek ~bk \SI <number>: Set item number
  899. ~bd This command is used to introduce an itemized list and to set the number
  900. of the first item.
  901. The value of <number> should be one less than the number of the first
  902. item.
  903. If <number> is omitted, it is taken to be 0, and the number of the first
  904. item is 1.
  905.  
  906. ~ed ~ek ~bk \SL <before> <after>: Set section heading layout
  907. ~bd This command controls the amount of white space surrounding a section
  908. or subsection heading.
  909. <before> is the number of blank lines that will be printed before
  910. the heading, and <after> is the number of blank lines that will be
  911. printed between the heading and the first paragraph of the section or
  912. subsection.
  913. The default values are <before>`=`6 and <after>`=`4.
  914.  
  915. ~ed ~ek ~bk \SM <number>: Set margin
  916. ~bd The width of the left margin, which is usually zero, will be set to 
  917. <number>.
  918. This command is used for indenting text in cases where a display is not
  919. appropriate.
  920. The margin is also used for creating numbered lists and displays; 
  921. therefore do not use this command in conjunction with \SI, \LI, \EL,
  922. or \BD.
  923. ~sp 2 The symbols "+" and "-" may be used with \SM in the usual way.
  924. The command ~bd \SM +5 ~ed
  925. means "move the margin right 5 character positions".
  926. The command ~bd \SM = ~ed means "set the margin to the current
  927. column".
  928. ~sp 2 See \IM.
  929.  
  930. ~ed ~ek ~bk \SP <number>: Space
  931. ~bd
  932. This command breaks the current line and inserts <number>-1 blank
  933. lines into the text.
  934. For example, "\SP`2" creates one blank line.
  935. "\SP`0" is equivalent to "\SP`1".
  936. ~sp 2 Think of the parameter as the number of times that you would hit
  937. <RETURN> if you were typing: two returns are needed to create one blank line.
  938.  
  939. ~ed ~ek ~bk \SS <subsection title>: Start a subsection
  940. ~bd TP leaves some white space, prints the subsection title, leaves some 
  941. more white space, and starts the subsection text with a new
  942. paragraph.
  943. This command is similar to \SE except that the number consists of
  944. the current chapter number, the current section number, and the
  945. current subsection number.
  946. The subsection header is written to the contents file if there is one.
  947.  
  948. ~ed ~ek ~bk \SU: Start an unnumbered section
  949. ~bd This command has the same effect as \SE and \SS, but no section
  950. number is associated with the section title and no entry is made in the
  951. table of contents.
  952.  
  953. ~ed ~ek ~bk \TC <title>: Create a table of contents
  954. ~bd If this command is used near the beginning of the input text,
  955. TP will create a table of contents in a file called "name.CON"
  956. (assuming that it is reading from "name.TEX").
  957. The contents file will contain <title> at the top of each page,
  958. and the text of each title, chapter heading, section heading, and
  959. subsection heading in the main text.
  960. The line spacing in the table of contents will be the same as the line
  961. spacing in the text at the point where the \TC command occurs.
  962. ~sp 2 The text of <title> must not contain embedded commands but it may
  963. contain the editing characters grave accent and underscore.
  964.  
  965. ~ed ~ek ~bk \TL <title>: Set a running title
  966. ~bd The text in <title> will be printed at the top of each page.
  967. This command is incompatible with the command \CH which also sets
  968. a running title.
  969. ~sp 2 The text of <title> must not contain embedded commands but it may
  970. contain the editing characters grave accent and underscore.
  971.  
  972. ~ed ~ek ~bk \TS <number>: Set tab spacing
  973. ~bd Tabs are at every eighth column by default.
  974. This command is used to change the number of columns between tab positions.
  975. Tabs cannot be placed at arbitrary positions.
  976.  
  977. ~ed ~ek ~bk \UL <string>: Add characters to the underline set
  978. ~bd \UL must be followed by a string of characters; subsequently TP will
  979. underline these characters.
  980. The string is terminated by the end of the line containing the \UL command.
  981. For example, if you wanted digits underlined, you would use the command
  982. ~bd \UL 0123456789 ~ed
  983. TP will underline grave accents (see Section ~rr s hblk on page
  984. ~rr p hblk) but it will never underline a normal blank character.
  985.  
  986. ~ed ~ek ~bk \VL <leadin> <lines> <footer> <chap>: 
  987. Set vertical layout parameters
  988. ~bd \VL must be followed by four numbers.
  989. These numbers define the space between the running header and the first
  990. line of text, the number of text lines on a page, the position of
  991. the running footer, and the number of blank lines before the first line of a
  992. chapter, respectively.
  993. The default values are <leadin>`=`3, <lines>`=`52, <footer>`=`55, and
  994. <chap>`=`20.
  995. These values give 1 inch margins above and below the text at 6 lines per inch.
  996.  
  997. ~ed ~ek ~bk \ZR: Show cross-references
  998. ~bd The mnemonic of every \MR command following \ZR will be printed
  999. in the left margin.
  1000. This is useful during document development if you use many cross-references
  1001. and can't remember what you called them.
  1002. ~ed ~ek
  1003.  
  1004. ~se Default Values
  1005. TP is set up to create double-spaced text at 12 characters per inch,
  1006. using the parameters listed below.
  1007. The values of these parameters can be changed by the commands shown on 
  1008. the right.
  1009. ~rb ~bk ~ss Horizontal Layout Parameters
  1010. ~sp
  1011. Left margin                                   6    HL
  1012. Width of text                                78    HL
  1013. Paragraph indentation                         5    PL
  1014. Tab separation                                8    TS
  1015. Display indentation                          10    DL
  1016. Display width                                78    DL
  1017. Indentation for numbered lists                5    IL
  1018. Additional indentation for list items         6    IL
  1019. ~ek
  1020. ~bk ~ss Vertical Layout Parameters
  1021. ~sp
  1022. Line spacing                                  2    LS
  1023. Paragraph spacing                             4    PL, LS
  1024. Space between heading and top line of text    3    VL
  1025. Number of text lines on page                 52    VL
  1026. Position of footer, relative to first line   55    VL
  1027. Lines before first line of a chapter         20    VL
  1028. Lines before subheading                       6    SL, LS
  1029. Lines after subheading                        4    SL, LS
  1030. Lines before a display                        3    DL, LS
  1031. Lines after a display                         3    DL, LS
  1032. Lins spacing within a display                 2    DL
  1033. Lines before a list item                      3    IL, LS
  1034. Lines after a list                            3    IL, LS
  1035. Minimum value for paragraph                   4    MV
  1036. Minimum value for a subsection                8    MV
  1037. Minimum value for a section                   8    MV
  1038. ~ek ~sb ~ec \
  1039.