Sun Java System Portal Server 7.1 Developer's Guide

Desktop Templates

This section contains:

Template Files

The /var/opt/SUNWportal/portals/portal-ID/desktop/desktoptype directory contains templates that are used to generate the Desktop pages. For each directory contained in this directory, a new directory for the locale must be created. The directory name must contain the existing directory with an underscore and the name of the locale; for example, /var/opt/SUNWportal/portals/portal-ID/desktop/default is translated to /var/opt/SUNWportal/portals/portal-ID/desktop/default_locale.

All of the file names can remain the same. Only files that require translation must be created in the locale-specific directory. If a file is not found in the locale-specific directory, it is automatically taken from the directory that does not have the locale specifier.

Template files are mostly markup text with embedded tags that specify substitutions to be performed at runtime. The tags have the form [...]. The tags should not be modified during the translation process.

Each template file is encoded using Java Unicode encoding where non-ASCII characters are represented with \\uXXXX notation. Here the \\uXXXX is the hexidecimal representation of the Unicode value for the character. This type of file can be created from a native file using the Java native2ascii program available in the JDK 1.3.1 package that is shipped with the Portal Server software.

JavaServer Pages

JSP files end with the .jsp suffix. The encoding for each top-level JSP file is specified using a header at the top of the file. The header appears as the following:

<%@ page contentType="text/html; charset=encoding" %>

where encoding is the desired encoding such as UTF-8 or EUC-JP. Note that this is only for top-level JSP files. JSPs that are statically included by other JSPs must use the encoding of the including JSP. That is, JSPs that are statically included by other JSPs using

<%@ include file="relativeURL" %>

must use the encoding of the including JSP. JSPs that are dynamically included using:

<jsp:include page="{ relativeURL | <%= expression %>}" flush="true" />

must have their own page directive that contains the encoding.

Image Files

If image files referenced by the existing templates are inappropriate for a locale, the references can be changed to refer to new files. The new file must be placed in the document root of the web container at PortalServer-base/web-src directory and then deploy it with the PortalServer-base/bin/psadmin deploy sub command. Or, you can deploy a new WAR file into the location of your choice.