********************************************
** ClearBox - An Other ClearCase Browser ***
********************************************
*** frederic.verdier@fra.modicon.com *******
*** Schneider Automation *******************
*** Sophia Antipolis - France **************
********************************************


ClearBox is a tool to help the developers to run 
the main commands they have to use with ClearCase. 


VERY IMPORTANT
**************
1 DON'T USE IT TO BROWSE ON A HUGE DISC SPACE
  FOR EXAMPLE USE IT TO BROWSE A VISUAL C++ PROJECT

2 THE TEMP ENVIRONMENT VRIABLE HAS TO BE SET



**************************************************
*************** INSTALL **************************
**************************************************


Installation In The Explorer
=============================


CHECKED IN DIRECTORIES
======================
1st Run clearmenuadmin.exe to add the tools to your explorer contextual menues
To run the Context Menu Editor:
1. From the Windows NT taskbar, choose Start Run.
2. In the Run dialog box, type clearmenuadmin in the Open box.
3. Click OK.

2nd On the Dialog Box, make the following selection :
Object Type : 		Directory
Object State : 		Checked In
Selection Type : 	Single Selection

3rd Then, Click on the Button New, and on the new dialog box (Menu Item Properties), 
fill the fields as it follows
Menu Text :		ClearBox
Help Text :		
Command Type :	Executable
Command :		\\.......\ClearBox.exe


Init. Directory :
Arguments :		$dir_or_file1
Comment : 
Then, Click on OK.

4th On the List Available Menu Choices, select ClearBox and click on the Button Add
So, in the list This Menu contents, you can decide where it will be placed 
in the contextual menu, moving it with the help of the button Move Up and Move Down

You can too separate this menu from the others adding '--------------' from the list 
Available Menu Choices, moving it with the same buttons.

5th At present you can run ClearBox on the Directory wich are checked In, 
It has too be available on the directory wich are checked Out :

CHECKED OUT DIRECTORIES
======================
On the Dialog Box, make the following selection :
Object Type : 		Directory
Object State : 		Checked OUT
Selection Type : 	Single Selection


On the List Available Menu Choices, select ClearBox and click on the Button Add, move it at 
the same place than you choose for the Checked in directory.



View Private DIRECTORIES
========================
The same with : 
Object State : 		View Private
...

Close the dialog box, and choose Yes when proposing to save the modifications.

**************************************************

Installation In Visual Studio
=============================
To install the integration of the ClearBox utility with Visual Studio,
add ClearBox to the Developer Studio Tools menu:

1. Start Visual C++ Developer Studio.
2. Choose Tools => Customize.
3. In the Customize dialog box, click the Tools tab.
4. On the Tools tab, click Add.
5. In the Add Tool dialog box, type .......\ClearBox.exe in the Command box.
6. In the Arguments box on the Tools tab, type the following line: $(WkspDir) 
7. In the Customize dialog box, click Close.


Then you will be able to run ClearBox on your current project, 
developed in a ClearCase environment

**************************************************
**************************************************
**************************************************


Features than the classical Explorer
===================================
=> Allow a Multi-Selection of elements which are in different directories
=> You can run an rmname and an apply label (with the option 'followed by a check in')
=> You can View Rules
=> You can make some 'Pre-Selection'
=> You can run commands in 2 different modes :
	(*) windows 
	(*) command line mode.


Meaning of the icons
====================
White : View Private Elements
Yellow : Checked In Elements
Yellow with a red check : Checked Out Elements


Pre-Selection Buttons (Buttons 'ALL')
=====================================
To help the developer, some buttons of preselection have been added to ClearBox : 
There is one Button for each action except for the Rmname comand


Remark :
========
The preselection for the commands check in/out, uncheck out doesn't select directories 
elements, because those elements doesn't often change.


Multi Modes
===========
The commands Check In, Check Out, UnCheck Out, can be run in 2 different modes 
(Too much pb with the 'Add to Source Control')

(*)Windows Mode :
The commands are run with the ClearCase executable windlg.exe, the executing interface 
will be identical as when you run your commands through the explorer :
The options will be proposed with the progression of the execution, 
and a dialog box will be mounted for each error; for example, if you run a Check In without 
the option Check In even if identical to the previous version, 
a dialog box will appear for each element which has not been modified since 
the previous version.

(*)Command Line Mode :
It is a mixte between a dos interface and a windows interface

options for the browser
=======================
(*)If you check the option View Rules, the rule of each elements is displayed 
(*)If you check the option Expand All, It will expand each node of the browser.