From: Olivier Lamy <olamy@apache.org>
Date: Sat, 21 Jan 2012 00:05:17 +0000 (+0000)
Subject:  more documentation
X-Git-Tag: archiva-1.4-M3~1525
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c029fed96c230ef18c7a9b6d10dab6b57590cc87;p=archiva.git

 more documentation

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

diff --git a/archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/js/archiva/templates/menu.html b/archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/js/archiva/templates/menu.html
index a7637c9f2..50d1750b0 100644
--- a/archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/js/archiva/templates/menu.html
+++ b/archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/js/archiva/templates/menu.html
@@ -16,7 +16,7 @@
   ~ specific language governing permissions and limitations
   ~ under the License.
 -->
-  <div class='well' id="main-menu" redback-permissions="{permissions: ['archiva-manage-users']}" style="display: none">
+  <div class='well' id="main-menu" redback-permissions="{permissions: ['archiva-manage-users','archiva-manage-configuration']}" style="display: none">
     <ul class="navigation">
       <li style="display: none" redback-permissions="{permissions: ['archiva-manage-users']}">
         <a href="#" id="menu-users-list-a" onclick="displayUsersGrid()">${$.i18n.prop('users.list')}</a>
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 1f7e114a3..462a1a698 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,28 @@
 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/guides/mini/guide-apt-format.html
 
-How javascript templates are loaded on application loading
\ No newline at end of file
+Html/Javascript templates loading
+
+  Templates are loaded on application loaded and added in the hidden div #html-fragments.
+
+  They are loaded using requirejs and the text plugin.
+
+  archiva tamplates are loaded as it:
+
++-------------------------
+require(["text!archiva/templates/menu.html","text!archiva/templates/topbar.html","text!archiva/templates/message.html",
+          "text!archiva/templates/modal.html","text!archiva/templates/grids-generics.html","text!archiva/templates/repositories.html"],
+  function(menu,topbar,message,modal,grids_generics,repositories) {
+
+    // template loading
+    $.tmpl( menu, $.i18n.map ).appendTo("#html-fragments");
+    $.tmpl( topbar, $.i18n.map ).appendTo("#html-fragments");
+    $.tmpl( modal, $.i18n.map ).appendTo("#html-fragments");
+    $("#html-fragments").append(message);
+    $("#html-fragments").append(grids_generics);
+    $("#html-fragments").append(repositories);
+  }
+);
++-------------------------
+
+  Note some templates which are only simple html which only need i18n are executed immediatly the others are only inserted in #html-fragments.
\ 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
index 6dd681f7a..f177e364b 100644
Binary files a/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/start-screen.png 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/xdoc/index.xml b/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml
index d4ea2914e..9a32b39f1 100644
--- 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
@@ -51,12 +51,55 @@
           <br/>
           This main page is divided in 3 parts:
           <p>
-          <a href="images/start-screen.png" class="single_image" title="Start Page">
-            <img src="images/start-screen.png" width="150" height="93" style="border: 1px solid silver; margin-left: 0.25em; margin-bottom: 0.25em" alt="" /><br/>
-            Start Page
-          </a>
+            <a href="images/start-screen.png" class="single_image" title="Start Page">
+              <img src="images/start-screen.png" width="150" height="93" style="border: 1px solid silver; margin-left: 0.25em; margin-bottom: 0.25em" alt="" /><br/>
+              Start Page
+            </a>
           </p>
+          <p>
+            <ul>
+              <li>#topbar-menu-container is populated with the template js/archiva/templates/topbar.html.</li>
+              <li>#sidebar-content is populated with the template js/archiva/templates/menu.html.</li>
+              <li>#main-content is the place where screen will appear.</li>
+              <li>hidden #html-fragments will contains loaded templates.</li>
+            </ul>
+          </p>
+          <p>
+            Link are visible/hide depending on needed redback karmas.
+            You can configure redback operations needed for a link using the attribute redback-permissions in your html element
+            (by default element needed karma must be marked display: none):
+            <source>
+<![CDATA[
+Support array: at least one operation is needed:
+<div .... redback-permissions="{permissions: ['archiva-manage-users','archiva-manage-configuration']}" style="display: none">
+Support single value:
+<li style="display: none" redback-permissions="{permissions: ['archiva-manage-users']}">
+]]>
+            </source>
+
+          </p>
+        </p>
+      </subsection>
+      <subsection name="Sources organisation">
+        <p>
+          Sources are located in src/main/webapp :
+          <ul>
+            <li>css</li>
+            <li>images</li>
+            <li>js</li>
+          </ul>
         </p>
+        <subsection name="js directory">
+          <p>
+            Root directory contains external libraries.
+          </p>
+          <p>
+            archiva directory contains archiva js files with a subdirectory templates which contains templates
+          </p>
+          <p>
+            redback directory contains redback js files with a subdirectory templates which contains templates
+          </p>
+        </subsection>
       </subsection>
     </section>
   </body>