Author: olamy
Date: Mon Jan 23 21:25:52 2012
New Revision: 1234993

URL: http://svn.apache.org/viewvc?rev=1234993&view=rev
Log:
start adding documentation on common javascript functions

Added:
    
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/error-message.png
   (with props)
    
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/modal-confirm-dialog.png
   (with props)
    
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/success-message.png
   (with props)
    
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/generics-js.xml
   (with props)
Removed:
    
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/generics-js.apt

Added: 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/error-message.png
URL: 
http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/error-message.png?rev=1234993&view=auto
==============================================================================
Binary file - no diff available.

Propchange: 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/error-message.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/modal-confirm-dialog.png
URL: 
http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/modal-confirm-dialog.png?rev=1234993&view=auto
==============================================================================
Binary file - no diff available.

Propchange: 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/modal-confirm-dialog.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/success-message.png
URL: 
http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/success-message.png?rev=1234993&view=auto
==============================================================================
Binary file - no diff available.

Propchange: 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/success-message.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/generics-js.xml
URL: 
http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/generics-js.xml?rev=1234993&view=auto
==============================================================================
--- 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/generics-js.xml
 (added)
+++ 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/generics-js.xml
 Mon Jan 23 21:25:52 2012
@@ -0,0 +1,71 @@
+<?xml version="1.0"?>
+<document>
+  <properties>
+    <title>Generics Javascript</title>
+    <author>Olivier Lamy</author>
+  </properties>
+  <body>
+
+    <script src="js/jquery-1.7.js" type="text/javascript"></script>
+    <script type="text/javascript" src="js/fancy-box-activation.js"></script>
+    <script src="js/jquery.fancybox-1.3.4.pack.js" 
type="text/javascript"></script>
+    <link rel="stylesheet" href="css/jquery.fancybox-1.3.4.css" 
type="text/css" media="screen" />
+
+    <macro name="toc"/>
+
+    <section name="Generics Javascript">
+      <p>Some common/generic javascript methods are available.</p>
+      <subsection name="User messages">
+      <p>A div "user-messages" is reserved for user messages.</p>
+        <subsection name="Success message">
+          <p>
+            Javascript function:
+            <source>
+displaySuccessMessage($.i18n.prop('managedrepository.added'));
+// the second parameter is optionnal by default user-messages id is used
+displaySuccessMessage=function(text,idToAppend){
+            </source>
+            <a href="images/success-message.png" class="single_image" 
title="Success Message">
+              <img src="images/success-message.png" width="150" height="93" 
style="border: 1px solid silver; margin-left: 0.25em; margin-bottom: 0.25em" 
alt="" /><br/>
+              Success Message
+            </a>
+          </p>
+        </subsection>
+
+        <subsection name="Error message">
+          <p>
+            Javascript function:
+            <source>
+displayErrorMessage($.i18n.prop('managedrepository.added'));
+// the second parameter is optionnal by default user-messages id is used
+displayErrorMessage=function(text,idToAppend){
+            </source>
+            <a href="images/error-message.png" class="single_image" 
title="Error Message">
+              <img src="images/error-message.png" width="150" height="93" 
style="border: 1px solid silver; margin-left: 0.25em; margin-bottom: 0.25em" 
alt="" /><br/>
+              Error Message
+            </a>
+          </p>
+        </subsection>
+      </subsection>
+      <subsection name="Modal Confirm dialog">
+        <p>
+          Javascript function:
+          <source>
+okFn: function to call in case of ok
+okMessage: message for Ok button
+cancelMessage: message for cancel button
+title: modal title
+bodyText: modal content (can be html)
+openDialogConfirm=function(okFn, okMessage, cancelMessage, title,bodyText)
+          </source>
+          <a href="images/modal-confirm-dialog.png" class="single_image" 
title="Modal Confirm dialog">
+            <img src="images/modal-confirm-dialog.png" width="150" height="93" 
style="border: 1px solid silver; margin-left: 0.25em; margin-bottom: 0.25em" 
alt="" /><br/>
+            Modal Confirm dialog
+          </a>
+        </p>
+      </subsection>
+    </section>
+  </body>
+</document>
+
+

Propchange: 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/generics-js.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: 
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/generics-js.xml
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision


Reply via email to