exteNd 5.2.1 Documentation Addenda


Content Administration Portlets

This document describes the new Content Administration portlets and how to use them in exteNd Director portal applications. Topics include:

 
Top of page

About the Content Administration portlets

exteNd Director 5.2.1 provides a set of Content Administration portlets—called CAP portlets—that allows you to access basic content management functions directly from a shared or personal portal page.

In earlier releases of exteNd Director 5 you could interact with the content management system only though the Content Management section of the Director Administration Console (DAC). This tool runs only in Windows, requires Internet Explorer version 5.5 or higher, and is available only to administrators.

By contrast, administrators can use Content Administration portlets to expose selected content management functions to authorized end-users in any browser and operating system supported by exteNd Director 5.2.1.

For more information    See the Novell exteNd Release Notes for the latest information on supported platforms and browsers.

Portlet-based content management consists of the following components:

 
Top of section

Embedded and standalone CAP portlets

exteNd Director 5.2.1 provides a set of CAP portlets that can run standalone on portal pages, provide embedded functionality to other CAP portlets, or both. Administrators can select standalone portlets as content for portal pages they build using the Portal Administration tool and Portal Personalizer, as described in Using the standalone CAP portlets.

Here is a brief description of the CAP portlets, with links to more information:

Name

Description

Embedded

Runs standalone

Content Administration portlet

Main administrative portlet that can be used as a central location for launching all other content management functions. The Content Administration portlet calls the CAP Editor, CAP Reader, and CAP Inspector portlets to execute specific functions.


ext521 GoldBullet

CAP Editor portlet

Allows you to create and edit documents in the content repository.

ext521 GoldBullet

ext521 GoldBullet

CAP Reader portlet

Allows you to browse directories and view documents in the content repository.

ext521 GoldBullet

ext521 GoldBullet

CAP Inspector portlet

Implements the ability to view and modify the properties of content elements in the Content Administration portlet.

ext521 GoldBullet


 
Top of section

Client-side widgets

exteNd Director 5.2.1 provides several JavaScript/DHTML client-side widgets that are used by the CAP portlets. The widgets are designed to be used as plug-in tools that developers can incorporate into other portlets with minimal coding effort. The JavaScript files are stored in the portal-general folder of an exteNd Director project resource set.

Here is a brief description of these widgets, with links to more information:

Name

Description

JavaScript file

HTML Editor widget

Implements an HTML editor

html_editor.js

Calendar widget

Provides the ability to select a date and time, and return the values to a specified location.

calendar_widget.js

Context Menu widget

Overrides the browser's right-click context menu with a menu based on the portlet's runtime context

context_menu_widget.js


 
Top of page

What you can do with Content Administration portlets

The Content Administration portlets allow you to perform most of the same functions as the Content Management section of the DAC, but not all. The following table illustrates the options available in each tool:\

Content management function

Available in Content Administration portlets

Available in Content Management section of DAC

Adding child documents and attachments

ext521 GoldBullet

ext521 GoldBullet

Assigning documents to categories


ext521 GoldBullet

Checking documents in and out

ext521 GoldBullet

ext521 GoldBullet

Adding child documents and attachments

ext521 GoldBullet

ext521 GoldBullet

Creating custom fields


ext521 GoldBullet

Creating document types


ext521 GoldBullet

Creating documents

ext521 GoldBullet

ext521 GoldBullet

Creating folders

ext521 GoldBullet

ext521 GoldBullet

Editing documents

ext521 GoldBullet

ext521 GoldBullet

Viewing and editing properties

ext521 GoldBullet

ext521 GoldBullet

Importing and exporting documents


ext521 GoldBullet

Moving folders


ext521 GoldBullet

Publishing and unpublishing content

ext521 GoldBullet

ext521 GoldBullet

Publishing and unpublishing all documents in a folder

ext521 GoldBullet


Rolling back to a previous version of content

ext521 GoldBullet

ext521 GoldBullet

Previewing unpublished content

ext521 GoldBullet

ext521 GoldBullet

Assigning and removing permissions on folders

ext521 GoldBullet

ext521 GoldBullet

Assigning and removing permissions on documents

ext521 GoldBullet

ext521 GoldBullet

Deleting content elements

ext521 GoldBullet

ext521 GoldBullet

 
Top of page

Using the standalone CAP portlets

Administrators and end-users can use standalone CAP portlets out of the box by adding them to portal pages in Web applications and modifying their preferences.

