From b9e5a9d8c6d4b4f2edcf85d08acd808b192950d8 Mon Sep 17 00:00:00 2001 From: Olivier Lamy Date: Fri, 20 Jan 2012 23:17:48 +0000 Subject: [PATCH] move to xdoc to be able to display images/schemas git-svn-id: https://svn.apache.org/repos/asf/archiva/trunk@1234202 13f79535-47bb-0310-9956-ffa450edef68 --- .../archiva-webapp-js/src/site/apt/index.apt | 74 ------------------- .../archiva-webapp-js/src/site/xdoc/index.xml | 54 ++++++++++++++ 2 files changed, 54 insertions(+), 74 deletions(-) delete mode 100644 archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt create mode 100644 archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml 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 deleted file mode 100644 index cc9ca8c64..000000000 --- a/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt +++ /dev/null @@ -1,74 +0,0 @@ - ----- - Archiva Javascript application General design - ----- - 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 - -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/xdoc/index.xml b/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml new file mode 100644 index 000000000..eb8dd181c --- /dev/null +++ b/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml @@ -0,0 +1,54 @@ + + + + Archiva Javascript application General design + Olivier Lamy + + +
+ +

+ 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). +
+ The server will be contacted only for REST request/response (see details). +
+ All UI rendering will be done only on client side. +
+ As we are not designer :-), the application will use the twitter bootstrap css. +

+ + +

+ We use some well known javascript framework librairies : +

+

+ + +

+ The main page will load javascript files, load i18n, load templates and insert menu. +
+ This main page is divided in 3 parts: +

+ +
+ + + +