[prettyfaces] r459 committed - updated documentation slightly to attempt clarification for newbies
prett...@googlecode.com
Author: lincolnbaxter
Date: Sun Oct 24 08:53:43 2010
Log: updated documentation slightly to attempt clarification for newbies
http://code.google.com/p/prettyfaces/source/detail?r=459
Modified:
/prettyfaces/trunk/docs/src/main/docbook/en-US/config/Page_actions.xml
/prettyfaces/trunk/docs/src/main/docbook/en-US/config/Path_parameters.xml
/prettyfaces/trunk/docs/src/main/docbook/en-US/config/Query_parameters.xml
/prettyfaces/trunk/docs/src/main/docbook/en-US/config/URL_mapping.xml
=======================================
--- /prettyfaces/trunk/docs/src/main/docbook/en-US/config/Page_actions.xml
Mon Jun 7 15:59:05 2010
+++ /prettyfaces/trunk/docs/src/main/docbook/en-US/config/Page_actions.xml
Sun Oct 24 08:53:43 2010
@@ -3,7 +3,7 @@
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<section id="config.actions">
- <title>* Page-load actions</title>
+ <title>* Load data when accessing mapped URLs (Page-action
methods)</title>
<caution>
<para>This feature is currently only available for URL mappings that
target a JSF view-ID.</para>
@@ -11,8 +11,11 @@
<para>
Most of the time, when creating bookmarkable URLs, it is not enough to
simply display a page
- to the user; we also need to load data to be shown on that page. This
would typically be
- difficult in JSF, but PrettyFaces comes to the rescue once again.
+ to the user; we also need to load data to be shown on that page -
allowing for pages to appear
+ completely stateless to the end-user. This would typically be difficult
in JSF, but PrettyFaces
+ has another option to satisfy this requirement that breaks the coupling
typically associated
+ with other solutions such as using @SessionScoped data beans to save
data across pages, or
+ passing values across views using: <f:setPropertyActionListener/>.
</para>
<para>
=======================================
---
/prettyfaces/trunk/docs/src/main/docbook/en-US/config/Path_parameters.xml
Tue Oct 5 08:39:22 2010
+++
/prettyfaces/trunk/docs/src/main/docbook/en-US/config/Path_parameters.xml
Sun Oct 24 08:53:43 2010
@@ -4,11 +4,12 @@
<section id="config.pathparams">
- <title>Path parameters (REST)</title>
+ <title>Add Path-parameters to your mapped URL (REST)</title>
<para>
Suppose we want to create a URL mapping that allows users to access
items in a specific category
- of a web-store, such as: <literal>/store/category/</literal>. In other
words, we need to parse
- the URL and gain access to the values we care about.
+ of a web-store, such as: <literal>/store/category/</literal>. In other
words, we want to take a piece
+ of the URL string itself - for example:
<literal>/store/[category]/</literal> and use that value:
+ <literal>[category]</literal> in our application's logic.
</para>
<para>
@@ -53,7 +54,7 @@
</para>
<section id="config.pathparams.named">
- <title>Named</title>
+ <title>Named path parameters</title>
<para>
In order to gain access to a value matched by our path-parameter
<literal>#{...}</literal>,
we can use the named path-parameter syntax: <literal>#{ cat }</literal>,
@@ -86,7 +87,7 @@
</section>
<section id="config.pathparams.el">
- <title>* EL-injected</title>
+ <title>* EL-injected path parameters</title>
<para>
Another method of accessing path-parameter values is via EL value
injection, where PrettyFaces
can inject the value of the URL parameter directly into a managed-bean.
This requires a
@@ -127,7 +128,7 @@
</section>
<section id="config.pathparams.regex">
- <title>Custom regex patterns (discriminators / filters)</title>
+ <title>Restrict what Path Parameters will accept (Custom regex
patterns)</title>
<para>
In PrettyFaces, each url-pattern compiles into a regular expression
that is used to match incoming
URLs. By default, any path-parameter expressions
=======================================
---
/prettyfaces/trunk/docs/src/main/docbook/en-US/config/Query_parameters.xml
Wed Sep 15 22:39:57 2010
+++
/prettyfaces/trunk/docs/src/main/docbook/en-US/config/Query_parameters.xml
Sun Oct 24 08:53:43 2010
@@ -3,7 +3,7 @@
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<section id="config.queryparams">
- <title>Query parameters</title>
+ <title>Manage Query-parameters in mapped URLs</title>
<para>
Most people are already familiar with URL query-parameters. They come in
<literal>key=value</literal>
pairs, and begin where the '?' character is found in a URL. For example:
=======================================
--- /prettyfaces/trunk/docs/src/main/docbook/en-US/config/URL_mapping.xml
Sun Jun 6 22:58:08 2010
+++ /prettyfaces/trunk/docs/src/main/docbook/en-US/config/URL_mapping.xml
Sun Oct 24 08:53:43 2010
@@ -4,9 +4,9 @@
<section id="config.mapping">
- <title>Mapping a simple URL</title>
+ <title>Create your first bookmarkable URL (mapping a URL)</title>
<para>
- The URL mapping element is the core configuration element for
+ The URL mapping element is the core configuration element for PrettyFaces
most applications. Let's consider, for instance, that we are building a
web-store and we want
our users to access the store at the URL <code>/store/</code> - we only
need the most basic
features of the URL-mapping to achieve this.
@@ -16,16 +16,15 @@
<view-id>/faces/shop/store.jsf</view-id>
</url-mapping>]]></programlisting>
- As you can see, we've specified a URL-mapping with
<code>pattern="/store/"</code> (the
- URL the user will see in the browser) and the view-id:
<code>/faces/shop/store.jsf</code>
- (the actual location of the page on the server.)
+ With these two simple lines of configuration, the user sees:
<code>pattern="/store/"</code>
+ in the browser URL and in the output HTML, but the server is actually
rendering the resource:
+ <code>/faces/shop/store.jsf</code> (the actual location of the page on
the server.)
</para>
<para>
- With these two simple lines of configuration, the user sees:
<code>/store/</code>, but
- the server displays the page at: <code>/faces/shop/store.jsf</code>.
Ignore the
- <code>id="store"</code> attribute for now, we'll cover that under <link
linkend="navigation">
- navigation</link>.
+ Ignore the <code>id="store"</code> attribute for now, we'll cover that
under
+ <link linkend="navigation"> navigation</link>. Which is useful when
redirecting a user between
+ different pages in your application.
</para>
</section>