From bleny@users.nuiton.org Thu Dec  1 14:54:58 2011
From: bleny@users.nuiton.org
To: nuiton-web-commits@list.nuiton.org
Subject: [Nuiton-web-commits] r149 - in trunk/nuiton-struts2/src: .
	main/java/org/nuiton/web/struts2/taglib site site/apt
Date: Thu, 01 Dec 2011 14:54:58 +0100
Message-ID: <20111201135458.4A7BE15A4D@nuiton.codelutin.com>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="===============7813612150297549185=="

--===============7813612150297549185==
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

Author: bleny
Date: 2011-12-01 14:54:58 +0100 (Thu, 01 Dec 2011)
New Revision: 149

Url: http://nuiton.org/repositories/revision/nuiton-web/149

Log:
documentation for helptag

Added:
   trunk/nuiton-struts2/src/site/
   trunk/nuiton-struts2/src/site/apt/
   trunk/nuiton-struts2/src/site/apt/index.apt
   trunk/nuiton-struts2/src/site/apt/taglib.apt
   trunk/nuiton-struts2/src/site/site_fr.xml
Modified:
   trunk/nuiton-struts2/src/main/java/org/nuiton/web/struts2/taglib/HelpTag.j=
ava

Modified: trunk/nuiton-struts2/src/main/java/org/nuiton/web/struts2/taglib/He=
lpTag.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/nuiton-struts2/src/main/java/org/nuiton/web/struts2/taglib/HelpTag.=
java	2011-11-28 22:21:46 UTC (rev 148)
+++ trunk/nuiton-struts2/src/main/java/org/nuiton/web/struts2/taglib/HelpTag.=
java	2011-12-01 13:54:58 UTC (rev 149)
@@ -8,6 +8,9 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
=20
+/**
+ * @since 1.7
+ */
 public class HelpTag extends AbstractClosingTag {
=20
     /** Logger. */

Added: trunk/nuiton-struts2/src/site/apt/taglib.apt
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/nuiton-struts2/src/site/apt/taglib.apt	                        (rev=
 0)
+++ trunk/nuiton-struts2/src/site/apt/taglib.apt	2011-12-01 13:54:58 UTC (rev=
 149)
@@ -0,0 +1,94 @@
+
+The ns:help tag
+
+* Abstract
+
+  The ns:help tag allow you to enhance your forms by adding on them
+  extra-informations (such a tooltip)
+ =20
+  It may be helpful if you want your application to include to inline
+  help, gathering data from an aside user documentation.
+
+* Usage=20
+
+  Let's say you have a simple form:
+
+------------------------------------------------
+<s:form ...>
+
+    <s:textfield name=3D"userName" />
+
+    <s:textfield name=3D"password" />
+
+</s:form>
+------------------------------------------------
+
+  Now, you want to make your form given the user helpful information about h=
ow
+  she can fill the field.
+
+------------------------------------------------
+<s:form ...>
+
+    <ns:help helpKey=3D"userName">
+        <s:textfield name=3D"userName" />
+    </ns:help>
+
+    <ns:help helpKey=3D"password">
+        <s:textfield name=3D"password" />
+    </ns:help>
+
+</s:form>
+------------------------------------------------
+
+  But first of all, you muste define two things :
+
+    * A place where the help will appear, it must have the id "helpZone"
+
+    * A handler function called "getHelpAsHtml" returning the html that shou=
ld be
+      printed to the user. It can either call a Json action that will use a =

+      text provider and a bundle where the help message for each helpKey is =
stored
+
+
+------------------------------------------------
+<div id=3D"helpZone">
+    Here will appear your help message
+</div>
+------------------------------------------------
+
+------------------------------------------------
+<script type=3D"text/javascript">
+    function getHelpAsHtml(helpKey) {
+        return "Ici, l'aide pour la cl=C3=A9 '" + helpKey + "'";
+    }
+</script>
+------------------------------------------------
+
+  You can surround more than one field with ns:help, all the fields will dis=
play
+  the help message. Instead of=20
+
+------------------------------------------------
+<s:form ...>
+
+    <ns:help helpKey=3D"loginHelp">
+        <s:textfield name=3D"userName" />
+    </ns:help>
+
+    <ns:help helpKey=3D"loginHelp">
+        <s:textfield name=3D"password" />
+    </ns:help>
+
+</s:form>
+------------------------------------------------
+
+  You can just
+
+------------------------------------------------
+<s:form ...>
+
+    <ns:help helpKey=3D"loginHelp">
+        <s:textfield name=3D"userName" />
+        <s:textfield name=3D"password" />
+    </ns:help>
+
+</s:form>
+------------------------------------------------

Added: trunk/nuiton-struts2/src/site/site_fr.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/nuiton-struts2/src/site/site_fr.xml	                        (rev 0)
+++ trunk/nuiton-struts2/src/site/site_fr.xml	2011-12-01 13:54:58 UTC (rev 14=
9)
@@ -0,0 +1,62 @@
+<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<!--
+  #%L
+  Nuiton Utils :: Nuiton RSS
+ =20
+  $Id: site_fr.xml 80 2011-06-28 12:25:30Z tchemit $
+  $HeadURL: http://svn.nuiton.org/svn/nuiton-web/trunk/nuiton-rss/src/site/s=
ite_fr.xml $
+  %%
+  Copyright (C) 2008 - 2010 CodeLutin, Tony Chemit, Benjamin Poussin
+  %%
+  This program is free software: you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as=20
+  published by the Free Software Foundation, either version 3 of the=20
+  License, or (at your option) any later version.
+ =20
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Lesser Public License for more details.
+ =20
+  You should have received a copy of the GNU General Lesser Public=20
+  License along with this program.  If not, see
+  <http://www.gnu.org/licenses/lgpl-3.0.html>.
+  #L%
+  -->
+
+
+<project name=3D"${project.name}">
+
+  <bannerLeft>
+    <name>${project.name}</name>
+    <href>index.html</href>
+  </bannerLeft>
+
+  <body>
+
+    <breadcrumbs>
+      <item name=3D"${project.name}" href=3D"index.html"/>
+    </breadcrumbs>
+
+    <menu ref=3D"parent"/>
+
+    <menu name=3D"Utilisateur">
+      <item name=3D"Nuiton taglib" href=3D"taglib.html"/>
+    </menu>
+
+    <menu name=3D"Downloads">
+      <item
+              href=3D"${repository.home.url}/org/nuiton/${project.artifactId=
}/${project.version}/${project.build.finalName}.jar"
+              name=3D"Librairie (jar)"/>
+      <item
+              href=3D"${repository.home.url}/org/nuiton/${project.artifactId=
}/${project.version}/${project.build.finalName}-javadoc.jar"
+              name=3D"Javadoc (jar)"/>
+      <item
+              href=3D"${repository.home.url}/org/nuiton/${project.artifactId=
}/${project.version}/${project.build.finalName}-sources.jar"
+              name=3D"Sources (jar)"/>
+    </menu>
+
+    <menu ref=3D"reports"/>
+
+  </body>
+</project>


--===============7813612150297549185==--