To add standalone CAP portlets to a portal page:

  1. Log in to the portal application and select Personalize or Portal Administration.

  2. Create or select a page.

    For more information    For more information about using the Personalizer or Portal Administration tool to create or edit pages, see the exteNd Director Portal Guide. The chapter "Personalizing Your Portal" describes how to create personal pages; the chapter "Administering the Portal" describes how administrators can create shared or container pages.

  3. Select Choose Content.

    The Content Selector window opens.

  4. In the Filter field, select Content Administration Portlets.

    The Available Content dropdown refreshes to display the standalone CAP portlets.

  5. Add one or more CAP portlets to your page.

  6. Modify portlet preferences as needed by following these steps:

    1. Select the CAP portlet you want to configure in the Selected Content panel and click Content Preferences.

    2. Modify the preferences as follows:

      For:

      See:

      Content Administration portlet

      Content Administration preferences

      CAP Editor portlet

      CAP Editor preferences

      CAP Reader portlet

      CAP Reader preferences

 
Top of page

Content Administration portlet

The Content Administration portlet is the main portlet for managing content. In a typical scenario, administrators can add the Content Administration portlet to a shared portal page to expose all content management functions to authorized end-users.

To further restrict access to the content repository, opt instead for the CAP Editor portlet or CAP Reader portlet.

The following diagram shows the default appearance of the Content Administration portlet and explains how each of its panels interact. In this example, the Content Panel displays the root folder of sample real estate data.

MainCAPDefaultViewAnnot

 
Top of section

Content Administration Tool Pallette

This section describes the panels of the Content Administration portlet Tool Pallette.

Actions panel options

The following table describes the actions available for each type of content element:

Element selected in Content panel

Available actions

Folder or Category

  • Open

    Opens the selected folder or category.

  • Properties

    Displays the property inspector for the selected folder or category.

  • Delete

    Deletes the selected folder or category.

Document

  • Open

    Opens the selected document for viewing only.

  • Properties

    Displays the property inspector for the selected document. Allows you to view settings only.

  • Check-Out

    Checks out the selected document for editing or deletion.

Checked out document

  • Open

    Opens the selected document for viewing only.

  • Edit

    Opens the selected document for editing.

  • Properties

    Displays the property inspector for the selected document. Allows you to modify settings.

  • Check-In

    Checks in the selected document.

  • Delete

    Deletes the selected document.

Tasks panel options

The following table describes the tasks available for each type of content element:

Element selected in Content panel

Available tasks

Folder or Document

  • New Folder

    Allows you to create a folder inside the current folder.

  • New Document

    Allows you to create a document inside the current folder.

Category

  • New Category

    Allows you to create a category.

General panel options

The following table describes General panel options affect the Content panel display:

View

Display Model

Content panel display

Folder

Large Icons

Folders and documents appear as large icons, as in these sample displays:

  • Documents inside a folder:

    DocumentLargeIconView

  • Folders inside a folder:

    FolderLargeIconView

Folder

Details

Folders and documents appear as small icons with metadata, as in these sample displays:

  • Documents inside a folder:

    DocumentDetailsView

  • Folders inside a folder:

    FolderDetailsView

Category

Large icons

Categories appear as large icons, as in this sample display:

CategoryLargeIconView

Category

Details

Categories appear as small icons with metadata, as in this sample display:

CategoryDetailsView

 
Top of section

Content Administration tasks

You can perform the following tasks using the Content Administration portlet:

Configuring the content display

You can specify how the Content Administration portlet displays documents, folders, and categories, as described in General panel options. Follow these steps:

  1. In the General panel, select a view from the dropdown list:

    View

    Description

    Folder

    Displays folders and documents in the Content panel

    Category

    Displays categories in the Content panel

  2. In the General panel, select a display mode from the dropdown list:

    Display Mode

    Description

    Large icons

    Displays content elements as large icons

    Details

    Displays content elements as small icons with metadata

Browsing the content repository

You can browse the content repository by folder or category. You must have LIST and READ permission for the folders you wish to browse.

Follow these steps:

  1. Specify a view and display mode for content, as described in Configuring the content display.

    The Content panel of the Content Administration portlet refreshes to reflect your choices. For example, if you select the folder view, you will see folders and documents in the Content panel.

  2. Browse the content repository by selecting elements in the Content panel, then selecting Open in the Actions panel, as in this example:

    BrowseEx

    TIP:   A short cut is available for Mozilla or Firefox browsers. The Content Administration portlet has a preference that lets you override the browser's right-click menu with actions relevant to the content element you have selected. This preference is called Override Context Menu, described in Content Administration preferences. When this preference is enabled, you can open content elements by right-clicking a folder or document, as in this example:

    BrowseRightClickEx

    TIP:   You can double-click content elements to navigate the repository, depending on the browser you use. Follow these guidelines:

    Browser

    Guideline

    Internet Explorer

    Double-click a folder to open it, or double-click a document to display its published content in the CAP Reader portlet.

    Mozilla/Firefox

    Select the content element, then double-click.

Creating folders

You can create folders inside folders for which you have WRITE permission.

Follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Open the folder where you want the new folder to reside.

  3. Select New Folder in the Tasks panel.

    A popup dialog appears, asking you to enter a name for the folder.

  4. Enter a folder name and click OK.

    A folder is created inside the currently open folder.

    TIP:   If you want more control over how and where to create folders, see CAP Editor portlet.

Creating documents

You can create documents in folders for which you have WRITE permission. When you create documents using the Content Administration portlet, the Default document type is used as its template.

Follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Open the folder where you want the new document to reside.

  3. Select New Document in the Tasks panel.

    The CAP Editor portlet opens in a new window.

  4. Fill in all required fields and any optional fields you wish.

    NOTE:   The CAP Editor portlet includes an HTML editor that you can use to enter content for the new document. For more information about the CAP Editor portlet, see CAP Editor portlet.

  5. Click OK.

    A document is created inside the currently open folder.

If you want more control over where and how to create documents, see CAP Editor portlet.

Adding child documents and attachments

You can set up relationships between documents in the content repository as long as all documents reside in the same folder and are checked out to you. The Content Administration portlet lets you establish several types of relationships:

Adding attachments to a document in a parent-child relationship   The Content Administration portlet allows you to attach two documents, where one document becomes the parent of the other. Each child document can have only one parent, but parent documents can have more than one child. This section describes how to add and remove attachments.

To add an attachment, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Open the folder that contains the two documents you want to attach.

  3. Check out the documents, as described in Checking documents in and out.

  4. Select the pair of documents.

    The Actions panel refreshes to display Link and Attach options.

    TIP:   Hold down the Control key to select more than one document.

  5. Click Attach in the Actions panel.

    A message box opens, asking you to designate a parent.

  6. To designate a parent, follow these steps:

    1. Click OK if you want the first document selected to be the parent.

    2. Click Cancel if you do not want the first document to be the parent.

      A message box opens, asking if the second document should be the parent. Click OK to confirm that action. If you click Cancel again, no attachments are made.

  7. Verify the attachment by following these steps:

    1. Select the parent document.

    2. Select Properties in the Actions panel, then select the Advanced tab in the property sheet.

    3. Scroll down to Child Document Attachments.

      All child documents are listed.

To remove attachments, follow these steps:

  1. Check out the child document you want to remove, as described in Checking documents in and out.

  2. Select the parent document and click Properties in the Actions panel.

  3. Select the Advanced tab and scroll down to the list of attachments.

  4. Select the child you want to remove and click Unattach Child.

  5. Click OK to confirm the action.

Linking documents   This section describes how to link and unlink documents.

To link documents, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Open the folder that contains the two documents you want to link.

  3. Check out the documents, as described in Checking documents in and out.

  4. Select the pair of documents, noting that the second document selected will be linked to the first document selected.

    The Actions panel refreshes to display Link and Attach options.

    TIP:   Hold down the Control key to select more than one document.

  5. Click Link in the Actions panel.

  6. Verify the link by following these steps:

    1. Select the first document (the one linked to).

    2. Select Properties in the Actions panel, then select the Advanced tab in the property sheet.

    3. Scroll down to Linked Document Attachments.

      All linked documents are listed.

To unlink documents, follow these steps:

  1. Check out the linked document, as described in Checking documents in and out.

  2. Select the document it is linked to and click Properties in the Actions panel.

  3. Select the Advanced tab and scroll down to the list of linked documents.

  4. Select the document you want to remove and click Unlink Document.

  5. Click OK to confirm the action.

Creating categories

The Content Administration portlet allows you to create categories, both at the root level and as subcategories of other categories. To create subcategories, you need WRITE, LIST, and READ access to the parent category.

NOTE:   To set security on categories and taxonomies, use the Content Management section of the DAC.

Although you cannot assign categories to documents or create taxonomies for grouping categories in the Content Administration portlet, you can open taxonomies and view assignments that were created using the Content Management section of the DAC.

To create categories, follow these steps:

  1. Select Category from the View dropdown menu in the General panel:

    SelectCategoryView

  2. Select New Category in the Tasks panel.

    A popup dialog appears, asking you to enter a name for the category.

  3. Enter a category name and click OK.

    A category is created in the Default repository.

Publishing and unpublishing content

You can only open content that has been published, although you can preview unpublished content, as described in Previewing unpublished content. To publish content, you must have the following permissions for accessing the document:

Follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document, as described in Browsing the content repository.

  3. Check out the document, as described in Checking documents in and out.

  4. Select the document and click Properties in the Actions panel.

    The CAP Inspector portlet opens in a new window.

  5. Select the Advanced tab, then choose the content version you wish to publish by clicking its radio button:

  6. Click Publish, then click OK in the popup that asks you to confirm the action.

    The CAP Inspector portlet closes.

  7. Check the document back in, as described in Checking documents in and out.

