DocuShare User's Guide
4. DocuShare Collections

Table of Contents     DocuShare Permissions     DocuShare Files

A collection is the DocuShare equivalent of a folder. A collection is represented by an icon.

Collections are considered container objects - which means that they can hold other DocuShare objects: other (sub)collections, documents or application files, bulletin boards, URLs, or calendars.


Adding a Collection

You can add a collection to any location in DocuShare to which you have at least Writer access permissions. However, you must be logged in to DocuShare to create a collection.

To create a collection:

  1. From the location in DocuShare where you want to add a collection, select Add Collection from the Add pull-down menu. The Add Collection page appears.

  2. Fill out the fields on the Add Collection page. Refer to the table below for descriptions of each field.
    Note: While creating the collection, if you are unsure of the purpose of a field, you can click on the highlighted field name for a brief Help description of the field.

  3. Click the Apply button to complete this process.

The Add Collection page has the following properties:

Property

Description

Title

Specifies a descriptive title for the collection. The title can contain spaces and other punctuation marks. You should assign a meaningful title to the collection. This is a required field.

Summary

(Optional) Specifies a brief description of the collection. The contents of this field are displayed below the collection title. Use the Description field to provide a more detailed description for the collection.

Description

(Optional) Contains a detailed description of the collection. The contents of this field are displayed below the collection title and summary on the DocuShare collection page. The Description field can contain HTML markup to customize the collection's appearance. (See Troubleshooting for cautions about using some HTML markup categories)

Note: There may be additional properties displayed on this page that are not listed here. They are specific to your DocuShare site. See your Site Administrator for details.

The collection is created in DocuShare and the Services page for the collection appears.

You can verify that the collection was created by clicking the Appears In link to move you up one level in the collection hierarchy. The collection should now be listed with a icon. If you don't see the collection, click Reload on your browser to refresh the page display.

Note: After creating the collection, you should adjust the access permissions for the collection to make sure they provide the desired level of access for other users and groups. See the section Viewing and Editing DocuShare Object Permissions in Chapter 3 for more information on adjusting these permissions.


Viewing Collection Properties

You can view the properties of a collection at any time. You do not need to be logged in to view the collection properties. However, you must be logged in to DocuShare to perform any editing functions that can be accessed through the Services page.

There are two ways to access a collection's Services page, depending upon your location:

  1. While in an open collection, select View Properties from the Edit pull-down menu.

  2. In a higher-level collection listing, click on the Services link to the right of the collection listing.

Collection properties include:

Note: There may be additional properties displayed on this page that are not listed here. They are specific to your DocuShare site. See your Site Administrator for details.

All of these properties (except the object id, the creation/modification dates/times and collection location) can be edited or modified by the owner of the collection or a user with Writer access permissions through the Edit Properties function. To edit the Appears In property (collection location), use the Edit Location function.

The Collection Services page provides access to editing functions, using these selections from the Edit pull-down menu:


Editing Collection Properties

Many of the Properties of a collection can be edited or modified after initial creation. You must be the owner of the collection or have Writer access permissions to edit the properties for a collection. You must also be logged in to DocuShare.

In addition to editing properties such as title, summary and description, you can also change the sort order of the objects contained within a collection, add an image that will appear at the top of a collection page, or add an image that will appear as the background for the collection page.

To edit the properties of a collection:

  1. Go to the edit page for this collection:
  2. Edit the information. Refer to the descriptions in the table below for details on the properties that can be edited through this function.
    Note: While adding a collection, if you are unsure of the purpose of a field, you can click on the highlighted field name for a brief Help description of the field.
  3. Click the Apply button. The Services page for the collection appears. The properties have now been updated to reflect your changes.

The Edit Collection page has the following properties:

Property

Description

Title

Specifies a descriptive title for the collection. The title can contain spaces and other punctuation marks. You should assign a meaningful title to the collection. This is a required field.

Summary

(Optional) Specifies a short description for the collection. The contents of this field are displayed below the collection title. Use the Description field to provide a more detailed description of the collection.

Description

(Optional) Specifies a detailed description for the collection. The contents of this field are displayed below the collection title and summary on the DocuShare collection page. The Description field can contain HTML markup to customize the collection's appearance. (See Troubleshooting for cautions about using some HTML markup categories)

