hide random home http://www.sgi.com/tech/relnotes/insight.html (Silicon Surf Promotional CD, 01/1995)

insight Release Notes

insight Release Notes

1 Introduction

2 Installation Information

3 Changes and Additions

4 Known Problems and Workarounds

 



                                  - 1 -



       1.  Introduction

       This release note documents two components of the IRIS
       InSight family-IRIS InSight Viewer and Document Library.
       IRIS InSight Viewer lets you access Silicon Graphics' online
       document and support libraries. With this product, you can
       view the glossary of terms, the online Help, and the online
       versions of the standard end-user documentation set.  If you
       have purchased the IRIS Development Option, you can view the
       development documentation set.

       Note:  Packaged with this software is a separate sheet that
              contains the Software License Agreement.  This
              software is provided to you solely under the terms
              and conditions of the Software License Agreement.
              Please take a few moments to review the Agreement.

       The End-User Document Library in this release includes:

          o End-User Glossary of terms

       Other End-User books are parts of the products included in
       the IRIX Execution Environment products. Developer books are
       part of the products included in IDO Software Option.  Many
       other optional software products include books as well.

       Note:  Products such as the Support Partner Advantage
              (ptnr_lib) CD and the Support Advantage (supp_lib) CD
              contain their own release notes which should be
              consulted and used in conjunction with the IRIS
              InSight Viewer release notes.































                                  - 2 -



       These release notes contain the following chapters:

         1.  Introduction

         2.  Installation Information

         3.  Changes and Additions

         4.  Known Problems and Workarounds


       1.1  Release_Identification_Information

       Following is the release identification information for IRIS
       InSight:

       Software Option Product        IRIS InSight

       Version                        2.2.1
       Product Code                   SC4-W4D-5.2

       System Software Requirements   IRIX 5.2 or later



       1.2  Online_Release_Notes

       After you install the online release notes for a product
       (the relnotes subsystem), you can view the release notes on
       your screen.

       Select ``Release Notes'' from the Tools submenu of the
       Toolchest. This displays the grelnotes(1) graphical browser
       for the online release notes.

       Refer to the grelnotes(1) man page for information on
       options to this command.

       Note:  You can read the online release notes for most
              products before installing the software.  Refer to
              the booklet in your CD-ROM case for more information.

       1.3  Online_Help

       After you install the IRIS InSight Viewer product, you can
       view the online help that is available for the product.

       The online help can be accessed from the ``Help'' menu item
       of the library or the book windows.













                                  - 3 -



       1.4  Product_Support

       Silicon Graphics, Inc., provides a comprehensive product
       support maintenance program for its products.

       If you are in North America and would like support for your
       Silicon Graphics-supported products, contact the Technical
       Assistance Center at
       1-800-800-4SGI.

       If you are outside North America, contact the Silicon
       Graphics subsidiary or authorized distributor in your
       country.














































 



                                  - 1 -



       2.  Installation_Information

       This chapter lists information supplemental to the IRIS
       Software Installation Guide.  The information listed here is
       product-specific; use it with the Installation Guide to
       install this product.


       Note:  Products such as the Support Partner Advantage
              (ptnr_lib) CD and the Support Advantage (supp_lib) CD
              contain their own release notes which should be
              consulted and used in conjunction with the IRIS
              InSight Viewer release notes.  Please read those
              first for preliminary installation information.


       2.1  IRIS_InSight_Subsystems

       The IRIS InSight product family includes these subsystems:

       insight.books.help            IRIS InSight help

       insight.man.man               IRIS InSight man pages

       insight.man.relnotes          The online version of these
                                     release notes

       insight.sw.client             IRIS InSight software

       insight.sw.data               IRIS InSight data files

       insight_gloss.books.global    IRIS InSight Glossary


       2.2  IRIS_InSight_Subsystem_Disk_Space_Requirements

       This section lists the subsystems (and their sizes) of the
       IRIS InSight software.

       All of the subsystems are installed if you use the ``go''
       menu item.  To install a different set of subsystems, use
       the ``install,'' ``remove,'' ``keep,'' and ``step'' commands
       in inst to customize the list of subsystems to be installed,
       then select the ``go'' menu item.

       Note:  The listed subsystem sizes are approximate. Refer to
              the IRIS Software Installation Guide for information
              on finding exact sizes.

       Subsystem Name                Subsystem Size
                                     (512-byte blocks)











                                  - 2 -



       insight.books.help                    750

       insight.man.man                        15
       insight.man.relnotes                   35

       insight.sw.client                    9940
       insight.sw.data                      1410

       insight_gloss.books.global            830



       2.3  Installation_Method

       All of the subsystems for IRIS InSight can be installed
       using IRIX.  You do not need to use the miniroot. Refer to
       the IRIS Software Installation Guide for complete
       installation instructions.


       2.4  Prerequisites

       Your workstation must be running release 4D1-5.2 in order to
       use release 2.2.1 of IRIS InSight.

       If you want to install the IRIS InSight viewer
       (insight.sw.client) then you must also install x_eoe.sw.eoe,
       motif_eoe.sw.eoe, and ViewKit_eoe.sw.base for the viewer to
       function properly.  If you want to install the online help
       (insight.books.help) for the IRIS InSight viewer then you
       must install sgihelp.sw.eoe along with the viewer.

       2.5  Compatibility

       The IRIS InSight 2.X viewers are incompatible with the IRIS
       InSight 1.0 books.  You will not be able to install the
       older 1.0 books after a 2.X viewer is installed, due to
       incompatibility rules during installation.  However, we have
       no means of preventing users from mounting 1.0 books onto a
       2.X viewer's filesystem.

       2.6  Other_Installation_Information

       You can install IRIS InSight in three configurations:

          o Local client and server

          o Client with remote server

          o Client with server on CD-ROM












                                  - 3 -



          o Book Access from multiple (mixed) sources

       Important: Please read this section carefully. It details
                  installation information specific to the IRIS
                  InSight product.

       2.6.1  Local_Client_and_Server  The default installation
       configuration is to install the IRIS InSight Viewer and
       Document Library on a single system.  The total size of the
       viewer, glossary, and help is a little more than 6 Mb.
       Installing additional books requires additional disk space.
       See the Release Notes for products that contain books to
       find out the disk space requirements for each book.

       2.6.2  Client_with_Remote_Server  To install the IRIS
       InSight Viewer and Document Library on a remote server and
       access the information from a local client system, follow
       these steps:

         1.  On the server:

               a.  Install the complete IRIS InSight product image
                   and all books.

                   Inst> install insight *.books.*

               b.  Export the
                   /usr/share/Insight/library/SGI_bookshelves
                   directory using the System Manager.

         2.  On the client:

               a.  Install the insight.sw subsystems (you might
                   want to install the insight.man.man and the
                   insight.man.relnotes subsystems as well).

                   Inst> keep insight insight_gloss
                   Inst> install insight.sw

               b.  Mount
                   :/usr/share/Insight/library/SGI_bookshelves
                   on /usr/share/Insight/library/SGI_bookshelves.

                   mkdir /usr/share/Insight/library/SGI_bookshelves
                   mount :/usr/share/Insight/library/SGI_bookshelves \
                   /usr/share/Insight/library/SGI_bookshelves


       2.6.3  Client_with_Server_on_CD-ROM













                                  - 4 -



       Note:  If you have a version of the IRIS InSight Document
              Library installed on your disk but want to mount the
              books from the CD-ROM, you must remove all the
              current IRIS InSight books (with the IRIX command
              versions remove) from your system and remove any
              remaining files in /usr/share/Insight/library before
              creating the symbolic link described in step 2.

       If you wish to use the IRIS InSight Viewer and Document
       Library from the CD-ROM and access the information from a
       local or remote system, follow these steps:

         1.  On the system with the CD-ROM drive, insert the IRIS
             InSight CD into the CD-ROM drive.

             If the drive is not mounted, use the System Manager to
             mount the drive.  The most common mount point is
             /CDROM.

             If the drive is mounted correctly, you should be able
             to change directories to /CDROM and see all the files
             in the IRIS InSight CD:

             cd /CDROM
             ls

         2.  As root create a symbolic link from
             /usr/share/Insight/library/SGI_bookshelves to the CD
             mount point for the insight directory.  You may need
             to create the directory /usr/share/Insight/library if
             it doesn't exist.

             mkdir -p /usr/share/Insight/library
             ln -s /CDROM/insight/SGI_bookshelves
                   /usr/share/Insight/library/SGI_bookshelves

         3.  As root create a symbolic link from /usr/share/help to
             the CD mount point for the help directory.

             ln -s /CDROM/help /usr/share/help

             If you are sharing this CD-ROM mount point with other
             users on your network, export the root (``/'')
             directory and the /CDROM directory using the System
             Manager.

         4.  On each client:

               a.  Install the insight.sw subsystems (you might
                   want to install the insight.man.man and the
                   insight.man.relnotes subsystems as well).  You











                                  - 5 -



                   can get the installation software from the CD in
                   the /CDROM/dist directory.

                   su
                   inst -f /CDROM/dist
                   Inst> keep *
                   Inst> install insight.sw
                   Inst> go


               b.  If you are mounting the CD-ROM from a remote
                   system, as root mount :/CDROM/insight/SGI_bookshelves on
                   /usr/share/Insight/library/SGI_bookshelves. You
                   may need to create the directory
                   /usr/share/Insight/library/SGI_bookshelves if it
                   doesn't exist.

                   mkdir -p /usr/share/Insight/library/SGI_bookshelves
                   mount :/CDROM/insight/SGI_bookshelves \
                   /usr/share/Insight/library/SGI_bookshelves

               c.  If you are mounting the CD-ROM from a remote
                   system, mount :/CDROM/help on
                   /usr/share/help. You may need to create the
                   directory /usr/share/help if it doesn't exist.

                   mkdir -p /usr/share/help
                   mount :/CDROM/help /usr/share/help



       2.6.4  Book_Access_from_Multiple_Sources

       It is possible to read books from multiple sources in IRIS
       InSight.  This is useful, for example, if you want to access
       the books available on the IRIX 5.2 CD-ROM along with the
       books on your system disk.

       To do so involves making the appropriate mounts and links in
       the /usr/share/Insight/library directory so that InSight
       will find the books.  IRIS InSight assumes that every
       subdirectory of /usr/share/Insight/library/SGI_bookshelves
       is a directory of bookshelves. For example, you may find a
       directory called "SGI_EndUser" containing the end user
       books.

       Each bookshelf directory contains a set of books, via
       subdirectories and files. It is important to note that each
       bookshelf is an integral unit and you cannot access
       individual books on it via links. (However, you can via











                                  - 6 -



       selecting the appropriate books through inst.)

       To add a new bookshelf to IRIS InSight, it is sufficient to
       make a link or to mount a bookshelf directory in the
       /usr/share/Insight/library/SGI_bookshelves.

       For example, if you don't have the SGI_Admin bookshelf
       installed on your hard disk and you want to access it
       directly from the IRIX 5.2 CD-ROM, do the following:


       su
       ln -s /CDROM/insight/SGI_bookshelves/SGI_Admin \
       /usr/share/Insight/library/SGI_bookshelves/SGI_Admin

       Note:  These instructions assume the CD-ROM is mounted as
              /CDROM.

       The next time IRIS InSight is started it will now read the
       SGI_Admin bookshelf from the CD-ROM along with any books
       that were already on your hard disk.

       In this manner, any number of bookshelves may be added or
       removed from IRIS InSight.

       If you would like to access all the bookshelves from a CD-
       ROM, you can making individual links for each bookshelf by
       directly linking the complete SGI_bookshelves directory to
       the IRIS InSight library using the following commands:


       su
       ln -s /CDROM/insight/SGI_bookshelves \
       /usr/share/Insight/library/SGI_bookshelves

       Note:  These instructions assume that no books are installed
              on your hard disk. If you already have books
              installed on your hard disk, you must remove them
              using the IRIX command versions remove.  Each CD-ROM
              contains only books for the products on that CD-ROM.


       2.7  Execution_After_Installation

       After the software has been installed, you might want to
       force your shell to re-cache its list of known executables:

       rehash

       You can then execute the IRIS InSight Viewer.  It is known
       as insight, or iiv for short.  iiv stands for IRIS InSight











                                  - 7 -



       Viewer.  The Viewer process places itself in the background
       by default.

       iiv























































 



                                  - 1 -



       3.  Changes_and_Additions

       The changes to the IRIS InSight Viewer product since its
       last release are:

          o Advanced search feature added for library level and
            individual book searches.

          o Support for inline media now includes audio, video,
            CGM, and RGB images.

          o Additional functionality added to the bookshelves,
            including the ability to collapse and expand them in
            the library view. A popup menu is available via the
            right mouse button to select and deselect all books
            simultaneously.

          o Real-time scrolling in the table of contents.

          o Zooming of figures preserving the aspect ratio.

          o User definable bookmarks.

          o Horizontal orientation of table of contents and book
            content in book viewer.

          o Search cancel feature added.

          o Support for Internationalization of the viewer.

          o Numerous bugs fixed.




























 



                                  - 1 -



       4.  Known_Problems_and_Workarounds

       This chapter describes the known problems with the current
       release of the IRIS InSight Viewer and Library and how to
       work around them.

       4.1  IRIS_InSight_Library

       Some glossary terms might be missing from the Glossary.
       When you click on such a term, the complete glossary is
       brought up, instead of a small window with only that term.

       4.2  IRIS_InSight_Viewer

          o After installing a new version of the viewer, you
            should remove any local defaults that may have been
            left around by previous versions, in particular, this
            should be done when going from IRIS InSight version 1.0
            to an ungraded version.  To do this, give this command
            before executing IRIS InSight for the first time after
            an installation:

            rm ~/.insightrc

          o Scrolling in the viewer may seem ``jumpy'' due to the
            rendering of images inline.  A workaround is to use the
            line up and line down buttons in the scroll bar, or the
             and  buttons on the keyboard.
            Another alternative is to use the ``Settings...''
            option from the Options menu and click on
            ``Figures/Media In-line?'' to not include figures
            inline.

          o If the IRIS InSight viewer is running and a new book or
            set of books are installed, IRIS InSight will not
            immediately ``see'' and utilize the new content. In
            order for IRIS InSight to view the newly-installed
            book(s), close and restart the IRIS InSight
            application.

          o Occasionally, the book viewer window might be narrower
            than required to display the full width of a table.  A
            warning message:

            Your window is too narrow for this table.
            Please resize the width of the viewing area.

            might be generated to the window.  This is not harmful;
            simply widen the window to view the entire table.













                                  - 2 -



          o On systems with few bitplanes, the colors might flash
            due to the limited colormap.

          o Occasionally, the IRIS InSight viewer cannot be
            executed and fails with the error message X Error:
            BadDrawable. This is because the viewer cannot allocate
            enough colormap entries to create the views of the
            bookshelves. It has been found that exiting colormap-
            intensive applications (for example, an application
            that makes extensive use of video), and resetting the
            colormap (using /usr/sbin/makemap), can usually
            workaround this problem.

          o If blank pages appear when printing portions of a book
            (or a whole book) or if other printing problems occur,
            quit IRIS InSight, and type the following:

            rm ~/.insightrc

            Execute insight and try the print operation again.

            Make sure that when printing you select one or more
            entries in the Print Window Table-of-Contents area.

          o Printing portions of a book (or a whole book) with
            graphics included can often take a substantial period
            of time. You may wish to consider printing without
            including graphics. From the Print Window, click on
            ``Print Graphics?'' to not include graphics in the
            printed output.

          o For Systems Administrators, it should be noted that the
            directory /usr/share/Insight/tmp is installed as an
            ``open'' directory, with the permissions being set to
            755. This area is used to store an Insight user's
            bookmarks. Note that this area can be changed through
            the modification of the PUBLIC_DIR and PRIVATE_DIR
            variables found in the IRIS InSight system
            configuration file,
            /usr/share/Insight/system.insightrc.

       4.3  IRIS_InSight_Help

          o The help card titled ``Using the Topic/Task Navigator''
            documents a function of IRIS InSight that is only
            available after purchasing and installing the IRIS
            InSight Support Library.  Contact your local sales
            representative for more information on obtaining the
            IRIS InSight Support Library.