Portal Guide

CHAPTER 30

System Portlets for Portal Pages

This chapter describes system portlets designed to provide out-of-the-box functionality for portal pages. It covers the following topics:

 
Top of page

Portal Page Controller portlet

The Portal Page Controller portlet displays the currently selected personal page or shared page at a designated location on a container page. This portlet must be added to all container pages.

Typically, the portal administrator places this portlet in a content pane on a container page, as in this example:

pgPPCinContentFrameOnContainer

In this layout, the Portal Page Controller portlet automatically renders the page selected from the navigation pane by displaying its content and layout in the content pane of the container page, as shown:

The links in the navigation pane are generated automatically by the Page Navigation portlet, described in Page Navigation portlet.

 
Top of section

Portal Page Controller preferences

There are no preferences to set for the Portal Page Controller portlet.

 
Top of page

Page Navigation portlet

The Page Navigation portlet provides a graphical user interface that lets users easily navigate to all container, shared, and personal pages that they are authorized to access.Typically, the portal administrator places this portlet in a navigation pane on a container page, as in this example:

pgPNinNavFrameOnContainer

The Navigation portlet automatically creates a set of links to the pages available to the logged-in user. In the following example, the Navigation portlet presents the container, shared, and personal pages that are available to the logged-in user:

 
Top of section

Page Navigation portlet preferences

You can configure the following preferences of Navigation portlets

Preference

Description

What to specify

width

Width of portlet content display

A number of pixels or percentage

layout

HTML layout for this portlet

HTML content or a scoped path pointing to HTML content

tooltip

Display tooltips for page links

true or false

navigation-justification

Justification of navigation text

none, left, right, or center

listmaxrows

Maximum number of displayed rows when navigation type is set to List

Integer

containerpages-show

Display links to container pages

true or false

containerpages-title

Text to display as a title for container page links

Text string

containerpages-navigation-type

Format for presenting links to container pages

One of these constants:

  • simpleRow

  • simpleColumn

  • simpleTree

  • list

  • menu

  • hierVMenu

  • hierHMenu

For more information    For more information, see Navigation type formats.

containerpages-urlmode

Method used for navigation: regular HTML links or use of an invisible HTML form

query(invisible form)

or

path(link)

containerpages-sorting

Order in which to display links to container pages

ascending

or

descending

containerpages-sortmode

Field used for sorting container page's name or priority

alphabetical

or

priority

containerpages-categories

List of page categories to filter the list of container pages. Uncategorized filters uncategorized container pages.

List of categories (text strings)

sharedpages-show

Display links to shared pages?

true or false

sharedpages-title

Text to display as a title for shared page links

Text string

sharedpages-navigation-type

Format for presenting links to shared pages

One of these constants:

  • simpleRow

  • simpleColumn

  • simpleTree

  • list

  • menu

  • hierVMenu

  • hierHMenu

For more information    For more information, see Navigation type formats.

sharedpages-urlmode

Method used for navigation: regular HTML links or use of an invisible HTML form

query(invisible form)

or

path(link)

sharedpages-sorting

Order in which to display links to shared pages

ascending

or

descending

sharedpages-sortmode

Field used for sorting shared page's name or priority

alphabetical

or

priority

sharedpages-categories

List of page categories to filter the list of shared pages. Uncategorized filters uncategorized pages

List of categories (Text strings)

userpages-show

Display links to personal pages?

true or false

userpages-title

Text to display as a title for personal page links

Text string

userpages-navigation-type

Format for presenting links to personal pages

One of these constants:

  • simpleRow

  • simpleColumn

  • simpleTree

  • list

  • menu

  • hierVMenu

  • hierHMenu

For more information    For more information, see Navigation type formats.

userpages-urlmode

Method used for navigation: regular HTML links or use of an invisible HTML form

query(invisible form)

or

path(link)

userpages-sorting

Order in which to display links to personal pages

ascending or descending

userpages-sortmode

Field used for sorting personal page's name or priority

alphabetical

or

priority

quicklinks-show

Display quicklinks?

true or false

quicklinks-title

Text to display as a title for quicklinks

Text string

quicklinks-navigation-type

Format for presenting quicklinks

One of these constants:

  • simpleRow

  • simpleColumn

  • simpleTree

  • list

  • menu

  • hierVMenu

  • hierHMenu

For more information    For more information, see Navigation type formats.

quicklinks

List of links, external or internal

Syntax: label~url

Example:

Novell~http://www.novell.com

personalize-display

Display link to Portal Personalizer?

true or false

portalpageadmin-display

Display link to Portal Administration page?

true or false

login-logout display

Display link to portal login or logout?

true or false

quicklink-display

Display quick links?

true or false

 
Top of section

Navigation type formats