To unpublish content, follow the same steps as for publishing, but select Unpublish in the Advanced tab of the CAP Inspector portlet.

Publishing and unpublishing all documents in a folder

Besides publishing and unpublishing the content of one document at a time, you can also publish and unpublish the content of multiple documents at once—either in a single folder, or recursively in one folder and all of its subfolders. In the latter case, documents will be published or unpublished recursively, even if they have not been checked out.

To publish all content in a folder, you must have PUBLISH and WRITE permission on the desired documents, and LIST permission on the folder.

Follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired folder. and click Properties in the Actions panel.

  3. Select the Advanced tab and take any of the following actions:

    To:

    Do this:

    Publish the content of all documents in the selected folder only

    Uncheck Recursive (left check box) and click Publish All.

    Publish the content of all documents in the selected folder and recursively in all of its subfolders

    Check Recursive (left checkbooks) and click Publish All.

    Unpublish the content of all documents in the selected folder only

    Uncheck Recursive (right checkbooks) and click Unpublish All.

    Unpublish the content of all documents in the selected folder and recursively in all of its subfolders

    Check Recursive (right checkbooks) and click Unpublish All.

  4. Click OK in the popup that asks you to confirm the action.

Rolling back to a previous version of content

You can roll back to a previous version of content, but be aware that all later versions will be deleted. The previous version does not need to be a published version.

To roll back to a previous version of content, you need the following permissions:

Follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document, as described in Browsing the content repository.

  3. Check out the document, as described in Checking documents in and out.

  4. Select the document and click Properties in the Actions panel.

    The CAP Inspector portlet opens in a new window.

  5. Select the Advanced tab.

  6. Select the desired content version, then click Rollback.

    You receive a warning that later versions of content will be deleted. Click OK if you wish to proceed. Otherwise, click Cancel.

Viewing published content

To view the published content of a document you need the following permissions:

Follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document, as described in Browsing the content repository.

  3. Select the document and click Open in the Actions panel:

    OpenDocument

    The CAP Reader portlet opens in a new window, displaying the published content of the selected document, as in this example:

    ViewedContentEx

    NOTE:   You can view content only if it has been published. See Publishing and unpublishing content for more information. To look at unpublished versions of content, see Previewing unpublished content.

Previewing unpublished content

To preview an unpublished version of content, you need READ permission on the document and LIST permission on the folder containing the document.

Follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document, as described in Browsing the content repository.

  3. Select the document and click Properties in the Actions panel.

    The CAP Inspector portlet opens in a new window.

  4. Click the Advanced tab.

  5. Choose the version of content you wish to preview by selecting its radio button.

  6. Click Preview.

    The CAP Reader portlet opens in a new window, displaying the content you selected.

Checking documents in and out

Before you can edit a document, you must check it out for your exclusive use. When you are finished making changes, you must check the document back in so others can edit it.

To check documents in and out you need the following permissions:

To check out a document, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document, as described in Browsing the content repository.

  3. Select the document and click Check-Out in the Actions panel:

    CheckOutDocument

    The Content panel refreshes to display the document with a red check mark:

    CheckedOutDocument

To check in a document, follow these steps:

  1. Select the document in Folder view and click Check-In in the Actions panel.

  2. Click OK in the popup that asks you to confirm the action.

    The document is checked in for others to access. The red check mark is removed from the document's icon.

Editing documents

Before you can edit a document, you must check it out for your exclusive use.

To edit a document you need the following permissions:

Follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document, as described in Browsing the content repository.

  3. Check out the document, as described in Checking documents in and out.

  4. Select the document you just checked out and click Edit in the Actions panel.

    The CAP Editor portlet opens in a new window.

  5. Enter your edits and click OK.

    The CAP Editor portlet closes.

  6. Publish the content you just edited, as described in Publishing and unpublishing content.

  7. Check in the document, as described in Checking documents in and out.

    The document is now available for others to edit.

Assigning and removing permissions on folders

Administrators can assign users and groups varying levels of permissions to work with folders, and also remove these permissions. If you do not have administrative privileges, you can view security settings, but not change them.

Typically, administrators assign PROTECT permission to designated users on folders that need to be secured. However, any user can assign and remove security on folders for which PROTECT permission has not been set.

To assign permissions on folders, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired folder. and click Properties in the Actions panel.

    The CAP Inspector portlet opens in a new window.

  3. Select the Security tab and click View Available Users/Groups.

    A list of available users and groups appears in the Security panel:

    AvailableUsersGroups

  4. Select a user or group from the list.

  5. Select a permission from the Permission dropdown.

  6. If you want to set this permission on all subfolders and documents stored in the selected folder, check Apply to all existing children?

  7. Click Add User/Group.

    AddSecurityEx

