DECdocument Producing Online and Printed Documentation

*HyperReader

CONTENTS

  Title Page

  Copyright Page

  Preface

  Part I   Writing a Document

  1      Introduction to DECdocument
    1.1 Writing Books for Both Printed and Bookreader Display
      1.1.1      Topics and Online Chunks
      1.1.2      Graphics Concepts
    1.2 Using the DOCUMENT Command Line

  2      Getting Started with DECdocument
    2.1 Global Tags and Doctype-Specific Tags
    2.2 Tags and Tag Arguments
    2.3 Basic Text Elements
      2.3.1      Chapters
      2.3.2      Headings and Subheadings
      2.3.3      Paragraphs
      2.3.4      Lists
    2.4 Controlling the Output of a Document
      2.4.1      Starting New Pages
      2.4.2      Starting New Lines
      2.4.3      Keeping a Text String on One Line
      2.4.4      Specifying Final Formatting
    2.5 Other Features
      2.5.1      Emphasizing Words and Phrases
      2.5.2      Using Footnotes in Text, Headings, and Tables
        2.5.2.1      Using Footnotes in Text
        2.5.2.2      Using Footnotes in Headings
        2.5.2.3      Using Footnotes in Tables
      2.5.3      Using Change Bars
      2.5.4      Coding Hyphens and Dashes in Text
      2.5.5      Dividing a Document into Separate Parts
    2.6 Considerations for Bookreader Display
      2.6.1      Dividing Long Sections or Examples into Online Chunks
      2.6.2      Setting Online Topic Levels
        2.6.2.1      Controlling the Topic Level Bookreader Displays
        2.6.2.2      Specifying the Online Topic Level within a File
      2.6.3      Changing Topic Labels
      2.6.4      Creating Online Popups

  3      Creating Tables, Figures, and Examples
    3.1 Tables
      3.1.1      Making Tables Formal or Informal
      3.1.2      Dividing a Table into Units
      3.1.3      Coding a Table with a Key
      3.1.4      Setting up Nested Tables
      3.1.5      Controlling Table Attributes
        3.1.5.1      Controlling the Width and Size of Table Text
        3.1.5.2      Controlling Page Breaks in Tables
      3.1.6      Additional Table Tags
    3.2 Figures
      3.2.1      The DECdocument Graphics Editor
      3.2.2      Making Figures Formal or Informal
      3.2.3      Figure Elements
      3.2.4      Controlling Figure Attributes
        3.2.4.1      Controlling Figure Margins
        3.2.4.2      Controlling Page Breaks in Figures
      3.2.5      Including Graphics Files
    3.3 Examples
      3.3.1      Making Examples Informal
      3.3.2      Making Examples Formal
    3.4 Considerations for Bookreader Display
      3.4.1      Preparing Informal Tables, Figures, and Examples for Bookreader Display
      3.4.2      Preparing Formal Tables, Figures, and Examples for Bookreader Display

  4      Providing Cross-References and Symbol Names
    4.1 When to Use Symbol Names to Cross Reference
    4.2 Creating Symbol Names
    4.3 Referring to Symbol Names
    4.4 Storing Symbol Names in Separate Files
    4.5 Storing Symbol Names in a Cross-Reference File
    4.6 Creating Hotspots for Any Piece of Text
    4.7 Automatically Generating Symbol Names

  5      Creating an Index
    5.1 Index Entries in Printed and Bookreader Books
    5.2 Using Tags to Create an Index
    5.3 Correct Placement of Index Tags
      5.3.1      Using Index Tags in Text
      5.3.2      Using Index Tags in Tables
      5.3.3      Using Index Tags in Figures and Examples
    5.4 Controlling Index Attributes
    5.5 Specifying Individual and Master Index Entries

  6      Creating Front Matter
    6.1 Front Matter Tags
    6.2 Front Matter Components
      6.2.1      Title Page
      6.2.2      Copyright Page
      6.2.3      Table of Contents
      6.2.4      Preface
        6.2.4.1      Specifying a Beginning Preface Page Number for a Printed Book
    6.3 Bookreader Formatting Tags for the License Management Facility (LMF)
      6.3.1      Using the <LMF> Tags
      6.3.2      Sample Front Matter File

  7      Creating an Appendix and a Glossary
    7.1 Creating an Appendix
    7.2 Creating a Glossary
    7.3 Displaying Glossary Entries in an Online Table of Contents

  Part II   Processing a Printed Document

  8      How DECdocument Processes an SDML File
    8.1 DECdocument Processors
    8.2 Informational Messages

  9      Processing and Printing Files and Books
    9.1 Processing Single Files
    9.2 Controlling File Processing
      9.2.1      Keeping Intermediate Files (Using /KEEP)
      9.2.2      Processing in Batch Mode (Using /BATCH)
      9.2.3      Altering Page Alignment (Using /DEVICE_CONVERTER)
      9.2.4      Including Additional Files (Using /INCLUDE)
      9.2.5      Setting Conditions for Files (Using /CONDITION)
      9.2.6      Including a Symbols File (Using /SYMBOLS)
      9.2.7      Assigning a New Output File Name (Using /OUTPUT)
    9.3 Processing Intermediate Files
    9.4 Printing Processed Files
    9.5 Processing Selected Pages
    9.6 Bookbuilding
      9.6.1      Creating Input Files
      9.6.2      Creating a Profile
      9.6.3      Processing a Profile
    9.7 Generating a Table of Contents
    9.8 Processing an Index
      9.8.1      Processing a Master Index
      9.8.2      Controlling Index Processing from the Command Line
    9.9 Processing an Element of a Book
    9.10 Processing a Subelement of a Book

  10     Diagnosing Errors in a Printed Book

  Part III   Processing a Book for Bookreader

  11     Building and Viewing a Book for Bookreader
    11.1 Bookshelf File Structure
    11.2 Preparing to Build a Bookreader Book
    11.3 Book Naming Conventions
    11.4 Building a Bookreader Book
      11.4.1     Online Doctypes and Destination for Bookreader
      11.4.2     Building the DECW$BOOK File
      11.4.3     Processing an Online Table of Contents
      11.4.4     Processing an Online Index
    11.5 Viewing a Processed Book
      11.5.1     Viewing a Book from a Private Directory
      11.5.2     Viewing a Book from the System Directory
      11.5.3     Defining the DECW$BOOK Logical
    11.6 Customizing a Library

  12     Diagnosing Errors in a Bookreader Book

  Part IV   Practical Exercises

  13     Practical Exercises
    13.1 EXERCISE_CHAP1.SDML
    13.2 EXERCISE_CHAP2.SDML
    13.3 Creating Front Matter
    13.4 Creating a Profile
    13.5 Building the Booklet
      13.5.1     Processing the Printed Booklet
      13.5.2     Processing the Online Booklet
    13.6 Copying the Processed Booklet

  A Using LSE with DECdocument
    A.1 Using LSE with DECdocument
      A.1.1      Entering Source Code Using Tokens and Placeholders
      A.1.2      Compiling Source Code
      A.1.3      Examples
        A.1.3.1      Lists
        A.1.3.2      Tables
        A.1.3.3      Profile
        A.1.3.4      Sample Template
      A.1.4      DECdocument Tokens and Placeholders

  Glossary
    G.1 Conventions
      argument . . . context-sensitive tag
      cross-reference file . . . element build
      file type . . . hotspot
      HTML . . . LETTER
      License Management Facility (LMF) . . . online chunk
      online topic . . . routine template
      SDML . . . tag
      tag template . . . VAX Language-Sensitive Editor