-MAGECIDX<br />Print an index list<br />-MAGECUSE<br />Print a Where-Used report<br />-MAGECGBL<br />Apply global changes (Domains only)<br />-MAGECI/O&nbsp;READONLY<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(col 1-18) Set file access mode for read-only for this entire execution. This must be first control card in input stream.<br />Col 11-14:<br />Key prefix (required)<br />LIB<br />Ordinary library member<br />DEF<br />Default algorithm<br />nnn<br />001<br />999 for MMP custom algorithm<br />nnnB<br />001B<br />999B for MBP custom algorithm<br />DOC<br />Documentation on DOC file<br />DIT<br />Data items in dictionary<br />PRO<br />Named proforma member<br />RUL<br />Business Rule<br />DOM<br />Domain<br />Col 15-22:<br />Member name (ALG file only)<br />xxxxxxxx<br />ALG member name<br />MM/DD/YY<br />for -MAGECIDX, list members updated since this date<br />Col 23-23:<br />Separator (ALG file only)<br />/<br />,<br />blank<br />Col 24-31:<br />Name modifier (ALG file only)<br />xxxxxxxx<br />Optional suffix for member name, 1-8 characters<br />Col 15-44:<br />Topic name (DOC file only -- required)<br />xxxxxxxx<br />Topic name of the documentation member on the DOC file<br />Col 15-19:<br />Element name (DIT file only -- required)<br />xxxxx<br />Name of element on DIT file<br />Col 24-25:<br />Mode (DIT file only)<br />T<br />Default -- test mode<br />P<br />Production mode<br />Col 45-45:<br />Suppress heading and page number reset. For<br />MAGECPRT and<br />MAGECLST of multiple members when resetting to page 01 at the start of each member is not desired.<br />C"<br />Continue (do not reset)<br />blank<br />Default -- reset to page 01<br />Col 46-46:<br />Uppercase flag (for<br />MAGECPRT and<br />MAGECLST only)<br />U<br />Mixed text (upper- and lowercase) wll be converted to all uppercase for output<br />L<br />Default -- Text remains in upper- and lowercase on output<br />Col 47-48:<br />Page increment (only for<br />MAGECADD and<br />MAGECREP)<br />nn<br />This controls the increment value MAGECLBR will use in generating "page" numbers as the member is being added to the (cont.)<br />file. Page number is the low-order portion of the key. The increment value will also be the page number of the first (cont.)<br />record added. If this value is 02 then the first page will be page 002, the next will be 004, etc. Default is 01 for (cont.)<br />DOC file, else 02.<br />Col 47-48:<br />Sequence column (only for<br />MAGECPUN and<br />MAGECPCH on ALG members)<br />nn<br />Starting card column into which MAGECLBR will insert sequence numbers. The sequence numbers are actually the page number and line number within the page on the ALG file.<br />Default is NO for -MAGECPUN and -MAGECPCH.<br />NO<br />Suppresses sequence numbers<br />Col 49-50:<br />Lines per page (only for<br />MAGECLST and<br />MAGECPRT)<br />nn<br />01 thru 90 -- The maximum number of lines per page to print before forcing a "top of form". Default is 59.<br />NO<br />Suppresses forced breaks<br />Col 51-54:<br />Entity type &nbsp;(DOC file only)<br />tttt<br />Entity type to be used to add "prime reference" to REF file. Required only for<br />MAGECADD DOC operations, ignored otherwise.<br />Col 15-24:<br />Domain name (for DOM key prefix only)<br />xxxxxxxx<br />20-character Domain name--valid only with the -MAGECUSE DOM and -MAGECGBL DOM operations<br />Note:<br />**<br />1. Only the<br />MAGECADD,<br />MAGECUSE, and<br />MAGECDEL operations are allowed to the DIT file. The input for the<br />MAGECADD DIT is a Cobol data definition, the dictionary definitions will be generated and added to the DIT file. The (cont.)<br />Element (ELT) definition must exist on the MAGEC dictionary prior to adding DIT definitions for that (cont.)<br />Element.<br />2. When new documentation is added via the<br />MAGECADD DOC operation, MAGECLBR also adds the "prime reference" entry to the REF file for the new topic. A prime (cont.)<br />reference is one in which the key word (or key phrase) is the same as the topic name and is generated to ensure that (cont.)<br />there is at least one reference to every topic since the usual path to documentation on the DOC file is via the (cont.)<br />references from the REF file. When a topic is deleted from the DOC file all references to it are deleted from the REF (cont.)<br />file.<br />## <br />Printing Members<br />EJECT - Top-of-Page Control<br />When printing a member using the -MAGECPRT or -MAGECLST operations, MAGECLBR will sense EJECT lines and will skip to Top of Page. The EJECT line is not printed. An EJECT line is formatted as follows:<br />' EJECT'<br />&nbsp;<br />where:<br />columns 1 - 11 contain blanks<br />columns 12 - 16 contain the literal 'EJECT' in uppercase<br />the remainder of the line will be ignored<br />SKIP and SPACE - Blank Line Insertion<br />During -MAGECPRT and -MAGECLST operation MAGECLBR will sense SKIP and SPACE control lines and will generate the (cont.)<br />specified number of blank lines. The line containing the SKIP or SPACE command will not be printed. These control cards (cont.)<br />are formatted as follows:<br />' SKIP 99'<br />&nbsp;<br />' SPACE99'<br />where:<br />columns 1 - 11 must be blank<br />columns 12 - 16 must contain the literal "SKIP&nbsp;" or "SPACE"<br />column 17 - 18 must contain a 2-digit number from 01 thru 99, indicating how many blank lines are to be inserted.<br />**<br />NOTE:<br />**<br />Blank lines within the member(s) being printed are not printed, they are bypassed.<br />SKIP and SPACE - Overprinting/Underlining<br />In the SKIP and SPACE lines described above, zero (00) may be specified as the number of lines to skip, to indicate (cont.)<br />that the NEXT data line is to be printed without skipping any lines. This enables overprinting to effect special (cont.)<br />characters, such as "<br />" or underlining.<br />**<br />NOTE:<br />**<br />Since MAGEC does not permit entering the underscore character (&nbsp;_&nbsp;) online (it is transformed to a space) (cont.)<br />special provision is made for it. In the data line immediately following the "SKIP 00" line, any occurrence of the (cont.)<br />"pseudo underscore" will be transformed into an underscore. The pseudo underscore is the uppercase letter (cont.)<br />"U".<br />Headings and Titles<br />During -MAGECPRT and -MAGECLST operations, the PAGE HEADING which MAGECLBR prints at every Top of Page, whether (cont.)<br />triggered by an EJECT line in the member being listed, or by reaching the maximum number of lines per page, will (cont.)<br />consist of a default heading with the page number displayed at the far right. The default heading is blanks if from the (cont.)<br />ALG file, or Topic Name if from the DOC file A user-defined page heading may be specified instead of this (cont.)<br />default.&nbsp;Up to 65 characters of heading literal may be given via the special "heading" line record(s) which may be (cont.)<br />embedded within the member being listed. The format is:<br />**HDG**This is the new heading<br />where: **HDG**<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />= Constant in columns 1-7<br />Upon encountering such a heading line, MAGECLBR will alter the heading literal. The new heading will appear as of the (cont.)<br />next Top of Page and on all subsequent Top of Page's until either the end of the member is reached or another heading (cont.)<br />line is encountered. The page number will continue to be displayed on the user-defined heading just as it did on the (cont.)<br />default heading. The page number is not reset on these heading changes; only the literal is changed.<br />MAGECLBR also recognizes special "title lines" within the member being printed. A title line is as:<br />**TTL**This is a title<br />where: **TTL<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br />= Constant in columns 1-7<br />The title which is in columns 8 thru 67 (maximum of 60 characters) will appear in the printout with a blank line (cont.)<br />preceeding and following it and indented 5 spaces and it will automatically be underscored. The headings and titles (cont.)<br />will appear in the automatic Table of Contents which is produced on printing operations and will also appear in the (cont.)<br />Page Index which is also produced.<br />## <br />Suppress Reset<br />When multiple members are being printed in one run, the heading is reset to its default value at the end of each (cont.)<br />member, unless the "suppress reset" option is specified on the -MAGECPRT (or LST) card for that member. Specifying (cont.)<br />"suppress reset" (value = "C") is used to concatenate members so that they will be treated as one, resulting in one (cont.)<br />Table of Contents and one Page Index for a set of members. The "C" must be specified on the first -MAGECPRT or (LST) (cont.)<br />card in the set and on all subsequent ones except for the last. If the last card specifies "C", but it is not followed (cont.)<br />by any other -MAGECPRT (or LST) cards, being the last card in the run, then the "C" is ignored.<br />A Table of Contents will be printed at the end of each member of set of members (if continuation specified in the (cont.)<br />suppress reset option on the -MAGECPRT or LST control cards, which will include each heading and title. This Table of (cont.)<br />Contents may be placed in front of the report to produce "suitable for binding" documentation manuals. A "Page Index" (cont.)<br />will also be printed which will include all headings and titles plus other Key Word or Key Phrase entries as specified (cont.)<br />by the author using the **IDX** lines discussed below.<br />## <br /><br />next: util04.md.txt