To remove permissions on folders, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired folder. and click Properties in the Actions panel.

    The CAP Inspector portlet opens in a new window.

  3. Select the Security tab and click View Assigned Security.

    A Permission dropdown control appears.

  4. Select the permission you wish to remove from the dropdown menu.

    The users who have been assigned this permission are displayed in the panel.

  5. Select the user whose access to the folder will be removed.

  6. If you wish to also remove access to all subfolders and documents stored in the selected folder, check Apply to all existing children?

  7. Click Remove/User/Group.

    RemoveSecurityEx

Assigning and removing permissions on documents

Administrators can assign users and groups varying levels of permissions to work with documents, and also remove these permissions. If you do not have administrative privileges, you can view security settings, but not change them.

Typically, administrators assign PROTECT permission to designated users on documents that need to be secured. However, any user can assign and remove security on documents for which PROTECT permission has not been set.

To assign permissions on documents, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document and check it out, as described in Checking documents in and out.

  3. Select the checked-out document and click Properties in the Actions panel.

    The CAP Inspector portlet opens in a new window.

  4. Select the Security tab and click View Available Users/Groups.

    A list of available users and groups appears in the Security panel:

    AvailableUsersGroups

  5. Select a user or group from the list.

  6. Select a permission from the Permission dropdown.

  7. Click Add User/Group.

    AddSecurityDocEx

  8. Check in the document.

To remove permissions on documents, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document and check it out, as described in Checking documents in and out.

  3. .Select the checked-out document and click Properties in the Actions panel.

    The CAP Inspector portlet opens in a new window.

  4. Select the Security tab and click View Assigned Security.

    A Permission dropdown control appears.

  5. Select the permission you wish to remove from the dropdown menu.

    The users who have been assigned this permission are displayed in the panel.

  6. Select the user whose access to the folder will be removed.

  7. Click Remove/User/Group.

    RemoveSecurityEx

  8. Check in the document.

Viewing and editing properties

Authorized users can view and edit the properties of content elements.

You need the following permissions:

To view properties of content elements, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document or folder, select it, and click Properties.

    The CAP Inspector portlet opens in a new window.

  3. Browse the General, Security, and Advanced tabs to view the properties of the element.

To edit properties of folders, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired folder, select it, and click Properties.

    The CAP Inspector portlet opens in a new window

  3. Select the General tab to edit the title of the folder, then click OK.

  4. Select the Security tab to set security on the folder, as described in Assigning and removing permissions on folders.

  5. Select the Advanced tab to publish documents in the folder, as described in Publishing and unpublishing all documents in a folder.

To edit properties of documents, follow these steps:

  1. Select Folder from the View dropdown menu in the General panel:

    SelectFolderView

  2. Navigate to the desired document and check it out, as described in Checking documents in and out.

  3. Select the checked-out document and click Properties in the Actions panel.

    The CAP Inspector portlet opens in a new window.

  4. Select the General tab to edit the following properties:

    NOTE:   To edit the publish of expiration dates, either type a date and time in the text field or click the ellipsis to launch the Calendar widget, which provides a graphical user interface for selecting dates and times.

  5. Click OK to record your changes.

  6. Select the Security tab to set security on the document, as described in Assigning and removing permissions on documents.

  7. Select the Advanced tab to perform the following functions:

  8. Check in the document.

Deleting content elements

To delete content elements you need the following permissions:

To delete folders, follow these steps:

  1. In the General panel, select Folder from the View dropdown.

  2. Select the folder you want to delete and select Delete in the Actions panel.

  3. Click OK to confirm the deletion.

To delete categories, follow these steps:

  1. In the General panel, select Category from the View dropdown.

  2. Select the category you want to delete and select Delete in the Actions panel.

  3. Click OK to confirm the deletion.

To delete documents, follow these steps:

  1. In the General panel, select Folder from the View dropdown.

  2. Select the document you want to delete and check it out, as described in Checking documents in and out.

  3. Select the checked-out document and click Delete in the Actions panel.

  4. Click OK to confirm the deletion.

 
Top of section

Content Administration preferences

When you add the Content Administration portlet to a portlet page, you can modify its preferences, as described in Using the standalone CAP portlets.

The preference sheet for the Content Administration portlet looks like this:

ContentAdministrationPortletPrefs

The following table describes each preference:

Preference

What to specify

Default View

  • Details = Documents, folders, and categories appear as small icons in a table view with metadata

  • Large Icons = Documents, folders, and categories appear as large icons in a tree view

Show Tool Pallette

Override Context Menu

  • True = Override right-click browser menu with portlet-specific right-click menu (for Mozilla/Firefox browsers only)

  • False = Do not override the right-click menus for Mozilla/Firefox browsers

When you have finished editing preferences, click Save Preferences at the bottom of the property sheet to record all changes.

