From: Olivier Lamy Date: Fri, 20 Jan 2012 23:17:34 +0000 (+0000) Subject: start documentation on webapp-js X-Git-Tag: archiva-1.4-M3~1529 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c2ed1c5e8f88521678f801dad98cc1a0d8a3a13b;p=archiva.git 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 index 000000000..fc5f27c74 --- /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 d14b2facf..cc9ca8c64 100644 --- 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}}). + + <> + + 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 index 000000000..110d726b7 --- /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 index a0a6e8f14..000000000 --- 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 3ea906dd0..05d9040bc 100644 --- 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 068e3239b..1f7e114a3 100644 --- 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 index 000000000..91473686e 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 cfce805d8..4bcc3e3e8 100644 --- 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 @@ - + +