HELPLIB.HLB  —  CONVERT  /DOCUMENT  CDA Base Service Converters
    Converters installed with the CDA Base Services are described
    below.

1  –  Analysis Output Converter

    The Analysis output converter produces formatted text output of
    the in-memory DDIF or DTIF format of the input file. The analysis
    output file shows the named objects and values stored in the
    input file. Application programmers use an analysis output file
    for debugging purposes.

    Application end users use an analysis output file to determine
    whether an input file contains references or links to multiple
    subfiles. Each subfile must be copied separately across a network
    because subfiles are not automatically included when an input
    file is transferred across the network.

    You can search the analysis output file for all occurrences of
    the string "ERF_". The following example shows that the image
    file "griffin.img" is linked to the DDIF compound document that
    is the input file:

    ERF_LABEL ISO LATIN1 "griffin.img" ! Char. string.
    ERF_LABEL TYPE RMS_LABEL TYPE "$RMS"
    ERF_CONTROL COPY_REFERENCE ! Integer = 1

    Note that an analysis output file is intended as a programmer's
    tool. The coded information in the file is not intended for
    modification but rather to examine the content of a file. The
    previous example shows how you can search analysis output for
    references to linked files.

1.1  –  Analysis Converter Options

    The Analysis output converter supports the following options:

    o  TRANSLATE_BYTE_STRINGS

       Overrides the default. For data of type BYTE STRING, the
       analysis output no longer displays the hexadecimal translation
       if all the characters in the byte string are printable
       characters (hex values 20 through 7E). This feature may be
       overridden by supplying the TRANSLATE_BYTE_STRINGS option.

    o  IMAGE_DATA

       Overrides the default. For the special case of byte string
       data for item DDIF$_IDU_PLANE_DATA (a bitmapped image), the
       analysis output previously included both a hexadecimal and an
       ASCII translation display, neither of which were of particular
       value to most users. With the new version, both displays will
       be replaced with the following comment:

       ! *** Bit-mapped data not displayed here ***

       To retain the hexadecimal display, supply the IMAGE_DATA
       option. Even with this option turned on, there will be no
       translation into ASCII.

    o  INHERITANCE

       Specifies that the analysis is shown with attribute
       inheritance enabled. Inherited attributes are marked as
       "[Inherited value.]" in the output. This option also causes
       external references to be imported into the main document.

2  –  DDIF Input Converter

    The DDIF input converter converts a compound document DDIF input
    file to an intermediate format that is then converted to the
    specified output file format. If the DDIF input file is a newer
    version of the DDIF grammar than that understood by the DDIF
    input converter, data represented by the new grammar elements is
    lost.

    The DDIF input converter does not resolve external references,
    although the converter kernel can if requested by the output
    converter. A document syntax error in the DDIF input file causes
    a fatal input processing error and conversion stops.

3  –  DDIF Output Converter

    The DDIF output converter creates a compound document DDIF output
    file from the intermediate format of the input file.

4  –  Domain Converter

    You may want to convert tabular input files to document output
    files so that you can include textual representations of data
    tables or spreadsheets in reports and other documents. You will,
    however, lose cell borders, headers, grid lines, all formulas,
    and font types when converting a tabular input file to a document
    output file.

    When you convert a tabular input file (for example, a DTIF file)
    to a document output file, the file format first undergoes an
    automatic domain conversion from a table format to a document
    format. The output is then converted to the document format you
    specified.

    You can create an options file containing processing options that
    apply to any CDA supported tabular file format for which there is
    an input converter. Data tables and spreadsheets are examples of
    tabular file formats.

    To convert tabular input files to document output files, use
    the DTIF_TO_DDIF format name, followed by the processing options
    listed below. Specify the DTIF_TO_DDIF processing options in
    addition to the processing options for a particular tabular input
    file format and a particular document output file format.

4.1  –  COLUMN_TITLE

    COLUMN_TITLE displays the column titles as contained in the
    column attributes centered at the top of the column.

4.2  –  CURRENT_DATE

    CURRENT_DATE displays the current date and time in the bottom
    left corner of the page. The value is formatted according to the
    document's specification for a default date and time.

4.3  –  DOCUMENT_DATE

    DOCUMENT_DATE displays the document date and time as contained
    in the document header in the top left corner of the page. The
    value is formatted according to the document's specification for
    a default date and time.

4.4  –  DOCUMENT_TITLE

    DOCUMENT_TITLE displays the document title or titles as contained
    in the document header centered at the top of the page, one
    string per line.