TIP:   You can also get information about all preferences by clicking Descriptions on the preference sheet.

 
Top of page

CAP Editor portlet

When added to a portal page, the CAP Editor portlet allows you to create a document using a specific document type and to store the new document in a particular folder automatically. This is in contrast to how the CAP Editor portlet works when running inside the Content Administration portlet. In that context, the document you create is automatically stored in the currently open folder.

The following diagram shows the default appearance of the CAP Editor portlet:

CAPEditorDefaultViewAnnot

You can add the CAP Editor portlet to a portal page and configure its preferences as described in Using the standalone CAP portlets.

 
Top of section

Creating documents with the CAP Editor

To create a document with the CAP Editor portlet, follow these steps:

  1. Set CAP Editor preferences to use a specific document type and folder, as described in CAP Editor preferences.

  2. Enter values for the required fields and for optional fields as necessary:

    Field

    Description

    Details

    Name

    Name of document. This is the name you see when you browse the content repository

    Required

    Title

    Title of document.

    Required

    Author

    Author of document. Defaults to the user name of the current user.

    (Optional)

    Abstract

    Summary of the content.

    (Optional)

    Publish Date

    Date that the content was published. This date must be entered manually; it is not automatically filled in when you publish the content.

    (Optional)

    Expiration Date

    Date that the content expires.

    (Optional)

  3. Enter content using the HTML Editor.

    For more information    For information on how to use the HTML Editor, see the chapter "Creating Content" in the exteNd Director Content Management Guide.

  4. Click OK to save the content.

 
Top of section

CAP Editor preferences

When you add the CAP Editor portlet to a portlet page, you can modify its preferences, as described in Using the standalone CAP portlets.

The preference sheet for the CAP Editor portlet looks like this:

CAPEditorPortletPrefs

The following table describes each preference:

Preference

What to specify

Default Document Type

Enter the name of a document type that has been defined in the Content Management section of the DAC.

For more information    For information about creating document types, see the chapter "Setting Up the Required Infrastructure" in the exteNd Director Content Management Guide.

Default Folder

Follow these steps:

  1. Click View/Edit Custom Preference.

  2. Navigate to the desired folder.

  3. Scroll to the bottom of the panel and click Save Query to record changes for this preference.

  4. Click Return to List View.

When you finish editing preferences, click Save Preferences at the bottom of the property sheet to record all changes.

TIP:   You can also get information about all preferences by clicking Descriptions on the preference sheet

 
Top of page

CAP Reader portlet

When added to a portal page, the CAP Reader portlet allows you to view folders and documents in the content repository.

Viewing documents with the CAP Reader portlet   To view documents, follow these steps:

  1. Set CAP Reader preferences to view a document, as described in CAP Reader preferences.

Here is an example of how the CAP Reader portlet displays the content of a document, based on specific preference settings:

CAPReaderDisplaysDocContent

Viewing folders with the CAP Reader portlet   To view folders, follow these steps:

  1. Set CAP Reader preferences to view a folder and its contents, as described in CAP Reader preferences.

Here is an example of how the CAP Reader portlet displays the content of a folder, based on specific preference settings:

CAPReaderDisplaysFolderContent

 
Top of section

CAP Reader preferences

When you add the CAP Reader portlet to a portlet page, you must modify its preferences to specify what and how content is displayed, as described in Using the standalone CAP portlets.

The preference sheet for the CAP Reader portlet looks like this:

CAPReaderPortletPrefs

The following table describes each preference:

Preference

What to specify

Show Folder Title

  • True = Show name of folder

  • False= Hide name of folder

Display Subfolders

  • True = Show subfolders

  • False = Hide subfolders

Reader Query

Follow these steps:

  1. Click View/Edit Custom Preference.

  2. Navigate to the folder or document you want to display and select it

  3. Scroll to the bottom of the panel and click Save Query to record changes for this preference.

  4. Click Return to List View.

For more information    For more information, see About the Reader Query preference.

List Template and Document Template

Follow these steps:

  1. Click View/Edit Custom Preference.

    The HTML Editor widget opens in a new window.

  2. Place content fields in the text area, either by selecting them from the Content Fields dropdown or typing in the field tags, as described in Application-specific content fields.

  3. Select the entire tag and apply formatting as desired using dropdowns and tool bar buttons.

  4. Scroll to the bottom of the panel and click Save Template.

  5. Click Return to List View.

For more information    For more information, see About the List Template preference and About the Document Template preference.

When you finish editing preferences, click Save Preferences at the bottom of the property sheet to record all changes.

TIP:   You can also get information about all preferences by clicking Descriptions on the preference sheet.

 
Top of section

About the Reader Query preference

The Reader Query preference allows you to select which folder or document to display in the CAP Reader portlet.

