svn commit: r966454 - /lenya/contributions/2_0_X/modules/javascript/xslt/head.xsl

Author: andreas
Date: Wed Jul 21 22:59:41 2010
New Revision: 966454

URL: http://svn.apache.org/viewvc?rev=966454&view=rev
Log:
Adding docu.

Modified:
    lenya/contributions/2_0_X/modules/javascript/xslt/head.xsl

Modified: lenya/contributions/2_0_X/modules/javascript/xslt/head.xsl
URL: http://svn.apache.org/viewvc/lenya/contributions/2_0_X/modules/javascript/xslt/head.xsl?rev=966454&r1=966453&r2=966454&view=diff
==============================================================================
--- lenya/contributions/2_0_X/modules/javascript/xslt/head.xsl (original)
+++ lenya/contributions/2_0_X/modules/javascript/xslt/head.xsl Wed Jul 21 22:59:41 2010
@@ -9,12 +9,20 @@
     <xsl:copy>
       <script type="text/javascript">
         Lenya = function() {
-        var baseUri = '<xsl:value-of select="$baseUri"/>';
-        return {
-        link: function(href) {
-        return baseUri + href;
-        }
-        }
+          var baseUri = '<xsl:value-of select="$baseUri"/>';
+          return {
+          
+            /*
+            Returns an absolute link for a link inside the current area.
+            Examples:
+              Authoring area:  Lenya.link("/index") -> "http://cms.example.com/mypub/authoring/index"
+              Live area:       Lenya.link("/index") -> "http://www.example.com/index"
+            */
+            link: function(areaUrl) {
+              return baseUri + href;
+            }
+            
+          }
         }();
       </script>
     </xsl:copy>