Previous Topic: 2.2.6 INCLLIB Modules

Next Topic: 3. Maintenance Policies and Procedures

2.2.7 Documentation Members


This section describes the naming conventions used for
the members of the CA MICS documentation libraries. The text
for the CA MICS documents is stored in three libraries:

      - sharedprefix.MICS.DOC.TEXT
      - sharedprefix.MICS.INC.TEXT
      - sharedprefix.MICS.DIC.TEXT

The TEXT libraries contain records up to 133 bytes in length
(LRECL=137).  The DOC.TEXT library contains the text of all
CA MICS manuals except the element Data Dictionary members.
The Data Dictionary text is contained in the DIC.TEXT
library.

The INC.TEXT library contains members of text that are
generated at your site or are distributed but likely to be
included in more than one place in the CA MICS documentation.
Members in the INC.TEXT library are copied into CA MICS
manuals using the functions of the CA MICS DOCUMENT program.
Much of the copied text is generated by the CA MICS Component
Generator.

Each section of the document, figure, and title page may be
stored as a separate member in the appropriate library.  The
document assembly commands for each document and chapter are
grouped in short record members, called picklists, which are
stored in sharedprefix.MICS.DOC.TEXT.
MEMBER NAMES

Each CA MICS document is assigned a one or two letter
document identifier.  This identifier is incorporated into
each member name to identify the document of which that
member is a part.  The exceptions to this are noted below.

The letter identifiers for CA MICS manuals are:

   AH - CA MICS Tandem Option Guide
   AI - CA MICS CA ASTEX Option Guide
   BE - CA MICS How to Use the PSP
   BS - CA MICS System Administrator Guide
   C  - CA MICS Network Analyzer Option Guide
   CK - CA MICS Space Collector Option Guide
   CL - CA MICS IMS Log Data Extractor Option Guide
   CM - CA MICS Data Transfer Option for VM/CMS Guide
   FB - CA MICS Analyzer for TSO Guide
   FC - CA MICS Hardware and SCP Analyzer Guide
   FD - CA MICS Batch and Operations Analyzer Guide
   FE - CA MICS Analyzer Option for CICS Guide
   FG - CA MICS Analyzer Option for IMS Guide
   FH - CA MICS System Reliability Analyzer Option Guide
   FI - CA MICS Analyzer Option for VM/CMS Guide
   FJ - CA MICS Space Analyzer Option Guide
   FM - CA MICS Analyzer Option for MeasureWare Guide
   FN - CA MICS Analyzer Option for DB2 Guide
   FO - CA MICS Analyzer Option for MQSeries Guide
   FQ - CA MICS Analyzer Option for VSE/Power Guide
   FT - CA MICS Tape Analyzer Option Guide
   FV - CA MICS Analyzer Option for VAX/VMS Guide
   FW - CA MICS Web Analyzer Option Guide
   H  - CA MICS Standard Reports Guide
   I  - CA MICS Database Structure and Content Guide
   JD - CA MICS Document Access Guide
   JR - CA MICS MICF Reference Guide
   JU - CA MICS MICF User Guide
   L  - CA MICS Planning, Installation, Operation, and
           Maintenance Guide
   M  - CA MICS System Modification Guide
   PA - CA MICS Capacity Planner Option Guide
   PD - CA MICS Performance Manager Option Guide
   PG - CA MICS StorageMate Option Guide
   PK - CA MICS Accounting and Chargeback Option
           Concepts and Overview Guide
   PL - CA MICS Accounting and Chargeback Option User Guide
   W  - CA MICS Analyzer Option for CA IDMS Guide

The member naming conventions, by library, follow.

LIBRARY:  sharedprefix.MICS.DOC.TEXT

  EXCnnnnn - Text for exception members.  'EXC' is the
             character string that identifies the member as
             containing an exception description, and 'nnnnn'
             is a five digit exception number.  These members
             are referenced by the picklist for each
             component guide.

             Example:  EXC01001 contains the text for
                      exception 01001, "CPU Usage Imbalance
                      Between MP/AP Processors."

  innnnnnn
   - or -
  iinnnnnn - For text members.  'i' or 'ii' is the document
             identifier, 'nnnnnnn' is one to seven digits and
             identifies the section number.  If a level of
             the section number exceeds 9, letters are used
             in the member name (e.g., 'A' for '10', 'B' for
             '11', etc.).

             Example:  L232 contains the text for section
                       section 2.3.2 of document 'L'.  LB31
                       contains the text for section 11.3.1
                       of document 'L'.

  PICi     - For the text member containing the picklist for
             document 'i'.  Section 4.8.1 describes the
             CA MICS document programs and explains
             picklists.

             Example:  PICL contains the picklist for
                       document 'L'.

  PICin    - For the text member containing the picklist for
             document 'i', chapter 'n'.

             Example:  PICL3 contains the picklist for
                       document 'L', chapter 3.

  iTITLE   - For the text member containing the document
             title for document 'i'.

             Example:  ATITLE contains the title page text
                       for document 'A'.

  iTITLEnn - For the text member containing the document
             title for document 'i', chapter 'nn'.

             Example:  ATITLE01 contains the title page text
                       for chapter 1 of document 'A'.

  icc$nnn  - For the text member containing a figure for
             document 'i', chapter 'cc', figure number 'nnn'.
             The '$' separates the chapter and figure
             numbers; the number of digits in 'cc' and 'nnn'
             is not fixed.  The only restrictions are that
             both numbers be present and that the two numbers
             plus the '$' not total more than 7 characters.

             Example:  L2$36 is figure 2-36 of document 'L'.
                       L14$2 is figure 14-2 of document 'L'.

LIBRARY:  sharedprefix.MICS.INC.TEXT

  #INSnnnn - For the text members which are copied into other
             members.  'nnnn' is a sequence number.

  #INSfffE - For the generated text members that contain data
             element lists for file fff.

  #INSfffS - For the generated text members that contain the
             sequence keys for file fff.

  #INSiiiA - For the text members that contains the file
             abstracts for the files in information area iii.

  #INScccF - For the generated text members that contain the
             portion of the file matrix for component ccc.

  #INScccQ - For the generated text members that contain the
             portion of the sequence chart for component ccc.

  #INLnnnn - For the text members which are copied into
             other members.  'nnnn' is a sequence number.