Document Properties

Document Properties

Top Previous Next

The Document Explorer displays the following document properties:

Document Name – The file's name.

Type – The file's extension.

Folder Name – The path of the folder which holds the file.

RCS Status – The file's archive status. The possible statuses are listed below.

Modified – The last date and time that the file was checked-in or modified locally.

Revision – The current archive head revision.

State – The workflow state of the archive head revision. (Pro edition only) Note: If your state promotion policy requires state promotion for each revision, rather than just the head revision, then you should not rely on this column. Instead, use the Change Explorer (refer to Change Explorer By Change).

Author – The last user to modify the file. In Exclusive Locks mode, when a file is locked, this column shows which user is currently locking the file.

CS-RCS uses the GNU RCS status terminology, which may be confusing for the novice user. The basic concept of workgroup version control is the locking of files. A file locked by a user is a file which this user has 'declared as his'; he becomes the 'owner' of the file. Such file is marked as Locked - only the owner can edit it and check it in again. No other user may edit such a file, as it is protected against unauthorized changes. The file appears with Blocked as its status for all other users. If a file is not locked by any user, it is in the Archived status, meaning it cannot be edited by anyone. An Archived file can be locked anytime by checking it out with the Lock option selected, thus giving the user 'ownership' of the file and enabling editing.

The displayed RCS status depends on the project work mode:

In the Single Owner mode, all documents are always editable (i.e., locked) by the user. A document may display one of the following RCS statuses:

Locked – You are the owner of the document and may edit it. The document is identical to the latest revision in the Repository.

Modified – You have edited the document. It is recommended to check-in the document whenever it receives a significant revision.

New – The document exists in the archive, but not in your working directory. Check-out the document to retrieve the latest revision.

Deleted – The document has been deleted from the project. You can still retrieve the various revisions of the document to backtrack to any previous project state.

Added on Branch – The document has been added on a branch. It will be added to the trunk after the next merge operation. (Pro edition only)

In the Exclusive Locks mode, a document may display one of the following RCS statuses:

Archived – The document has no owner. No one can edit it. The document is identical to the latest revision in the Repository.

Blocked – Another user owns the document. No other user can edit it until the lock is released. The document is identical to the latest revision in the Repository. (The Author column shows which user is currently locking the document.)

Locked – You are the owner of the document and may edit it. The document is identical to the latest revision in the Repository. No other user can edit it until the lock is released.

Modified – You have edited the document. It is recommended to check-in the document whenever it receives a significant revision.

Modified (Unlocked) – The document has been modified circumventing CS-RCS by assigning the file a read-write permission. Use the check-out command to lock this document or to undo all changes.

Updated – A new revision of the document exists in the Repository. Check-out the document to retrieve the latest revision.

New – The document exists in the archive, but not in your working directory. Check-out the document to retrieve the latest revision.

Deleted – The document has been deleted from the project. You can still retrieve the various revisions of the document to backtrack to any previous project state.

Added on Branch – The document has been added on a branch. It will be added to the trunk after the next merge operation. (Pro edition only)

In the Concurrent Changes (CVS) mode, a document may display one of the following RCS statuses: (Pro edition only)

Archived – The document is archived. The document is identical to the latest revision in the Repository.

Modified (Unlocked) – You have edited the document. It is recommended to check-in the document whenever it receives a significant revision.

Modified (Auto Merge) – You have edited the document, but the document was updated in the archive as well. It is recommended to check-in the document whenever it receives a significant revision. The merge can be done automatically by CS-RCS.

Modified (Merge Conflict) – You have edited the document, but the document was updated in the archive as well. It is recommended to check-in the document whenever it receives a significant revision. The merge can be done automatically by CS-RCS. However, you must review the result, as there are conflicts you must resolve manually.

Modified (Manual Merge) – You have edited the document, but the document was updated in the archive as well. It is recommended to check-in the document whenever it receives a significant revision. A manual merge is needed. (This is normal for binary files.)

Updated – The document was updated in the archive. Check-out the document to retrieve the latest revision.

New – The document exists in the archive, but not in your working directory. You may check-out the document to retrieve the latest revision.

Deleted – The document has been deleted from the project. You can still retrieve the various revisions of the document to backtrack to any previous project state.

Added on Branch – The document has been added on a branch. It will be added to the trunk after the next merge operation.

For full information on the CVS mode, refer to Concurrent Changes (CVS) Mode.

Note: In the Exclusive Locks mode, you may use the Windows Explorer to assign read-write permission to documents without locking them. This will result in the possibility to perform concurrent changes to these documents. The following CVS mode statuses will be applicable in this scenario: Modified (Unlocked), Modified (Auto Merge), Modified (Merge Conflict) and Modified (Manual Merge). This situation is common for users with transitory connections to the Repository or for users using portable computers. These features are available on the Pro edition only.