records). There is no limit as to how many topics you may concatenate nor to how many records or pages they may consist (cont.)
of.
To print a manual made up of more than one topic from the DOC file use MAGECLBR with a control cards as:
-MAGECPRT DOC tttttttttttttttttttttttttttttt C
-MAGECPRT DOC ssssssssssssssssssssssssssssss C
|
|
-MAGECPRT DOC llllllllllllllllllllllllllllll
where:
tttt...tt
= the first topic name
sss...ss
= the second topic name
lll...ll
= the last topic name
The "C" in column 45 indicates to MAGECLBR that the following topic is to be concatenated or is a continuation of this one.
##
Headings, Index, and Page Numbers
When you print your documentation using MAGECLBR you can also allow it to automatically generate headings, titles, and (cont.)
page numbers and to automatically create a table of contents and page index for you. To do that you would use the (cont.)
control cards:
**HDG**
for headings
**IDX**
for index entries
**TTL**
for titles
**PAG**
to control page numbering
You should refer to the "Offline Utilities" chapter for more detailed information about these control cards.
#
Online Maintenance
##
DOCxxx Functions
Online maintenance to documentation on the DOC file is accomplished using the DOC . . . functions provided and the documentation maintenance screen.
##
Displaying Online
Figure 02 depicts the documentation maintenance & display screen as it would appear for displaying a "page" of documentation. To display a page of documentation you would enter:
DOCSEE tttttttttttttttttttttttttttttt
where:
tttt...tt
= the desired topic name
You do not enter the page number with the key (topic name). What will be displayed to you will be the first page (cont.)
(usually page 01) of the topic, its page number will be shown in the area titled PAGE: on the screen. If you wish to go (cont.)
to another page then you may simply key the desired page number over the one shown and press ENTER, the next display (cont.)
will be the page you have specified (if it exists).
Since most topics are more than one page long and since it is very common to want to "browse" through the text to find (cont.)
the area in which you wish to make some change, you will notice that the DOCSEE function code you entered is (cont.)
automatically changed to DOCNXT when the page is displayed to you. The DOCNXT function works very much like all (cont.)
standard . . .NXT functions in MAGEC, it gets the next record (page) and displays it to you when you press ENTER, (cont.)
unless you have altered either the topic name in SKEY (top line of screen) or the page number in the body of the (cont.)
screen. If you change either of these then DOCNXT assumes you wanted to see some record other than the next one and it (cont.)
automatically does a DOCSEE for it.
You can also browse "backwards" using DOCNXT. If you would like to see the previous page rather than the next page then press PF7 instead of ENTER.
| ```
DOCxxx tttttttttttttttttttt
SEARCH ARG: ...................................................................
M A G E C DOCUMENTATION MAINTENANCE/DISPLAY
PAGE: 01
TOPIC NAME: ttttttttttttttttttt
...;+..;10....+...20....+...30....+...40....+...50....+...60....+...70..
SEMICOLON (;) IS THE TAB CHARACTER - THE RULER LINE INDICATES TAB POSITIONS
Press PF12 to return to HELP menu Press PF4 for browse (LOC) Screen
```**
Figure 02 -- Documentation Display Screen
##
Finding Documentation
An online facility is built into MAGEC to enable you to find documentation at your screen. It includes a three-level (cont.)
"menu" to help you to choose among all the many topics stored in the documentation file (the DOC file) by navigating (cont.)
down through the natural heriarchy of the dictionary.
To begin, you enter the function code:
**HELP.
You will be presented a list of Entity Types* defined to the MAGEC dictionary (in Table #250). You can choose one by (cont.)
positioning the cursor to the line it is displayed on and pressing ENTER. The list may be more than one page (cont.)
(screenful) long. If you wish to page forward, just press ENTER without cursor-selecting an Entity (cont.)
Type.
When you select an Entity Type you will be presented a list of *Keywords (or Key Phrases)*. They will be the ones (cont.)
associated with the selected Entity Type. For example, if you chose an Entity Type of FUNC (online function codes), you (cont.)
would receive a list of keywords which were online function codes; if you selected an Entity Type of BPGM (batch (cont.)
programs), you would receive a list of keywords which were batch program names, and so forth. Your list could continue (cont.)
for multiple pages, to page forward just press PF8 or ENTER. When you see the Keyword or Phrase you are interested in, (cont.)
point to it with the cursor and press ENTER.
When you cursor-select a Keyword or Phrase, as described above, you will then be presented a list of *Topics* from the (cont.)
MAGEC documentation file. They will be those topics which are referenced by (associated with) the Keyword or Phrase you (cont.)
have selected. This list may also continue for multiple pages, you can just press PF8 or ENTER to page forward. When (cont.)
you see the Topic you are interested in you can cursor-select it and press ENTER, you will be displayed the first page (cont.)
(screenful) of text for that Topic.
As you browse through the selected Topic you can page forward by pressing ENTER or PF8, or page backward by pressing (cont.)
PF7 (F7, on a PC). When you are through reading it, you can press PF12 (Shift-F2, on a PC) to return to the Topics (cont.)
list.
At each level of the selection menus the PF12 (Shift-F2, on a PC) key will take you back up to the prior menu. If your (cont.)
security authorization permits you to modify documentation, you can do so while you are browsing through the Topic. To (cont.)
do that you would alter the function code (SFUNCT) to DOCCHG, key in your changes, and press ENTER.
Another way you can look for a Topic in the DOC file is by simply browsing through it using the DOCLOC function. The (cont.)
DOCLOC screen is merely a list of Topics, in alphanumeric order, which are on the file. They are not organized by (cont.)
Keyword references. This method is handy when you know the Topic (and how it is spelled, approximately) that you want (cont.)
to view. You do not need to enter the complete Topic Name as a key value in SKEY (though you could), you could enter (cont.)
only the first few characters of it or just enter a "1" to start browsing at the beginning of the file. As with all (cont.)
lists in MAGEC, you can cursor-select the item you are looking for by positioning the cursor to it, when it is shown in (cont.)
the list on the screen, then you can press ENTER and be immediately presented the DOCSEE display of the first page (cont.)
(screenful) of text for the Topic you chose.
##
Finding Documentation
*
Figure 03 -- Finding Documentation
##
Scans of Text
You can use the DOCNXT function to search for a sequence of characters in your text also. To do a search, you do (cont.)
exactly the same as you would to display and browse (DOCSEE, DOCNXT) but you also enter the character string you would (cont.)
like to find into the SEARCH ARGument area.
Your search argument may be up to 66 characters in length. DOCNXT will sequentially search each page of text either (cont.)
browsing forward or backwards (depending on PF8 or PF7 key) looking for the character sequence you have given. When it (cont.)
finds a "hit" it stops searching and displays the page to you with the line(s) on which it found the hit highlighted (cont.)
(bright display or colored red, depending on your terminal).
If you would like to continue searching for the same search argument then you may just press ENTER or PF8 or PF7 again, (cont.)
leaving everything else alone on the screen. It is OK to change directions as often as you like by using the PF8 and (cont.)
PF7 keys, therefore you can search forward to find all the hits and then "back up" to the one you are interested (cont.)
in.
You may also change the search argument at any time by simply overkeying it on the screen; thus you might want to (cont.)
"position" forward to the major section of your text in which you are interested and then search for a certain phrase (cont.)
starting at that point, or from that point backwards.
At any time while you are browsing or searching through your text you may decide that you have found the place where (cont.)
you wish to make some changes. To do so you simply alter the function code from DOCNXT to DOCCHG and press ENTER, You (cont.)
will then see the screen returned to you in maintenance mode for the page you were looking at.
##
Updating Online
Figure 04 depicts the documentation maintenance/display screen as it will appear when you are updating documentation online. It is almost identical to the display mode screen except that:
you can key over the displayed text
the search argument area is gone
the TAB OPTION area appears at the top of the screen
You may, at any time, go directly to the maintenance screen by entering the proper function code and topic name, such as:
DOCCHG tttttttttttttttttttttttttttttt
Again, you do not enter the page number until the screen is returned to you defaulting to the first page of the topic. (cont.)
From that point on you can overkey the page number to "jump around" through the text if you wish.
Since it is difficult to remember page numbers, you will probably prefer to use the browse and scan functions to position yourself before updating.
| ```
**
DOCxxx tttttttttttttttttttt
TAB OPTION: ON