You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@archiva.apache.org by ol...@apache.org on 2012/01/21 00:17:35 UTC

svn commit: r1234201 - in /archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site: ./ apt/ resources/ resources/images/

Author: olamy
Date: Fri Jan 20 23:17:34 2012
New Revision: 1234201

URL: http://svn.apache.org/viewvc?rev=1234201&view=rev
Log:
start documentation on webapp-js

Added:
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/i18n.apt   (contents, props changed)
      - copied, changed from r1234200, archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-simple-grid-binding.apt
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-binding.apt
      - copied, changed from r1234200, archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/start-screen.png   (with props)
Removed:
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-simple-grid-binding.apt
Modified:
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt
    archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/site.xml

Copied: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/i18n.apt (from r1234200, archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-simple-grid-binding.apt)
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/i18n.apt?p2=archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/i18n.apt&p1=archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-simple-grid-binding.apt&r1=1234200&r2=1234201&rev=1234201&view=diff
==============================================================================
--- archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-simple-grid-binding.apt (original)
+++ archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/i18n.apt Fri Jan 20 23:17:34 2012
@@ -1,5 +1,5 @@
  -----
- Knockout Simple Grid binding
+ i18n
  -----
  Olivier Lamy
  -----
@@ -26,4 +26,4 @@
 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
 
-  How javascript are loaded on application loading
\ No newline at end of file
+i18n management
\ No newline at end of file

Propchange: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/i18n.apt
------------------------------------------------------------------------------
    svn:eol-style = native

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

Modified: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt?rev=1234201&r1=1234200&r2=1234201&view=diff
==============================================================================
--- archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt (original)
+++ archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt Fri Jan 20 23:17:34 2012
@@ -26,4 +26,49 @@
 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
 
-  Archiva Javascript webapplication General design
\ No newline at end of file
+Archiva Javascript Web Application
+
+* General design
+
+  The goal is to have a "one page loading" javascript application.
+
+  For this the only html page will contains a div with id "main-content" this div will be populated
+  by jquery template execution (see {{{./template-loading.html}template loading}}).
+
+  The server will be contacted only for REST request/response (see {{{./rest.html}details}}).
+
+  <<All UI rendering will be done only on client side.>>
+
+  As we are not designer :-), the application will use the {{{http://twitter.github.com/bootstrap/}twitter bootstrap css}}.
+
+* Used Javascript frameworks
+
+  We use some well known javascript framework librairies :
+
+  * {{{http://jquery.com/}jquery}}
+
+  * {{{http://labjs.com}labjs}} for javascript loading
+
+  * {{{http://requirejs.org}requirejs}} for template loading (see {{{./template-loading.html}details}}
+
+  * {{{http://code.google.com/p/jquery-i18n-properties}jquery-i18n-properties}} for i18n loading (see {{{./i18n.html}details}}
+
+  * {{{http://knockoutjs.com/}knockoutjs}} as we use a MVVM pattern (see {{{./knockout-binding.html}knockout binding}})
+
+  * {{{http://twitter.github.com/bootstrap/javascript.html}twitter bootstrap js}} to magnify the ui
+
+  * {{{http://bassistance.de/jquery-plugins/jquery-plugin-validation/}jquery validate}} for form validation
+
+  []
+
+* Start page
+
+  The main page will load javascript and ask for {{{./template-loading.html}template loading}}.
+
+  This main page is divided in 3 parts:
+
+
+
+
+
+

Copied: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-binding.apt (from r1234200, archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt)
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-binding.apt?p2=archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-binding.apt&p1=archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt&r1=1234200&r2=1234201&rev=1234201&view=diff
==============================================================================
--- archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt (original)
+++ archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-binding.apt Fri Jan 20 23:17:34 2012
@@ -1,5 +1,5 @@
  -----
- REST call
+ Knockout binding
  -----
  Olivier Lamy
  -----
@@ -26,4 +26,4 @@
 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
 
-  Expose Rest Services (sample with redback annotations)
\ No newline at end of file
+Knockout binding
\ No newline at end of file

Modified: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt?rev=1234201&r1=1234200&r2=1234201&view=diff
==============================================================================
--- archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt (original)
+++ archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt Fri Jan 20 23:17:34 2012
@@ -26,4 +26,4 @@
 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
 
-  Expose Rest Services (sample with redback annotations)
\ No newline at end of file
+Expose Rest Services (sample with redback annotations)
\ No newline at end of file

Modified: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt?rev=1234201&r1=1234200&r2=1234201&view=diff
==============================================================================
--- archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt (original)
+++ archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt Fri Jan 20 23:17:34 2012
@@ -26,4 +26,4 @@
 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
 
-  How javascript are loaded on application loading
\ No newline at end of file
+How javascript templates are loaded on application loading
\ No newline at end of file

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

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

Modified: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/site.xml
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/site.xml?rev=1234201&r1=1234200&r2=1234201&view=diff
==============================================================================
--- archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/site.xml (original)
+++ archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/site.xml Fri Jan 20 23:17:34 2012
@@ -43,7 +43,8 @@
       <item name="General Design"        href="/index.html" />
       <item name="Rest service"          href="/rest.html"/>
       <item name="JS Template loading"   href="/template-loading.html"/>
-      <item name="Knockout Grid Binding" href="/knockout-simple-grid-binding"/>
+      <item name="Knockout Binding"      href="/knockout-binding.html"/>
+      <item name="i18n"                  href="/i18n.html"/>
     </menu>
 
   </body>