The following table shows each format that you can specify for containerpages-navigation-type, sharedpages-navigation-type, and userpages-navigation-type preferences in the Navigation portlet:

Navigation type

Preview

simpleRow

pgNavigationTypeSimpleRow

simpleColumn

pgNavigationTypeSimpleColumn

simpleTree

pgNavigationTypeSimpleTree

list

pgNavigationTypeList

menu

pgNavigationTypeMenu

hierVMenu

pgNavigationTypeHierVMenu

hierHMenu

pgNavigationTypeHierHMenu

 
Top of page

Page Header portlet

The Page Header portlet provides a mechanism for creating a customized look and feel for Web pages in an organization. Typically, the portal administrator places this portlet in a header pane on a container page to establish a corporate identity.

pgPHinHeaderFrameOnContainer

 
Top of section

Page Header portlet preferences

You can configure the following preferences for Header portlets:

Preference

Description

What to specify

width

Width of portlet content display

A number of pixels or a percentage

logo-image

Logo to be displayed in the header

URL

background-image

Background image for the header

URL

background-repeat

Repeat pattern for the background image

no-repeat

repeat-x

repeat-y

repeat

background-position

Position of the background image

top, middle, bottom

OR

left, center, right

layout

HTML layout for this portlet

HTML content or a scoped path pointing to HTML content

sitename

Portal main title

Text string

salutation

Welcoming words to precede the username display in the header

Text string

anonymous-salutation

Welcoming words to anonymous users

Text string

userformat-html

HTML layout to define the display pattern for the username

HTML content with uses of User scoped path

date-display

Display today's date?

true or false

date-style

Date format patterns

Date format

See Format scoped path for available patterns

personalize-display

Display link to Portal Personalizer?

true or false

portalpageadmin-display

Display link to Portal Administration page?

true or false


login-logout display

Display link to portal login or logout?

true or false

Tooltip

Display tooltips for page links?

true or false

navigation-justification

Justification of navigation text

none, left, right, or center

listmaxrows

Maximum number of displayed rows when navigation is set to List

Integer

containerpages-show

Display links to container pages?

true or false

containerpages-title

Text to display as a title for container page links

Text string

containerpages-navigation-type

Format for presenting links to container pages

One of these constants:

One of these constants:

  • simpleRow

  • simpleColumn

  • simpleTree

  • list

  • menu

  • hierVMenu

  • hierHMenu

For more information    For more information, see Navigation type formats.

containerpages-urlmode

Method used for navigation: regular HTML links or use of an invisible form

query(invisible form)

OR

path(link)

containerpages-sorting

Order in which to display links to container pages

ascending

OR

descending

containerpages-sortmode

Field used for sorting container page's name or priority

alphabetical

OR

priority

containerpages-categories

List of page categories to filter the list of container pages. Uncategorized filters uncategorized container pages.

List of categories (text strings)

sharedpages-show

Display links to shared pages?

true or false

sharedpages-title

Text to display as a title for shared page links

Text string

shared pages-navigation-type

Format for presenting links to shared pages

One of these constants:

  • simpleRow

  • simpleColumn

  • simpleTree

  • list

  • menu

  • hierVMenu

  • hierHMenu

For more information    For more information, see Navigation type formats.

sharedpages-urlmode

Method used for navigation: regular HTML links or use of an invisible HTML form

query(invisible form)

OR

path(link)

sharedpages-sorting

Order in which to display links to shared pages

ascending

or

descending

sharedpages-sortmode

Field used for sorting shared page's: name or priority

alphabetical

or

priority

sharedpages-categories

List of page categories to filter the list of shared pages. Uncategorized filters uncategorized pages

List of categories (Text strings)

userpages-show

Display links to personal pages?

true or false

userpages-title

Text to display as a title for personal page links

Text string

userpages-navigation-type

Format for presenting links to personal pages

One of these constants:

  • simpleRow

  • simpleColumn

  • simpleTree

  • list

  • menu

  • hierVMenu

  • hierHMenu

For more information    For more information, see Navigation type formats.

userpages-urlmode

Method used for navigation: regular HTML links or use of an invisible HTML form

query(invisible form)

or

path(link)

userpages-sorting

Order in which to display links to personal pages

ascending

or

descending

userpages-sortmode

Field used for sorting personal page's name or priority

alphabetical

or

priority

quicklinks-show

Display quicklinks?

true or false

quicklinks-title

Text to display as a title for quicklinks

Text string

quicklinks-navigation-type

Format for presenting quicklinks

One of these constants:

  • simpleRow

  • simpleColumn

  • simpleTree

  • list

  • menu

  • hierVMenu

  • hierHMenu

  • For more information    For more information, see Navigation type formats.

quicklinks

List of links, external, or internal

Syntax: label~URl

Example:

Novell~http://www.novell.com




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