Author: cdupoirieux
Date: Mon Dec 19 01:39:50 2005
New Revision: 357673
URL: http://svn.apache.org/viewcvs?rev=357673&view=rev
Log:
Add documentation of the fallback mecanism to include css files...
Modified:
forrest/trunk/main/template-sites/v2/src/documentation/resources/themes/common/html/branding-css-links.ft
forrest/trunk/main/template-sites/v3/src/documentation/resources/themes/common/html/branding-css-links.ft
Modified:
forrest/trunk/main/template-sites/v2/src/documentation/resources/themes/common/html/branding-css-links.ft
URL:
http://svn.apache.org/viewcvs/forrest/trunk/main/template-sites/v2/src/documentation/resources/themes/common/html/branding-css-links.ft?rev=357673&r1=357672&r2=357673&view=diff
==============================================================================
---
forrest/trunk/main/template-sites/v2/src/documentation/resources/themes/common/html/branding-css-links.ft
(original)
+++
forrest/trunk/main/template-sites/v2/src/documentation/resources/themes/common/html/branding-css-links.ft
Mon Dec 19 01:39:50 2005
@@ -22,10 +22,47 @@
<description>
<p>branding-css-links will output html link elements for css usage. </p>
+ <p>The contract includes css files which are passed in parameter with the
following syntax :</p>
+ <source><![CDATA[<css url="layout.]]><em>media</em>.css"
[media="screen|print"] [theme="themeName"]<![CDATA[/>]]></source>
+ <ul>
+ <li><strong>url</strong> attribute indicates the name of the css file,
the dispatcher
+ searches for this file in the following order :
+ <ul>
+ <li>Does the css file exists in the following directory - if yes,
use this one :
+
<source>$PROJECT_HOME/src/documentation/resources/themes/yourtheme/css/</source>
+ </li>
+ <li>Otherwise, does the css file exists in the following directory -
if yes, use this one :
+
<source>$FORREST_HOME/whiteboard/plugins/org.apache.forrest.plugin.output.themer/resources/themes/yourtheme/css/</source>
+ </li>
+ <li>Otherwise, does the css file exists in the following directory -
if yes, use this one :
+
<source>$FORREST_HOME/whiteboard/plugins/org.apache.forrest.plugin.output.themer/resources/themes/common/css/</source>
+ </li>
+ </ul>
+ </li>
+ <li><strong>media</strong> to the browser the stylesheets to use
+ depending on the detination media :
+ <ul>
+ <li>screen : the stylesheet is used with the browser displaying the
page on the screen,</li>
+ <li>print : the stylesheet is used while printing the document - or
print preview...</li>
+ <li>othervalues can also be managed by browsers.cf. <a
href="http://www.w3.org/TR/REC-CSS2/media.html#media-types"; class="fork">W3C
Media Types</a>.</li>
+ </ul>
+ <div class="note">
+ <div class="label">Firefox has a bug !</div>
+ <div class="content">
+ <p>There is a bug with firefox which does not manage media attribute
while printing, the bug is already declared twice in bugzilla, so we are
waiting...</p>
+ </div>
+ </div>
+ </li>
+ <li><strong>theme</strong> attribute indicates to the browser for which
theme this
+ stylesheet should be used, letting you add several css files
+ corresponding to different themes of the same page.
+ </li>
+ </ul>
</description>
<usage><![CDATA[<forrest:contract name="branding-css-links">
<forrest:property name="branding-css-links-input">
<css url="common.css"/>
+ <css .../>
</forrest:property>
</forrest:contract>]]></usage>
<forrest:template xmlns:forrest="http://apache.org/forrest/templates/1.0";
Modified:
forrest/trunk/main/template-sites/v3/src/documentation/resources/themes/common/html/branding-css-links.ft
URL:
http://svn.apache.org/viewcvs/forrest/trunk/main/template-sites/v3/src/documentation/resources/themes/common/html/branding-css-links.ft?rev=357673&r1=357672&r2=357673&view=diff
==============================================================================
---
forrest/trunk/main/template-sites/v3/src/documentation/resources/themes/common/html/branding-css-links.ft
(original)
+++
forrest/trunk/main/template-sites/v3/src/documentation/resources/themes/common/html/branding-css-links.ft
Mon Dec 19 01:39:50 2005
@@ -22,10 +22,47 @@
<description>
<p>branding-css-links will output html link elements for css usage. </p>
+ <p>The contract includes css files which are passed in parameter with the
following syntax :</p>
+ <source><![CDATA[<css url="layout.]]><em>media</em>.css"
[media="screen|print"] [theme="themeName"]<![CDATA[/>]]></source>
+ <ul>
+ <li><strong>url</strong> attribute indicates the name of the css file,
the dispatcher
+ searches for this file in the following order :
+ <ul>
+ <li>Does the css file exists in the following directory - if yes,
use this one :
+
<source>$PROJECT_HOME/src/documentation/resources/themes/yourtheme/css/</source>
+ </li>
+ <li>Otherwise, does the css file exists in the following directory -
if yes, use this one :
+
<source>$FORREST_HOME/whiteboard/plugins/org.apache.forrest.plugin.output.themer/resources/themes/yourtheme/css/</source>
+ </li>
+ <li>Otherwise, does the css file exists in the following directory -
if yes, use this one :
+
<source>$FORREST_HOME/whiteboard/plugins/org.apache.forrest.plugin.output.themer/resources/themes/common/css/</source>
+ </li>
+ </ul>
+ </li>
+ <li><strong>media</strong> to the browser the stylesheets to use
+ depending on the detination media :
+ <ul>
+ <li>screen : the stylesheet is used with the browser displaying the
page on the screen,</li>
+ <li>print : the stylesheet is used while printing the document - or
print preview...</li>
+ <li>othervalues can also be managed by browsers.cf. <a
href="http://www.w3.org/TR/REC-CSS2/media.html#media-types"; class="fork">W3C
Media Types</a>.</li>
+ </ul>
+ <div class="note">
+ <div class="label">Firefox has a bug !</div>
+ <div class="content">
+ <p>There is a bug with firefox which does not manage media attribute
while printing, the bug is already declared twice in bugzilla, so we are
waiting...</p>
+ </div>
+ </div>
+ </li>
+ <li><strong>theme</strong> attribute indicates to the browser for which
theme this
+ stylesheet should be used, letting you add several css files
+ corresponding to different themes of the same page.
+ </li>
+ </ul>
</description>
<usage><![CDATA[<forrest:contract name="branding-css-links">
<forrest:property name="branding-css-links-input">
<css url="common.css"/>
+ <css .../>
</forrest:property>
</forrest:contract>]]></usage>
<forrest:template xmlns:forrest="http://apache.org/forrest/templates/1.0";
