Author: atsebro
Date: 2009-07-10 11:49:29 -0400 (Fri, 10 Jul 2009)
New Revision: 14894
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/loadStyle.desc.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/loadStyle.xml
Log:
RF-7484:a4j:loadStyle component description review
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/loadStyle.desc.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/loadStyle.desc.xml 2009-07-10
15:48:33 UTC (rev 14893)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/loadStyle.desc.xml 2009-07-10
15:49:29 UTC (rev 14894)
@@ -1,15 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter>
- <section>
- <sectioninfo>
- <keywordset>
- <keyword>loadStyle</keyword>
- </keywordset>
- </sectioninfo>
-
- <title>Description</title>
- <para>
- The component Inserts stylesheet links to the head element. Render the value of the
component, after passing it to the <code>getResourceURL()</code> method of the
ViewHandler for this application, and passing the result through the
<code>encodeResourceURL()</code> method of the ExternalContext.
- </para>
- </section>
+ <section>
+ <sectioninfo>
+ <keywordset>
+ <keyword>loadStyle</keyword>
+ </keywordset>
+ </sectioninfo>
+ <title>Description</title>
+ <para>
+ The <emphasis
role="bold"><property><a4j:loadStyle></property></emphasis>
component allows to load a style sheet file from alternative sources like a jar file, etc.
+ It inserts stylesheet links to the head element.
+ </para>
+ </section>
</chapter>
\ No newline at end of file
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/loadStyle.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/loadStyle.xml 2009-07-10
15:48:33 UTC (rev 14893)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/loadStyle.xml 2009-07-10
15:49:29 UTC (rev 14894)
@@ -36,7 +36,7 @@
</table>
<section>
- <title>Creating on a page</title>
+ <title>Creating the Component with a Page Tag</title>
<para>To create the simplest variant on a page use the following
syntax:</para>
<para>
@@ -57,29 +57,31 @@
...
]]></programlisting>
</section>
- <section>
- <title>Key attributes and ways of usage</title>
- <para>
- As it was mentioned <link linkend="loadStyle">above</link>
this component returns its value as the value of
- the
<emphasis><property>"src"</property></emphasis>
attribute passing it to the
- <code>getResourceURL()</code> method of the ViewHandler for this
application, and passing
- the result via the <code>encodeResourceURL()</code> method of the
ExternalContext.
- </para>
- <para>
- It means that the Context is inserted automatically to the link. And calls
- like <code>resource://</code> is properly handled.
- </para>
- <para>
- Except this - you may be free to put your stylesheet links right from the child
- page while using <property>facelets templates</property>.
- </para>
-</section>
- <section>
- <title>Relevant resources links</title>
- <para>
- Some additional information about usage of component can be found
- <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/style.jsf?c...
the component Live Demo page</ulink>.
- </para>
- </section>
+ <section>
+ <title>Details of usage</title>
+ <para>
+ The main attribute of the <emphasis
role="bold"><property><a4j:loadStylet></property></emphasis>
is
<emphasis><property>"src"</property></emphasis>,
wich defines the context relative path to the script.
+ The value of the attribute does not require a prefix of an application.
+ Leading slash in the path means the root of the web context.
+ It is also possible to use <code>resource:///</code> prefix
to access the script file using RichFaces resource framework.
+ </para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[<a4j:loadStyle
src="resource:///org/mycompany/assets/script/focus.js"
/>]]></programlisting>
+ <para>
+ The
<emphasis><property>"src"</property></emphasis>
attribute passses value to the <code>getResourceURL()</code> method of the
ViewHandler of the application,
+ The result is passed through the
<code>encodeResourceURL()</code> method of the ExternalContext.
+ </para>
+
+ </section>
+
+ <section>
+ <title>Relevant resources links</title>
+ <para>
+ Vizit the <ulink
url="http://livedemo.exadel.com/richfaces-demo/richfaces/style.jsf?c...
page at RichFaces LiveDemo</ulink> for examples of component usage abd their
sources.
+ </para>
+ </section>
+
</chapter>
\ No newline at end of file