If you select a folder, the CAP Reader uses the List Template to configure the display for each item in that folder. If you select a document, the CAP Reader uses the Document Template to configure the display for that document.

For more information    For more information about these templates, see About the List Template preference and About the Document Template preference.

 
Top of section

About the List Template preference

The CAP Reader uses the List Template if you select a folder in the Reader Query preference. The List Template specifies how to display each subfolder or document that resides in the selected folder.

The List Template uses the HTML Editor widget as the interface for specifying how the folder and its contents will appear in the CAP Reader portlet.

 
Top of section

About the Document Template preference

The CAP Reader uses the Document Template if you select a document in the Reader Query preference. The Document Template specifies how to display the selected document.

The Document Template uses the HTML Editor widget as the interface for specifying how the document will appear in the CAP Reader portlet.

The template settings do not apply to any attached child documents or linked documents.

 
Top of section

Using the HTML Editor widget to edit templates

Both the List Template and Document Template preferences use the HTML Editor widget for specifying how content should appear in the CAP Reader portlet:

ListTemplateAnnot

As you can see there are several dropdown menus and tool bar buttons for specifying standard HTML formatting tags. In addition, there is a menu for displaying one or more application-specific content fields, described in Application-specific content fields.

Application-specific content fields

You can think of content fields as substitution strings, or as placeholders for content or metadata. The following table describes each of the application-specific content fields:

Content field

Template tag

What gets displayed in the CAP Reader

Title

$[[title]]

Title of the document or name of the folder

(Title of a folder is the same as Folder Name)

Author

$[[author]]

Author of the document

Content

$[[content]]

Content of the document

Abstract

$[[abstract]]

Abstract of the document

Subtitle

$[[subtitle]]

Subtitle of the document as specified in the Content Management section of the DAC

Folder Name

$[[folder_name]]

Name of the folder

(same as folder Title)

Folder Link

$[[folder_link]]

URL to the parent folder

Self Link

$[[self_link]]

URL to the CAP Reader portlet pointing to the document

Publication Date

$[[publish_date]]

Publication date of the document

Expiration Date

$[[expiration_date]]

Expiration date of the document

Last Modified

$[[last_modified]]

Date the document was last modified

Custom Field

$[[field_FIELDNAME]]

(Replace FIELDNAME with the name of the custom field)

Value of the custom field specified in the tag

NOTE:   The custom field must be part of a document type that was defined in the Content Management section of the DAC.

 
Top of page

CAP Inspector portlet

The CAP Inspector portlet provides access to the properties of content elements. The Content Administration portlet invokes the CAP Inspector to allow users to view and modify the properties of folders, documents, and categories. The CAP Inspector is not designed to run standalone.

The CAP Inspector interface is content-sensitive—that is, it provides different functions depending on the type of element you select. In this example, the CAP Inspector has been invoked for a folder:

CAPInspectorFolder

Here is the CAP Inspector interface for a document:

CAPInspectorDocument

As you can see, the CAP Inspector portlet provides three tabs, each exposing a different type of property:

Tab

Property type

Related tasks

General

Metadata fields

Security

Access control lists

Advanced

Publish and rollback

 
Top of page

HTML Editor widget

The HTML Editor widget incorporates an HTML editor into a portlet. It is used by the Content Administration, CAP Reader, and CAP Editor portlets.

For example, here is how the HTML Editor widget is implemented in the CAP Reader portlet:

CAPEditorDefaultView

 
Top of section

Implementing the HTML Editor widget in a portlet

To implement the HTML Editor widget in a portlet, follow these steps:

  1. Import the JavaScript file into the portlet:

      <script language="JavaScript" type="text/javascript" src="RESOURCE_URL/portal-general/html_editor.js">
    
  2. Initialize the HTML Editor.

      //Usage: initEditor(imagesDir, palletteDir, CSSDir)
      initEditor("RESOURCE_URL/images", "RESOURCE_URL/portal-general", "");
    

    initEditor() arguments:

    1. imagesDir: Directory containing images for the editor

    2. palletteDir: Directory containing the color pallette for the editor

    3. CSSDir: Directory containing additional CSS files

  3. (Optional) Add a custom dropdown control (as implemented by the CAP Reader portlet).

      var customControls = new Object();
      customControls["Title"] = "$[[title]]";
      customControls["Author"] = "$[[author]]";
      customControls["Content"] = "$[[content]]";
      customControls["Abstract"] = "$[[abstract]]";
      customControls["Subtitle"] = "$[[subtitle]]";
      customControls["Folder Name"] = "$[[folder_name]]";
      customControls["Folder Link"] = "$[[folder_link]]";
      customControls["Self Link"] = "$[[self_link]]";
      customControls["Publish Date"] = "$[[publish_date]]";
      customControls["Expiration Date"] = "$[[expiration_date]]";
      customControls["Last Modified"] = "$[[last_modified]]";
      customControls["Custom Field"] = "$[[field_FIELDNAME]]";
      
      //Usage: addCustomControl(initialText, selections)
      addCustomControl("Custom Dropdown Text", customControls);
    

    addCustomControl() arguments:

    1. initialText: Text to display as the first selection item

    2. selections: JavaScript array of the selection choices

  4. Generate the HTML Editor.

      // Usage: writeEditor(fieldname, html, width, height, buttons)
      writeEditor('documentTemplate', document.getElementById("tempHolder").innerHTML, 640, 200, true);
      
      </script>
    

    writeEditor() arguments:

    1. fieldname: ID of the field that contains text entered by the user

    2. html: HTML for seeding the editor

    3. width: Width of the editor in pixels

    4. height: Height of the editor in pixels

    5. buttons: Boolean variable indicating whether or not to show control buttons

 
