DEC VTX Information Provider's Guide

*HyperReader

  CONTENTS

  Title Page

  Copyright Page

  Preface

  1      What is VTX?

  1.1     VTX Components
    1.1.1      Platforms

  1.2     Who Does What?
    1.2.1      The VTX Service Provider
    1.2.2      The VTX Subscriber
    1.2.3      The VTX Application Provider
    1.2.4      The VTX Information Provider

  1.3     VTX Concepts
    1.3.1      What Is an Infobase?
    1.3.2      What Is a Page?
      1.3.2.1      Page Types
      1.3.2.2      Page Numbers
      1.3.2.3      Page Number Ranges
      1.3.2.4      Assigning Page Ranges
      1.3.2.5      Current Page Range
      1.3.2.6      Page Number Prefixes
    1.3.3      What Is a Keyword?
      1.3.3.1      Keyword Searches
        1.3.3.1.1       Duplicate Keyword Searches
        1.3.3.1.2       Generic Keyword Searches
        1.3.3.1.3       Context-Sensitive Keyword Searches
      1.3.3.2      How to Implement Context-Sensitive Keywords
      1.3.3.3      How the Server Finds Context-Sensitive Keywords
      1.3.3.4      Example of Context-Sensitive Keyword Use
    1.3.4      Keyword Searches on Remote Servers
      1.3.4.1      Example of Searching Keywords on a Remote Server

  1.4     The VTX Information Provider's Tools
    1.4.1      The Workbench
    1.4.2      The Update Server
    1.4.3      The VTX Automatic Page Management System (VTXAPMS) Utility
    1.4.4      Paginating Documents

  2      DECtalk Page Design Tips

  2.1     Introduction

  3      DEC VTX Workbench

  3.1     Introduction to the Workbench
    3.1.1      Workbench Components
    3.1.2      Workbench Concepts
      3.1.2.1      Integrating WBGI and WBCL
      3.1.2.2      Page Names
      3.1.2.3      Menu Structures
      3.1.2.4      Detached Pages

  3.2     DEC VTX Workbench Graphical Interface (WBGI)
    3.2.1      Getting Started With WBGI
      3.2.1.1      IP Tasks
      3.2.1.2      Screen Components
      3.2.1.3      Navigating a WBGI Screen
      3.2.1.4      Starting a WBGI Session
      3.2.1.5      Adding Menu Choices
      3.2.1.6      Specifying Page Text
      3.2.1.7      Adding Page Control Information
      3.2.1.8      Using Forms
      3.2.1.9      Specifying General Page Control Information
      3.2.1.10     Specifying Keyword Information
      3.2.1.11     Specifying Help and Template Page Information
      3.2.1.12     Specifying Remote Page Information
      3.2.1.13     Specifying Workbench Specific Information
      3.2.1.14     Saving Your Menu Structure
    3.2.2      Advanced WBGI Techniques
      3.2.2.1      Building a Second Menu Structure
      3.2.2.2      Viewing a Directory Listing
      3.2.2.3      Locating Updated Pages
      3.2.2.4      Inserting Choices
      3.2.2.5      Deleting and Undeleting Choices
      3.2.2.6      Moving Choices
      3.2.2.7      Including Pages from One Menu into Another
      3.2.2.8      Working with Detached Pages
        3.2.2.8.1       Adding Detached Pages
        3.2.2.8.2       Specifying Page Text for Detached Pages
        3.2.2.8.3       Specifying Control Information for Detached Pages
      3.2.2.9      Updating the VTX Infobase
      3.2.2.10     Specifying Form Page Information
      3.2.2.11     Creating a Form Page
        3.2.2.11.1      Creating Form Help Pages
        3.2.2.11.2      Providing Page Text and Control Information
      3.2.2.12     Changing a Page Name
    3.2.3      WBGI Reference
      3.2.3.1      WBGI Template
    ADD CHOICE
    DEL CHOICE
    DETACHED
    DIRECTORY
    EXIT
    EXTRACT
    HELP
    INCLUDE
    INS CHOICE
    LOCATE
    MOV CHOICE
    PAGE INFO
    PAGE TEXT
    QUIT
    SELECT
    UNDELETE
    UNRESERVE
    UPDATE
    VERIFY

  3.3     DEC VTX Workbench Command Language (WBCL)
    3.3.1      New Pages and Existing Pages
      3.3.1.1      Creating Pages
    3.3.2      Modifying Pages
      3.3.2.1      Defining Form Fields
    3.3.3      Including Page Text in a Loadfile
    3.3.4      Deleting Pages
    3.3.5      Workbench Loadfile
      3.3.5.1      Processing a Loadfile
    3.3.6      WBCL Reference
      3.3.6.1      WBCL Template
    BEGINPAGETEXT
    CREATE
    DELETE
    ENDPAGETEXT
    FIELD
    MODIFY
    3.3.7      Workbench Style Files
      3.3.7.1      Style File Format
    DEFINE CHOICES
    DEFINE ENTRIES
    DEFINE HEADER
    SET SCREEN
    SET MENU_TYPE
      3.3.7.2      Workbench Default Style Values

  3.4     Workbench Status Messages

  3.5     Converting Existing Pages to Workbench Format
    3.5.1      Converting an Infobase to Workbench Format

  4      VTXUPD Utility

  4.1     Methods for Updating Infobase Files
    4.1.1      Page Image Files
    4.1.2      VTU Files
    4.1.3      VTX Collection File
    4.1.4      Interactive Updating
    4.1.5      Modes of Operation

  4.2     VTXUPD Utility Command Mode
    4.2.1      Running the Utility
    4.2.2      Getting Help
    4.2.3      Infobase Access and Management Commands
    CLOSE/KEYWORD
    CLOSE/PAGE
    CONNECT
    CREATE/KEYWORD
    CREATE/PAGE
    DISCONNECT
    EXIT
    HELP
    MENU
    OPEN/KEYWORD
    OPEN/PAGE
    REBUILD
    SET
    4.2.4      Standard Infobase Manipulation Commands
    ADD/KEYWORD
    ADD/PAGE
    DELETE/KEYWORD
    DELETE/PAGE
    EXTRACT/KEYWORD
    EXTRACT/PAGE
    SHOW
    UPDATE
    4.2.5      Collection Infobase Manipulation Commands
    CHANGE
    COMPOSE
    ERASE
    LIST
    MARK
    READ
    SUBMIT
    WRITE
    4.2.6      DEC VTX Text Retrieval Commands
    CREATE/INDEX
    DELETE/INDEX
    INSERT/INDEX/KEYWORDFILE
    INSERT/INDEX/PAGEFILE
    INSERT/VISIBILITY_RANGE
    MODIFY/INDEX
    OPEN/INDEX
    REMOVE/INDEX/PAGEFILE
    REMOVE/INDEX/KEYWORDFILE
    REMOVE/VISIBILITY_RANGE
    SHOW/INDEX
    UPDATE/INDEX

  4.3     VTXUPD Utility Menu Mode
    4.3.1      Running the Utility in Menu Mode

  4.4     Navigating and Completing a Form
    4.4.1      Creating Infobase Files
      4.4.1.1      Creating the New VTD File
      4.4.1.2      Creating the New VTK File
    4.4.2      Updating the Files with the Collection Method
      4.4.2.1      Creating a Collection and Assigning Keywords
      4.4.2.2      Updating the VTD and VTK Files
    4.4.3      Exiting from the Utility
    4.4.4      Menu Mode Restrictions

  4.5     Enhancing VTXUPD Utility Performance
    4.5.1      Sorting
    4.5.2      Allocating Additional Buffers
    4.5.3      Extending Files and Preallocating Blocks
    4.5.4      Choosing Between the /SORT and /FAST_LOAD Qualifiers

  4.6     Special Form and Template Pages
    4.6.1      Updating Your Infobase with Special Pages
    4.6.2      Numbering Special Pages
      4.6.2.1      Structure of Special Page Numbers
        4.6.2.1.1       Prefix
        4.6.2.1.2       Page Type
        4.6.2.1.3       Protocol
        4.6.2.1.4       Language
        4.6.2.1.5       Form Field Help Page Number
        4.6.2.1.6       Example
    4.6.3      Login Pages
      4.6.3.1      Providing Relogin Capability
      4.6.3.2      Help Pages
    4.6.4      Usage Page
      4.6.4.1      Activating the Usage Page
    4.6.5      Personal Magazine Form Page
    4.6.6      Personal Magazine Template Page
    4.6.7      Dynamic Menu Template Page

  4.7     Determining Maximum Menu Choices and List Menu Entries
    4.7.1      Determining Page Number Size
    4.7.2      Calculating the Maximum Byte Count

  4.8     Error Messages

  5      VTXAPMS Utility

  5.1     Purpose of the VTXAPMS Utility

  5.2     Function of the Preprocessor

  5.3     Contents of the Extended VTU File
    5.3.1      Command Options
    5.3.2      Labels

  5.4     Page Assignment File

  5.5     Index Assignment File

  5.6     Standard VTU File

  5.7     Requirements for VTXAPMS Information Processing

  5.8     Getting Started
    5.8.1      Establishing Logical Names
    5.8.2      Starting and Stopping the VTXAPMS Utility
    5.8.3      Getting Help
    5.8.4      Creating the Page and Index Assignment Files
    5.8.5      Populating the Page Assignment File
      5.8.5.1      Categorizing the Information
      5.8.5.2      Creating Page Groups
    5.8.6      Populating the Index Assignment File
      5.8.6.1      Creating the Menus

  5.9     Creating and Processing Extended VTU Files

  5.10    Extended VTU File Format
    5.10.1     Extended VTU Files and Processed Output
    5.10.2     Processing Extended VTU Files
      5.10.2.1     Using the SUBMIT Command
      5.10.2.2     Using the BUILD Command
    5.10.3     Recovering from Errors
    5.10.4     Updating the Infobase

  5.11    VTXAPMS Utility Commands
    5.11.1     Bulk Page Manipulation Commands
    BUILD
    EXIT
    HELP
    PURGE
    SUBMIT
    5.11.2     Index (Menu) Manipulation Commands
    CREATE/INDEX
    INITIALIZE/INDEX
    MODIFY/INDEX
    REMOVE/INDEX
    SHOW/INDEX
    5.11.3     Page Group Manipulation Commands
    CREATE/PAGE
    INITIALIZE/PAGE
    MODIFY/PAGE
    REMOVE/PAGE
    SHOW/PAGE

  5.12    Error Messages

  6      Paginating Documents

  6.1     Paginating WPS-PLUS Documents
    6.1.1      Contents of the Header File
    6.1.2      Making the Header File Available
      6.1.2.1      Transferring the Header File
      6.1.2.2      Creating the Library Document
    6.1.3      Using the Library Document
    6.1.4      Controlling Pagination Through WPS-PLUS
    6.1.5      Sending the WPS-PLUS Document to the VTX Print Queue
    6.1.6      Printing the WPS-PLUS Document

  6.2     Paginating Text Files and DDIF Documents
    6.2.1      Customizing Page Appearance
      6.2.1.1      Contents of the Options File
      6.2.1.2      Sample Options File
    VTX/PAGINATE Command

  7      Error Messages

  EXAMPLES

  5-1        First Page Group Display Page

  5-2        First Display Page After Processing

  5-3        Second Page Group Display Page

  5-4        Second Display Page After Processing

  5-5        Primary and Continuation Pages in an Extended VTU File

  5-6        Primary and Continuation Pages After Processing

  6-1        Header File Contents

  6-2        Customizing Page Appearance with an Options File

  FIGURES

  3-1        WBGI Screen Components

  3-2        Initial WBGI Menu

  3-3        Initial MAIN Menu Structure

  3-4        WBGI Response to an ADD CHOICE Request

  3-5        Specifying Three Menu Choices

  3-6        The Three Menu Choices Displayed

  3-7        Making INDUSTRY NEWS the Current Menu

  3-8        Subordinate Menu Structure

  3-9        Three-Level Menu Structure

  3-10       Adding Menu Choices to the PRODUCT INFORMATION Menu

  3-11       Options for Specifying Page Text

  3-12       PAGE INFO Options

  3-13       Sample General Page Control Information Form

  3-14       Sample Keyword Information Form

  3-15       Sample Template and Help Page Information Form

  3-16       Sample Remote Page Information Form

  3-17       Sample Workbench Specific Information Form

  3-18       Creating a New Structure

  3-19       New Menu Structure

  3-20       Directory Listing

  3-21       Located Pages Listing

  3-22       Result of a LOCATE Operation

  3-23       Inserted Menu Choices

  3-24       Deleted Menu Choices

  3-25       Menu Structure After Five Deletions

  3-26       Undeleting the INDUSTRY NEWS Menu

  3-27       Result of a MOV CHOICE Selection

  3-28       Repositioned Menu Structure

  3-29       INDUSTRY NEWS in its Original Location

  3-30       WBGI's Response to a Wildcard

  3-31       EMPLOYEE DISCOUNTS Page Included Under PRODUCT INFORMATION Menu

  3-32       DETACHED Option Menu

  3-33       Detached Pages

  3-34       PAGE INFO Options

  3-35       Sample General Page Control Information Form

  3-36       Sample Remote Page Information Form

  3-37       Sample Keyword Information Form

  3-38       Screen After an Update Operation

  3-39       Form Page Template

  3-40       Completed Form Page Template

  3-41       Filled in Form Page Information Form (1 of 3)

  3-42       Filled in Form Page Information Form (2 of 3)

  3-43       Filled in Form Page Information Form (3 of 3)

  3-44       Sample Menu Structure Files in VTX$WORKBENCH Subdirectory

  3-45       General Page Control Information Form

  3-46       Keyword Information Form

  3-47       Template and Help Page Information Form

  3-48       Remote Page Information Form

  3-49       Workbench Specific Information Form

  3-50       Form Page Information Form

  3-51       Default Style Values

  3-52       Default Style Menu Display

  4-1        VTXUPD Utility Main Menu

  4-2        CREATE Form

  4-3        CREATE Form with PAGE File Field Selected

  4-4        Completed CREATE Form for the Page File

  4-5        Main Menu with Page File Range Messages

  4-6        CREATE Form with KEYWORD File Field Selected

  4-7        Completed CREATE Form for the Keyword File

  4-8        Main Menu with Keyword File Range Message

  4-9        COMPOSE-1 Form

  4-10       Completed COMPOSE-1 Form

  4-11       COMPOSE-2 Form

  4-12       COMPOSE - KEYWORDS Form

  4-13       COMPOSE - KEYWORDS Form Showing First Keyword

  4-14       SUBMIT Form

  4-15       SUBMIT Form with Asterisk for Page Number

  5-1        VTXAPMS Information Processing Cycle

  5-2        Generic Industries' Infobase Hierarchy

  TABLES

  1 Structure of This Guide

  1-1        Keyword Searches, Case A: Connected to SERVER_A

  1-2        Keyword Searches, Case B: Connected to SERVER_B Through SERVER_A

  3-1        Navigating in WBGI

  3-2        DELETE Option Keypad Functions

  3-3        EXTRACT Option Keypad Functions

  3-4        PAGE INFO Option Keypad Functions

  3-5        Command Format

  4-1        Summary of Commands

  4-2        Navigating on a Form

  4-3        Login Page Numbers

  4-4        Usage Page Numbers

  4-5        Personal Magazine Form Page Numbers

  4-6        Personal Magazine Template Page Numbers

  4-7        Dynamic Menu Template Page Numbers

  5-1        Summary of VTXAPMS Utility Commands