Reference Manual

*HyperReader

  CONTENTS

  Title Page

  Copyright Page

  Preface

  Summary of New Features

  1      CDA Item Data Types and Default Values

  1.1     CDA Item Data Types

  1.2     CDA Default Values

  2      DDIF Structures

  2.1     Overview of DDIF
    2.1.1      Document Content
      2.1.1.1      Document Hierarchy
      2.1.1.2      Document Root
      2.1.1.3      Document Descriptor
      2.1.1.4      Document Header
      2.1.1.5      Root Segment
        2.1.1.5.1       Text Content
        2.1.1.5.2       Graphics Content
        2.1.1.5.3       Image Content
        2.1.1.5.4       Computed Content
        2.1.1.5.5       Galley Layout Content
        2.1.1.5.6       Restricted Content
        2.1.1.5.7       Private Data
      2.1.1.6      Relationships in Revisable Documents
        2.1.1.6.1       Initial Values
        2.1.1.6.2       Attribute Inheritance
        2.1.1.6.3       Generic Attributes
        2.1.1.6.4       Specific Attributes
        2.1.1.6.5       Generic Types
        2.1.1.6.6       References to Generic Types
        2.1.1.6.7       Generic Content
        2.1.1.6.8       References to Generic Content
        2.1.1.6.9       Variables
        2.1.1.6.10      Style Guide
      2.1.1.7      Example of Document Content
    2.1.2      Document Layout
      2.1.2.1      Page Description
      2.1.2.2      Page Set
      2.1.2.3      Page Layout
      2.1.2.4      Galley
      2.1.2.5      Implementation of Layout Separation
        2.1.2.5.1       Wrap Attributes
        2.1.2.5.2       Layout Attributes
      2.1.2.6      Content Streams in Layout

  2.2     Hierarchy of DDIF Aggregates
    2.2.1      Conventions
    2.2.2      Generic Aggregate Items
    2.2.3      Summary of DDIF Aggregates
    2.2.4      DDIF Document Structure Overview
    2.2.5      Document Information Aggregates
      2.2.5.1      Document Root Aggregate
      2.2.5.2      Document Descriptor Aggregate
      2.2.5.3      Document Header Aggregate
      2.2.5.4      Document Segment Aggregate
        2.2.5.4.1       Segment Attributes
        2.2.5.4.2       Generic Layout
        2.2.5.4.3       Specific Layout
        2.2.5.4.4       Document Content
    2.2.6      Document Content Aggregates
      2.2.6.1      Text Content Aggregates
        2.2.6.1.1       Latin1 Text Content Aggregate
        2.2.6.1.2       General Text Content Aggregate
      2.2.6.2      Directives
        2.2.6.2.1       Hard Directive Aggregate
        2.2.6.2.2       Soft Directive Aggregate
        2.2.6.2.3       Hard Value Directive Aggregate
        2.2.6.2.4       Soft Value Directive Aggregate
      2.2.6.3      Graphics Content
        2.2.6.3.1       Bézier Curve Content Aggregate
        2.2.6.3.2       Polyline Content Aggregate
        2.2.6.3.3       Arc Content Aggregate
        2.2.6.3.4       Fill Area Set Content Aggregate
      2.2.6.4      Image Content
      2.2.6.5      Content Reference Aggregate
      2.2.6.6      Layout Galley Aggregate
      2.2.6.7      Restricted Content
        2.2.6.7.1       External Content
        2.2.6.7.2       Private Content
    2.2.7      Segment Attributes Aggregate
      2.2.7.1      General Segment Attributes
        2.2.7.1.1       Private Data
        2.2.7.1.2       Segment Bindings
        2.2.7.1.3       Counter Variables
        2.2.7.1.4       List Variables
      2.2.7.2      Computed Content Attributes
      2.2.7.3      Structure Attributes
      2.2.7.4      Language Attributes
      2.2.7.5      Legend and Measurement Attributes
      2.2.7.6      Alternate Presentation
      2.2.7.7      Layout
        2.2.7.7.1       Galley-Based Layout
        2.2.7.7.2       Path-Based Layout
        2.2.7.7.3       Position-Relative Layout
        2.2.7.7.4       Text Position Layout
      2.2.7.8      Font Definitions
      2.2.7.9      Pattern Definitions
      2.2.7.10     Path Definitions
      2.2.7.11     Line-Style Definitions
      2.2.7.12     Content Definitions
      2.2.7.13     Type Definitions
      2.2.7.14     Text Attributes
      2.2.7.15     Line Attributes
      2.2.7.16     Marker Attributes
      2.2.7.17     Galley Attributes
      2.2.7.18     Image Attributes
      2.2.7.19     Image Component Space Attributes
      2.2.7.20     Frame Parameters

  2.3     Aggregate Definitions

  DDIF$_ARC

  DDIF$_BEZ

  DDIF$_CPH

  DDIF$_CRF

  DDIF$_CTD

  DDIF$_CTS

  DDIF$_DDF

  DDIF$_DHD

  DDIF$_DSC

  DDIF$_ERF

  DDIF$_EXT

  DDIF$_FAS

  DDIF$_FTD

  DDIF$_GLA

  DDIF$_GLY

  DDIF$_GTX

  DDIF$_HRD

  DDIF$_HRV

  DDIF$_IDU

  DDIF$_IMG

  DDIF$_LG1

  DDIF$_LIN

  DDIF$_LL1

  DDIF$_LS1

  DDIF$_LSD

  DDIF$_LW1

  DDIF$_OCC

  DDIF$_PGD

  DDIF$_PGL

  DDIF$_PGS

  DDIF$_PHD

  DDIF$_PJD

  DDIF$_PLJ

  DDIF$_PTD

  DDIF$_PTH

  DDIF$_PVT

  DDIF$_RCD

  DDIF$_RGB

  DDIF$_SEG

  DDIF$_SFT

  DDIF$_SFV

  DDIF$_SGA
    General Segment Attributes
    Computed Content Attributes
    Copied and Remote Computed Content
    Variable Computed Content
    Cross-Reference Computed Content
    Function Computed Content
    Structure Description
    Language Attributes
    Legend Attributes
    Measurement Attributes
    Alternate Presentation Attribute
    Layout Attributes
    Galley-Based Layout
    Path-Based Layout
    Position-Relative Layout
    Text Position Layout
    Font Definitions
    Pattern Definitions
    Path Definitions
    Line-Style Definitions
    Content Definitions
    Type Definitions
    Text Attributes
    Text Mask Pattern
    Text Font
    Text Rendition
    Text Size
    Text Direction
    Text Character Decimal Alignment
    Text Leader
    Text Kerning
    Text Background
    Force Horizontal
    Line Attributes
    Marker Attributes
    Galley Attributes
    Image Attributes
    Image Component Space
    Frame Parameters
    Frame Flags
    Frame Bounding Box
    Frame Outline
    Frame Clipping
    Frame Position
    Fixed Frame
    Inline Frame
    Galley Frame
    Margin Frame
    Frame Content Transformation
    Item Change List
    Polyline Join Definitions

  DDIF$_SGB
    Counter Variable Values
    Computed Variable Values
    List Variable Values

  DDIF$_TBS

  DDIF$_TRN

  DDIF$_TXT

  DDIF$_TYD

  3      DTIF Structures

  3.1     Overview of DTIF
    3.1.1      DTIF Table Structure
      3.1.1.1      DTIF Document Hierarchy
      3.1.1.2      DTIF Document Root
      3.1.1.3      DTIF Document Descriptor
      3.1.1.4      DTIF Document Header
        3.1.1.4.1       Private Data
        3.1.1.4.2       External References
        3.1.1.4.3       Languages
        3.1.1.4.4       Language Preference Tables
        3.1.1.4.5       Generic Column Attributes
      3.1.1.5      DTIF Tables
        3.1.1.5.1       Metadata
        3.1.1.5.2       Column Attributes
        3.1.1.5.3       Ranges
        3.1.1.5.4       Windows
        3.1.1.5.5       Rows
        3.1.1.5.6       Cells
        3.1.1.5.7       Cell Coordinates
    3.1.2      Format Information
    3.1.3      Sample DTIF Table and Analysis Back End Output

  3.2     Hierarchy of DTIF Aggregates
    3.2.1      Conventions
    3.2.2      Generic Aggregate Items
    3.2.3      Summary of DTIF Aggregates
    3.2.4      DTIF Document Structure Overview
    3.2.5      DTIF Document Information Aggregates
      3.2.5.1      Document Root Aggregate
      3.2.5.2      Document Descriptor Aggregate
      3.2.5.3      Document Header Aggregate
        3.2.5.3.1       External Reference Aggregate
        3.2.5.3.2       Language Preference Table Aggregate
        3.2.5.3.3       Column Attributes Aggregate
        3.2.5.3.4       Format Information Aggregate
        3.2.5.3.5       Expression Aggregate
    3.2.6      Table Definition Aggregates
      3.2.6.1      Table Metadata Aggregates
        3.2.6.1.1       Range Aggregate
      3.2.6.2      Window Aggregate
      3.2.6.3      Row Aggregate
        3.2.6.3.1       Cell Data Aggregate

  3.3     Aggregate Definitions

  DTIF$_ARD

  DTIF$_CAT

  DTIF$_CCD

  DTIF$_CFT

  DTIF$_CLD

  DTIF$_CLR

  DTIF$_COR

  DTIF$_DAT

  DTIF$_DSC

  DTIF$_DTF

  DTIF$_ERF

  DTIF$_EXT

  DTIF$_FMI

  DTIF$_HDR

  DTIF$_LPT

  DTIF$_NES

  DTIF$_NMR

  DTIF$_NVL

  DTIF$_RNG

  DTIF$_ROW

  DTIF$_RWR

  DTIF$_TBL

  DTIF$_TMD

  DTIF$_VTX

  DTIF$_WND

  4      CFE Structures

  4.1     Generic Aggregate Items

  4.2     Summary of CFE Aggregates

  4.3     Aggregate Definitions

  CFE$_CCD

  CFE$_CFT

  CFE$_CLR

  CFE$_COR

  CFE$_DAT

  CFE$_EXL

  CFE$_EXP

  CFE$_FRF

  CFE$_NPM

  CFE$_PEX

  CFE$_PFE

  CFE$_RWR

  CFE$_SLL

  CFE$_STF

  CFE$_STP

  CFE$_TXC

  CFE$_VTX

  5      ESF Structures

  5.1     Generic Aggregate Items

  5.2     Summary of ESF Aggregates

  5.3     Aggregate Definitions

  ESF$_DAT

  ESF$_EDS

  ESF$_EXT

  ESF$_NVL

  ESF$_RPT

  ESF$_TXS

  6      CDA Access Routines

  6.1     CDA Access Routines
    6.1.1      Root Aggregate Management Routines
    6.1.2      Aggregate Management Routines
      6.1.2.1      Aggregate Structuring Routines
      6.1.2.2      Aggregate Reading Routines
      6.1.2.3      Aggregate Writing Routines
      6.1.2.4      Aggregate Input Support Routines
      6.1.2.5      Aggregate Output Support Routines
      6.1.2.6      Item Access Routines
    6.1.3      File Management Routines
    6.1.4      Text File Management Routines
    6.1.5      Stream Management Routines
    6.1.6      Aggregate Conversion Management Routines
    6.1.7      Message Facility Routines
      6.1.7.1      Retrieving CDA Access Routine Messages
      6.1.7.2      Integrating Logged Messages through a Common Message Log
      6.1.7.3      Enhanced Message Reporting

  6.2     Methods of Reading and Writing Documents
    6.2.1      Reading Documents Using the Incremental and Document Methods
      6.2.1.1      Incremental Method of Reading Document Data
      6.2.1.2      Incremental Method of Reading Table Data
      6.2ţ~~~     ~ ~~