Copyright (c) Perforce Software, Inc., 1997-2010. All rights reserved

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1.  Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.

2.  Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PERFORCE
SOFTWARE, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.

User contributed content on the Perforce Public Depot is not supported by Perforce,
although it may be supported by its author. This applies to all contributions 
even those submitted by Perforce employees.



OVERVIEW
-------------------------------------------------------------------------------
This project contains a P4V applet that presents a quick overview
of a sample PDS for a depot with three products.

The applet uses the P4JsApi framework introduced in the 2010.1 
release.

MANIFEST
-------------------------------------------------------------------------------
README.txt          This file
applets.css         CSS file for applets
pds.html            Applet HTML 

Several screenshots (PNG images) are also included.

INSTALLATION
-------------------------------------------------------------------------------
Refer to the P4JsApi guide 
(http://www.perforce.com/perforce/r10.1/manuals/p4jsapi/p4jsapi.pdf) for more details.

1. Customize the example pds.html file to taste, then check in.

2. Create and check in a central settings file that uses
   the applet.  For example, the file could have a block like this:
    if (key == "p4v_mainTabs")  {
        return ["p4:///files/jsapi/pds.html"];
    }
    (Assuming the applet is checked in as //jsapi/pds.html)

3. Enable the centralsettings file for the appropriate users or groups.
   For example, to enable it for a group called BranchCurators.G, 
   add a protections entry like:
        list group BranchCurators.G centralsettings //jsapi/centralsettings.js
   This entry assumes that your central settings file lives at 
   //jsapi/centralsettings.js.

4. To use the applet in P4V, follow the instructions in the P4JsApi guide
    for enabling applets in P4V.  Then, restart P4V and select 
    'PDS' from the View menu.  The applet will appear as a tab
    in P4V.