start documentation on webapp-js

git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@1234201 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/i18n.apt b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/i18n.apt
new file mode 100644 (file)
index 0000000..fc5f27c
--- /dev/null
+++ b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/i18n.apt
@@ -0,0 +1,29 @@
+ -----
+ i18n
+ -----
+ Olivier Lamy
+ -----
+ 2012-01-19
+ -----
+
+~~ Licensed to the Apache Software Foundation (ASF) under one                      
+~~ or more contributor license agreements.  See the NOTICE file                    
+~~ distributed with this work for additional information                           
+~~ regarding copyright ownership.  The ASF licenses this file                      
+~~ to you under the Apache License, Version 2.0 (the                               
+~~ "License"); you may not use this file except in compliance                      
+~~ with the License.  You may obtain a copy of the License at                      
+~~                                                                                 
+~~   http://www.apache.org/licenses/LICENSE-2.0                                    
+~~                                                                                 
+~~ Unless required by applicable law or agreed to in writing,                      
+~~ software distributed under the License is distributed on an                     
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY                          
+~~ KIND, either express or implied.  See the License for the                       
+~~ specific language governing permissions and limitations                         
+~~ under the License.                                                              
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+i18n management
\ No newline at end of file

diff --git a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt
index d14b2facf79dc8c2399ba3f85cb9cb6f821df8c0..cc9ca8c64036722c51736d6a5056bc353b95cf5c 100644 (file)
--- a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt
+++ b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt
@@ -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:
+
+
+
+
+
+

diff --git a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-binding.apt b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-binding.apt
new file mode 100644 (file)
index 0000000..110d726
--- /dev/null
+++ b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-binding.apt
@@ -0,0 +1,29 @@
+ -----
+ Knockout binding
+ -----
+ Olivier Lamy
+ -----
+ 2012-01-19
+ -----
+
+~~ Licensed to the Apache Software Foundation (ASF) under one                      
+~~ or more contributor license agreements.  See the NOTICE file                    
+~~ distributed with this work for additional information                           
+~~ regarding copyright ownership.  The ASF licenses this file                      
+~~ to you under the Apache License, Version 2.0 (the                               
+~~ "License"); you may not use this file except in compliance                      
+~~ with the License.  You may obtain a copy of the License at                      
+~~                                                                                 
+~~   http://www.apache.org/licenses/LICENSE-2.0                                    
+~~                                                                                 
+~~ Unless required by applicable law or agreed to in writing,                      
+~~ software distributed under the License is distributed on an                     
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY                          
+~~ KIND, either express or implied.  See the License for the                       
+~~ specific language governing permissions and limitations                         
+~~ under the License.                                                              
+
+~~ NOTE: For help with the syntax of this file, see:
+~~ http://maven.apache.org/guides/mini/guide-apt-format.html
+
+Knockout binding
\ No newline at end of file

diff --git a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-simple-grid-binding.apt b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-simple-grid-binding.apt
deleted file mode 100644 (file)
index a0a6e8f..0000000
--- a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/knockout-simple-grid-binding.apt
+++ /dev/null
@@ -1,29 +0,0 @@
- -----
- Knockout Simple Grid binding
- -----
- Olivier Lamy
- -----
- 2012-01-19
- -----
-
-~~ Licensed to the Apache Software Foundation (ASF) under one                      
-~~ or more contributor license agreements.  See the NOTICE file                    
-~~ distributed with this work for additional information                           
-~~ regarding copyright ownership.  The ASF licenses this file                      
-~~ to you under the Apache License, Version 2.0 (the                               
-~~ "License"); you may not use this file except in compliance                      
-~~ with the License.  You may obtain a copy of the License at                      
-~~                                                                                 
-~~   http://www.apache.org/licenses/LICENSE-2.0                                    
-~~                                                                                 
-~~ Unless required by applicable law or agreed to in writing,                      
-~~ software distributed under the License is distributed on an                     
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY                          
-~~ KIND, either express or implied.  See the License for the                       
-~~ specific language governing permissions and limitations                         
-~~ under the License.                                                              
-
-~~ 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

diff --git a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt
index 3ea906dd0664f7102daa7baa5cb6764a934e3e1d..05d9040bc84aa51148fe231946394f26fccf424a 100644 (file)
--- a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt
+++ b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/rest.apt
@@ -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

diff --git a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt
index 068e3239b2b670928601cbcf3c3eb83adb136c8a..1f7e114a39fda6536d4d7ee992c73347a5c31bdf 100644 (file)
--- a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt
+++ b/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt
@@ -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

diff --git a/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/start-screen.png b/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/start-screen.png
new file mode 100644 (file)
index 0000000..9147368
Binary files /dev/null and b/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/start-screen.png differ

diff --git a/archiva-modules/archiva-web/archiva-webapp-js/src/site/site.xml b/archiva-modules/archiva-web/archiva-webapp-js/src/site/site.xml
index cfce805d83be94e4277dac5e0e058d89387f8396..4bcc3e3e869fbb0f76d1646a524aa99d6035cbd5 100644 (file)
--- a/archiva-modules/archiva-web/archiva-webapp-js/src/site/site.xml
+++ b/archiva-modules/archiva-web/archiva-webapp-js/src/site/site.xml
@@ -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>