liferay-look-and-feel_3_5_0.dtd
: Elements - Entities - Source | Intro - Index
FRAMES / NO FRAMES
This is the DTD for the Look and Feel parameters for Liferay Portal.
<!DOCTYPE look-and-feel PUBLIC "-//Liferay//DTD Look and Feel 3.5.0//EN" "http://www.liferay.com/dtd/liferay-look-and-feel_3_5_0.dtd">
<look-and-feel> | Root element |
The look-and-feel element is the root of the deployment descriptor for a Liferay look and feel archive. The look and feel archive will hereafter be referred to as a LAF archive.
Element's model:
<look-and-feel>'s children Name Cardinality compatibility Only one theme Any number
(compatibility, theme*)
<compatibility> | Child of look-and-feel |
The compatibility element specifies a list of Liferay Portal versions that will properly deploy the themes in this LAF archive.
Element's model:
<compatibility>'s children Name Cardinality version At least one
(version+)
<version> | Child of compatibility |
The version element specifies a specific Liferay Portal version number. For example, if its value is "3.5.0", that means the themes in this LAF archive will deploy correctly in Liferay Portal 3.5.0. The portal will not deploy themes from a LAF archive unless the version numbers match.
<theme> | Child of look-and-feel |
The theme element contains the declarative data of a theme.
Element's model:
<theme>'s children Name Cardinality color-scheme At least one images-path Only one root-path Only one settings One or none template-extension Only one templates-path Only one
<theme>'s attributes Name Values Default id name
(root-path, templates-path, images-path, template-extension, settings?, color-scheme+)
@id | Attribute of theme |
The id attribute specifies the unique key for a theme. The name attribute specifies the friendly name of a theme that is displayed to the user.
Required
@name | Attribute of theme |
The id attribute specifies the unique key for a theme. The name attribute specifies the friendly name of a theme that is displayed to the user.
Required
<root-path> | Child of theme |
The root-path value sets the location of the root path for the theme. For example, the root path for the Classic theme is "/html/themes/classic". This means you can find the files for the Classic theme in /docroot/html/themes/classic.
<templates-path> | Child of theme |
The templates-path value sets the location of the templates path for the theme. For example, the templates path for the Classic theme is "/html/themes/classic/templates". This means you can find the JSP templates for the Classic theme in /docroot/html/themes/classic/templates.
<images-path> | Child of theme |
The images-path value sets the location of the images path for the theme. For example, the images path for the Classic theme is "/html/themes/classic/images". This means you can find the images for the Classic theme in /docroot/html/themes/classic/images.
<template-extension> | Child of theme |
The templates-extension value sets the file extension of the files located in the templates directory. If you specify the value "jsp", then the portal will look for files such as portal_nav.jsp in the templates directory. If you specify the value "vm", then the portal will look for files such as portal_nav.vm in the templates directory. Specifying "vm" means you can use Velocity to create your theme. New extensions will be supported in the future to allow for even more flexibility in the creation of themes.
<settings> | Child of theme |
The settings element contain a list of settings or properties that are available to the theme object at runtime. They are described with a key value pair.
For example, you can access it with the command: theme.getSetting("hello").
Element's model:
<settings>'s children Name Cardinality setting Any number
(setting*)
<setting> | Child of settings |
See the comments in settings element.
<setting>'s attributes Name Values Default key value
@key | Attribute of setting |
See the comments in settings element.
Required
@value | Attribute of setting |
See the comments in settings element.
Required
<color-scheme> | Child of theme |
A theme can have many color schemes. It works very similar to Windows. The Windows XP theme has one set of color schemes, and the Windows Classic theme has another set of color schemes. Each color scheme contains a list of colors that helps decorate the theme.
A sample list of available colors are:
body-bg=#FFFFFF
layout-bg=#FFFFFF layout-text=#000000
layout-tab-bg=#E0E0E0 layout-tab-text=#000000
layout-tab-selected-bg=#6699CC layout-tab-selected-text=#4A517D
portlet-title-bg=#6699CC portlet-title-text=#4A517D
portlet-menu-bg=#B6CBEB portlet-menu-text=#000000
portlet-bg=#FFFFFF
portlet-font=#000000 portlet-font-dim=#C4C4C4
portlet-msg-status=#000000 portlet-msg-info=#000000 portlet-msg-error=#FF0000 portlet-msg-alert=#FF0000 portlet-msg-success=#007F00
portlet-section-header=#596171 portlet-section-header-bg=#AFBEDA
portlet-section-subheader=#405278 portlet-section-subheader-bg=#91AEE8
portlet-section-body=#3F3F3F portlet-section-body-bg=#EAF2FF
portlet-section-body-hover=#FFFFFF portlet-section-body-hover-bg=#5274AE
portlet-section-alternate=#3F3F3F portlet-section-alternate-bg=#DBE1ED
portlet-section-alternate-hover=#FFFFFF portlet-section-alternate-hover-bg=#5274AE
portlet-section-selected=#7AA0EC portlet-section-selected-bg=#FAFCFE
portlet-section-selected-hover=#00329A portlet-section-selected-hover-bg=#C0D2F7
<color-scheme>'s attributes Name Values Default id name
@id | Attribute of color-scheme |
The id attribute specifies the key for a color scheme that is unique for its parent theme. The name attribute specifies the friendly name of a color scheme that is displayed to the user.
Required
@name | Attribute of color-scheme |
The id attribute specifies the key for a color scheme that is unique for its parent theme. The name attribute specifies the friendly name of a color scheme that is displayed to the user.
Required