4.5  –  PAGE_NUMBER

    PAGE_NUMBER displays the current page number in the top right
    corner of the page.

4.6  –  PAPER_SIZE

    PAPER_SIZE keyword specifies the size of the paper to be used
    when formatting the file. Valid values for the size argument are
    as follows:

    Keyword            Size

    A0                 841 x 1189 millimeters (33.13 x 46.85 inches)
    A1                 594 x 841 millimeters (23.40 x 33.13 inches)
    A2                 420 x 594 millimeters (16.55 x 23.40 inches)
    A3                 297 x 420 millimeters (11.70 x 16.55 inches)
    A4                 210 x 297 millimeters (8.27 x 11.70 inches)
    A5                 148 x 210 millimeters (5.83 x 8.27 inches)
    A                  8.5 x 11 inches (216 x 279 millimeters)
    B                  11 x 17 inches (279 x 432 millimeters)
    B4                 250 x 353 millimeters (9.84 x 13.90 inches)
    B5                 176 x 250 millimeters (6.93 x 9.84 inches)
    C                  17 x 22 inches (432 x 559 millimeters)
    C4                 229 x 324 millimeters (9.01 x 12.76 inches)
    C5                 162 x 229 millimeters (6.38 x 9.02 inches)
    D                  22 x 34 inches (559 x 864 millimeters)
    DL                 110 x 220 millimeters (4.33 x 8.66 inches)
    E                  34 x 44 inches (864 x 1118 millimeters)
    10x13_ENVELOPE     10 x 13 inches (254 x 330 millimeters)
    9x12_ENVELOPE      9 x 12 inches (229 x 305 millimeters)
    BUSINESS_ENVELOPE  4.13 x 9.5 inches (105 x 241 millimeters)
    EXECUTIVE          7.5 x 10 inches (191 x 254 millimeters)
    LEDGER             11 x 17 inches (279 x 432 millimeters)
    LEGAL              8.5 x 14 inches (216 x 356 millimeters)
    LETTER             8.5 x 11 inches (216 x 279 millimeters)
    LP                 13.7 x 11 inches (348 x 279 millimeters)
    VT                 8 x 5 inches (203 x 127 millimeters)

    The A paper size (8.5 x 11 inches) is the default.

4.7  –  PAPER_HEIGHT

    PAPER_HEIGHT value specifies a paper size other than one of
    the predefined values provided. The default paper height is 11
    inches.

4.8  –  PAPER_WIDTH

    PAPER_WIDTH value specifies a paper size other than one of the
    predefined sizes provided. The default paper width is 8.5 inches.

4.9  –  PAPER_TOP_MARGIN

    PAPER_TOP_MARGIN value specifies the width of the margin provided
    at the top of the page. The default value is 0.25 inch.

4.10  –  PAPER_BOTTOM_MARGIN

    PAPER_BOTTOM_MARGIN value specifies the width of the margin
    provided at the bottom of the page. The default value is 0.25
    inch.

4.11  –  PAPER_LEFT_MARGIN

    PAPER_LEFT_MARGIN value specifies the width of the margin
    provided on the left-hand side of the page. The default value
    is 0.25 inch.

4.12  –  PAPER_RIGHT_MARGIN

    PAPER_RIGHT_MARGIN value specifies the width of the margin
    provided on the right-hand side of the page. The default value
    is 0.25 inch.

4.13  –  PAPER_ORIENTATION

    PAPER_ORIENTATION keyword specifies the paper orientation to be
    used in the output file. The valid values for the orientation
    argument are as follows:

    Keyword         Meaning

    PORTRAIT        The page is oriented so that the larger dimension
                    is parallel to the vertical axis.
    LANDSCAPE       The page is oriented so that the larger dimension
                    is parallel to the horizontal axis.

    The default is PORTRAIT.

5  –  DTIF Input Converter

    The DTIF input converter converts a DTIF input file to an
    intermediate format that is then converted to the specified
    output file format. DTIF (Digital Table Interchange Format) is
    a standard format for the storage and interchange of tabular
    data files, such as those created by spreadsheet and database
    applications.

    If the DTIF input file is a newer version of the DTIF grammar
    than that understood by the DTIF front end, data represented by
    the new grammar elements is lost.

    The DTIF input converter does not resolve external references. A
    document syntax error in the DTIF input file causes a fatal input
    processing error. A document syntax error in the DTIF input file
    causes a fatal input processing error and conversion stops.

6  –  DTIF Output Converter

    The DTIF output converter converts the intermediate format of the
    input file to a DTIF output file. DTIF (Digital Table Interchange
    Format) is a standard format for the storage and interchange
    of tabular data files, such as those created by spreadsheet and
    database applications.

    The DTIF output converter converts external file references
    stored in the intermediate representation of the input file but
    does not resolve external references.

