You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by pa...@apache.org on 2001/10/19 06:15:33 UTC
cvs commit: jakarta-jetspeed/docs/site config_guide.html
paulsp 01/10/18 21:15:33
Modified: xdocs config_guide.xml
docs/site config_guide.html
Log:
o Add some Layout and Navigation information
o Correct some spelling errors
Revision Changes Path
1.4 +110 -24 jakarta-jetspeed/xdocs/config_guide.xml
Index: config_guide.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/config_guide.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- config_guide.xml 2001/09/29 05:17:57 1.3
+++ config_guide.xml 2001/10/19 04:15:32 1.4
@@ -36,7 +36,7 @@
<li><a href="#Define skins in local-skins.xreg">Define skins in local-skins.xreg</a></li>
<li><a href="#Define local controls and controllers in local-managers.xreg">Define local controls and controllers in local-managers.xreg</a></li>
<li><a href="#Define content feeds">Define content feeds</a></li>
- <li><a href="#Configure the layout and navigaton bars">Configure the layout and navigaton bars</a></li>
+ <li><a href="#Configure the layout and navigation bars">Configure the layout and navigation bars</a></li>
<li><a href="#Configure default home page">Configure default home page</a></li>
<li><a href="#Define users">Define users</a></li>
<li><a href="#Configure the admin and turbine users">Configure the admin and turbine users</a></li>
@@ -82,31 +82,112 @@
<p>
</p>
</section>
- <section name="Configure the layout and navigaton bars">
+ <section name="Configure the layout and navigation bars">
+<!-- FIXME: David Sean Taylor will work on the section -->
<p><center>This section is incomplete</center></p>
<p>
- The look of Jetspeed's portal is controlled by the layout and nagivation templates. Below are some of the
+ The look of Jetspeed's portal is controlled by the layout and navigation templates. Below are some of the
file that define that look.
</p>
- <subsection name="Velocity Layout Manager - 1.3a2 default">
- <ul>
- <li><tt><jetspeed_home>/WEB-INF/template/vm/layouts/html/<i>language/country/</i>default.vm</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>top.vm</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>left.vm</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>bottom.vm</tt></li>
- </ul>
- </subsection>
-
- <subsection name="JSP Layout Manager - 1.3a1 default">
- <ul>
- <li><tt><jetspeed_home>/WEB-INF/template/jsp/layouts/html/<i>language/country/</i>default.jsp</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>top.jsp</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>left.jsp</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>bottom/jsp</tt></li>
- </ul>
- </subsection>
+ <p>
+ A Layout Manager is used in the generation of the resulting portal. Jetspeed support 2 Layout Manager, JSP
+ and Velocity. Both layout manager produce the similar results, which one you use is dictated by which
+ language you prefer.
+ </p>
+ <p>
+ The parameter <tt>services.TemplateService.default.extension</tt> in TurbineResource.properties defines
+ the Layout manager used.
+ </p>
+ <table>
+ <tr>
+ <th>Value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>jsp</td>
+ <td>The JSP layout manager will be used. This is the 1.3a1 default</td>
+ </tr>
+ <tr>
+ <td>vm</td>
+ <td>The vm layout manager will be used. This is 1.3a2 default</td>
+ </tr>
+ </table>
+ <br/>
+ <subsection name="Files uses by the Velocity Layout Manager">
+ <dd>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/vm/layouts/html/<i>language/country/</i>default.vm</tt></dt>
+ <dd>
+ Display the logo in the upper left hand corner and the define the top, bottom, and left navigation bars.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>top.vm</tt></dt>
+ <dd>
+ Top navigation bar when the user it NOT logged in.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>left.vm</tt></dt>
+ <dd>
+ Left navigation bar for all users.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>bottom.vm</tt></dt>
+ <dd>
+ Bottom navigation bar for all users.
+ </dd>
+ </dl>
+ </dd>
+ </subsection>
+ <subsection name="Files uses by the JSP Layout Manager">
+ <dd>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/layouts/html/<i>language/country/</i>default.jsp</tt></dt>
+ <dd>
+ Display the logo in the upper left hand corner and the define the top, bottom, and left navigation bars.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>top_default.jsp</tt></dt>
+ <dd>
+ Top navigation bar when the user is NOT logged in.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>top_loggedin.jsp</tt></dt>
+ <dd>
+ Top navigation bar for logged in users.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>left.jsp</tt></dt>
+ <dd>
+ Left navigation bar for all users.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>bottom/jsp</tt></dt>
+ <dd>
+ Bottom navigation bar for all users.
+ </dd>
+ </dl>
+ </dd>
+ </subsection>
+ <p>
+ To customize the navigation bars, the following steps are suggested:
+ <ul>
+ <li>Replace the reference to the Jetspeed logo with your logo in <tt>default.</tt><i>xx</i></li>
+ <li>Add "banner adds" to <tt>top.vm</tt> or <tt>top_default.jsp</tt> and <tt>top_loggedin.jsp</tt></li>
+ <li>If no left navigation bar is desired, them remove the referance from <tt>default.</tt><i>xx</i></li>
+ <li>If a left navigation bar is desired, then update <tt>left.</tt><i>xx</i></li>
+ <li>Add any copyright notices, disclaimers, logos, ... to <tt>bottom.</tt><i>xx</i></li>
+ </ul>
+ </p>
</section>
<section name="Configure default home page">
+<!-- FIXME: David Sean Taylor will work on the section -->
<p><center>This section is incomplete</center></p>
<p>
The default home page is stored in the <tt><jetspeed_home>/WEB-INF/psml/anon</tt> directory. Currently this
@@ -115,20 +196,23 @@
</p>
</section>
<section name="Define users">
+<!-- FIXME: David Sean Taylor will work on the section -->
<p><center>This section is incomplete</center></p>
<p>
</p>
</section>
<section name="Configure the admin and turbine users">
+<!-- FIXME: David Sean Taylor will work on the section -->
<p><center>This section is incomplete</center></p>
<p>
<center><font size="+2"><strong>Change the passwords!</strong></font></center>
</p>
</section>
<section name="Define default portal for new users">
+<!-- FIXME: David Sean Taylor will work on the section -->
<p>
- A new users home page is coppied from the user <tt>TURBINE</tt>. Thus you should customized the <tt>TURBINE</tt>'s
- user home page to refect the desired default home page for new users.
+ A new users home page is copied from the user <tt>TURBINE</tt>. Thus you should customized the <tt>TURBINE</tt>'s
+ user home page to reflect the desired default home page for new users.
</p>
</section>
<section name="Set portlet caching and other refresh rates">
@@ -190,6 +274,7 @@
</td>
</tr>
</table>
+ <br/>
<subsection name="FileLogger">
<p>
This is a logging service provide with Turbine.
@@ -233,7 +318,7 @@
</tr>
<tr>
<td>INFO</td>
- <td>Designates informational messages that highlight the progress of the application at coarse-grained level.</td>
+ <td>Designates informational messages that highlight the progress of the application at course-grained level.</td>
</tr>
<tr>
<td>DEBUG</td>
@@ -368,7 +453,7 @@
</subsection>
<subsection name="Example configuration">
<p>
- The following confuration will rotate the logging among 6 files. All logging
+ The following configuration will rotate the logging among 6 files. All logging
will be at the DEBUG level.
</p>
<source>
@@ -430,6 +515,7 @@
</subsection>
</section>
<section name="Enable e-mail confirmation">
+<!-- FIXME: David Sean Taylor will work on the section -->
<p><center>This section is incomplete</center></p>
<p>
</p>
1.4 +126 -21 jakarta-jetspeed/docs/site/config_guide.html
Index: config_guide.html
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/docs/site/config_guide.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- config_guide.html 2001/09/29 05:20:32 1.3
+++ config_guide.html 2001/10/19 04:15:33 1.4
@@ -136,7 +136,7 @@
<li><a href="#Define skins in local-skins.xreg">Define skins in local-skins.xreg</a></li>
<li><a href="#Define local controls and controllers in local-managers.xreg">Define local controls and controllers in local-managers.xreg</a></li>
<li><a href="#Define content feeds">Define content feeds</a></li>
- <li><a href="#Configure the layout and navigaton bars">Configure the layout and navigaton bars</a></li>
+ <li><a href="#Configure the layout and navigation bars">Configure the layout and navigation bars</a></li>
<li><a href="#Configure default home page">Configure default home page</a></li>
<li><a href="#Define users">Define users</a></li>
<li><a href="#Configure the admin and turbine users">Configure the admin and turbine users</a></li>
@@ -224,30 +224,98 @@
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="Configure the layout and navigaton bars"><strong>Configure the layout and navigaton bars</strong></a>
+ <a name="Configure the layout and navigation bars"><strong>Configure the layout and navigation bars</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<p><center>This section is incomplete</center></p>
<p>
- The look of Jetspeed's portal is controlled by the layout and nagivation templates. Below are some of the
+ The look of Jetspeed's portal is controlled by the layout and navigation templates. Below are some of the
file that define that look.
</p>
+ <p>
+ A Layout Manager is used in the generation of the resulting portal. Jetspeed support 2 Layout Manager, JSP
+ and Velocity. Both layout manager produce the similar results, which one you use is dictated by which
+ language you prefer.
+ </p>
+ <p>
+ The parameter <tt>services.TemplateService.default.extension</tt> in TurbineResource.properties defines
+ the Layout manager used.
+ </p>
+ <table>
+ <tr>
+ <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Value
+ </font>
+</td>
+ <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Description
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ jsp
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ The JSP layout manager will be used. This is the 1.3a1 default
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ vm
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ The vm layout manager will be used. This is 1.3a2 default
+ </font>
+</td>
+ </tr>
+ </table>
+ <br />
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="Velocity Layout Manager - 1.3a2 default"><strong>Velocity Layout Manager - 1.3a2 default</strong></a>
+ <a name="Files uses by the Velocity Layout Manager"><strong>Files uses by the Velocity Layout Manager</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
- <ul>
- <li><tt><jetspeed_home>/WEB-INF/template/vm/layouts/html/<i>language/country/</i>default.vm</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>top.vm</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>left.vm</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>bottom.vm</tt></li>
- </ul>
+ <dd>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/vm/layouts/html/<i>language/country/</i>default.vm</tt></dt>
+ <dd>
+ Display the logo in the upper left hand corner and the define the top, bottom, and left navigation bars.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>top.vm</tt></dt>
+ <dd>
+ Top navigation bar when the user it NOT logged in.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>left.vm</tt></dt>
+ <dd>
+ Left navigation bar for all users.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/vm/navigations/html/<i>language/country/</i>bottom.vm</tt></dt>
+ <dd>
+ Bottom navigation bar for all users.
+ </dd>
+ </dl>
+ </dd>
</blockquote>
</td></tr>
<tr><td><br/></td></tr>
@@ -255,21 +323,57 @@
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="JSP Layout Manager - 1.3a1 default"><strong>JSP Layout Manager - 1.3a1 default</strong></a>
+ <a name="Files uses by the JSP Layout Manager"><strong>Files uses by the JSP Layout Manager</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
- <ul>
- <li><tt><jetspeed_home>/WEB-INF/template/jsp/layouts/html/<i>language/country/</i>default.jsp</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>top.jsp</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>left.jsp</tt></li>
- <li><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>bottom/jsp</tt></li>
- </ul>
+ <dd>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/layouts/html/<i>language/country/</i>default.jsp</tt></dt>
+ <dd>
+ Display the logo in the upper left hand corner and the define the top, bottom, and left navigation bars.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>top_default.jsp</tt></dt>
+ <dd>
+ Top navigation bar when the user is NOT logged in.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>top_loggedin.jsp</tt></dt>
+ <dd>
+ Top navigation bar for logged in users.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>left.jsp</tt></dt>
+ <dd>
+ Left navigation bar for all users.
+ </dd>
+ </dl>
+ <dl>
+ <dt><tt><jetspeed_home>/WEB-INF/template/jsp/navigations/html/<i>language/country/</i>bottom/jsp</tt></dt>
+ <dd>
+ Bottom navigation bar for all users.
+ </dd>
+ </dl>
+ </dd>
</blockquote>
</td></tr>
<tr><td><br/></td></tr>
</table>
+ <p>
+ To customize the navigation bars, the following steps are suggested:
+ <ul>
+ <li>Replace the reference to the Jetspeed logo with your logo in <tt>default.</tt><i>xx</i></li>
+ <li>Add "banner adds" to <tt>top.vm</tt> or <tt>top_default.jsp</tt> and <tt>top_loggedin.jsp</tt></li>
+ <li>If no left navigation bar is desired, them remove the referance from <tt>default.</tt><i>xx</i></li>
+ <li>If a left navigation bar is desired, then update <tt>left.</tt><i>xx</i></li>
+ <li>Add any copyright notices, disclaimers, logos, ... to <tt>bottom.</tt><i>xx</i></li>
+ </ul>
+ </p>
</blockquote>
</p>
</td></tr>
@@ -336,8 +440,8 @@
<tr><td>
<blockquote>
<p>
- A new users home page is coppied from the user <tt>TURBINE</tt>. Thus you should customized the <tt>TURBINE</tt>'s
- user home page to refect the desired default home page for new users.
+ A new users home page is copied from the user <tt>TURBINE</tt>. Thus you should customized the <tt>TURBINE</tt>'s
+ user home page to reflect the desired default home page for new users.
</p>
</blockquote>
</p>
@@ -469,6 +573,7 @@
</td>
</tr>
</table>
+ <br />
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica,sanserif">
@@ -549,7 +654,7 @@
</tr>
<tr>
<td>INFO</td>
- <td>Designates informational messages that highlight the progress of the application at coarse-grained level.</td>
+ <td>Designates informational messages that highlight the progress of the application at course-grained level.</td>
</tr>
<tr>
<td>DEBUG</td>
@@ -778,7 +883,7 @@
<tr><td>
<blockquote>
<p>
- The following confuration will rotate the logging among 6 files. All logging
+ The following configuration will rotate the logging among 6 files. All logging
will be at the DEBUG level.
</p>
<div align="left">
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org