portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From a..@apache.org
Subject svn commit: r514329 [3/7] - in /portals/jetspeed-2/trunk/xdocs: ./ guides/ style/
Date Sun, 04 Mar 2007 02:13:24 GMT
Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-decorators.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-decorators.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-decorators.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-decorators.xml Sat Mar  3 18:13:22 2007
@@ -1,306 +1,306 @@
-<?xml version="1.0"?>
-<!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed 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>Guide to Jetspeed Decoration</title>
-    <subtitle>Documentation for Designers working with Jetspeed Decorations</subtitle>
-    <authors>
-      <person name="Scott T Weaver" email="weaver@apache.org"/>
-      <person name="David Sean Taylor" email="taylor@apache.org"/>
-    </authors>
-  </properties>
-  <body>
-<section name="Introduction to Decorators">
-<p>
-Decorators are defined as any static or semi-static markup surrounding a dynamically generated Fragment. 
-Decorators are usually written with either Velocity or JSP templates.  This guide will focus primarily
-on using the Velocity scripting language to build decoration.  However, most of the standards and 
-approaches described here can be applied to writing decroations in other scripting languages.
-</p>
-<p>
-    There are two different types of decorations that are used when building a page; Portlet and Layout (or page).
-    <p>
-    Portlet decorations are the "window dressings" of Jetspeed.  They wrap each indivual portlet fragment's
-    rendered content with HTML (XHTML, VXML, etc).  Portlet decoration's are responsible for displaying the
-    appropriate title and any buttons associated with changing window states or portlet modes.
-    </p>
-    <p>
-    Layout or Page decorations responsible for providind a "header" area and "footer" area for a single
-    portal page which is represented by a .psml document (see: <a href="guide-psml.html">Documentation for Designers working with PSML</a>
-    for more information on psml).  They also provide general style information for the page and portlets.  However,
-    portlet level style settings can be overidden at the portlet decoration level.
-    </p>
-    
-</p>
-</section>
-<section name="Decoration File Structure">
-<p>
-    All decorations are stored in a directory directly off of the web applications
-    root called <code>decorations</code>.  The two primary directories under the 
-    here are <code>layout</code> for layout decorations and <code>portlet</code>
-    for portlet decorations.  Individual decoartions are housed in their own directories
-    underneath these two directories.  The name of the directory you create for under either
-    <code>layout</code> or <code>portlet</code> is how Jetspeed will locate your decoration.  We
-    will go into further detail on how this works later on in this guide.
-</p>        
-</section>
-
-<section name="Anatomy of a Layout(Page) Decoration">
-  <subsection name='Four Files in a Nutshell'>
-    <p>
-        In it's most basic form a Layout Decroation only requires you to define
-        four files:
-        <ul>
-            <li>decorator.properties</li>
-            <li>styles.css</li>
-            <li>header.vm</li>
-            <li>footer.vm</li>
-        </ul>
-        Three of these files; decorator.properties, header.vm, and footer.vm go directly into 
-        the directory you create under <code>/decorations/layout</code>.  The styles.css needs
-        to be put into a subdirectory of your decoration names <code>css/</code>.
-    </p>
-  </subsection>
-  
-   <subsection name='Basic Layout Decoration Configuration: decorator.properties'>
-    <p>
-        The decorator.properties file holds basic information about your layout
-        decoration.  In all actuallity, this file can be blank, but we still require
-        that it be present as it is used by other APIs to "discover" available decorations.  
-        With that being said, it is safe to assume that all the properties defined below 
-        are optional.
-        <table>
-            <tr>
-                <th>Property Name</th>
-                <th>Description</th>
-                <th>Default</th>
-            </tr>
-            <tr>
-                <td>base.css.class</td>
-                <td>
-                    This value is generally placed in the top most element tag
-                    of your header template.  You will see how it is used when
-                    we go into development of a header template.
-                </td>
-                <td>Defaults to the name of your decoration</td>
-            </tr>
-            <tr>
-                <td>stylesheet</td>
-                <td>Relative path to your decoration's stylesheet</td>
-                <td>css/styles.css</td>
-            </tr>
-            <tr>
-                <td>header</td>
-                <td>Relative path to your decoration's header template</td>
-                <td>header.vm</td>
-            </tr>
-            <tr>
-                <td>footer</td>
-                <td>Relative path to your decoration's footer template</td>
-                <td>footer.vm</td>
-            </tr>            
-        </table>
-    </p>
-   </subsection>
-   <subsection name='Top o&apos; the Page to ya: header.vm'>
-    <p>
-        The <strong>header.vm</strong> represnts the top portion of your portal page.  Below is a section
-        by section walkthrough of the basics required to write a functional header
-        template.
-        <br/><br/>
-        <strong>NOTICE:</strong> It is assumed that the reader is proficient in both
-        the use of HTML and CSS.  A rudimentary knowledge of Velocity helps but is not 
-        required to develop a decoration.
-    </p>
-    <p>
-<source>
-<![CDATA[        
-<html>
-   <head>
-     #defineLayoutObjects()
-]]></source>   
-        The first two lines should be obvious, if they are not, this guide from here
-        on out will not be much help to you ;-)
-
-  		<h4>Our First Macro: #defineLayoutObjects()</h4>
-        <p>
-            Now the line containing <code>#defineLayoutObjects()</code> will not be as obvious in its
-            purpose as the previous two.  <code>#defineLayoutObjects()</code> is what is known, in
-            Velocity vernacular, as a macro.  A macro is a predefined snippet of Velocity 
-            code that can be reused within any Velocity template.  All of the global macros
-            we will be using (including this one) are defined within the <code>WEB-INF/jetspeed_macros.vm</code>.
-            Later in this guide we will discuss supplying your own, custom macros for assisting
-            you in your decoration development, if you choose to.  Now, back to the <code>#defineLayoutObjects()</code>.
-            <code>#defineLayoutObjects()</code> adds values to Velocity that will be accessible within header.vm,
-            footer.vm, other macros and all of your portlet decoration templates.  We could easily stop here 
-            regarding <code>#defineLayoutObjects()</code>, however, I feel it can be helpful to have some 
-            insights into the inner workings of Velocity for the uninitiated.  With out further ado, the 
-            code:        
-<source>
-<![CDATA[        
-  #macro (defineLayoutObjects)
-    #set($preferedLocale = $JS2RequestContext.locale)
-    #set($rootFragment = $jetspeed.currentFragment)
-    #set($site = $request.getAttribute("org.apache.jetspeed.portalsite.PortalSiteRequestContext"))
-    #set($theme = $request.getAttribute("org.apache.jetspeed.theme"))
-    #set($layoutDecoration = $theme.getDecoration($rootFragment))
-  #end        
-]]></source>        
-			
-            Hmm. What is actually happening here. Okay first off we have, <code>#set()</code>, this is what is known as a
-            directive in Velocity.  A directive is built-in functionallity and not a macro. <code>#set()</code>
-            is pretty straight forward in that it takes the value on the right of the = and assigns it to
-            the left.  Cool, that seems fairly straight forward. But how does one work with these values and where
-            the heck did <code>$JS2RequestContext.locale</code> come from?  I guess i should take a quick step back
-            and describe how we work with objects in Velocity.  All objects available to a Velocity template
-            can be referenced via the <code>$someObject</code> notation.  Knowing that much invoking a method
-            , let's getFoo(), can be done just like this <code>$someObject.getFoo()</code>.  Even cooler is the
-            fact we can short-hand getter methods that don't take any arguments like this, 
-            <code>$someObject.foo</code>.  As for this <code>$JS2RequestContext</code> this is actually
-            an instance of the <code>org.apache.jetspeed.RequestContext</code> that has been availble to Velocity
-            by Jetspeed itself.  So, by looking the javadoc for <code>org.apache.jetspeed.RequestContext</code> we see
-            <code>$JS2RequestContext.locale</code> will give us an instance of <code>java.util.Locale</code> that represents
-            the locale of the current user.  Couldn't be much simpler than that could it?
-               <br/><br/>
-            Next up we have this line <code>#set($rootFragment = $jetspeed.currentFragment)</code> another set()
-            statement, this time creating an object called <code>$rootFragment</code> which is an instance of
-            <a href="http://portals.apache.org/jetspeed-2/multiproject/jetspeed-api/apidocs/org/apache/jetspeed/om/page/ContentFragment.html">org.apache.jetspeed.om.page.ContentFragment</a>.
-			It is really not relevant to this guide
-            to describe what <code>$jetspeed.currentFragment</code> is doing so I am going to skip that and move on. 
-            <br/><br/>
-            <code>
-              #set($site = $request.getAttribute("org.apache.jetspeed.portalsite.PortalSiteRequestContext"))
-             <br/>
-             #set($theme = $request.getAttribute("org.apache.jetspeed.theme"))
-            </code>
-            <br/>
-            Ah <code>$request</code>, now that looks familiar, this is actually an instance of <code>javax.servlet.http.HttpServletRequest</code>
-            from which we are retreiving objects that were been placed into Velocity by Jetspeed.  The actual objects are:
-            <a href="http://portals.apache.org/jetspeed-2/multiproject/jetspeed-api/apidocs/org/apache/jetspeed/portalsite/PortalSiteRequestContext.html">org.apache.jetspeed.portalsite.PortalSiteRequestContext</a>
-            and
-            <a href="http://portals.apache.org/jetspeed-2/multiproject/jetspeed-api/apidocs/org/apache/jetspeed/decroation/Theme.html">org.apache.jetspeed.decoration.Theme</a>
-            respectively.  We will put all of these objects to good use in just a little while.       
-        </p>
-	  <h4>Feed Your HEAD: How to Properly Code Your Head Tag.</h4>
-	   <p>
-		This section provides you with all the information to properly code the
-		&lt;HEAD&gt; of your Layout decroation.  So, straight to the code.
-		<source>
-<![CDATA[  
-<html>
-    <head>
-     #defineLayoutObjects()
-     
-     <base href="#BaseHref()">
-     <meta http-equiv="Content-type" content="#ContentType()" />
-     <meta http-equiv="Content-style-type" content="text/css" />   
-     #includeJavaScriptForHead()
-     #IncludeStylesheets()    
-     <title>#PageTitle()</title>
-     <meta name="description" content="#PageDescription()" />
-]]></source>
-	   </p>	
-	 
-    </p>
-	<h5>The &lt;base&gt; Tag</h5>
-	  <p>	
-		First off we have <code><![CDATA[ <base href="#BaseHref()">]]></code> which allows 
-		us to define the base path for resolution of web resources, for an in depth discussion
-		of the <code><![CDATA[ <base>]]></code> see: <a href="http://www.w3schools.com/tags/tag_base.asp">W3C Schools Reference</a>.  
-		If you have spent any time playing with Jetspeed, you will have noticed it does all sorts
-		of crazy URL rewriting that will totally hose any attempts to consistently path you html
-		and styles sheets.  By defining the BASE tag, this probelms will all but disappear.  As 
-		for the <code>#BaseHref()</code> macro, it simply generates a fully qualified path to your
-		web application's root.  The actual code, interms of the servlet api is synonimous with this:
-<source>
-HttpServletRequest request;
-StingBuffer baseHref = new StringBuffer(request.getScheme())
-     .append("://").append(request.getServerName())
-	 .append(":").append(request.getServerPort())
-	 .append(request.getContextPath()).append("/");
-return baseHref.toString();		 
-</source>
-       The actual Velocity macro code is a bit more terse ;)
-<source>
-${request.scheme}://${request.serverName}:${request.serverPort}${request.contextPath}/
-</source>
-       </p>
-	 <h5>Meta Tag: <![CDATA[<meta http-equiv="Content-type" content="#ContentType()" />]]></h5>
-	 <p>
-		Will return text/html plus the proper encoding, such as UTF.
-	 </p>
-	 <h5>#includeJavaScriptForHead()</h5>
-	 <p>
-	   At the time of the writing of this guide there is really very little javascript
-	   required to for the base Jetspeed 2 server to run.  However this may change in
-	   near future as we try to employ the use of AJAX in things such as configuration 
-	   and administration.
-	 </p>
-   </subsection>
-</section>
-<!--
-<section name='Packaging'>
-<p>
-Layouts are packaged in a JAR file. Supported decorators: 
-<ul>
-    <li>Page Decorators</li>
-    <li>Portlet Decorators</li>
-    <li>Generic Decorators</li>    
-    <li>Localized Decorators</li>
-</ul>
-Operations Supported:
-<ul>
-    <li>Deploy</li>
-    <li>Un-deploy</li>
-    <li>Re-deploy</li>
-</ul>
-The decorator.properties file must be located in the root directory of the jar archive and 
-contain the properties outlined in the next slide to be identified as a decorator by the auto 
-deployment system. The deployer will relocate the locale specific content to satisfy J2 
-content locators as necessary on deploy and undeploy. The current implementation supports 
-only 2 character language and country codes.    
-</p>    
-</section>
-<section name='Decorator Properties'>
-<p>
-The decorator.properties file must be located in the root directory of the jar archive and 
-contain the properties outlined above to be identified as a decorator by the auto-deployment system. 
-</p>
-<p>
-A deployable decorator must have the following properties set or defaulted in the decorator.properties 
-configuration:
-
-<source test=""><![CDATA[
-
-id = IDENTIFIER
-media.type=  HTML | WML
-decorates =  layout | portlet | any
-
-]]></source>
-
-To avoid conflicts with the locale logic and runtime locators, decorators should be 
-named with ids longer than 2 characters in length. The media.type property defaults to 'html'. 
-The 'any' value for the decorates property is mapped to the generic deployment directory.
-The deployer will relocate the locale specific content to satisfy J2 content locators as 
-necessary on deploy and undeploy. The current implementation supports only 2 
-character language and country codes.
-</p>    
-</section>
--->
-</body>
-</document>
-
+<?xml version="1.0"?>
+<!--
+Copyright 2004 The Apache Software Foundation
+
+Licensed 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>Guide to Jetspeed Decoration</title>
+    <subtitle>Documentation for Designers working with Jetspeed Decorations</subtitle>
+    <authors>
+      <person name="Scott T Weaver" email="weaver@apache.org"/>
+      <person name="David Sean Taylor" email="taylor@apache.org"/>
+    </authors>
+  </properties>
+  <body>
+<section name="Introduction to Decorators">
+<p>
+Decorators are defined as any static or semi-static markup surrounding a dynamically generated Fragment. 
+Decorators are usually written with either Velocity or JSP templates.  This guide will focus primarily
+on using the Velocity scripting language to build decoration.  However, most of the standards and 
+approaches described here can be applied to writing decroations in other scripting languages.
+</p>
+<p>
+    There are two different types of decorations that are used when building a page; Portlet and Layout (or page).
+    <p>
+    Portlet decorations are the "window dressings" of Jetspeed.  They wrap each indivual portlet fragment's
+    rendered content with HTML (XHTML, VXML, etc).  Portlet decoration's are responsible for displaying the
+    appropriate title and any buttons associated with changing window states or portlet modes.
+    </p>
+    <p>
+    Layout or Page decorations responsible for providind a "header" area and "footer" area for a single
+    portal page which is represented by a .psml document (see: <a href="guide-psml.html">Documentation for Designers working with PSML</a>
+    for more information on psml).  They also provide general style information for the page and portlets.  However,
+    portlet level style settings can be overidden at the portlet decoration level.
+    </p>
+    
+</p>
+</section>
+<section name="Decoration File Structure">
+<p>
+    All decorations are stored in a directory directly off of the web applications
+    root called <code>decorations</code>.  The two primary directories under the 
+    here are <code>layout</code> for layout decorations and <code>portlet</code>
+    for portlet decorations.  Individual decoartions are housed in their own directories
+    underneath these two directories.  The name of the directory you create for under either
+    <code>layout</code> or <code>portlet</code> is how Jetspeed will locate your decoration.  We
+    will go into further detail on how this works later on in this guide.
+</p>        
+</section>
+
+<section name="Anatomy of a Layout(Page) Decoration">
+  <subsection name='Four Files in a Nutshell'>
+    <p>
+        In it's most basic form a Layout Decroation only requires you to define
+        four files:
+        <ul>
+            <li>decorator.properties</li>
+            <li>styles.css</li>
+            <li>header.vm</li>
+            <li>footer.vm</li>
+        </ul>
+        Three of these files; decorator.properties, header.vm, and footer.vm go directly into 
+        the directory you create under <code>/decorations/layout</code>.  The styles.css needs
+        to be put into a subdirectory of your decoration names <code>css/</code>.
+    </p>
+  </subsection>
+  
+   <subsection name='Basic Layout Decoration Configuration: decorator.properties'>
+    <p>
+        The decorator.properties file holds basic information about your layout
+        decoration.  In all actuallity, this file can be blank, but we still require
+        that it be present as it is used by other APIs to "discover" available decorations.  
+        With that being said, it is safe to assume that all the properties defined below 
+        are optional.
+        <table>
+            <tr>
+                <th>Property Name</th>
+                <th>Description</th>
+                <th>Default</th>
+            </tr>
+            <tr>
+                <td>base.css.class</td>
+                <td>
+                    This value is generally placed in the top most element tag
+                    of your header template.  You will see how it is used when
+                    we go into development of a header template.
+                </td>
+                <td>Defaults to the name of your decoration</td>
+            </tr>
+            <tr>
+                <td>stylesheet</td>
+                <td>Relative path to your decoration's stylesheet</td>
+                <td>css/styles.css</td>
+            </tr>
+            <tr>
+                <td>header</td>
+                <td>Relative path to your decoration's header template</td>
+                <td>header.vm</td>
+            </tr>
+            <tr>
+                <td>footer</td>
+                <td>Relative path to your decoration's footer template</td>
+                <td>footer.vm</td>
+            </tr>            
+        </table>
+    </p>
+   </subsection>
+   <subsection name='Top o&apos; the Page to ya: header.vm'>
+    <p>
+        The <strong>header.vm</strong> represnts the top portion of your portal page.  Below is a section
+        by section walkthrough of the basics required to write a functional header
+        template.
+        <br/><br/>
+        <strong>NOTICE:</strong> It is assumed that the reader is proficient in both
+        the use of HTML and CSS.  A rudimentary knowledge of Velocity helps but is not 
+        required to develop a decoration.
+    </p>
+    <p>
+<source>
+<![CDATA[        
+<html>
+   <head>
+     #defineLayoutObjects()
+]]></source>   
+        The first two lines should be obvious, if they are not, this guide from here
+        on out will not be much help to you ;-)
+
+  		<h4>Our First Macro: #defineLayoutObjects()</h4>
+        <p>
+            Now the line containing <code>#defineLayoutObjects()</code> will not be as obvious in its
+            purpose as the previous two.  <code>#defineLayoutObjects()</code> is what is known, in
+            Velocity vernacular, as a macro.  A macro is a predefined snippet of Velocity 
+            code that can be reused within any Velocity template.  All of the global macros
+            we will be using (including this one) are defined within the <code>WEB-INF/jetspeed_macros.vm</code>.
+            Later in this guide we will discuss supplying your own, custom macros for assisting
+            you in your decoration development, if you choose to.  Now, back to the <code>#defineLayoutObjects()</code>.
+            <code>#defineLayoutObjects()</code> adds values to Velocity that will be accessible within header.vm,
+            footer.vm, other macros and all of your portlet decoration templates.  We could easily stop here 
+            regarding <code>#defineLayoutObjects()</code>, however, I feel it can be helpful to have some 
+            insights into the inner workings of Velocity for the uninitiated.  With out further ado, the 
+            code:        
+<source>
+<![CDATA[        
+  #macro (defineLayoutObjects)
+    #set($preferedLocale = $JS2RequestContext.locale)
+    #set($rootFragment = $jetspeed.currentFragment)
+    #set($site = $request.getAttribute("org.apache.jetspeed.portalsite.PortalSiteRequestContext"))
+    #set($theme = $request.getAttribute("org.apache.jetspeed.theme"))
+    #set($layoutDecoration = $theme.getDecoration($rootFragment))
+  #end        
+]]></source>        
+			
+            Hmm. What is actually happening here. Okay first off we have, <code>#set()</code>, this is what is known as a
+            directive in Velocity.  A directive is built-in functionallity and not a macro. <code>#set()</code>
+            is pretty straight forward in that it takes the value on the right of the = and assigns it to
+            the left.  Cool, that seems fairly straight forward. But how does one work with these values and where
+            the heck did <code>$JS2RequestContext.locale</code> come from?  I guess i should take a quick step back
+            and describe how we work with objects in Velocity.  All objects available to a Velocity template
+            can be referenced via the <code>$someObject</code> notation.  Knowing that much invoking a method
+            , let's getFoo(), can be done just like this <code>$someObject.getFoo()</code>.  Even cooler is the
+            fact we can short-hand getter methods that don't take any arguments like this, 
+            <code>$someObject.foo</code>.  As for this <code>$JS2RequestContext</code> this is actually
+            an instance of the <code>org.apache.jetspeed.RequestContext</code> that has been availble to Velocity
+            by Jetspeed itself.  So, by looking the javadoc for <code>org.apache.jetspeed.RequestContext</code> we see
+            <code>$JS2RequestContext.locale</code> will give us an instance of <code>java.util.Locale</code> that represents
+            the locale of the current user.  Couldn't be much simpler than that could it?
+               <br/><br/>
+            Next up we have this line <code>#set($rootFragment = $jetspeed.currentFragment)</code> another set()
+            statement, this time creating an object called <code>$rootFragment</code> which is an instance of
+            <a href="http://portals.apache.org/jetspeed-2/multiproject/jetspeed-api/apidocs/org/apache/jetspeed/om/page/ContentFragment.html">org.apache.jetspeed.om.page.ContentFragment</a>.
+			It is really not relevant to this guide
+            to describe what <code>$jetspeed.currentFragment</code> is doing so I am going to skip that and move on. 
+            <br/><br/>
+            <code>
+              #set($site = $request.getAttribute("org.apache.jetspeed.portalsite.PortalSiteRequestContext"))
+             <br/>
+             #set($theme = $request.getAttribute("org.apache.jetspeed.theme"))
+            </code>
+            <br/>
+            Ah <code>$request</code>, now that looks familiar, this is actually an instance of <code>javax.servlet.http.HttpServletRequest</code>
+            from which we are retreiving objects that were been placed into Velocity by Jetspeed.  The actual objects are:
+            <a href="http://portals.apache.org/jetspeed-2/multiproject/jetspeed-api/apidocs/org/apache/jetspeed/portalsite/PortalSiteRequestContext.html">org.apache.jetspeed.portalsite.PortalSiteRequestContext</a>
+            and
+            <a href="http://portals.apache.org/jetspeed-2/multiproject/jetspeed-api/apidocs/org/apache/jetspeed/decroation/Theme.html">org.apache.jetspeed.decoration.Theme</a>
+            respectively.  We will put all of these objects to good use in just a little while.       
+        </p>
+	  <h4>Feed Your HEAD: How to Properly Code Your Head Tag.</h4>
+	   <p>
+		This section provides you with all the information to properly code the
+		&lt;HEAD&gt; of your Layout decroation.  So, straight to the code.
+		<source>
+<![CDATA[  
+<html>
+    <head>
+     #defineLayoutObjects()
+     
+     <base href="#BaseHref()">
+     <meta http-equiv="Content-type" content="#ContentType()" />
+     <meta http-equiv="Content-style-type" content="text/css" />   
+     #includeJavaScriptForHead()
+     #IncludeStylesheets()    
+     <title>#PageTitle()</title>
+     <meta name="description" content="#PageDescription()" />
+]]></source>
+	   </p>	
+	 
+    </p>
+	<h5>The &lt;base&gt; Tag</h5>
+	  <p>	
+		First off we have <code><![CDATA[ <base href="#BaseHref()">]]></code> which allows 
+		us to define the base path for resolution of web resources, for an in depth discussion
+		of the <code><![CDATA[ <base>]]></code> see: <a href="http://www.w3schools.com/tags/tag_base.asp">W3C Schools Reference</a>.  
+		If you have spent any time playing with Jetspeed, you will have noticed it does all sorts
+		of crazy URL rewriting that will totally hose any attempts to consistently path you html
+		and styles sheets.  By defining the BASE tag, this probelms will all but disappear.  As 
+		for the <code>#BaseHref()</code> macro, it simply generates a fully qualified path to your
+		web application's root.  The actual code, interms of the servlet api is synonimous with this:
+<source>
+HttpServletRequest request;
+StingBuffer baseHref = new StringBuffer(request.getScheme())
+     .append("://").append(request.getServerName())
+	 .append(":").append(request.getServerPort())
+	 .append(request.getContextPath()).append("/");
+return baseHref.toString();		 
+</source>
+       The actual Velocity macro code is a bit more terse ;)
+<source>
+${request.scheme}://${request.serverName}:${request.serverPort}${request.contextPath}/
+</source>
+       </p>
+	 <h5>Meta Tag: <![CDATA[<meta http-equiv="Content-type" content="#ContentType()" />]]></h5>
+	 <p>
+		Will return text/html plus the proper encoding, such as UTF.
+	 </p>
+	 <h5>#includeJavaScriptForHead()</h5>
+	 <p>
+	   At the time of the writing of this guide there is really very little javascript
+	   required to for the base Jetspeed 2 server to run.  However this may change in
+	   near future as we try to employ the use of AJAX in things such as configuration 
+	   and administration.
+	 </p>
+   </subsection>
+</section>
+<!--
+<section name='Packaging'>
+<p>
+Layouts are packaged in a JAR file. Supported decorators: 
+<ul>
+    <li>Page Decorators</li>
+    <li>Portlet Decorators</li>
+    <li>Generic Decorators</li>    
+    <li>Localized Decorators</li>
+</ul>
+Operations Supported:
+<ul>
+    <li>Deploy</li>
+    <li>Un-deploy</li>
+    <li>Re-deploy</li>
+</ul>
+The decorator.properties file must be located in the root directory of the jar archive and 
+contain the properties outlined in the next slide to be identified as a decorator by the auto 
+deployment system. The deployer will relocate the locale specific content to satisfy J2 
+content locators as necessary on deploy and undeploy. The current implementation supports 
+only 2 character language and country codes.    
+</p>    
+</section>
+<section name='Decorator Properties'>
+<p>
+The decorator.properties file must be located in the root directory of the jar archive and 
+contain the properties outlined above to be identified as a decorator by the auto-deployment system. 
+</p>
+<p>
+A deployable decorator must have the following properties set or defaulted in the decorator.properties 
+configuration:
+
+<source test=""><![CDATA[
+
+id = IDENTIFIER
+media.type=  HTML | WML
+decorates =  layout | portlet | any
+
+]]></source>
+
+To avoid conflicts with the locale logic and runtime locators, decorators should be 
+named with ids longer than 2 characters in length. The media.type property defaults to 'html'. 
+The 'any' value for the decorates property is mapped to the generic deployment directory.
+The deployer will relocate the locale specific content to satisfy J2 content locators as 
+necessary on deploy and undeploy. The current implementation supports only 2 
+character language and country codes.
+</p>    
+</section>
+-->
+</body>
+</document>
+

Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-decorators.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-dir-structure.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-dir-structure.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-dir-structure.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-dir-structure.xml Sat Mar  3 18:13:22 2007
@@ -1,30 +1,30 @@
-<?xml version="1.0"?>
-<!--
-	Copyright 2004 The Apache Software Foundation
-	
-	Licensed 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>Guide to Jetspeed-2 Component Architecture</title>
-		<subtitle>Guide to Jetspeed-2 Component Architecture</subtitle>
-		<authors>
-			<person name="David Le Strat" email="dlestrat@apache.org" />
-		</authors>
-	</properties>
-	<body>
-		<section name="Guide to Jetspeed-2 Component Architecture">
-			
-		</section>
-	</body>
+<?xml version="1.0"?>
+<!--
+	Copyright 2004 The Apache Software Foundation
+	
+	Licensed 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>Guide to Jetspeed-2 Component Architecture</title>
+		<subtitle>Guide to Jetspeed-2 Component Architecture</subtitle>
+		<authors>
+			<person name="David Le Strat" email="dlestrat@apache.org" />
+		</authors>
+	</properties>
+	<body>
+		<section name="Guide to Jetspeed-2 Component Architecture">
+			
+		</section>
+	</body>
 </document>

Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-dir-structure.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml Sat Mar  3 18:13:22 2007
@@ -1,43 +1,43 @@
-<?xml version="1.0"?>
-<!--
-	Copyright 2004 The Apache Software Foundation
-	
-	Licensed 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>Guide to Jetspeed-2 Development</title>
-		<subtitle>Guide to Jetspeed-2 Development</subtitle>
-		<authors>
-			<person name="David Le Strat" email="dlestrat@apache.org" />
-		</authors>
-	</properties>
-	<body>
-		<section name="Guide to Jetspeed-2 Development">
-		    <subsection name="Working with Jetspeed-2 Source Code">
-		    <p>
-		    For information on how to get started with Jetspeed-2 source code, check 
-		    <a href="../getting-started-source.html">getting started with Jetspeed-2 source code</a>.
-		    </p>
-		    </subsection>
-			<subsection name="How to Submit Patches?">
-			<p>
-			When working with Eclipse with the <a href="http://subclipse.tigris.org/">Subclipse plugin</a>,
-			it is possible to generate a patch for the code changed as illustrated below:
-			<br/><br/>
-			<img src="images/create-patch.gif" border="0" />
-			</p>
-			</subsection>
-		</section>
-	</body>
+<?xml version="1.0"?>
+<!--
+	Copyright 2004 The Apache Software Foundation
+	
+	Licensed 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>Guide to Jetspeed-2 Development</title>
+		<subtitle>Guide to Jetspeed-2 Development</subtitle>
+		<authors>
+			<person name="David Le Strat" email="dlestrat@apache.org" />
+		</authors>
+	</properties>
+	<body>
+		<section name="Guide to Jetspeed-2 Development">
+		    <subsection name="Working with Jetspeed-2 Source Code">
+		    <p>
+		    For information on how to get started with Jetspeed-2 source code, check 
+		    <a href="../getting-started-source.html">getting started with Jetspeed-2 source code</a>.
+		    </p>
+		    </subsection>
+			<subsection name="How to Submit Patches?">
+			<p>
+			When working with Eclipse with the <a href="http://subclipse.tigris.org/">Subclipse plugin</a>,
+			it is possible to generate a patch for the code changed as illustrated below:
+			<br/><br/>
+			<img src="images/create-patch.gif" border="0" />
+			</p>
+			</subsection>
+		</section>
+	</body>
 </document>

Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-jpt.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-jpt.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-jpt.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-jpt.xml Sat Mar  3 18:13:22 2007
@@ -1,164 +1,164 @@
-<?xml version="1.0"?>
-<!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed 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>Guide to Jetspeed Power Tool</title>
-    <subtitle>Documentation for Designers working with the Jetspeed Power Tool.</subtitle>
-    <authors>
-      <person name="David Sean Taylor" email="taylor@apache.org"/>
-    </authors>
-  </properties>
-  <body>
-<section name="Jetspeed Power Tool">
-<p>
-The Jetspeed Power Tool (JPT) is a velocity tool used in Layouts and Decorators to generate dynamic content.
-The JPT is a request level velocity tool, and is available to all layouts and decorators.
-The JPT is referenced in your decorator or layout as:
-<source test=""><![CDATA[
-$jetspeed
-]]></source>
-All public JPT APIs can be accessed with:
-<ul>
-    <li>Java dot notation for methods</li>
-    <li>JavaBean shortcuts for properties (getter/setter)</li>    
-</ul>
-Example of calling a method:
-<source test=""><![CDATA[
-# call a method 'getTitle' with 2 parameters
-$jetspeed.getTitle($myPE, $myF)
-]]></source>
-Example of calling getting a property:
-<source test=""><![CDATA[
-# get the page bean, equivalent to $jetspeed.getPage()
-$jetspeed.page
-]]></source>
-</p>
-</section>
-<section name="JPT Velocity API">
-<p>The table below defines the Jetspeed Power Tool API for Velocity</p>
-<hr/>
-<table>
-  <tr> 
-    <th>API</th>
-    <th><b>decorateAndInclude($fragment)</b></th>
-  </tr>
-  <tr>
-    <td>Description</td>
-    <td>
-        Retrieves the application relative path to a decorator template for a given 
-        fragment parameter <b>($fragment)</b> to be included by Velocity. 
-        Should be passed as a parameter to the Velocity #parse function (#parse includes 
-        another Velocity template). 
-     </td>
-  </tr>
-  <tr>
-    <td>Parameter</td>
-    <td><b>$fragment</b> - the fragment to be included and decorated.</td>         
-  </tr>
-  <tr>
-    <td>Returns</td>
-    <td><b>String</b> - Application relative path to a decorator template.</td>
-  </tr>
-  <tr>
-    <td>Examples</td>
-    <td>#parse($jetspeed.decorateAndInclude($fragment))<br/>returns<br/>/WEB-INF/decorations/layout/html/tigris/header.vm</td>
-  </tr>  
-</table>
-<hr/>
-<table>
-  <tr> 
-    <th>API</th>
-    <th><b>getAbsoluteUrl(appRelativePath)</b></th>
-  </tr>
-  <tr>
-    <td>Description</td>
-    <td>
-        Given a relative path to an portlet application resource, returns an absolute URL.
-        This API should not be used to reference template ULS since they are usually inaccessible 
-        as absolute URLs because they are often located in a CMS or behind the secured WEB-INF directory.
-     </td>
-  </tr>
-  <tr>
-    <td>Parameter</td>
-    <td><b>relativePath</b> - a relative path to a resource in the decorator package.</td>         
-  </tr>
-  <tr>
-    <td>Returns</td>
-    <td><b>String</b> - The full absolute path to a web resource</td>
-  </tr>
-  <tr>
-    <td>Examples</td>
-    <td>$jetspeed.getAbsoluteUrl("/images/test.gif")<br/>returns<br/>http://localhost:8080/jetspeed/portal/images/test.gif</td>
-  </tr>  
-</table>
-<hr/>
-<table>
-  <tr> 
-    <th>API</th>
-    <th><b>columns</b></th>
-  </tr>
-  <tr>
-    <td>Description</td>
-    <td>
-        Returns a list of column for the current fragment during a layout aggregation.
-     </td>
-  </tr>
-  <tr>
-    <td>Parameter</td>
-    <td><b>-</b></td>         
-  </tr>
-  <tr>
-    <td>Returns</td>
-    <td><b>List</b> - a standard Java List of sub-fragments or portlets</td>
-  </tr>
-  <tr>
-    <td>Examples</td>
-    <td>#set ($table = $jetspeed.columns)<br/>#foreach($entry in $table)
-    </td>
-  </tr>  
-</table>
-<hr/>
-<table>
-  <tr> 
-    <th>API</th>
-    <th><b></b></th>
-  </tr>
-  <tr>
-    <td>Description</td>
-    <td>
-     </td>
-  </tr>
-  <tr>
-    <td>Parameter</td>
-    <td><b></b></td>         
-  </tr>
-  <tr>
-    <td>Returns</td>
-    <td><b></b></td>
-  </tr>
-  <tr>
-    <td>Examples</td>
-    <td></td>
-  </tr>  
-</table>
-<hr/>
-
-</section>
-
-</body>
-</document>
-
+<?xml version="1.0"?>
+<!--
+Copyright 2004 The Apache Software Foundation
+
+Licensed 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>Guide to Jetspeed Power Tool</title>
+    <subtitle>Documentation for Designers working with the Jetspeed Power Tool.</subtitle>
+    <authors>
+      <person name="David Sean Taylor" email="taylor@apache.org"/>
+    </authors>
+  </properties>
+  <body>
+<section name="Jetspeed Power Tool">
+<p>
+The Jetspeed Power Tool (JPT) is a velocity tool used in Layouts and Decorators to generate dynamic content.
+The JPT is a request level velocity tool, and is available to all layouts and decorators.
+The JPT is referenced in your decorator or layout as:
+<source test=""><![CDATA[
+$jetspeed
+]]></source>
+All public JPT APIs can be accessed with:
+<ul>
+    <li>Java dot notation for methods</li>
+    <li>JavaBean shortcuts for properties (getter/setter)</li>    
+</ul>
+Example of calling a method:
+<source test=""><![CDATA[
+# call a method 'getTitle' with 2 parameters
+$jetspeed.getTitle($myPE, $myF)
+]]></source>
+Example of calling getting a property:
+<source test=""><![CDATA[
+# get the page bean, equivalent to $jetspeed.getPage()
+$jetspeed.page
+]]></source>
+</p>
+</section>
+<section name="JPT Velocity API">
+<p>The table below defines the Jetspeed Power Tool API for Velocity</p>
+<hr/>
+<table>
+  <tr> 
+    <th>API</th>
+    <th><b>decorateAndInclude($fragment)</b></th>
+  </tr>
+  <tr>
+    <td>Description</td>
+    <td>
+        Retrieves the application relative path to a decorator template for a given 
+        fragment parameter <b>($fragment)</b> to be included by Velocity. 
+        Should be passed as a parameter to the Velocity #parse function (#parse includes 
+        another Velocity template). 
+     </td>
+  </tr>
+  <tr>
+    <td>Parameter</td>
+    <td><b>$fragment</b> - the fragment to be included and decorated.</td>         
+  </tr>
+  <tr>
+    <td>Returns</td>
+    <td><b>String</b> - Application relative path to a decorator template.</td>
+  </tr>
+  <tr>
+    <td>Examples</td>
+    <td>#parse($jetspeed.decorateAndInclude($fragment))<br/>returns<br/>/WEB-INF/decorations/layout/html/tigris/header.vm</td>
+  </tr>  
+</table>
+<hr/>
+<table>
+  <tr> 
+    <th>API</th>
+    <th><b>getAbsoluteUrl(appRelativePath)</b></th>
+  </tr>
+  <tr>
+    <td>Description</td>
+    <td>
+        Given a relative path to an portlet application resource, returns an absolute URL.
+        This API should not be used to reference template ULS since they are usually inaccessible 
+        as absolute URLs because they are often located in a CMS or behind the secured WEB-INF directory.
+     </td>
+  </tr>
+  <tr>
+    <td>Parameter</td>
+    <td><b>relativePath</b> - a relative path to a resource in the decorator package.</td>         
+  </tr>
+  <tr>
+    <td>Returns</td>
+    <td><b>String</b> - The full absolute path to a web resource</td>
+  </tr>
+  <tr>
+    <td>Examples</td>
+    <td>$jetspeed.getAbsoluteUrl("/images/test.gif")<br/>returns<br/>http://localhost:8080/jetspeed/portal/images/test.gif</td>
+  </tr>  
+</table>
+<hr/>
+<table>
+  <tr> 
+    <th>API</th>
+    <th><b>columns</b></th>
+  </tr>
+  <tr>
+    <td>Description</td>
+    <td>
+        Returns a list of column for the current fragment during a layout aggregation.
+     </td>
+  </tr>
+  <tr>
+    <td>Parameter</td>
+    <td><b>-</b></td>         
+  </tr>
+  <tr>
+    <td>Returns</td>
+    <td><b>List</b> - a standard Java List of sub-fragments or portlets</td>
+  </tr>
+  <tr>
+    <td>Examples</td>
+    <td>#set ($table = $jetspeed.columns)<br/>#foreach($entry in $table)
+    </td>
+  </tr>  
+</table>
+<hr/>
+<table>
+  <tr> 
+    <th>API</th>
+    <th><b></b></th>
+  </tr>
+  <tr>
+    <td>Description</td>
+    <td>
+     </td>
+  </tr>
+  <tr>
+    <td>Parameter</td>
+    <td><b></b></td>         
+  </tr>
+  <tr>
+    <td>Returns</td>
+    <td><b></b></td>
+  </tr>
+  <tr>
+    <td>Examples</td>
+    <td></td>
+  </tr>  
+</table>
+<hr/>
+
+</section>
+
+</body>
+</document>
+

Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-jpt.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-l10n.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-l10n.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-l10n.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-l10n.xml Sat Mar  3 18:13:22 2007
@@ -1,87 +1,87 @@
-<?xml version="1.0"?>
-<!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed 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>Guide to Localization for Jetspeed 2</title>
-    <subtitle>Jetspeed 2 Localization for your language</subtitle>
-    <authors>
-      <person name="Shinsuke Sugaya" email="shinsuke@yahoo.co.jp"/>
-    </authors>
-  </properties>
-  <body>
-<section name="Translate Messages">
-<p>
-Jetspeed2 has the translatable messages in Java properties and XML files
-</p>
-<subsection name="Properties File">
-<p>
-This document shows how to create a message properties file for your language.
-</p>
-<h5>1. Find <code>*_en.properties</code></h5>
-<p>
-<code>*_en.properties</code> is English message properties file. You can use it as a base properties file for your language. 
-</p>
-<p>
-If you use UNIX system, you can use <code>find</code> command to find the properties files:
-</p>
-<source test=""><![CDATA[
-$ cd ${jetspeed-2-home}
-$ find . -type f | grep -v CVS | grep _en.properties
-]]></source>
-<h5>2. Copy <code>*_en.properties</code> to <code>*_&lt;your language, [country and variant]&gt;.properties.orig</code></h5>
-<p>
-To translate messages, copy the properties file for your language. For more information about Language, Country and Variant code, see "<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Locale.html">JavaDoc: Locale Class</a>", "<a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">ISO Language Code</a>" and "<a href="http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html">ISO Country Code</a>".
-</p>
-<p>
-Example:
-</p>
-<source test=""><![CDATA[
-$ cd applications/localeselector/src/java/org/apache/jetspeed/portlets/localeselector/resources/
-$ cp LocaleSelectorResources_en.properties LocaleSelectorResources_ja.properties.orig
-]]></source>
-<p>
-where <code>*_ja.properties</code> is Japanese message file.
-</p>
-<h5>3. Translate *_&lt;your language, [country and variant]&gt;.properties.orig in your language</h5>
-<p>
-For more information about a properties file, see "<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Properties.html#load(java.io.InputStream)">JavaDoc: Properties Class</a>".
-</p>
-<h5>4. Run <code>native2ascii</code> command</h5>
-<p>
-Since the properties file is assumed to be using the ISO 8859-1 character encoding, use <code>native2ascii</code> command to convert to ISO 8859-1. For more information about "<a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/native2ascii.html">native2ascii(Solaris)</a>" or "<a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/native2ascii.html">native2ascii(Windows)</a>".
-</p>
-<p>
-Example:
-</p>
-<source test=""><![CDATA[
-$ native2ascii LocaleSelectorResources_ja.properties.orig LocaleSelectorResources_ja.properties
-]]></source>
-<h5>5. Build &amp; Deploy Jetspeed2, and see if your translation is displayed</h5>
-<p>
-For more information about Jetspeed 2 build and deploy steps, see "<a href="getting-started.html">Getting Started</a>".
-</p>
-<h5>6. Create a new JIRA issue, and attach <code>*_&lt;your language, [country and variant]&gt;.properties</code></h5>
-<p>
-JIRA site for Jetspeed 2 is <a href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10492">http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10492</a>. To create a new JIRA issue, go to "CREATE NEW ISSUE"(select "l10n" as Component/s name).
-</p>
-
-</subsection>
-</section>
-
-</body>
-</document>
-
+<?xml version="1.0"?>
+<!--
+Copyright 2004 The Apache Software Foundation
+
+Licensed 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>Guide to Localization for Jetspeed 2</title>
+    <subtitle>Jetspeed 2 Localization for your language</subtitle>
+    <authors>
+      <person name="Shinsuke Sugaya" email="shinsuke@yahoo.co.jp"/>
+    </authors>
+  </properties>
+  <body>
+<section name="Translate Messages">
+<p>
+Jetspeed2 has the translatable messages in Java properties and XML files
+</p>
+<subsection name="Properties File">
+<p>
+This document shows how to create a message properties file for your language.
+</p>
+<h5>1. Find <code>*_en.properties</code></h5>
+<p>
+<code>*_en.properties</code> is English message properties file. You can use it as a base properties file for your language. 
+</p>
+<p>
+If you use UNIX system, you can use <code>find</code> command to find the properties files:
+</p>
+<source test=""><![CDATA[
+$ cd ${jetspeed-2-home}
+$ find . -type f | grep -v CVS | grep _en.properties
+]]></source>
+<h5>2. Copy <code>*_en.properties</code> to <code>*_&lt;your language, [country and variant]&gt;.properties.orig</code></h5>
+<p>
+To translate messages, copy the properties file for your language. For more information about Language, Country and Variant code, see "<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Locale.html">JavaDoc: Locale Class</a>", "<a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">ISO Language Code</a>" and "<a href="http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html">ISO Country Code</a>".
+</p>
+<p>
+Example:
+</p>
+<source test=""><![CDATA[
+$ cd applications/localeselector/src/java/org/apache/jetspeed/portlets/localeselector/resources/
+$ cp LocaleSelectorResources_en.properties LocaleSelectorResources_ja.properties.orig
+]]></source>
+<p>
+where <code>*_ja.properties</code> is Japanese message file.
+</p>
+<h5>3. Translate *_&lt;your language, [country and variant]&gt;.properties.orig in your language</h5>
+<p>
+For more information about a properties file, see "<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Properties.html#load(java.io.InputStream)">JavaDoc: Properties Class</a>".
+</p>
+<h5>4. Run <code>native2ascii</code> command</h5>
+<p>
+Since the properties file is assumed to be using the ISO 8859-1 character encoding, use <code>native2ascii</code> command to convert to ISO 8859-1. For more information about "<a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/solaris/native2ascii.html">native2ascii(Solaris)</a>" or "<a href="http://java.sun.com/j2se/1.4.2/docs/tooldocs/windows/native2ascii.html">native2ascii(Windows)</a>".
+</p>
+<p>
+Example:
+</p>
+<source test=""><![CDATA[
+$ native2ascii LocaleSelectorResources_ja.properties.orig LocaleSelectorResources_ja.properties
+]]></source>
+<h5>5. Build &amp; Deploy Jetspeed2, and see if your translation is displayed</h5>
+<p>
+For more information about Jetspeed 2 build and deploy steps, see "<a href="getting-started.html">Getting Started</a>".
+</p>
+<h5>6. Create a new JIRA issue, and attach <code>*_&lt;your language, [country and variant]&gt;.properties</code></h5>
+<p>
+JIRA site for Jetspeed 2 is <a href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10492">http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10492</a>. To create a new JIRA issue, go to "CREATE NEW ISSUE"(select "l10n" as Component/s name).
+</p>
+
+</subsection>
+</section>
+
+</body>
+</document>
+

Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-l10n.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-layouts.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-layouts.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-layouts.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-layouts.xml Sat Mar  3 18:13:22 2007
@@ -1,150 +1,150 @@
-<?xml version="1.0"?>
-<!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed 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>Layouts and Decorations</title>
-    <subtitle>Documentation for Designers working with Jetspeed Layouts and Decorations</subtitle>
-    <authors>
-      <person name="David Sean Taylor" email="taylor@apache.org"/>
-    </authors>
-  </properties>
-  <body>
-<section name="Layouts">
-<p>
-Layout templates are packaged in special Jetspeed-specific and deployable portlet applications. 
-Layout templates control the overall aggregation of a portal page. Layout templates are 
-combined with portlets, providing a component model for aggregation. Jetspeed-2 comes out 
-of the box with several layout components including one, two and three column layouts. 
-See the <a href='#Jetspeed-2 Layouts'>Jetspeed-2 Layouts</a> below for all available Layouts in the 
-default Jetspeed-2 system. Of course you can define and derive your own layouts. 
-</p>
-<p>
-With regards to aggregation, layouts define how a single portal page is aggregated.
-A l ayout defines the fashion in which grouping of fragments
-will organized relative to the final, aggregated
-content of a request to the portal. Layouts are defined by 
-a portlet which applies an algorithm to a template to 
-generate the aggregated content of a page. Typical
-algorithms are two column, three column, nested.   
-</p>
-<p>A layout is made up of:
-<ul>
-  <li>One or more templates</li>
-  <li>A template descriptor</li>
-  <li>Images</li>
-  <li>A Stylesheet (CSS)</li>
-  <li>Macros</li>
-</ul>
-</p>
-<p>
-    <img src='images/layouts/layouts-overview.png'/>
-</p>
-</section>
-<section name="Layouts Packaging">
-<p>
-Layouts are packaged as standard portlet applications.
-Layouts usual have a 
-</p>
-<p>
-Operations Supported:
-<ul>
-    <li>Deploy</li>
-    <li>Un-deploy</li>
-    <li>Re-deploy</li>
-</ul>
-</p>    
-</section>
-<section name='Jetspeed-2 Layouts'>
-<p>
-Jetspeed-2 comes out of the box with several layout components including one, two and three 
-column layouts. Of course you can define and derive your own layouts. The table below lists
-the available layout components in Jetspeed. When customizing (editing) a page,
-the layout component is selected. One layout may be assigned per PSML page.
-</p>    
-<table>
-  <tr> 
-    <th>Layout</th>
-    <th>Type</th>
-    <th>Columns</th>
-    <th>Sizes</th>
-    <th>Modes</th>
-    <th>Description</th>
-  </tr>    
-  <tr>
-    <td><b>VelocityOneColumn</b></td>
-    <td>OneColumn</td>
-    <td>1</td>
-    <td>100%</td>
-    <td>view,edit,help</td>
-    <td>A single column display of one or more fragments taking up 100% of the portlet display area.</td>
-  </tr>
-  <tr>
-    <td><b>VelocityTwoColumns</b></td>
-    <td>TwoColumns</td>
-    <td>2</td>
-    <td>50%,50%</td>
-    <td>view,edit,help</td>
-    <td>A two column display of one or more fragments where each column is allocated to 50% respectively of the portlet display area.
-        Fragments may be placed in either column using <a href='psml.html'>PSML</a> fragment definitions.
-     </td>
-  </tr>
-  <tr>
-    <td><b>VelocityTwoColumns</b></td>
-    <td>TwoColumns</td>
-    <td>2</td>
-    <td>50%,50%</td>
-    <td>view,edit,help</td>
-    <td>A two column display of one or more fragments where each column is allocated to 50% of the portlet display area respectively.
-        Fragments may be placed in either column using <a href='psml.html'>PSML</a> fragment definitions.
-     </td>
-  </tr>
-  <tr>
-    <td><b>VelocityTwoColumnsSmallLeft</b></td>
-    <td>TwoColumns</td>
-    <td>2</td>
-    <td>15%,85%</td>
-    <td>view,edit,help</td>
-    <td>A two column display of one or more fragments where the left column is allocated to 15% of the portlet display area,
-        and the right column is allocated to 85% of the portlet display area.
-        Fragments may be placed in either column using <a href='psml.html'>PSML</a> fragment definitions.
-     </td>
-  </tr>
-  <tr>
-    <td><b>VelocityThreeColumns</b></td>
-    <td>ThreeColumns</td>
-    <td>3</td>
-    <td>33%,33%,33%</td>
-    <td>view,edit,help</td>
-    <td>A three column display of one or more fragments where each column is allocated to 33% of the portlet display area respectively.
-        Fragments may be placed in either column using <a href='psml.html'>PSML</a> fragment definitions.
-     </td>
-  </tr>
-  <tr>
-    <td><b>VelocityOneColumnNoActions,<br/>VelocityTwoColumnsNoActions,<br/>VelocityThreeColumnsNoActions</b></td>
-    <td></td>
-    <td></td>
-    <td></td>
-    <td>view</td>
-    <td>Same parameters as their counterparts with actions, but no decorator actions are displayed.
-     </td>
-  </tr>  
-</table>
-</section>
-
-</body>
-</document>
-
+<?xml version="1.0"?>
+<!--
+Copyright 2004 The Apache Software Foundation
+
+Licensed 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>Layouts and Decorations</title>
+    <subtitle>Documentation for Designers working with Jetspeed Layouts and Decorations</subtitle>
+    <authors>
+      <person name="David Sean Taylor" email="taylor@apache.org"/>
+    </authors>
+  </properties>
+  <body>
+<section name="Layouts">
+<p>
+Layout templates are packaged in special Jetspeed-specific and deployable portlet applications. 
+Layout templates control the overall aggregation of a portal page. Layout templates are 
+combined with portlets, providing a component model for aggregation. Jetspeed-2 comes out 
+of the box with several layout components including one, two and three column layouts. 
+See the <a href='#Jetspeed-2 Layouts'>Jetspeed-2 Layouts</a> below for all available Layouts in the 
+default Jetspeed-2 system. Of course you can define and derive your own layouts. 
+</p>
+<p>
+With regards to aggregation, layouts define how a single portal page is aggregated.
+A l ayout defines the fashion in which grouping of fragments
+will organized relative to the final, aggregated
+content of a request to the portal. Layouts are defined by 
+a portlet which applies an algorithm to a template to 
+generate the aggregated content of a page. Typical
+algorithms are two column, three column, nested.   
+</p>
+<p>A layout is made up of:
+<ul>
+  <li>One or more templates</li>
+  <li>A template descriptor</li>
+  <li>Images</li>
+  <li>A Stylesheet (CSS)</li>
+  <li>Macros</li>
+</ul>
+</p>
+<p>
+    <img src='images/layouts/layouts-overview.png'/>
+</p>
+</section>
+<section name="Layouts Packaging">
+<p>
+Layouts are packaged as standard portlet applications.
+Layouts usual have a 
+</p>
+<p>
+Operations Supported:
+<ul>
+    <li>Deploy</li>
+    <li>Un-deploy</li>
+    <li>Re-deploy</li>
+</ul>
+</p>    
+</section>
+<section name='Jetspeed-2 Layouts'>
+<p>
+Jetspeed-2 comes out of the box with several layout components including one, two and three 
+column layouts. Of course you can define and derive your own layouts. The table below lists
+the available layout components in Jetspeed. When customizing (editing) a page,
+the layout component is selected. One layout may be assigned per PSML page.
+</p>    
+<table>
+  <tr> 
+    <th>Layout</th>
+    <th>Type</th>
+    <th>Columns</th>
+    <th>Sizes</th>
+    <th>Modes</th>
+    <th>Description</th>
+  </tr>    
+  <tr>
+    <td><b>VelocityOneColumn</b></td>
+    <td>OneColumn</td>
+    <td>1</td>
+    <td>100%</td>
+    <td>view,edit,help</td>
+    <td>A single column display of one or more fragments taking up 100% of the portlet display area.</td>
+  </tr>
+  <tr>
+    <td><b>VelocityTwoColumns</b></td>
+    <td>TwoColumns</td>
+    <td>2</td>
+    <td>50%,50%</td>
+    <td>view,edit,help</td>
+    <td>A two column display of one or more fragments where each column is allocated to 50% respectively of the portlet display area.
+        Fragments may be placed in either column using <a href='psml.html'>PSML</a> fragment definitions.
+     </td>
+  </tr>
+  <tr>
+    <td><b>VelocityTwoColumns</b></td>
+    <td>TwoColumns</td>
+    <td>2</td>
+    <td>50%,50%</td>
+    <td>view,edit,help</td>
+    <td>A two column display of one or more fragments where each column is allocated to 50% of the portlet display area respectively.
+        Fragments may be placed in either column using <a href='psml.html'>PSML</a> fragment definitions.
+     </td>
+  </tr>
+  <tr>
+    <td><b>VelocityTwoColumnsSmallLeft</b></td>
+    <td>TwoColumns</td>
+    <td>2</td>
+    <td>15%,85%</td>
+    <td>view,edit,help</td>
+    <td>A two column display of one or more fragments where the left column is allocated to 15% of the portlet display area,
+        and the right column is allocated to 85% of the portlet display area.
+        Fragments may be placed in either column using <a href='psml.html'>PSML</a> fragment definitions.
+     </td>
+  </tr>
+  <tr>
+    <td><b>VelocityThreeColumns</b></td>
+    <td>ThreeColumns</td>
+    <td>3</td>
+    <td>33%,33%,33%</td>
+    <td>view,edit,help</td>
+    <td>A three column display of one or more fragments where each column is allocated to 33% of the portlet display area respectively.
+        Fragments may be placed in either column using <a href='psml.html'>PSML</a> fragment definitions.
+     </td>
+  </tr>
+  <tr>
+    <td><b>VelocityOneColumnNoActions,<br/>VelocityTwoColumnsNoActions,<br/>VelocityThreeColumnsNoActions</b></td>
+    <td></td>
+    <td></td>
+    <td></td>
+    <td>view</td>
+    <td>Same parameters as their counterparts with actions, but no decorator actions are displayed.
+     </td>
+  </tr>  
+</table>
+</section>
+
+</body>
+</document>
+

Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-layouts.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-migration.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml Sat Mar  3 18:13:22 2007
@@ -1,39 +1,39 @@
-<?xml version="1.0"?>
-<!--
-	Copyright 2004 The Apache Software Foundation
-	
-	Licensed 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>Jetspeed-2 Pipeline</title>
-		<subtitle>Documentation for Jetspeed-2 Pipeline</subtitle>
-		<authors>
-			<person name="David Le Strat" email="dlestrat@apache.org" />
-		</authors>
-	</properties>
-	<body>
-		<section name="Jetspeed-2 Pipeline">
-			<p>As described below, one of key component of the Jetspeed-2 portal engine is its request pipeline.
-			<br/><br/>
-			<img src="images/j2-overview.gif" border="0"/>
-			<br/>
-			In Jetspeed-2 request are processed through a series of <code>Valve</code> assembled together as a
-			pipeline.  For detailed information about Jetspeed-2 pipeline, 
-			<a href="../multiproject/jetspeed-portal/pipeline.html">click here</a>.
-			</p>
-		</section>
-
-	</body>
-</document>
-
+<?xml version="1.0"?>
+<!--
+	Copyright 2004 The Apache Software Foundation
+	
+	Licensed 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>Jetspeed-2 Pipeline</title>
+		<subtitle>Documentation for Jetspeed-2 Pipeline</subtitle>
+		<authors>
+			<person name="David Le Strat" email="dlestrat@apache.org" />
+		</authors>
+	</properties>
+	<body>
+		<section name="Jetspeed-2 Pipeline">
+			<p>As described below, one of key component of the Jetspeed-2 portal engine is its request pipeline.
+			<br/><br/>
+			<img src="images/j2-overview.gif" border="0"/>
+			<br/>
+			In Jetspeed-2 request are processed through a series of <code>Valve</code> assembled together as a
+			pipeline.  For detailed information about Jetspeed-2 pipeline, 
+			<a href="../multiproject/jetspeed-portal/pipeline.html">click here</a>.
+			</p>
+		</section>
+
+	</body>
+</document>
+

Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-portal-assembly.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-portal-assembly.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-portal-assembly.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-portal-assembly.xml Sat Mar  3 18:13:22 2007
@@ -1,30 +1,30 @@
-<?xml version="1.0"?>
-<!--
-	Copyright 2004 The Apache Software Foundation
-	
-	Licensed 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>Jetspeed 2 Home Page</title>
-		<subtitle>Welcome to Jetspeed 2</subtitle>
-		<authors>
-			<person name="David Le Strat" email="dlestrat@apache.org" />
-		</authors>
-	</properties>
-	<body>
-		<section name="Welcome to Jetspeed-2">
-			
-		</section>
-	</body>
+<?xml version="1.0"?>
+<!--
+	Copyright 2004 The Apache Software Foundation
+	
+	Licensed 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>Jetspeed 2 Home Page</title>
+		<subtitle>Welcome to Jetspeed 2</subtitle>
+		<authors>
+			<person name="David Le Strat" email="dlestrat@apache.org" />
+		</authors>
+	</properties>
+	<body>
+		<section name="Welcome to Jetspeed-2">
+			
+		</section>
+	</body>
 </document>

Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-portal-assembly.xml
------------------------------------------------------------------------------
    svn:eol-style = native



---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org


Mime
View raw message