You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by ta...@apache.org on 2009/02/24 00:30:58 UTC
svn commit: r747203 - in
/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02:
customizing-overview.xml default-page.xml deploy-custom.xml
desktop-theme.xml page-decoration.xml portlet-decoration.xml
Author: taylor
Date: Mon Feb 23 23:30:57 2009
New Revision: 747203
URL: http://svn.apache.org/viewvc?rev=747203&view=rev
Log:
eoln
Added:
portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/customizing-overview.xml (with props)
portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/desktop-theme.xml (with props)
portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/page-decoration.xml (with props)
portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/portlet-decoration.xml (with props)
Modified:
portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/default-page.xml
portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/deploy-custom.xml
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/customizing-overview.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/customizing-overview.xml?rev=747203&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/customizing-overview.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/customizing-overview.xml Mon Feb 23 23:30:57 2009
@@ -0,0 +1,85 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Customization</title>
+ <subtitle>Decorator and Theme Customization</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="David Dyer"
+ email="ddyer@artifact-software.com" />
+ <person name="Ron Wheeler"
+ email="rwheeler@artifact-software.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Decorator and Theme Customization">
+ <p>
+ Now that we have created our custom Jetspeed project,
+ lets start customizing the portal design. The portal
+ design, or skins, are known in Jetspeed as
+ <i>decorators and themes</i>
+ . With decorators and themes, you can customize the
+ portal experience to the branding of your organization.
+ In this tutorial, we will simply change a few images,
+ CSS styles and colors to get you on your way.
+ </p>
+ <p>
+ It is important to note that all of the changes made in
+ this section are made in the build environment. The
+ changes we are making here could just as easily be made
+ using the portal's live customization features. For
+ example, you can drop a decorator or theme into the
+ portal while its running. Jetspeed will pick it up
+ automatically. Or, to customize a page, you can use the
+ portlet customizer or desktop customizer, portlet
+ selector, and site manager: all administrative portlets
+ that work on your live portal. However, the point of
+ configuring everything in a Maven build is to be able to
+ easily reproduce portal environments for development,
+ testing, and new deployments.
+ </p>
+ <p>
+ This section of the tutorial covers customizing:
+ <ul>
+ <li>
+ Portal Skins (or Decorators). We replace the
+ default logo, colors, and page header and
+ footers with our own.
+ </li>
+ <li>
+ Portal Themes. Same as Portal Skins, but themes
+ apply to the Jetspeed Desktop.
+ </li>
+ <li>
+ Configuring the default portal page to use these
+ new decorators and themes
+ </li>
+ </ul>
+ </p>
+ <p>
+ Lets get started with customization of the default
+ portal page decoration
+ </p>
+ <p>
+ <a href='../01/run-it.html'>Previous</a>
+ <a href='page-decoration.html'>Next</a>
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/customizing-overview.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/customizing-overview.xml
------------------------------------------------------------------------------
svn:keywords = Id
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/default-page.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/default-page.xml?rev=747203&r1=747202&r2=747203&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/default-page.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/default-page.xml Mon Feb 23 23:30:57 2009
@@ -1,86 +1,86 @@
-<?xml version="1.0"?>
-<!--
+<?xml version="1.0"?>
+<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-<document>
- <properties>
- <title>Default Page</title>
- <subtitle>Modifying the Default Page</subtitle>
- <authors>
- <person name="David Sean Taylor" email="taylor@apache.org" />
- <person name="David Dyer"
- email="ddyer@artifact-software.com" />
- <person name="Ron Wheeler"
- email="rwheeler@artifact-software.com" />
- </authors>
- </properties>
- <body>
- <section name="Modifying the Default Page">
- <p>
- Now that we have created our decorators and themes, lets
- put them to use on the default page. Lets get started
- with customization of the default portal page
- decoration. Copy in our sample default-page:
- </p>
- <source>
- <![CDATA[
-# Linux
-cd /JetspeedTraining/workspace/jetexpress
-cp ../../resources/pages/default-page.psml portal/src/webapp/WEB-INF/pages/
-
-# Windows
-cd \JetspeedTraining\workspace\jetexpress
-copy ..\..\resources\pages\default-page.psml portal\src\webapp\WEB-INF\pages
- ]]>
- </source>
- <p>
- Refresh your Eclipse project and edit the
- default-page.psml. Make the following modifications
- <ul>
- <li>
- for the layout-decorator, replace tigris with
- <b>express-page</b>
- </li>
- <li>
- for the portlet-decorator, replace tigris with
- <b>express-portlet</b>
- </li>
- <li>
- add a skin default attribute as
- <b>skin="express"</b>
- for the desktop theme
- </li>
- </ul>
- </p>
- <source>
- <![CDATA[
-<page>
- <defaults layout-decorator="express-page"
- portlet-decorator="express-portlet"
- skin="express"/>
- ]]>
- </source>
- <p>
- Go ahead and save that file. We are now ready to deploy
- your changes to the portal
- </p>
- <p>
- <a href='desktop-theme.html'>Previous</a>
- <a href='deploy-custom.html'>Next</a>
- </p>
- </section>
- </body>
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Default Page</title>
+ <subtitle>Modifying the Default Page</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="David Dyer"
+ email="ddyer@artifact-software.com" />
+ <person name="Ron Wheeler"
+ email="rwheeler@artifact-software.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Modifying the Default Page">
+ <p>
+ Now that we have created our decorators and themes, lets
+ put them to use on the default page. Lets get started
+ with customization of the default portal page
+ decoration. Copy in our sample default-page:
+ </p>
+ <source>
+ <![CDATA[
+# Linux
+cd /JetspeedTraining/workspace/jetexpress
+cp ../../resources/pages/default-page.psml portal/src/webapp/WEB-INF/pages/
+
+# Windows
+cd \JetspeedTraining\workspace\jetexpress
+copy ..\..\resources\pages\default-page.psml portal\src\webapp\WEB-INF\pages
+ ]]>
+ </source>
+ <p>
+ Refresh your Eclipse project and edit the
+ default-page.psml. Make the following modifications
+ <ul>
+ <li>
+ for the layout-decorator, replace tigris with
+ <b>express-page</b>
+ </li>
+ <li>
+ for the portlet-decorator, replace tigris with
+ <b>express-portlet</b>
+ </li>
+ <li>
+ add a skin default attribute as
+ <b>skin="express"</b>
+ for the desktop theme
+ </li>
+ </ul>
+ </p>
+ <source>
+ <![CDATA[
+<page>
+ <defaults layout-decorator="express-page"
+ portlet-decorator="express-portlet"
+ skin="express"/>
+ ]]>
+ </source>
+ <p>
+ Go ahead and save that file. We are now ready to deploy
+ your changes to the portal
+ </p>
+ <p>
+ <a href='desktop-theme.html'>Previous</a>
+ <a href='deploy-custom.html'>Next</a>
+ </p>
+ </section>
+ </body>
</document>
\ No newline at end of file
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/deploy-custom.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/deploy-custom.xml?rev=747203&r1=747202&r2=747203&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/deploy-custom.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/deploy-custom.xml Mon Feb 23 23:30:57 2009
@@ -1,82 +1,82 @@
-<?xml version="1.0"?>
-<!--
+<?xml version="1.0"?>
+<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-<document>
- <properties>
- <title>Deploying Decorations, Themes and Pages</title>
- <subtitle>Deploying Decorations, Themes and Pages</subtitle>
- <authors>
- <person name="David Sean Taylor" email="taylor@apache.org" />
- <person name="David Dyer"
- email="ddyer@artifact-software.com" />
- <person name="Ron Wheeler"
- email="rwheeler@artifact-software.com" />
- </authors>
- </properties>
- <body>
- <section name="Deploying Decorations, Themes and Pages">
- <p>
- To deploy the new resources (decorations, themes, and
- page) that we created in this section of the tutorial,
- you could simply rebuild the portal by typing
- <b>mvn -P tomcat,min</b>
- . Or, if your portal is aleady up and running, a simpler
- way is to automate the easy deployment tasks with Ant.
- We have created a simple build.xml to copy over changed
- portal resources:
- </p>
- <source>
- <![CDATA[
-# Linux
-cd /JetspeedTraining/workspace/jetexpress
-cp ../../resources/build.xml .
-
-# Windows
-cd \JetspeedTraining\workspace\jetexpress
-copy ..\..\resources\build.xml
- ]]>
- </source>
- <p>
- To copy over the resources to the running portal, type:
- </p>
- <source>
- <![CDATA[
-ant
- ]]>
- </source>
- <p>
- Refresh the portal home page,
- <a href="http://localhost:8080/jetexpress/portal">
- http://localhost:8080/jetexpress/portal
- </a>
- You should now see a portal with our new custom
- decorators:
- </p>
- <p>
- <img src="../images/jetexpress-portal.png" />
- </p>
- <p>and desktop theme:</p>
- <p>
- <img src="../images/jetexpress-desktop.png" />
- </p>
- <p>
- <a href='default-page.html'>Previous</a>
- <a href='../03/portlet-app.html'>Next</a>
- </p>
- </section>
- </body>
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Deploying Decorations, Themes and Pages</title>
+ <subtitle>Deploying Decorations, Themes and Pages</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="David Dyer"
+ email="ddyer@artifact-software.com" />
+ <person name="Ron Wheeler"
+ email="rwheeler@artifact-software.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Deploying Decorations, Themes and Pages">
+ <p>
+ To deploy the new resources (decorations, themes, and
+ page) that we created in this section of the tutorial,
+ you could simply rebuild the portal by typing
+ <b>mvn -P tomcat,min</b>
+ . Or, if your portal is aleady up and running, a simpler
+ way is to automate the easy deployment tasks with Ant.
+ We have created a simple build.xml to copy over changed
+ portal resources:
+ </p>
+ <source>
+ <![CDATA[
+# Linux
+cd /JetspeedTraining/workspace/jetexpress
+cp ../../resources/build.xml .
+
+# Windows
+cd \JetspeedTraining\workspace\jetexpress
+copy ..\..\resources\build.xml
+ ]]>
+ </source>
+ <p>
+ To copy over the resources to the running portal, type:
+ </p>
+ <source>
+ <![CDATA[
+ant
+ ]]>
+ </source>
+ <p>
+ Refresh the portal home page,
+ <a href="http://localhost:8080/jetexpress/portal">
+ http://localhost:8080/jetexpress/portal
+ </a>
+ You should now see a portal with our new custom
+ decorators:
+ </p>
+ <p>
+ <img src="../images/jetexpress-portal.png" />
+ </p>
+ <p>and desktop theme:</p>
+ <p>
+ <img src="../images/jetexpress-desktop.png" />
+ </p>
+ <p>
+ <a href='default-page.html'>Previous</a>
+ <a href='../03/portlet-app.html'>Next</a>
+ </p>
+ </section>
+ </body>
</document>
\ No newline at end of file
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/desktop-theme.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/desktop-theme.xml?rev=747203&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/desktop-theme.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/desktop-theme.xml Mon Feb 23 23:30:57 2009
@@ -0,0 +1,203 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Page Themes</title>
+ <subtitle>Desktop Page Themes</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="David Dyer"
+ email="ddyer@artifact-software.com" />
+ <person name="Ron Wheeler"
+ email="rwheeler@artifact-software.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Desktop Page Themes">
+ <p>
+ The Jetspeed Desktop has its own kinds of decorations.
+ These decorations are called
+ <b>Desktop Themes</b>
+
+ Each Jetspeed Desktop page can be associated with a
+ different theme. Themes control some important aspect of
+ a desktop page:
+ <ul>
+ <li>
+ The colors, images, CSS styles that skin this
+ page
+ </li>
+ <li>The header portion of the page</li>
+ <li>The page margins</li>
+ <li>The footer portion of the page</li>
+ <li>Menus displayed on the page</li>
+ <li>Action buttons displayed on the window</li>
+ </ul>
+ Themes do not control the placement of portlets. That is
+ handled by the Jetspeed Desktop engine, which follows
+ the layout plan provided by the stuctured page markup
+ (PSML). This is the same layout instructions applied to
+ a portal page. You will see that themes are much simpler
+ content than decorators. That is because most of the
+ content in a theme is populated by the Jetspeed Desktop
+ engine at runtime. Jetspeed comes with a few desktop
+ themes out of the box. The default desktop theme for
+ most pages is called
+ <i>blue</i>
+ . It looks like this:
+ </p>
+ <img src="../images/theme.png" />
+ <p>
+ We are going to create a new desktop theme for this
+ tutorial. This new theme can be copied into our project
+ from the
+ <i>/JetspeedTutorial/resources/themes/express/</i>
+ directory. This will save you the trouble of creating
+ all the logo images and CSS definitions.
+ </p>
+ <source>
+ <![CDATA[
+# Linux
+cd /JetspeedTraining/workspace/jetexpress
+mkdir portal/src/webapp/desktop-themes/express
+cp -r ../../resources/desktop-themes/express/* portal/src/webapp/desktop-themes/express/
+
+# Windows
+cd \JetspeedTraining\workspace\jetexpress
+mkdir portal\src\webapp\desktop-themes\express
+xcopy /s ..\..\resources\desktop-themes\express\* portal\src\webapp\desktop-themes\express\
+ ]]>
+ </source>
+ <subsection name="The Theme template">
+ <p>
+ Have a look at the
+ <i>express</i>
+ theme directory. Notice that there are two theme
+ files:
+ <i>express.jsp</i>
+ and
+ <i>express.vm</i>
+ Since there were so many complaints about no JSP
+ support in templates, with the Desktop we decided to
+ require support for both. The
+ <i>theme.properties</i>
+ determines which templates is active. Lets look at
+ the Velocity template. We have macros to
+ display-theme relative resources:
+ </p>
+ <source>
+ <![CDATA[
+ <img src="$jetspeedDesktop.getDesktopThemeResourceUrl('images/logo.gif')" alt="Logo" border="0"/>
+ ]]>
+ </source>
+ </subsection>
+ <subsection name="Theme Variables">
+ <p>
+ JSP and Velocity make several variables about the
+ context of a theme available for dynamic substition
+ of menus and content:
+ </p>
+ <table>
+ <tr>
+ <th>Variable</th>
+ <th>Desc</th>
+ <th>Usage</th>
+ </tr>
+ <tr>
+ <td>$jetspeedDesktop</td>
+ <td>
+ Retrieve theme resources, and the name of
+ the theme
+ </td>
+ <td>${jetspeedDesktop.getDesktopTheme()</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Content Divs">
+ <p>
+ The remainder of the page is HTML DIV markup with
+ special widget types and identifiers. The desktop
+ will populate these Divs with various content such
+ as the portlets and menus.
+ <i>Jetspeed Menus</i>
+ are build from a collection of portal resources
+ known as the
+ <i>Portal Site</i>
+ . The portal site is a content tree (like a file
+ system) of portal resources. The site can be stored
+ in the file system or in a database. Resources can
+ be a page, folder, or link. Lets look at some of the
+ available macros for displaying menus on your page.
+ </p>
+ <p>
+ <table>
+ <tr>
+ <th>Widget</th>
+ <th>Type</th>
+ <th>Desc</th>
+ </tr>
+ <tr>
+ <td>jetspeed-menu-pages</td>
+ <td>jetspeed:PortalTabContainer</td>
+ <td>
+ relative pages menu of pages in the
+ current folder. Used to define the page
+ tabs above the portal.
+ </td>
+ </tr>
+ <tr>
+ <td>jetspeed-menu-breadcrumbs</td>
+ <td>jetspeed:PortalBreadcrumbContainer</td>
+ <td>
+ paths to page used to provide history
+ links below the page tabs
+ </td>
+ </tr>
+ <tr>
+ <td>jetspeed-menu-navigations</td>
+ <td>jetspeed:PortalAccordionContainer</td>
+ <td>
+ relative subfolders and root level links
+ menu used to define the navigation pane
+ beside the portal.
+ </td>
+ </tr>
+ </table>
+ You can also define your own menus (not covered in
+ this tutorial).
+ </p>
+ <p>
+ Finally, the Div to hold the portlet content must be
+ defined. It is just a plain HTML DIV:
+ <source>
+ <![CDATA[
+<div class="layout-${jetspeedDesktop.getDesktopTheme()}" id="jetspeedDesktop"></div>
+ ]]>
+ </source>
+ Notice that while decorators require two templates,
+ desktops only require one template. This makes for a
+ much simpler page.
+ </p>
+ </subsection>
+ <p>
+ <a href='portlet-decoration.html'>Previous</a>
+ <a href='default-page.html'>Next</a>
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/desktop-theme.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/desktop-theme.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/page-decoration.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/page-decoration.xml?rev=747203&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/page-decoration.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/page-decoration.xml Mon Feb 23 23:30:57 2009
@@ -0,0 +1,276 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Page Decorators</title>
+ <subtitle>Customizing Page Decorators</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="David Dyer"
+ email="ddyer@artifact-software.com" />
+ <person name="Ron Wheeler"
+ email="rwheeler@artifact-software.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Page Decorators">
+ <p>
+ Each Jetspeed page can be associated with a different
+ page decoration. Page decorations control some important
+ aspect of a portal page:
+ <ul>
+ <li>
+ The colors, images, CSS styles that skin this
+ page
+ </li>
+ <li>The header portion of the page</li>
+ <li>The page margins</li>
+ <li>The footer portion of the page</li>
+ <li>Menus displayed on the page</li>
+ <li>Action buttons displayed on the window</li>
+ </ul>
+ Decorators do not control the placement of portlets.
+ That is handled by layouts. Jetspeed comes with several
+ page decorations out of the box. The default page
+ decorator for most pages is called
+ <i>tigris</i>
+ . It looks like this:
+ </p>
+ <img src="../images/tigris-page.png" />
+ <p>
+ We are going to create a new decorator for this
+ tutorial. This new decorator can be copied into our
+ project from the
+ <i>
+ /JetspeedTutorial/resources/decorations/layout/express-page/
+ </i>
+ directory. This will save you the trouble of creating
+ all the logo images and CSS definitions.
+ </p>
+ <source>
+ <![CDATA[
+# Linux
+cd /JetspeedTraining/workspace/jetexpress
+mkdir portal/src/webapp/decorations/layout/express-page
+cp -r ../../resources/decorations/layout/express-page/* portal/src/webapp/decorations/layout/express-page/
+
+# Windows
+cd \JetspeedTraining\workspace\jetexpress
+mkdir portal\src\webapp\decorations\layout\express-page
+xcopy /s ..\..\resources\decorations\layout\express-page\* portal\src\webapp\decorations\layout\express-page
+ ]]>
+ </source>
+ <subsection name="The Header">
+ <p>
+ Open up the
+ <i>decorations/layout/express-page/header.vm</i>
+ This is a Velocity template, very much like JSP but
+ simpler, with no Java compilation required. Jetspeed
+ does support JSP-based decorators. However no one
+ has contributed one yet. We could spend a lot of
+ time teaching you about all the macros available.
+ But lets just concentrate on changing the logos
+ first. Scroll down to the banner content. Here we
+ add our new left-hand side logo:
+ </p>
+ <source>
+ <![CDATA[
+#GetPageResource('images/blueSunrisePicture.gif')
+ ]]>
+ </source>
+ <p>
+ We've added a few more custom images, one in the
+ center area of the banner:
+ </p>
+ <source>
+ <![CDATA[
+<img src="#GetPageResource('images/BlueSunriseTextTahoma.gif')" height="29" width="165">
+ ]]>
+ </source>
+ <p>and one more in the right area of the banner:</p>
+ <source>
+ <![CDATA[
+<img src="#GetPageResource('images/RisingEdgeSlogan.gif')" height="28" width="300">
+ ]]>
+ </source>
+ <p>
+ <i>#GetPageResource</i>
+ is a Velocity macro. It retrieves a resource (image,
+ CSS, HTML) from the decoration folder, relative to
+ the root of the express-page decoration folder.
+ Besides the images, the header.vm is pretty much the
+ same as Tigris. In fact we simply cut and paste the
+ Tigris decorator to get us started. This gives you a
+ good start of customizing the page.
+ </p>
+ </subsection>
+ <subsection name="Velocity Variables">
+ <p>
+ Velocity makes several variables about the context
+ of a decoration available for dynamic substition of
+ menus and content:
+ </p>
+ <table>
+ <tr>
+ <th>Variable</th>
+ <th>Desc</th>
+ <th>Usage</th>
+ </tr>
+ <tr>
+ <td>$layoutDecoration</td>
+ <td>
+ Retrieve layout content from the decoration
+ dir
+ </td>
+ <td>
+ $layoutDecoration.getResource("decorator-macros.vm")
+ </td>
+ </tr>
+ <tr>
+ <td>$site</td>
+ <td>Retrieve menus by name</td>
+ <td>$site.getMenu("pages")</td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Menus">
+ <p>
+ The remainder of the page is HTML markup mixed in
+ with some important macros for displaying Jetspeed
+ Menus.
+ <i>Jetspeed Menus</i>
+ are build from a collection of portal resources
+ known as the
+ <i>Portal Site</i>
+ . The portal site is a content tree (like a file
+ system) of portal resources. The site can be stored
+ in the file system or in a database. Resources can
+ be a page, folder, or link. Lets look at some of the
+ available macros for displaying menus on your page.
+ </p>
+ <p>
+ The $site always has the following menus available
+ to you at any time:
+ <table>
+ <tr>
+ <th>Menu</th>
+ <th>Desc</th>
+ </tr>
+ <tr>
+ <td>pages</td>
+ <td>
+ relative pages menu of pages in the
+ current folder. Used to define the page
+ tabs above the portal.
+ </td>
+ </tr>
+ <tr>
+ <td>breadcrumbs</td>
+ <td>
+ paths to page used to provide history
+ links below the page tabs
+ </td>
+ </tr>
+ <tr>
+ <td>navigations</td>
+ <td>
+ relative subfolders and root level links
+ menu used to define the navigation pane
+ beside the portal.
+ </td>
+ </tr>
+ <tr>
+ <td>back</td>
+ <td>
+ parent folder menu used to define the
+ single "back" link above the portal page
+ tabs.
+ </td>
+ </tr>
+ </table>
+ You can also define your own menus (not covered in
+ this tutorial).
+ </p>
+ <p>
+ There are some helper macros for creating different
+ styles of menus. The macros are defined in the
+ decorator-macros.vm file:
+ <table>
+ <tr>
+ <th>Macro</th>
+ <th>Decription</th>
+ </tr>
+ <tr>
+ <td>
+ #includeTabsNavigation($someMenu
+ $LEFT_TO_RIGHT)
+ </td>
+ <td>
+ Displays a menu in a vertical tabbed
+ navigation style.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ #includeLinksNavigation($breadCrumb
+ $LEFT_TO_RIGHT "" $BREADCRUMBS_STYLE "")
+ </td>
+ <td>
+ Displays a menu of links according to a
+ given style.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ #includeNestedLinksWithIconNavigation($standardNavs
+ $TOP_TO_BOTTOM)
+ </td>
+ <td>
+ Displays a nested top-to-bottom menu
+ navigation of folders, links, and pages.
+ </td>
+ </tr>
+ <tr>
+ <td>#PageActionBar()</td>
+ <td>
+ Not a menu, but the available actions
+ (edit, view, help, print...) for this
+ page
+ </td>
+ </tr>
+ </table>
+ </p>
+ </subsection>
+ <subsection name="The Footer">
+ <p>
+ Open up the
+ <i>decorations/layout/express-page/footer.vm</i>
+ </p>
+ <source>
+ <![CDATA[
+<img src="#GetPageResource('images/jetspeed-powered.gif')" alt="Jetspeed 2 Powered" border="0" />
+ ]]>
+ </source>
+ </subsection>
+ <p>
+ <a href='customizing-overview.html'>Previous</a>
+ <a href='portlet-decoration.html'>Next</a>
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/page-decoration.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/page-decoration.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/portlet-decoration.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/portlet-decoration.xml?rev=747203&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/portlet-decoration.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/portlet-decoration.xml Mon Feb 23 23:30:57 2009
@@ -0,0 +1,92 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Portlet Decorators</title>
+ <subtitle>Customizing PortletDecorators</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="David Dyer"
+ email="ddyer@artifact-software.com" />
+ <person name="Ron Wheeler"
+ email="rwheeler@artifact-software.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Portlet Decorators">
+ <p>
+ Each Jetspeed portlet window on a page can be associated
+ with a different portlet decoration. Portlet decorations
+ control some important aspect of a portlet window:
+ <ul>
+ <li>
+ The colors, images, CSS styles that skin this
+ window
+ </li>
+ <li>The title portion of the portlet</li>
+ <li>The borders of the window</li>
+ <li>Action buttons displayed on the window</li>
+ </ul>
+ Jetspeed comes with several portlet decorations out of
+ the box. The default page decorator for most pages is
+ called
+ <i>tigris</i>
+ . It looks like this:
+ </p>
+ <img src="../images/tigris-portlet.png" />
+ <p>
+ We are going to create a new decorator for this
+ tutorial. This new decorator can be copied into our
+ project from the
+ <i>
+ /JetspeedTutorial/resources/decorations/portlet/express-portlet/
+ </i>
+ directory. This will save you the trouble of creating
+ all the logo images and CSS definitions.
+ </p>
+ <source>
+ <![CDATA[
+# Linux
+cd /JetspeedTraining/workspace/jetexpress
+mkdir portal/src/webapp/decorations/portlet/express-portlet
+cp -r ../../resources/decorations/portlet/express-portlet/* portal/src/webapp/decorations/portlet/express-portlet/
+
+# Windows
+cd \JetspeedTraining\workspace\jetexpress
+mkdir portal\src\webapp\decorations\portlet\express-portlet
+xcopy /s ..\..\resources\decorations\portlet\express-portlet\* portal\src\webapp\decorations\portlet\express-portlet
+ ]]>
+ </source>
+ <p>
+ We are going to skip over the intricate details of
+ portlet decorators, as page decorators are much more
+ important, as they set your organization's branding.
+ Whereas the standard window decorators are good enough
+ for getting you started. Go ahead and review the content
+ of our custom portlet decorator. You will see that the
+ directory layout is the same as for page decorators. The
+ decorator simply creates a new color variation on an
+ existing window decorator.
+ </p>
+ <p>
+ <a href='page-decoration.html'>Previous</a>
+ <a href='desktop-theme.html'>Next</a>
+ </p>
+ </section>
+ </body>
+</document>
\ No newline at end of file
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/portlet-decoration.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/tutorials/ant/02/portlet-decoration.xml
------------------------------------------------------------------------------
svn:keywords = Id
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org