Apache
/
archiva
mirror of https://github.com/apache/archiva.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Olivier Lamy 2012-01-20 23:17:48 +00:00
parent c2ed1c5e8f
commit b9e5a9d8c6
2 changed files with 54 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/index.apt
View File

@ -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}}).
<<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:

54
archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml Normal file
View File

@ -0,0 +1,54 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Archiva Javascript application General design</title>
<author>Olivier Lamy</author>
</properties>
<body>
<section name="Archiva Javascript Web Application">
<subsection name="General design">
<p>
The goal is to have a "one page loading" javascript application.
<br/>
For this the only html page will contains a div with id "main-content" this div will be populated
by jquery template execution (see <a href="./template-loading.html">template loading</a>).
<br/>
The server will be contacted only for REST request/response (see <a href="./rest.html">details</a>).
<br/>
<b>All UI rendering will be done only on client side.</b>
<br/>
As we are not designer :-), the application will use the <a href="http://twitter.github.com/bootstrap" target="_blank">twitter bootstrap css</a>.
</p>
</subsection>
<subsection name="Used Javascript frameworks">
<p>
We use some well known javascript framework librairies :
<ul>
<li><a target="_blank" href="http://jquery.com/">jquery</a>.</li>
<li><a target="_blank" href="http://labjs.com">labjs</a> for javascript loading.</li>
<li><a target="_blank" href="http://requirejs.org">requirejs</a> for template loading (see <a href="./template-loading.html">details</a>.</li>
<li><a target="_blank" href="http://code.google.com/p/jquery-i18n-properties">jquery-i18n-properties</a> for i18n loading (see <a href="./i18n.html">details</a>.</li>
<li><a target="_blank" href="http://knockoutjs.com">knockoutjs</a> as we use a MVVM pattern (see <a href="./knockout-binding.html">knockout binding</a>).</li>
<li><a target="_blank" href="http://twitter.github.com/bootstrap/javascript.html">twitter bootstrap js</a> to magnify the ui.</li>
<li><a target="_blank" href="http://bassistance.de/jquery-plugins/jquery-plugin-validation">jquery validate</a> for form validation.</li>
</ul>
</p>
</subsection>
<subsection name="Start page">
<p>
The main page will load javascript files, load <a href="./i18n.html">i18n</a>, <a href="./template-loading.html">load templates</a> and insert menu.
<br/>
This main page is divided in 3 parts:
</p>
</subsection>
</section>
</body>
</document>