[Openutils-svn] SF.net SVN: openutils: [397] trunk/openutils-mgnlstripes/src

[<fg...@us...>]

Revision: 397
          http://openutils.svn.sourceforge.net/openutils/?rev=397&view=rev
Author:   fgiust
Date:     2007-08-13 03:04:10 -0700 (Mon, 13 Aug 2007)

Log Message:
-----------
basic documentation

Added Paths:
-----------
    trunk/openutils-mgnlstripes/src/site/
    trunk/openutils-mgnlstripes/src/site/apt/
    trunk/openutils-mgnlstripes/src/site/apt/index.apt

Added: trunk/openutils-mgnlstripes/src/site/apt/index.apt
===================================================================
--- trunk/openutils-mgnlstripes/src/site/apt/index.apt	                        (rev 0)
+++ trunk/openutils-mgnlstripes/src/site/apt/index.apt	2007-08-13 10:04:10 UTC (rev 397)
@@ -0,0 +1,149 @@
+                                 --------------------------
+                                   openutils-mgnlstripes
+                                 --------------------------
+                                     Fabrizio Giustina
+                                 --------------------------
+
+About
+
+ openutils-mgnlstripes is a custom {{{http://www.magnolia.info}magnolia}} module which integrates the
+ {{{http://mc4j.org/confluence/display/stripes/Home}Stripes}} MVC framework.
+
+ After installed into magnolia, this module will allow you to use any available Stripes action as a Magnolia paragraph,
+ Any magically-converted Stripes action will still be able to use any standard Stripes feature, plus it will enjoy the
+ automatic injection of any paragraph property.
+
+ <<This module requires magnolia 3.1-m3, and will not work on any earlier version!>>
+
+Configuration
+
+ First of all drop the openutils-mgnlstripes jar and the stripes jar into WEB-INF/lib, or (better) if you are using maven
+ just declare the following dependency:
+
++----------------------------------------------+
+    <dependency>
+        <groupId>net.sourceforge.openutils</groupId>
+        <artifactId>openutils-mgnlstripes</artifactId>
+        <version>0.1</version>
+    </dependency>
++----------------------------------------------+
+
+ Then configure stripes in your web.xml as usual (see {{{http://mc4j.org/confluence/display/stripes/Quick+Start+Guide}}} for this.
+
+ You only need to change the configuration for the stripes <<<ActionResolver.Class>>> in order to use
+ <<<it.openutils.magnoliastripes.MgnlActionResolver>>>. You can do that by adding/modifying the following init parameter
+ in WEB.xml:
+
+
++----------------------------------------------+
+    <init-param>
+      <param-name>ActionResolver.Class</param-name>
+      <param-value>it.openutils.magnoliastripes.MgnlActionResolver</param-value>
+    </init-param>
++----------------------------------------------+
+
+Usage
+
+ When magnolia and stripes will startup now any auto-discovered stripes action will be configured in order to be used as
+ a magnolia paragraph. This means that paragraphs will be auto-generated, and they don't need to be configured into jcr.
+
+ You should see a few <<<info>>> logs that enumerates the list of stripes paragraphs configured. By convention the name of
+ the paragraph is the same name of the Stripes action class minus action and lowercase.
+
+ So <<<it.myapp.web.MyStripesAction >>> will be available as a paragraph named <<<mystripes>>>.
+
+ Before being able to use any paragraph you will need to create a dialog for that. By convention the dialog should have
+ the same name of the paragraph so, following the previous example, you will need to configure a dialog called <<<mystripes>>>.
+
+ Try to put a property called <<<title>>> in such dialog for a test.
+
+ You are ready to use your paragraph into any magnolia template as usual:
+
++----------------------------------------------+
+
+  <cms:contentNodeIterator contentNodeCollectionName="column">
+    <cms:editBar adminOnly="true" />
+    <cms:includeTemplate />
+  </cms:contentNodeIterator>
+  <cms:newBar contentNodeCollectionName="column" paragraph="mystripes" adminOnly="true" />
+
++----------------------------------------------+
+
+ Try to add an instance of the <<<mystripes>>> paragraph. Set the title property to whatever you want, you
+ will be able to use it in your Stripes action bean.
+
+ The following example show the code for the simple <<<MyStripesAction>>> that prints out the configured title to the log:
+
++----------------------------------------------+
+package it.myapp.web;
+
+import net.sourceforge.stripes.action.ActionBean;
+import net.sourceforge.stripes.action.ActionBeanContext;
+import net.sourceforge.stripes.action.DefaultHandler;
+import net.sourceforge.stripes.action.ForwardResolution;
+import net.sourceforge.stripes.action.Resolution;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+public class MyStripesAction implements ActionBean
+{
+
+    private Logger log = LoggerFactory.getLogger(MyStripesAction.class);
+
+    private String title;
+
+    @Override
+    public ActionBeanContext getContext()
+    {
+        // TODO
+        return null;
+    }
+
+    @Override
+    public void setContext(ActionBeanContext context)
+    {
+        // TODO
+    }
+
+    public void setTitle(String title)
+    {
+        this.title = title;
+    }
+
+    @DefaultHandler
+    public Resolution show()
+    {
+
+        log.info("My title is: {}!", title);
+
+        return new ForwardResolution("/templates/paragraphs/anyjsp.jsp");
+    }
+}
++----------------------------------------------+
+
+ As you can see, you will be able to mix parameters that you can use in Stripes action with pure content. Note that you
+ will not need to configure and use any magnolia paragraph property into your action since you can still use also the
+ standard magnolia tags in the jsp that is rendered by stripes!
+
+
+Todo/improvements
+
+ Warning! This is a preliminary technology-preview release!
+
+ What does this means? Well, that it should work fine, but the integration is not yet complete and there are still some
+ missing features... be careful for what is know to not to work.
+
+
+ This is a list of know todos:
+
+ * Important! reload stripes paragraph when the configuration of other paragraphs in magnolia is changed! At this moment
+   stripes paragraphs disappear after any change in paragraphs configured into jcr.
+
+ * Handle multipart forms in request wrapper (should be easy to do)
+
+ * A better way of handling multivalued properties in paragraph
+
+ * Handle binary properties in paragraph
+


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.