7  –  Text Input Converter

    The Text input converter converts a Text (ISO Latin1) input file
    to an intermediate format that is then converted to the specified
    output file format. The information in the text input file maps
    directly to an intermediate representation. Line breaks and form
    feeds are mapped to DDIF directives. One or more contiguous blank
    lines are interpreted as end-of-paragraph markers.

    If the text input file was entered as a DEC Multinational
    Character Set file on a character-cell terminal or terminal
    emulator, the following conversions occur:

    Original Character      Converted Character

    Concurrency sign        Diaeresis
    Capital OE ligature     Multiplication sign
    Capital Y with          Capital Y with acute accent
    diaeresis
    Small oe ligature       Division sign
    Small y with diaeresis  Y with acute accent

    The text input file does not lose any text when converted
    to the intermediate representation because no structure
    information is contained in a text file. All nonprinting
    characters are converted to space characters. For example,
    characters introducing ANSI escape characters are converted to
    space characters. There is no attempt to interpret ANSI escape
    sequences.

8  –  Text Output Converter

    The Text output converter converts the intermediate format of
    the input file to a Text output file. Text output files contain
    only textual content and minimal formatting such as line feeds,
    page breaks, and tabs. The output converter preserves formatting
    information to the extent possible. Page coordinates convert to
    the nearest character cell (line,column) position.

    All graphics, images, and text attributes in the input file
    are lost when converted to the text output file. Because a
    monospace font is used, it is possible some text may be lost due
    to overwriting to preserve the layout. Lines can be truncated if
    the specified page width is smaller than the page width specified
    in the document's format information. Neither of these cases
    occur when you use the OVERRIDE_FORMAT processing option because,
    in that case, the document's format information is ignored.

    The Text output converter supports the processing options listed
    below.

8.1  –  ASCII_FALLBACK

    ASCII_FALLBACK [ON,OFF] causes the Text output converter to
    output text in 7-bit ASCII. The fallback representation of the
    characters is described in the ASCII standard. If this option is
    not specified, the default is OFF; if this option is specified
    without a value, the default is ON.

8.2  –  CONTENT_MESSAGES

    CONTENT_MESSAGES [ON,OFF] causes the Text output converter to
    put a message in the output file each time a nontext element is
    encountered in the intermediate representation of the input file.
    If this option is not specified, the default is OFF; if this
    option is specified without a value, the default is ON.

8.3  –  HEIGHT

    HEIGHT value specifies the maximum number of lines per page
    in your text output file. If you specify zero, the number of
    lines per page will correspond to the height specified in your
    document. If you also specify OVERRIDE_FORMAT, or if the document
    has no inherent page size, the document is formatted to the
    height value specified by this option. The default height is
    66 lines.

8.4  –  OVERRIDE_FORMAT

    OVERRIDE_FORMAT [ON,OFF] causes the Text output converter to
    ignore the document formatting information included in your
    document, so that the text is formatted in a single large galley
    per page that corresponds to the size of the page as specified
    by the HEIGHT and WIDTH processing options. If this option is
    not specified, the default is OFF; if this option is specified
    without a value, the default is ON.

8.5  –  SOFT_DIRECTIVES

    SOFT_DIRECTIVES [ON,OFF] causes the Text output converter to
    obey the soft directives contained in the document when creating
    your text output file. (Soft directives specify such formatting
    commands as new line, new page, and tab.) If this option is
    not specified, the default is OFF; if this option is specified
    without a value, the default is ON.

8.6  –  WIDTH

    WIDTH value specifies the maximum number of columns of characters
    per page in your text output file. If you specify zero, the
    number of columns per page will correspond to the width specified
    in your document. If you also specify OVERRIDE_FORMAT, or if the
    document has no inherent page size, the document is formatted
    to the value specified by this processing option. If any lines
    of text exceed this width value, the additional columns are
    truncated. The default width is 80 characters.

9  –  PostScript Output Converter

    The PostScript output converter converts the intermediate format
    of the input file to a PostScript output file. The PostScript
    output converter supports the processing options listed below.

