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/11/24 01:36:01 UTC
cvs commit: jakarta-jetspeed/xdocs config_skin_param_summary.xml config_skin.xml config_guide.xml
paulsp 01/11/23 16:36:01
Modified: xdocs config_guide.xml
Added: xdocs config_skin_param_summary.xml config_skin.xml
Log:
Add Skin documentation
Revision Changes Path
1.5 +3 -0 jakarta-jetspeed/xdocs/config_guide.xml
Index: config_guide.xml
===================================================================
RCS file: /home/cvs/jakarta-jetspeed/xdocs/config_guide.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- config_guide.xml 2001/10/19 04:15:32 1.4
+++ config_guide.xml 2001/11/24 00:36:01 1.5
@@ -70,6 +70,9 @@
Any site specific skins should be define in <tt><jetspeed_home>/WEB-INF/conf/local-skins.xreg</tt>.
because this file will not be overwritten by upgrades.
</p>
+ <p>
+ See the <a href="config_skin.html">Skin configuration guide</a> for more information.
+ </p>
</section>
<section name="Define local controls and controllers in local-managers.xreg">
<p>
1.1 jakarta-jetspeed/xdocs/config_skin_param_summary.xml
Index: config_skin_param_summary.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Skin Configuration Guide</title>
<subtitle>Skin Parameter Summary</subtitle>
<authors>
<person name="Paul Spencer" email="paulsp@apache.org"/>
</authors>
</properties>
<body>
<section name="Parameter Usage Summary">
<subsection name="Velocity templates">
<table>
<tr>
<th>Template File</th>
<th>background-color</th>
<th>content-style-class</th>
<th>controller-style-class</th>
<th>highlight-background-color</th>
<th>highlight-text-color</th>
<th>highlight-title-style-class</th>
<th>portlet-style-class</th>
<th>tab-content-style-class</th>
<th>tab-style-class</th>
<th>tab-title-style-class</th>
<th>text-color</th>
<th>title-background-color</th>
<th>title-style-class</th>
<th>title-text-color</th>
</tr>
<tr>
<td>controllers/html/column.vm</td>
<td></td> <!-- background-color -->
<td></td> <!-- content-style-class -->
<td>Yes</td> <!-- controller-style-class -->
<td></td> <!-- highlight-background-color -->
<td></td> <!-- highlight-text-color -->
<td></td> <!-- highlight-title-style-class -->
<td></td> <!-- portlet-style-class -->
<td></td> <!-- tab-content-style-class -->
<td></td> <!-- tab-style-class -->
<td></td> <!-- tab-title-style-class -->
<td></td> <!-- text-color -->
<td>If present, overrides border color</td> <!-- title-background-color -->
<td></td> <!-- title-style-class -->
<td></td> <!-- title-text-color -->
<td>controllers/html/column.vm</td>
</tr>
<tr>
<td>controllers/html/multicolumn.vm</td>
<td></td> <!-- background-color -->
<td></td> <!-- content-style-class -->
<td>Yes</td> <!-- controller-style-class -->
<td></td> <!-- highlight-background-color -->
<td></td> <!-- highlight-text-color -->
<td></td> <!-- highlight-title-style-class -->
<td></td> <!-- portlet-style-class -->
<td></td> <!-- tab-content-style-class -->
<td></td> <!-- tab-style-class -->
<td></td> <!-- tab-title-style-class -->
<td></td> <!-- text-color -->
<td>If present, overrides border color</td> <!-- title-background-color -->
<td></td> <!-- title-style-class -->
<td></td> <!-- title-text-color -->
<td>controllers/html/multicolumn.vm</td>
</tr>
<tr>
<td>controllers/html/row.vm</td>
<td>If present
<ul>
<li>overrides border color</li>
<li>overrides background color define in title-style-class</li>
<li>overrides border color define in portlet-style-class</li>
</ul>
</td> <!-- background-color -->
<td>Yes</td> <!-- content-style-class -->
<td></td> <!-- controller-style-class -->
<td></td> <!-- highlight-background-color -->
<td></td> <!-- highlight-text-color -->
<td></td> <!-- highlight-title-style-class -->
<td></td> <!-- portlet-style-class -->
<td></td> <!-- tab-content-style-class -->
<td></td> <!-- tab-style-class -->
<td></td> <!-- tab-title-style-class -->
<td></td> <!-- text-color -->
<td>If present, overrides border color</td> <!-- title-background-color -->
<td></td> <!-- title-style-class -->
<td></td> <!-- title-text-color -->
<td>controllers/html/row.vm</td>
</tr>
<tr>
<th>Template File</th>
<th>background-color</th>
<th>content-style-class</th>
<th>controller-style-class</th>
<th>highlight-background-color</th>
<th>highlight-text-color</th>
<th>highlight-title-style-class</th>
<th>portlet-style-class</th>
<th>tab-content-style-class</th>
<th>tab-style-class</th>
<th>tab-title-style-class</th>
<th>text-color</th>
<th>title-background-color</th>
<th>title-style-class</th>
<th>title-text-color</th>
</tr>
<tr>
<td>controls/jetspeed.vm</td>
<td>If present, overrides background color define in content-style-class</td> <!-- background-color -->
<td>Yes</td> <!-- content-style-class -->
<td></td> <!-- controller-style-class -->
<td></td> <!-- highlight-background-color -->
<td></td> <!-- highlight-text-color -->
<td></td> <!-- highlight-title-style-class -->
<td>Yes</td> <!-- portlet-style-class -->
<td></td> <!-- tab-content-style-class -->
<td></td> <!-- tab-style-class -->
<td></td> <!-- tab-title-style-class -->
<td>If present, overrides text color defined in content-style-class</td> <!-- text-color -->
<td>If present
<ul>
<li>overrides border color</li>
<li>overrides background color define in title-style-class</li>
<li>overrides border color define in portlet-style-class</li>
</ul>
</td> <!-- title-background-color -->
<td>Yes</td> <!-- title-style-class -->
<td>If present, overrides text color defined in title-style-class</td> <!-- title-text-color -->
<td>controls/jetspeed.vm</td>
</tr>
<tr>
<td>controls/jetspeed_menu.vm</td>
<td>Yes</td> <!-- background-color -->
<td>Yes</td> <!-- content-style-class -->
<td>Yes</td> <!-- controller-style-class -->
<td>If present, overrides background color defined in highlight-title-style-class</td> <!-- highlight-background-color -->
<td>If present, overrides text color defined in highlight-title-style-class</td> <!-- highlight-text-color -->
<td>Yes</td> <!-- highlight-title-style-class -->
<td></td> <!-- portlet-style-class -->
<td></td> <!-- tab-content-style-class -->
<td>Yes</td> <!-- tab-style-class -->
<td></td> <!-- tab-title-style-class -->
<td></td> <!-- text-color -->
<td>If present, overrides background color defined in title-style-class</td> <!-- title-background-color -->
<td>Yes</td> <!-- title-style-class -->
<td>If present, overrides text color defined in title-style-class</td> <!-- title-text-color -->
<td>controls/jetspeed_menu.vm</td>
</tr>
<tr>
<td>controls/jetspeed_tab.vm</td>
<td>Yes</td> <!-- background-color -->
<td></td> <!-- content-style-class -->
<td></td> <!-- controller-style-class -->
<td>If present, overrides background color defined in highlight-title-style-class</td> <!-- highlight-background-color -->
<td>If present, overrides text color defined in highlight-title-style-class</td> <!-- highlight-text-color -->
<td>Yes</td> <!-- highlight-title-style-class -->
<td></td> <!-- portlet-style-class -->
<td>Yes</td> <!-- tab-content-style-class -->
<td>Yes</td> <!-- tab-style-class -->
<td>Yes</td> <!-- tab-title-style-class -->
<td></td> <!-- text-color -->
<td>If present, overrides background color defined in title-style-class</td> <!-- title-background-color -->
<td>Yes</td> <!-- title-style-class -->
<td>If present, overrides text color defined in title-style-class</td> <!-- title-text-color -->
<td>controls/jetspeed_tab.vm</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 jakarta-jetspeed/xdocs/config_skin.xml
Index: config_skin.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Skin Configuration Guide</title>
<subtitle>Skin configuration guidelines</subtitle>
<authors>
<person name="Paul Spencer" email="paulsp@apache.org"/>
</authors>
</properties>
<body>
<section name="Description">
<p>
Skins are used to define color, font, and borders for various components in
Jetspeed. The skin definition is used in the Template files used to general
the HTML sent to the user's browser.
</p>
</section>
<section name="Skin Files">
<p>
Skin file are located in <tt><jetspeed_home>/WEB-INF/conf/</tt>
</p>
<table>
<tr>
<th>File Name</th>
<th>Description</th>
</tr>
<tr>
<td>skins.xreg</td>
<td>
Skin definitions that are part of the Jetspeed distribution. Since this
is part of the distribution, modifications and additions are discouraged.
If a skin is not used, then it should be hidden.
</td>
</tr>
<tr>
<td>local-skins.xreg</td>
<td>
Installation specific skin definitions should be places in this file.
This file is not part the the Jetspeed distribution. To create it, just
skins.xreg and remove all of the skin entries.
</td>
</tr>
</table>
</section>
<section name="Parameters">
<table>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td>text-color</td>
<td>
Color of normal text
<br/>
It is recommended that the text color be set using in styles used
by the skin.
</td>
</tr>
<tr>
<td>background-color</td>
<td>
Color of background.
<br/>
It is recommended that the background color be set in the styles used
by the skin.
</td>
</tr>
<tr>
<td>title-text-color</td>
<td>
Color of text used in titles
<br/>
It is recommended that the text color be set in the style defined by
title-style-class.
</td>
</tr>
<tr>
<td>title-background-color</td>
<td>
Background color of titles.
<br/>
It is recommended that the background color be set in the styles used
by the skin.
</td>
</tr>
<tr>
<td>title-style-class</td>
<td>
Style that defines text color, font, and background-color for title
<br/>
Only set font and color properties.
</td>
</tr>
<tr>
<td>highlight-text-color</td>
<td>
Color of text used in selected titles
<br/>
It is recommended that the text color be set in the style defined by
highlight-title-style-class.
</td>
</tr>
<tr>
<td>highlight-background-color</td>
<td>
Background color of selected titles.
<br/>
It is recommended that the background color be set in the style defined
by highlight-title-style-class.
</td>
</tr>
<tr>
<td>highlight-title-style-class</td>
<td>
Style that defines text color, font, and background-color for
selected title.
<br/>
Only set font and color properties.
</td>
</tr>
<tr>
<td>controller-style-class</td>
<td>
Style that defines text color, font, background-color, and border used by
controllers.
</td>
</tr>
<tr>
<td>portlet-style-class</td>
<td>
Style that defines text color, font, background-color, and border used by
portlet controls.
</td>
</tr>
<tr>
<td>content-style-class</td>
<td>
Style that defines text color, font, background-color, and border used to
display portlet content.
</td>
</tr>
<tr>
<td>tab-style-class</td>
<td>
Style that defines text color, font, background-color, and border used to
display tabs.
</td>
</tr>
<tr>
<td>tab-title-style-class</td>
<td>
Style that defines text color, font, and background-color used to
display tab titles.
<br/>
Only set font and color properties.
</td>
</tr>
<tr>
<td>tab-content-style-class</td>
<td>
Style that defines text color, font, background-color, and border used to
display tab content.
</td>
</tr>
</table>
<br/>
<center>
<a href="config_skin_param_summary.html">
Parameter Usage Summary in Velocity templates
</a>
</center>
</section>
<section name="General Recommendations">
<ul>
<li>
Reuse styles, as defined in the stylesheet, as often as practical. This will
help keep the size of the stylesheet small.
</li>
<li>
Set only *-style-class parameter in the skin definition. This will keep the
generated HTML simpler without the losing functionality.
</li>
</ul>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>