[Contents] [Intro] [Reference] [Tutorial] [Question [New [Index]
Overview -> General Information -> Using the Online-Documentation

[daVinciLogo] - Online Documentation V2.1

Using the Online Documentation


The daVinci online documentation is the set of HTML pages you are currently reading. For best results the documentation should be loaded in the Netscape Navigator WWW browser. The search engine of the documentation is written in Java which is available in Navigator 2.0 or higher. Further, the daVinci help system communicates with Netscape to display particular pages of the online documentation when the user requests for help, e.g. by pressing the help button in a dialog window. The help system does not work with other browsers. Refer to Questions & Answers for a PostScript version of the documentation (Warning: information is lost in the Postscript documentation because hyperlinks are not present there!). The HTML hypertext approach has several advantages:

HTML is a format for hypertexts and can be loaded in a WWW browser. By clicking on one of the blue underlined links or buttons, you can go to another page where more information is provided about the link. Most browsers offer the opportunity to go back and forth according to the followed links and to see the history of previously visited pages. These navigation features are very important to avoid getting lost in the daVinci online documentation. Consult the manual of your browser for details about navigation.

Using the Online Documentation together with daVinci

Of course the online documentation can be read "stand-alone" with any kind of WWW browser by loading file overviewF.html, the topmost page of the documentation. If you have installed the Netscape Navigator browser, version 1.1 or higher, daVinci will be able to communicate with the browser to display particular HTML pages when the user requests for help. This communication only works with Netscape Navigator at the moment, so it is strongly recommended to use this software together with daVinci. Product informations about Netscape Navigator are available in WWW.

After you have successfully installed Netscape, daVinci should be able to communicate with the browser by default. This is true if:

  1. You are able to start Netscape by typing netscape in your UNIX shell. This means that the Netscape binary must have its default name and can be found in one of the directories specified by your environment variable $PATH.
    Note: If netscape is a shell script at your site, make sure that the script passes the commandline arguments to the Netscape binary (by using $*), otherwise it is not possible to use daVinci's help system.

  2. You have set environment variable $DAVINCIHOME to the directory where the daVinci binary is inside (i.e the topmost directory of the daVinci V2.x distribution). Further, this directory must contain the online documentation in the docs directory (this is default).
If these two conditions are not true, you can specify both the location and name of the Netscape binary and the daVinci online documentation by using the Options/General Settings... dialog window in daVinci and saving the options with menu Options/Save Options afterwards. By starting daVinci for the first time, the system will try to launch Netscape to present the introduction page of the online documentation. So this way you can easily find out if communication with the WWW browser works.

Technically, daVinci does not start the browser each time as a new process. Instead, Netscape is called with the -remote option. This command looks for an already open browser and gives instruction to load a particular URL. Otherwise, if no Netscape process is currently running, a new browser will be started.

How to get help in daVinci

First of all, daVinci must be able to communicate with Netscape. Read above for details about this issue. There are three different ways to access the online documentation and help system: Note: It may take some time after calling the help system to display the particular page in Netscape, so please be patient and do not press a help button more than one time.

Roadmap to the Online Documentation

The entry to the online documentation is the overview page. There you can find links to the seven chapters of the documentation:
  1. General Information:
    Everything a starter needs to know about daVinci: Installation, licence, introduction, and concepts.

  2. User Interface
    This chapter explains how to work with daVinci's Motif user interface. The help system refers to these pages, so usually there is no need to read the whole chapter. Instead, read the tutorial and use this chapter as a reference when questions or problems occur.

  3. Tutorial
    The tutorial is a guided tour through daVinci V2.1.x to learn about all features.

  4. Questions & Answers
    This chapter is a summary of solutions for frequently asked questions.

  5. New Features in daVinci V2.1.x
    A list of modifications compared to previous release daVinci V2.0.x.

  6. Reference
    Detailed information about particular aspects of daVinci: Term representation (daVinci's graph format), application programmer interface (API), PostScript interface, program options, tools available in the distribution, bibliography.

  7. daVinci in the Internet
    Survey about important daVinci resources in the Internet: WWW-server, e-mail address, mailing list, bugreport, etc. Do not miss to read it!

Features of the Online Documentation

Each page of the documentation has a header with seven buttons which can be selected for direct access to frequently used pages. Click on these buttons to go to the corresponding pages:
[Contents] [Intro] [Reference] [Tutorial] [Question [New [Index] Underneath these buttons, you can see the location of the particular page in the online documentation. By clicking on the links, you have direct access to parent pages. For example, here is the location of this page (also displayed at the header of this page above): Overview -> General Information -> Using the Online-Documentation Furthermore, the overview page has some additional functionality by clicking on the folder icons:
Click it to open the folder. This shows the content of the corresponding chapter.


Click it to close an opened folder.


Click it to open all folders in one step. Another click on this icon undos this operation by closing all folders.

The index page features a search engine to find any keyword in the online documentation. The search engine is written in Java and requires a Java compliant WWW browser such as Netscape 2.0 or higher. Instructions for using the search engine can be found on the index page.


daVinci V2.1 Online Documentation - Page update: June 15, 1998