Article View: comp.text
Article #4732Re: Thesis Macros, Troff
From: Steve Ring
Date: Mon, 23 May 1988 15:54
Date: Mon, 23 May 1988 15:54
379 lines
17058 bytes
17058 bytes
I have a comprehensive set of -ms macros that do automatic TOC generation. We
have been using here at CG for over 3 years in our internal specification
documents and other Engineering documentation. Is comp.text the right place
to submit these [nt]roff command set. Here is my man page
CGWRITER(7) PUBLIC CGWRITER(7)
Last Changed: December 14, 1987 1
CG Writer Release 2.0 Compugraphic
______________________________________________________________________
NAME
CG Writers ToolKit - text formatting utilities & [nt]roff command
macros
DESCRIPTION
The "Cg Writers ToolKit:" is an integrated set of Bourne shell
utilities combined with [nt]roff -ms enhancements and extensions,
all designed to assist and simplify the preparation of Compu-
graphic Engineering documents, memos, and employee performance
reviews, meeting notices, and any other type of typeset documen-
tation. This ToolKit cannot do your writing, of course, but with
the tools and services provided you will be able to minimize time
and effort in text command programming so concentration can be
placed on composing the document text.
SETUP
1) Place the path /part3/epsfs/bin into your .profile/.login,
usually right after your own $HOME/bin path
2) Establish a directory called /_Tmp in your home directory.
Various temporary files created during document processing are
stored there. You will need to remove these files at various
times (usually from a .logout file for whenever you log off).
3) Set the environmental variable EDITOR in your .profile/.login
to either tve, vi, emacs to cause one of them to be automati-
cally invoked as your editor of choice. The default is to
invoke vi.
4) Optionally, you can set the environmental variable VIEW to
less if that is the previewer of your choice. The default is
more.
5) To make viewing of nroffed documents more readable on your
terminal screen, I recommend that you set the environmental
variable MORE in your .cshrc_or_.login to the options -cs.
Then whenever you use more, or less, your document will scroll
from the top of the screen down - squeezing multiple blank
lines into one as it scrolls.
6) Include one of the .so/part3/epsfs/lib/INIT* lines at the
front of your text file. Several INIT* files exist - each spe-
cially designed for different CG documents
File Document Type
____________________________________________________
INIT Report Style Documents
INIT.memo Memos
INIT.man Manual Pages
INIT.vugraph VuGraphs
INIT.meet Meeting Notices
INIT.perf_hour Hourly Employee Performance Review
INIT.perf_sal Salary Employee Performance Review
INIT.self_asses Employee Self Assessment
FILES
/part3/epsfs/lib/INIT*
SEE_ALSO
eqn(1), tbl(1), troff(1), pic(1), epx(1)
AUTHOR
Steve Ring
NOTE:
The following pages can be xeroxed 2-sided and used as refer-
ences.
TOOLKIT_UTILITIES
memo [file] dww [file] pww [file]
______________________________________________________________________
nrf [*Pntr*] [*Host*] [-man|-me|-mm] [-noinit] [-col] [-nodate]
[-noquote] [-notoc] file[.n|.nrf|.nro|.txt]
where:
usage: nrf [*Pntr*] [*Host*] [-man|-me|-mm] [-noinit] [-col] [-nodate]
[-noquote] [-notoc] [-sc] file[.n|.nrf|.nro|.txt]
or: nrf [-Q] = Nroff queues on Vaxes
or: nrf [-k] = Kill Nroff job on Vaxes
or: nrf [-BB] = Bulletin Board Info, Last Update `mm/dd/yy'
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*Prntr*: = -[a|b|z|c|cz|CZ|ep1|Ep1|ep2|Ep2|5|5x|7|7x|p|pr|P|d|dp|D|q ]
*Host*: = -[stymie|garth|oracle|moon|surf|opus|liberty]
-man/-me/-mm = use if UR using "man/me/mm" macros
-sc = enable short screen format (.SC)
-noinit = use if U don't want "../lib/INIT" provided for U
-nodate = don't insert current date/time stamp
-nopath = don't insert file path name
-noquote= just print warning message for lines beginning with '
-notoc = don't print the Table of Contents
-col: = pipe output thru 'col' for .B1/.x1 usages (i.e. 'nroff|col')
Note: -Q gives the Vax Nroff job queue, -k kills Vax nroff jobs
______________________________________________________________________
trf [*Pntr*] [*Host*] [-man|-me|-mm] [-noinit] [-nodate] [-nopath]
[-noquote] [-notoc] file[.n|.nrf|.nro|.txt]
where:
usage: trf [*Pntr*] [*Host*] [-man|-me|-mm] [-noinit] [-nodate] [-nopath]
[-noquote] [-notoc] file[.n|.nrf|.nro|.txt]
or: trf [-BB] = Read Bulletin Board, Last Update `mm/dd/yy'
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*Prntr*: = [-im]
*Host*: = [-ep1|-ep2|
-stymie|-garth|-oracle|-moon|-surf|-opus|-liberty]
-man/-me/-mm = use if UR using "man/me/mm" macros
-noinit = use if U don't want "../lib/INIT" provided for U
-nodate = disable inserting current date/time stamp
-nopath = disable inserting file path name
-noquote = only print warning message for lines beginning with '
-notoc = disable printing of a Document's Table of Contents "
______________________________________________________________________
INSERTED_DATA
.so _Date \" Insert Current Date/Time stamp
.so _FileDate \" Insert File Date/Time Stamp
.so _Path \" Insert full file path name
CUSTOMIZED_DEFAULT_STRING_VALUES
Note: !A, !C only apply to Report type documents. They do not exist
for other type documents (memos, etc.). On the other hand, !P, !N, !E,
!H, !F are common string variables defined for all types of documents.
-----------------------
.\" REPORT DOCUMENTS
.ds !A new-page-ah1-on
.ds !C toc-on
.\" COMMON VARIABLES
.ds !P new-page-nh1-on
.ds !N para-indent-on
.ds !E even-odd-page-off
.ds !H hanging-indent-on
.ds !F dashed
-----------------------
-----------------------
.\" MEMOS
.\"
.\" COMMON VARIABLES
.ds !P new-page-nh1-OFF
.ds !N para-indent-on
.ds !E even-odd-page-off
.ds !H hanging-indent-on
.ds !F number
-----------------------
-----------------------
.\" REVIEWS
.\"
.\" COMMON VARIABLES
.ds !P new-page-nh1-OFF
.ds !N para-indent-on
.ds !E even-odd-page-off
.ds !H hanging-indent-OFF
.ds !F number
-----------------------
-----------------------
.\" VUGRAPHS
.\"
.\" COMMON VARIABLES
.ds !P new-page-nh1-OFF
.ds !N para-indent-on
.ds !E even-odd-page-off
.ds !H hanging-indent-OFF
.ds !F number
-----------------------
-----------------------
.\" MEETING NOTICES
.\"
.\" COMMON VARIABLES
.ds !P new-page-nh1-OFF
.ds !N para-indent-on
.ds !E even-odd-page-off
.ds !H hanging-indent-on
.ds !F number
-----------------------
TOOLKIT_COMMAND_LIBRARY
Table 1. ToolKit Command Library
Name Options Explanations
.B> - Indented paragraph: =>
.BA/ba word indent Indented paragraph: Word
.BH/bh - Indented Paragraph: -
.BI/bi word indent Indented paragraph: Word
.BK - Indented Paragraph:
.BN/bn style num format Indented paragraph: #'s
.BS/bs - Indented Paragraph: *
.BU/bu - Indented Paragraph: o+
.CI - Indented Paragraph: O
.DS [I|B|L|C] title Start no-fill display keep
.Fo Pts Vert Local Font Changes
.Fz Pts - Global Font Change
.G9 [I|B|L|C] title Start 9 pt no-fill display keep
.GE - End no-fill display keep
.GS [I|B|L|C] title Start no-fill display keep
.IB word - Italics Bold Word
.LG [I|B] word Large word
.Qb word punct "Word"
.Qe - End special paragraphing
.Qi word punct "Word"
.Qo word punct "Word"
.Qp [I|B] Offset Paragraphing
.Rv - Revision History
.SM [I|B] word Smaller word
.SC width Short screen presentation format
.TE - End Tables
.TS [-9] [H|H9]
[NK|NK9] [title] Start Tables
.UC [-l|word] Translate lower <=> uppercase
.Wi width Set page line width
.Wz width Set default page line width
.ah 0|level title - Appendices
.ej level
EJECT|NOEJECT page eject
.ep [0|word] Skip to next even page
.fg title Figure captions
.hl char Draw horizontal line
.i - Convenience: .IP
.ip - Indented Paragraph, no space
.ke - End no-fill keep
.kl - Start wide no-fill keep,
.kp - Start floating no-fill keep
.ks - Start no-fill keep
.l - Convenience: .LP
.nh level title - Numbered (sub)Sections
.op [0|word] Skip to next odd page
.p - Convenience: .PP
.sb title - o+ title, .PP
.sc title - title, Underline .IP
.sg title - title, .PP
.sh title - title, .LP
.si title - title, .IP
.sk [0|word] Skip blank page
.sq title - Left to User, .IP, No Space
.su title - title, .IP
.sv title - title, .IP, No Space
.tb title - Captioned Tables
.uc title - Continuous Underline
.un number Undent margin
.us title - Underline title
.x1 C [-9|-10] Start no-fill Boxed keep (.)
.x2 - End no-fill Boxed keep
.y1 C [-9|-10] Start no-fill Boxed keep (.)
.y2 - End no-fill Boxed keep
.z1 - Start Block text region
.z2 - End Block text region
STRING/NUMBER_REFERENCES_&_VARIABLES
Table 2. Number References{|-}
Reference Description
B# most recent Table number
B+ next Table number
F# most recent Figure number
F+ next Figure number
D# most recent Display number
D+ next Figure Display number
yr Current year
dy Current day date
{|-} Note: Number references preceded by \n(
Table 3. String References{|=}
Reference Description
Bb 'Table xx' portion of the next Table
Bh title portion of the Table heading
Bt 'Table xx' portion of the Table heading
Ff 'Figure xx' portion of the next Figure
Fh title portion of the Figure heading
Ft 'Figure xx' portion of the Figure heading
Df 'Display xx' portion of the next Display
Dh title portion of the Display heading
Dt 'Display xx' portion of the Display heading
Cf Center text, first bottom line
DY Current Date
LF Eng. Number(or left bottom text)
LH Document Title
MO current month
DW current day
Rf first bottom line, right corner text
RF Author's Organization (right bottom text)
SN current section number
Sh current Top level section number
st current section title
PN current page number
{|=} Note: String references preceded by \*(
Table 4. Common String Variables
String Value Description
!P new-page-nh1-on Do Page break @ .nh1
(anything else) Don't page break @ .nh1
!N para-indent-on Do Indent (.PP) after .nh/ah
(anything else) Don't indent (.LP) after .nh/ah
!F dashed Set captions as "Figure S-n Text"
number Set captions as "Figure n. Text"
no-number Set captions as "Text"
!E even-odd-page-off page title lines same on all pages
(anything else) Even/odd page Title lines
!H hanging-indent-on Hanging symbol - indent (1.0i)
(anything else) Hanging symbol - indent (0.5i)
Table 5. Document Specific String Variables
String Value Description
!A new-page-ah1-on Do Page break @ .ah A,B..
(anything else) Don't page break @ .ah A/B..
!C toc-on Print Table of Contents
(anything else) Don't print Table of Contents
--
...!{decvax,ima,ism780c,ulowell,laidbak,cgeuro,cg-f}!cg-atla!ring
Steve Ring
CompuGraphic Corp.
Wilmington, Mass., 01887, (617) 658-5600, x5092
Technical Details
Message-ID:
<4172@cg-atla.UUCP>Path:
arc1-ca.pugleaf.net!utzoo!attcan!uunet!husc6!m2c!ulowell!cg-atla!ringReferences:
<250100002@smu>Show Full Headers
Complete Article Headers
Path: arc1-ca.pugleaf.net!utzoo!attcan!uunet!husc6!m2c!ulowell!cg-atla!ring From: ring@cg-atla.UUCP (Steve Ring) Newsgroups: comp.text Subject: Re: Thesis Macros, Troff Summary: Supplementary -ms library Message-ID: <4172@cg-atla.UUCP> Date: 23 May 88 15:54:06 GMT References: <250100002@smu> Organization: Compugraphic Corp., Wilmington, Mass Lines: 379