Help on the Viewer

  Adding of New Docsets To The Configuration:

   There are three ways to add a new docset to the configuration:
  • Open the docset manager using the button and then click the "Add Docset..." button.
  • Open a new docset in the viewer window (all the frames should be visible in the window) and then click the button.
  • Edit the configuration file.
  •   The J2SE Docsets:

            There may be number of J2SE docsets in the configuration, but only one from them may be enabled each time. By default, the viewer uses the mustang javadoc set. It is recommended to download and install a zipped J2SE docset here (use the context menu to open the link in an external browser), add it to the configuration and enable.

      The bookmarks:

            Bookmark can be added by using the context menu of the bookmark tab; or link(s) can be dropped there from an external application (like firefox), or from the desktop using D&D. It is allowed to drop a number of the links at once. Also D&D may be used to reorder the bookmarks and folders. The bookmarks, also can be dragged from the viewer to an external application.

    If one drops a bookmark (a folder, or a link) to an existing bookmark or a closed folder, the dropped item will be inserted above the existing one. After that, it is possible to use D&D again if it is necessary to reorder the items. It is necessary to open a folder to add or move an item there. An exception is that if one drags an open folder item and drops it to the same folder, the item will be moved from the folder to the location above it.

      The Keystrokes:

        -- [BackSpace] returns the viewer to the previous page. 
        -- [CTRL]+C copy selected text to the clipboard.
        -- [CTRL]+F search on the page.
        -- F3 search again.
        -- F1 show this page.
        -- [CTRL]+Q quit the application.
      

      HTTP Proxy Configuration:

            To use an HTTP proxy select the Options option of the context menu.
    Note: there is a bug in the j2se 1.5.0 stack that disallows to reach any URL's those have a "hash" when the server sends a redirect (like http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode() ) and the viewer uses a proxy.
    (j2se build 1.6.0-beta-b59g also has the same bug)
    As the workaround current version of the viewer uses the mustang docset instead of the j2se 1.5.0 javadoc set as a default one.
    You may need to restart the viewer after the proxy options change.

      The password authentication:

            The viewer supports the HTTP password authentication, including the HTTP proxy authentication. The authentication info can be stored in the wallet. The wallet uses Blowfish encryption with 128 bits key based on your master password. The master password itself is not stored in the wallet (only its MD5-hash).

      The cookie support:

            The viewer treats all cookies as session cookies now.

      The SSL support:

            There is a basic SSL-support in the viewer. Use the context Page/Frame menus to look at the cipher suite.

      Command Line Arguments:

            It is possible to pass an URL as an argument with the viewer command line, for example: java -jar globaldocs.jar http://java.sun.com.
    If there is a running instance of the viewer on the display then the URL will be opened in this running viewer, otherwise a new viewer will be started and the URL will be opened there. The viewer uses a special RPC to communicate between JVM's. This mechanism was designed to integrate the viewer to various IDE's in the future.

      The Configuration File:

      
       
           The viewer keeps its configuration
         in the file:  $HOME/.globaldocs/config.xml 
         (in the MS-Win environment $HOME is, ordinary, something like:
            C:\Documents and Settings\[USER-ID]
         ).
         
           The application creates, at the start time, this file, with the default content, 
         each  time when  it does  not exist.  The file contains the docset definition tags
         like:
         
    
         <docset 
            project="j2se" 
            ver="1.5.0" 
            j2se="yes"
            base="http://java.sun.com/j2se/1.5.0/docs/api/"
            home="http://java.sun.com/j2se/1.5.0/docs/"
         />
       
         
         You can add, or remove the docsets as you need.  After configuration file editing you
         should restart the viewer to make it to get the new options
         (Note: don't remove the j2se javadoc set).
         
    To exclude a docset from the browsing, without the removing of it, add disable="yes" attribute to the docset declaration. The viewer, may replace, by some reasons (to fix broken links, etc), some from the standard docsets with the others (keeping the same product/major-version-number), to prevent a docset from such replacement add managed="no" attribute to the docset declaration. (Note: the viewer never removes the docsets from the configuration file, but sets disable="yes" attribute to the replicable docset and adds the replacement).