Branding the Developer Portal

C H A P T E R 3

This chapter describes how to brand the Developer Portal component of Sun Java System Content Delivery Server. You can change any or all of the files described in the following table to make the Developer Portal interface more closely conform to your corporate image.

TABLE 3-1 Developer Portal Files
File	Description
`$CDS_HOME/deployment/`deployment-name`/.../tpl/_tpl_main.jsp`¹	Banner and footer for each page
`$CDS_HOME/deployment/`deployment-name`/localization/DevPortalMessages.properties`	Strings used for the title and other text elements
`$CDS_HOME/deployment/`deployment-name`/...developer/media/v_banner001.gif`¹	Graphic used for the logo
`$CDS_HOME/deployment/`deployment-name`/.../developer/styles/m4_developer.css`¹	Style sheet used for basic colors and fonts
`$CDS_HOME/deployment/`deployment-name`/.../developer/html/developer_agreement.html`¹	User license agreement
`$CDS_HOME/deployment/`deployment-name`/.../developer/support/docs/ContentDeveloperGuide.pdf`¹	File shown when the Help link is clicked
¹The directory path differs depending on the application server that you are using: If you are using Sun Java System Application Server, Developer Portal files are in the `$CDS_HOME/deployment/`deployment-name`/sun/domains/`server-domain`/applications/j2ee-modules/CDSDeveloperPortal` directory. If you are using WebLogic Server, Developer Portal files are in the `$CDS_HOME/deployment/`deployment-name`/weblogic/domains/`server-domain`/applications/developer` directory. deployment-name is the name specified when the Catalog Manager was deployed. server-domain is the value specified in the deployment configuration file for the `app.server.domain` property.

Tip - The files listed in TABLE 3-1 are used to present the pages of the Developer Portal. Changes are displayed when a page is refreshed. You might want to edit copies of the files, then replace the original files with the changed files after you are sure there are no errors.

The following topics are presented:

Changing the Banner

Adding a Footer

Changing the Title

Changing the Logo Graphic

Changing Basic Colors and Fonts

Providing a Developer License Agreement

Changing the Registration Confirmation

Changing the Help File

3.1 Changing the Banner

The banner is a graphic that is displayed at the top of each page. To use a different logo graphic or change the top banner in other ways, edit the template used to build the page:

1. Open the $CDS_HOME/deployment/deployment-name/.../tpl/_tpl_main.jsp file.

Note - Use caution when editing this file. A mistake could cause pages to render incorrectly or not render at all.

2. Find the table containing the banner image (v_banner001.gif) and replace the entire table with your customized table.

3. Save your changes.

3.2 Adding a Footer

The Developer Portal does not have a default footer. You can add a footer, if desired, by editing the template used to build the page:

1. Open the $CDS_HOME/deployment/deployment-name/.../tpl/_tpl_main.jsp file.

Note - Use caution when editing this file. A mistake could cause pages to render incorrectly or not render at all.

2. Find the comment  at the end of the page and after the comment add a table that contains your footer.

3. Save your changes.

3.3 Changing the Title

To change the title of the main page, edit the $CDS_HOME/deployment/deployment_name/localization/DevPortalMessages.properties file and replace the value of the following property with the title that you require:

default.app.title=Sun Java [TM] System Content Delivery Server - Developer Portal

3.4 Changing the Logo Graphic

To change the logo graphic, replace $CDS_HOME/deployment/deployment-name/.../developer/media/v_banner001.gif with your company logo. If you plan to use the existing banner source code, the image size is 215x25 pixels. For proper display, provide a replacement logo with the same dimensions.

Note - Changing the logo changes the logo display throughout the Developer Portal.

3.5 Changing Basic Colors and Fonts

To simplify branding, the layout of the Developer Portal is controlled by a style sheet, $CDS_HOME/deployment/deployment-name/.../developer/styles/m4_developer.css. The background and font colors are defined in the style sheet. Edit the style sheet to change the colors and fonts for the Developer Portal. You can use any text editor to edit this file.

3.6 Providing a Developer License Agreement

The Developer Portal provides a placeholder for a license agreement that you can provide to specify the terms and conditions that developers must accept to submit content to your server. Replace the placeholder with your license agreement.

Provide a license agreement using one of the following methods:

Replace the$CDS_HOME/deployment/deployment-name/.../developer/html/developer_agreement.html file with your own file of the same name.

Point the Developer Portal to a different file. If you choose to provide a different file, edit the $CDS_HOME/deployment/deployment-name/localization/DevPortalMessages.properties file and set the value of the following property to the location of your license agreement.

content.developers.agreement.url=/developer/html/developer_agreement.html

To change the text for the links to the license agreement, edit the DevPortalMessages.properties file located in the $CDS_HOME/deployment/deployment_name/localization directory and set the value of the following property to the string of your choice:

agreement.name=Wireless, Inc. Content Developers Agreement

3.7 Changing the Registration Confirmation

Developers who want to submit content to Content Delivery Server can create a developer account by registering through the Developer Portal. When the registration completes successfully, a confirmation page is displayed. You can configure the title and the message for this page by setting the following properties in the DevPortalMessages.properties file located in the $CDS_HOME/deployment/deployment_name/localization directory:

registration_done.page.title. Set this property to the title that you want displayed.

registration_done.title. Set this property to the message that you want displayed.

3.8 Changing the Help File

When when a developer clicks the Help link from any page in the Developer Portal, a PDF file that describes how to submit content to Content Delivery Server is presented. To customize the information presented, do one of the following options:

Replace the ContentDeveloperGuide.pdf file in the $CDS_HOME/deployment/deployment-name/.../developer/support/docs directory with a PDF file of the same name that you created.

Set the login.devguide.link property in the $CDS_HOME/deployment/deployment-name/localization/DevPortalMessages.properties file to the location of your help file.