Top of page

Calendar widget

The Calendar widget implements a graphical date selector into a portlet. It is used by the Content Administration and CAP Editor portlets for entering document publication dates and expiration dates.

Here is what the Calendar widget looks like:

CalendarWidget

 
Top of section

Implementing the Calendar widget in a portlet

To implement the Calendar widget in a portlet, follow these steps:

  1. Import the JavaScript file into the portlet:

      <script language="JavaScript" type="text/javascript" src="RESOURCE_URL/portal-general/calendar_widget.js">
    
  2. Create the calendar.

      <script>
      //Usage: createCalendar(calendarID, dateFieldID, dateFunctionID, top, left)
      NCW_createCalendar("calHolder","dateHolder","setActualDate","40px","35px");
      </script>
    

    createCalendar() arguments:

    1. calendarID: ID of the calendar, passed to the DIV tag

    2. dateFieldID: ID of the field that holds the date value

    3. dateFunctionID: Name of a custom JavaScript function that is called when the user presses OK

    4. top: Top coordinate of calendar (number of pixels from the top of the browser)

    5. left: Left coordinate of calendar (number of pixels from the left of the browser)

  3. Incorporate your calendar into the portlet.

    For example, suppose you want to use the calendar in the same way as the Content Administration portlet for selecting dates in two fields that each use ellipsis buttons. Here is JavaScript code that handles this user interface:

      <script>
      //Usage: showCalendar(fieldID, currentDate)
      function setPub() {
      NCW_showCalendar('publishDate',Date.parse(document.getElementById("publishDate").value));
      }
      
      function setExp() {
      NCW_showCalendar('expirationDate',Date.parse(document.getElementById("expirationDate").value));
      }
      
      //Usage: setActualDate(dateFunctionID)
      function setActualDate(whichField) {
      document.getElementById(whichField).value = document.getElementById("dateHolder").value;
      }
      </script>
    

    NCW_showCalendar() arguments:

    1. fieldID: ID of the field the portlet displays to show the date

    2. currentDate: Existing date to show in the calendar in milliseconds

    NOTE:   The function setActualData() is the function specified in the dateFunctionID argument of createCalendar(). This function is called when the user presses the OK button in the widget to select a date. In this example, setActualData() passes back the ID of the field that should be set to the selected date.

 
Top of page

Context Menu widget

The Context Menu widget overrides the browser's right-click context menu with a menu based on the portlet's runtime context. It determines when to show or hide the portlet-based menu and automatically positions the menu at the cursor location.

The Content Administration portlet uses the Context Menu widget to give you access to its Tool Pallette functions when you right-click on a folder, document, or category in its Content panel.

 
Top of section

Implementing the Context Menu widget in a portlet

To implement the Calendar widget in a portlet, follow these steps:

  1. Import the JavaScript file into the portlet:

      <script language="JavaScript" type="text/javascript" src="RESOURCE_URL/portal-general/context_menu_widget.js">
    
  2. Create the user interface for the menu inside a <div> tag.

    For example, here is an interface that displays a menu with three choices: Item 1, Item 2, and Item 3:

      <div id="menu_holder">
      <ul>
      <li>Item 1</li>
      <li>Item 2</li>
      <li>Item 3</li>
      </ul>
      </div>
    
  3. Activate the menu:

      <script>
      //Usage: NCMW_activateContextMenu(menuID, callbackFunction)
      NCMW_activateContextMenu("menu_holder","selectRow");
      </script>
    

    NCMW_activateContextMenu() arguments:

    1. menuID: ID of the <div> tag that specifies the user interface for the menu

    2. callbackFunction: Optional function that is called when you click an item in the menu. This function must be provided in your portlet. If you do not provide the callback function, no actions are executed when a user selects an option in the portlet-based context menu.



Copyright © 2004-2005 Novell, Inc. All rights reserved. Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003 SilverStream Software, LLC. All rights reserved.  more ...