taylor 2005/01/17 23:55:19
Modified: xdocs navigation.xml
Added: xdocs authentication.xml jpt.xml sso.xml psml.xml
authorization.xml security-overview.xml
portal-design.xml site.xml spi.xml layouts.xml
decorators.xml bronco.xml
Log:
http://issues.apache.org/jira/browse/JS2-83
Lots of documentation left to do
This is the start of:
1. an outline for security documentation
2. an outline for Site and Layout documentation
3. partial work completed on layouts, jpt, decorators
(sigh)
Revision Changes Path
1.6 +16 -0 jakarta-jetspeed-2/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed-2/xdocs/navigation.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- navigation.xml 14 Jan 2005 13:04:07 -0000 1.5
+++ navigation.xml 18 Jan 2005 07:55:19 -0000 1.6
@@ -33,6 +33,22 @@
<item name="Tasks" href="tasks.html"/>
<item name="Sub Projects" href="projects-overview.html"/>
</menu>
+ <menu name='Security'>
+ <item name="Security Overview" href="security-overview.html"/>
+ <item name="Authentication" href="authentication.html"/>
+ <item name="JAAS Authorization" href="authorization.html"/>
+ <item name="PSML Authorization" href="bronco.html"/>
+ <item name="SPI: Providers and Handlers" href="spi.html"/>
+ <item name="Single Sign on" href="sso.html"/>
+ </menu>
+ <menu name='Portal Design'>
+ <item name="Portal Design Overview" href="portal-design.html"/>
+ <item name="Layouts" href="layouts.html"/>
+ <item name="Decorators" href="decorators.html"/>
+ <item name="Jetspeed Power Tool" href="jpt.html"/>
+ <item name="PSML" href="psml.html"/>
+ <item name="Site" href="site.html"/>
+ </menu>
<menu name="Support">
<item name="Mailing List" href="mail-lists.html"/>
<item name="Bug Database" href="issue-tracking.html"/>
1.1 jakarta-jetspeed-2/xdocs/authentication.xml
Index: authentication.xml
===================================================================
<?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 Authentication</title>
<subtitle>Documentation for Jetspeed-2 Authentication</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Authentication">
<p>
TODO: talk about components of a authentication : Login Module...
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/jpt.xml
Index: jpt.xml
===================================================================
<?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 Power Tool</title>
<subtitle>Documentation for Designers working with the Jetspeed Power
Tool.</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</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/decorator-top.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/>
<p>
<i>Documentation for Jetspeed 2.0-M2 release.</i>.
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/sso.xml
Index: sso.xml
===================================================================
<?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 Single Sign On</title>
<subtitle>Documentation for Jetspeed-2 SSO (Single Sign On)</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Single Sign On">
<p>
TODO: talk about SSO
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/psml.xml
Index: psml.xml
===================================================================
<?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>PSML</title>
<subtitle>Documentation for Designers working with PSML</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="PSML">
<p>
PSML - The Portal Structured Markup Language
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/authorization.xml
Index: authorization.xml
===================================================================
<?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 Authorization</title>
<subtitle>Documentation for Jetspeed-2 Authorization</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Authorization">
<p>
TODO: talk about components of a authorization : ...
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/security-overview.xml
Index: security-overview.xml
===================================================================
<?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 Security Overview</title>
<subtitle>Introduction to the Jetspeed-2 Security Model</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Introduction">
<p>
TODO: introduce J2 Security
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/portal-design.xml
Index: portal-design.xml
===================================================================
<?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>Portal Design</title>
<subtitle>Documentation for Designers working with Jetspeed Portal
Design</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Introduction">
<p>
The Java Portlet API (JSR-168) defines the Java standard interface for
programming portlets.
The Java Portlet API specification enables interoperability between Portlets
and Portals.
It is the standard specification for developing Java portlets. However the
Java Portlet API
does not define standards for laying out and aggregating portlets and markup
on a page.
The documentation here under "Portal Design" covers:
<ul>
<li><a href='psml.html'>Page Aggregation - see the section on PSML</a></li>
<li><a href='decorators.html'>Page and Portlet Decorators</a></li>
<li><a href='layouts.html'>Page Layouts</a></li>
<li><a href='jpt.html'>The Jetspeed Power Tool</a></li>
<li><a href='site.html'>The Site Content Model</a></li>
<li><a href='#Template Locators'>Template Locators</a></li>
<li><a href='#Terminology'>Terminology</a></li>
</ul>
</p>
</section>
<section name='Templates'>
<p>
Rendering one or more portlets into a portlet page is largely made up of the
process of aggregating
portlets as dynamic content with templates. Jetspeed-2 makes use of Velocity
templates in
creating a page layout. Although the Jetspeed-2 architecture fully supports
the use of JSP templates for
decorators and layouts, the developers thus far have chosen Velocity as the
tool of choice for writing
templates. There are two types of templates in Jetspeed: layouts and
decorators.
The process of rendering a page is the combined aggregation of a layout
template,
a page decorator template, a PSML definition, and one or more portlet
decorator templates.
As of release 2.0, templates can be stored on the file system. In future
releases, templates
will also be stored in a CMS backend for versioning.
</p>
<subsection 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='layouts.html'>Layout Documentation</a> for all available
Layouts in the
default Jetspeed-2 system. Of course you can define and derive your own
layouts.
</p>
</subsection>
<subsection name='Decorators'>
<p>
Decorator templates are packaged in special Jetspeed-specific and deployable
archives.
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='decorators.html'>Decorator Documentation</a> for all
available Layouts in the
default Jetspeed-2 system. Of course you can define and derive your own
layouts.
</p>
</subsection>
</section>
<section name='Template Locators'>
<p>
Templates are located by the Jetspeed Template (and Decorator) Locator
Component. These components
locates templates using a normalized name/value pair URL scheme.
using this scheme in what is called a 'normalized' URL to either a decorator
or layout.
However, templating engines such as Velocity need to work with templates
using paths to templates that are
relative of a document root. The <a href='jpt.html'>Jetspeed Power Tool</a>
facilitates conversion between normalized
and relative paths. Typically in the Spring configuration, the template root
of all decorators is defined as:
<source test=""><![CDATA[
${applicationRoot}/WEB-INF/decorations
]]></source>
and the root of all layouts (per portlet application) is defined as:
<source test=""><![CDATA[
${applicationRoot}/WEB-INF/templates
]]></source>
The Normalized Path is defined with named pair values. Examples:
<source test=""><![CDATA[
type/layout/media-type/html/name/tigris/decorator.vm
type/decorator/media-type/html/language/en/country/US/name/metal/decorator.vm
]]></source>
<table>
<tr>
<th>Name</th>
<th>Value</th>
<th>Description</th>
</tr>
<tr>
<td>type</td>
<td>layout | portlet | generic</td>
<td>The type of template locator. Expected to be either one of the
following values
<b>layout</b>, <b>portlet</b> (decorator) or <b>generic</b>
(decorator). Layouts can be for either page layouts
or decorators. Generic type decorators can be used
for either portlets or page decorations.</td>
</tr>
<tr>
<td>media-type</td>
<td>html | wml | dhtml | ...</td>
<td>The markup media type to be located. Should be a valid media type
(html, dhtml, wml...)</td>
</tr>
<tr>
<td>name</td>
<td>A valid decorator or layout name</td>
<td>The name of the decorator or layout. Usually corresponds to a
sub-directory holding the decorator or layout templates, images
and stylesheets.</td>
</tr>
<tr>
<td>language</td>
<td>A valid ISO-639 standard two-character language abbreviation</td>
<td>ISO-639 (http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt)
defines a standard for language abbreviations.
Typical abbreviations are en for english, fr for french, de for
German, ...</td>
</tr>
<tr>
<td>country</td>
<td>A valid ISO-3166 standard two-character country code
abbreviation</td>
<td>ISO-3166
(http://userpage.chemie.fu-berlin.de/diverse/doc/ISO_3166.html) defines a
standard for country code abbreviations.
Typical abbreviations are US for United States, FR for France,
...</td>
</tr>
</table>
</p>
</section>
<section name='Terminology'>
<table>
<tr>
<th>
Term
</th>
<th>
Definition
</th>
</tr>
<tr>
<td>
Layout
</td>
<td>
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.
</td>
</tr>
<tr>
<td>
TODO: left off here:
</td>
<td>
fragment, decoration, page, page decorator, portlet decorator,
application relative, normalized template path, absolute URL
</td>
</tr>
</table>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/site.xml
Index: site.xml
===================================================================
<?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>Site</title>
<subtitle>Documentation for Designers working with a Jetspeed-2
Site</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Site">
<p>
TODO: talk about components of a site i.e. pages, folders, fragments,
decorators, layouts, folder metadata,
links, PSML, document sets.
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/spi.xml
Index: spi.xml
===================================================================
<?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 Security SPI</title>
<subtitle>Documentation for Jetspeed-2 Security SPI</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Security Provider Interface">
<p>
TODO: talk about SPIs
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/layouts.xml
Index: layouts.xml
===================================================================
<?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="[EMAIL PROTECTED]"/>
</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='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 version 2.0. 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>
1.1 jakarta-jetspeed-2/xdocs/decorators.xml
Index: decorators.xml
===================================================================
<?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 Decorations</title>
<subtitle>Documentation for Designers working with Jetspeed
Decorations</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</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.
Decorators define how a single portal page is aggregated. 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='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>
1.1 jakarta-jetspeed-2/xdocs/bronco.xml
Index: bronco.xml
===================================================================
<?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 PSML Authorization</title>
<subtitle>Documentation for Jetspeed-2 PSML Authorization</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="PSML Authorization">
<p>
TODO: talk about Bronco authorization : ...
</p>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