Keywords

(Optional) Lets you associate one or more words with the collection. Keywords help categorize the different collections and streamline searches.

Logo

(Optional) Contains a URL that points to a GIF or JPG image that is displayed at the top of the collection page. You can specify any valid URL. If you want to use an image that is already in DocuShare, you can supply the file handle (object ID#) for that image here (for example, File-3072), and DocuShare automatically converts the file handle into the correct URL for the image.

Background image

(Optional) Contains a URL that points to a GIF or JPG image that is displayed as the background of the collection page. You can specify any valid URL. If you want to use an image that is already in DocuShare, you can supply the file handle (object ID#) for that image here (for example, File-3072), and DocuShare automatically converts the file handle into the correct URL for the image.

Sort Order

Sorts the contents of the collection by type and title, type and date, date only, or title only. The default sort order is by type and title.

Note: There may be additional, editable properties displayed on this page that are not listed here. They are specific to your DocuShare site. See your Site Administrator for details.


Deleting a Collection

Only the owner of a collection or a user with Manager access can delete a collection from DocuShare. You must be logged in to delete a collection from DocuShare.

Unlike the more familiar file-management model that requires you to select an item before you delete it, DocuShare requires that you must open or be within a collection in order to delete it. This ensures that you view the contents of the collection prior to deletion.

If you choose to delete a collection that contains other objects, you will be given the choice to delete the collection and all objects contained within the collection or to delete just the collection. Deleting a collection without deleting its contents will orphan the contents of the collection. Orphaned objects still exist within DocuShare but are not accessible to users. Only a Site Administrator can recover orphaned objects.

Note: Your collection will not be deleted if it contains objects that you do not own or do not have Manager access permission.

To delete a collection:

  1. Open the collection that you want to delete.

  2. Select Delete from the Edit pull-down menu.

  3. If there are no objects in the collection, the Confirm Deletion page appears. Select the Delete button to delete the collection.
    If the collection contains other objects the Delete page appears. This page lists the number of objects in the collection that will be deleted. It also lists the number of objects that will not be deleted because of insufficient access rights or because they appear in other locations.

    Note: If you change your mind about deleting this collection, use the Back button on your browser to close the Delete or Confirm Deletion page.

  4. The Delete Successful page appears. Click the Click here to continue link.

The collection is now deleted. You may need to Reload the page to see these changes.


Editing the Location of a Collection

The Edit Location command allows a user to move a DocuShare object from one location to another or allows the object to appear in multiple locations within the DocuShare repository. You must have at least Writer access to the object to change its location.

The location of an object is displayed in the Appears In property, which is displayed at the end of each Properties listing for an object. Using the Edit Location command allows you to edit the Appears In property.

This is a helpful command if you have created a collection (or any other DocuShare object) in the wrong location and want to move it instead of deleting it and then re-creating it. It is also helpful if you would like the same object to appear in one or more additional locations. All DocuShare objects can appear in multiple locations at once. However, there is actually only one physical copy of the object in the DocuShare database; the system simply creates additional pointers or references to the object.

A negative side effect of this command is that if used incorrectly, you can orphan the object. Orphaned objects still exist within the DocuShare repository but are not accessible to users. Only a Site Administrator can recover orphaned objects.

To edit the location of a collection:

  1. From an open collection, select Edit Location from the Edit pull-down menu. The Edit Collection Location page appears.

  2. For the Appears In field, a scrolling list is displayed that contains all DocuShare collections to which you have at least Writer access. The collection's current location is highlighted.

    Note: Use caution when deselecting locations. Deselecting improperly can create orphaned files. Be sure that at least one location is selected in the scrolling list before selecting the Update Locations button.

  3. Click the Update Locations button.

The Services page for that collection now appears and the new location(s) is/are displayed in Appears In. If you don't see this change reflected on the Services page, click Reload on your browser to refresh the page display.


Table of Contents     DocuShare Permissions     DocuShare Files

Copyright © 1997, 1998, 1999 by Xerox Corporation. All Xerox product names mentioned in this document are trademarks of Xerox Corporation. All other product names mentioned in this document are trademarks of their respective companies.