You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@archiva.apache.org by ol...@apache.org on 2012/01/21 01:05:18 UTC
svn commit: r1234213 - in
/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src:
main/webapp/js/archiva/templates/menu.html site/apt/template-loading.apt
site/resources/images/start-screen.png site/xdoc/index.xml
Author: olamy
Date: Sat Jan 21 00:05:17 2012
New Revision: 1234213
URL: http://svn.apache.org/viewvc?rev=1234213&view=rev
Log:
more documentation
Modified:
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/js/archiva/templates/menu.html
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/start-screen.png
archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml
Modified: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/js/archiva/templates/menu.html
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/js/archiva/templates/menu.html?rev=1234213&r1=1234212&r2=1234213&view=diff
==============================================================================
--- archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/js/archiva/templates/menu.html (original)
+++ archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/main/webapp/js/archiva/templates/menu.html Sat Jan 21 00:05:17 2012
@@ -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>
Modified: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt?rev=1234213&r1=1234212&r2=1234213&view=diff
==============================================================================
--- archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt (original)
+++ archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/apt/template-loading.apt Sat Jan 21 00:05:17 2012
@@ -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
Modified: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/start-screen.png
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/resources/images/start-screen.png?rev=1234213&r1=1234212&r2=1234213&view=diff
==============================================================================
Binary files - no diff available.
Modified: archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml?rev=1234213&r1=1234212&r2=1234213&view=diff
==============================================================================
--- archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml (original)
+++ archiva/trunk/archiva-modules/archiva-web/archiva-webapp-js/src/site/xdoc/index.xml Sat Jan 21 00:05:17 2012
@@ -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>