Model Templates : Template for nroff : Segment 1: Heading and Report Overview (nroff) : Producing the Heading and Overview (nroff)

Producing the Heading and Overview (nroff)

The template uses WRITE statements to write nroff formatting commands to the output document segments. Note that there is a \n before each nroff command so each command written to the output segment starts on a separate line. For example, after executing the template, the first three WRITE statements cause the following to appear in the output segment seg1:

.PAGE
.CENTER; Description of SC_ACTIVITIES
.SKIP
.HL 1 Overview

The contents of the overview section are taken from an include file, sys_overview. This file resides in your workarea. As written in the comments, this file can contain formatting instructions in addition to the text. The entire file is passed verbatim to the output segment following the overview header.

After the output segment has been generated, it can then be formatted by nroff so the formatting commands are interpreted and the final, formatted document produced. For example, the formatting commands in seg1 would cause a new page to be started; the words “Description of SC_ACTIVITIES” would then be centered in the middle of the line, followed by a “skipped” line. The next formatting command would produce a header marked by the number 1. Lastly, the text contained in sys_overview is formatted according to the formatting instructions in this file or, if missing, according to the nroff defaults.