9.1  –  PAPER_SIZE

    PAPER_SIZE keyword specifies the size of the paper to be used
    when formatting the resulting PostScript output file. Valid
    values for the size argument are as follows:

    Keyword     Size

    A0          841 x 1189 millimeters (33.13 x 46.85 inches)
    A1          594 x 841 millimeters (23.40 x 33.13 inches)
    A2          420 x 594 millimeters (16.55 x 23.40 inches)
    A3          297 x 420 millimeters (11.70 x 16.55 inches)
    A4          210 x 297 millimeters (8.27 x 11.70 inches)
    A           8.5 x 11 inches (216 x 279 millimeters)
    B           11 x 17 inches (279 x 432 millimeters)
    C           17 x 22 inches (432 x 559 millimeters)
    D           22 x 34 inches (559 x 864 millimeters)
    E           34 x 44 inches (864 x 1118 millimeters)
    LEDGER      11 x 17 inches (279 x 432 millimeters)
    LEGAL       8.5 x 14 inches (216 x 356 millimeters)
    LETTER      8.5 x 11 inches (216 x 279 millimeters)
    LP          13.7 x 11 inches (348 x 279 millimeters)
    VT          8 x 5 inches (203 x 127 millimeters)

    The A paper size (8.5 x 11 inches) is the default.

9.2  –  PAPER_HEIGHT

    PAPER_HEIGHT value specifies a paper size other than one of the
    predefined values provided. The default paper height is 11 inches
    (in). Other valid units of measurement are: centimeters (cm),
    millimeters (mm), and points (pt or po).

9.3  –  PAPER_WIDTH

    PAPER_WIDTH value specifies a paper size other than one of the
    predefined sizes provided. The default paper width is 8.5 inches
    (in). Other valid units of measurement are: centimeters (cm),
    millimeters (mm), and points (pt or po).

9.4  –  PAPER_TOP_MARGIN

    PAPER_TOP_MARGIn value specifies the width of the margin
    provided at the top of the page. The default value is 0.25 inch
    (in). Other valid units of measurement are: centimeters (cm),
    millimeters (mm), and points (pt or po).

9.5  –  PAPER_BOTTOM_MARGIN

    PAPER_BOTTOM_MARGIN value specifies the width of the margin
    provided at the bottom of the page. The default value is 0.25
    inch (in). Other valid units of measurement are: centimeters
    (cm), millimeters (mm), and points (pt or po).

9.6  –  PAPER_LEFT_MARGIN

    PAPER_LEFT_MARGIN value specifies the width of the margin
    provided on the left-hand side of the page. The default value is
    0.25 inch (in). Other valid units of measurement are: centimeters
    (cm), millimeters (mm), and points (pt or po).

9.7  –  PAPER_RIGHT_MARGIN

    PAPER_RIGHT_MARGIN value specifies the width of the margin
    provided on the right-hand side of the page. The default value is
    0.25 inch (in). Other valid units of measurement are: centimeters
    (cm), millimeters (mm), and points (pt or po).

9.8  –  PAPER_ORIENTATION

    PAPER_ORIENTATION keyword specifies the paper orientation to
    be used in the output PostScript file. The valid values for the
    orientation argument are as follows:

    Keyword         Meaning

    PORTRAIT        The page is oriented so that the larger dimension
                    is parallel to the vertical axis.
    LANDSCAPE       The page is oriented so that the larger dimension
                    is parallel to the horizontal axis.

    The default is PORTRAIT.

9.9  –  EIGHT_BIT_OUTPUT

    EIGHT_BIT_OUTPUT [ON,OFF] specifies whether the PostScript output
    converter should use 8-bit output. The default value is ON.

9.10  –  LAYOUT

    LAYOUT [ON,OFF] specifies whether the PostScript output converter
    processes the layout specified in the DDIF document. The default
    value is ON.

9.11  –  OUTPUT BUFFER SIZE value

    OUTPUT_BUFFER_SIZE value specifies the size of the output buffer.
    The value you specify must be within the range 64 to 256. The
    default value is 132.

9.12  –  PAGE_WRAP

    PAGE_WRAP [ON,OFF] specifies whether the PostScript output
    converter performs page wrapping of any text that would exceed
    the bottom margin. The default value is ON.

9.13  –  SOFT_DIRECTIVES

    SOFT_DIRECTIVES [ON,OFF] specifies whether the PostScript output
    converter processes soft directives in the DDIF file in order
    to format output. (Soft directives specify such formatting
    commands as new line, new page, and tab.) If the PostScript
    output converter processes soft directives, the output file will
    look more like you intended. The default value is ON.

9.14  –  WORD_WRAP

    WORD_WRAP [ON,OFF] specifies whether the PostScript output
    converter performs word wrapping of any text that would exceed
    the right margin. The default value is ON. If you specify OFF,
    the PostScript output converter allows text to exceed the right
    margin.
Close Help