zorba-coders team mailing list archive

Thread
Date

[Merge] lp:~zorba-coders/zorba/fixes_xqdoc into lp:zorba

To: mp+86104@xxxxxxxxxxxxxxxxxx,Daniel Turcanu <danielturcanu@xxxxxxxxx>
From: Sorin Marian Nasoi <sorin.marian.nasoi@xxxxxxxxx>
Date: Fri, 16 Dec 2011 19:11:26 -0000
Reply-to: mp+86104@xxxxxxxxxxxxxxxxxx
Sender: bounces@xxxxxxxxxxxxx

Sorin Marian Nasoi has proposed merging lp:~zorba-coders/zorba/fixes_xqdoc into lp:zorba.

Requested reviews:
  Sorin Marian Nasoi (sorin.marian.nasoi)
  Daniel Turcanu (danielturcanu)

For more details, see:
https://code.launchpad.net/~zorba-coders/zorba/fixes_xqdoc/+merge/86104

Fixed the function parameters showing.
Small fixes for a better XHTML 1.0 conformance.
Fixed the title of the links in the function summary table.
-- 
https://code.launchpad.net/~zorba-coders/zorba/fixes_xqdoc/+merge/86104
Your team Zorba Coders is subscribed to branch lp:zorba.

=== modified file 'doc/zorba/xqdoc/templates/main.html'
--- doc/zorba/xqdoc/templates/main.html	2011-10-07 08:28:43 +0000
+++ doc/zorba/xqdoc/templates/main.html	2011-12-16 19:10:30 +0000
@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <html>
   <head>
-    <meta content="text/html; charset=UTF-8" http-equiv="content-type" />
+    <meta content="text/html; charset=utf-8" http-equiv="content-type" />
     <meta content="public" http-equiv="CACHE-CONTROL" />
     <meta content="-1" http-equiv="Expires" />
     <link rel="stylesheet" type="text/css" href="styles/main.css" />
-    <link rel="stylesheet" href="styles/jquery.treeview.css" />
+    <link rel="stylesheet" href="styles/jquery.treeview.css" type="text/css" />
     <script type="text/javascript" src="lib/jquery.js"></script>
     <script type="text/javascript" src="lib/jquery.cookie.js"></script>
     <script type="text/javascript" src="lib/jquery.treeview.js"></script>
@@ -16,25 +16,37 @@
     <link type="text/css" rel="stylesheet" href="styles/shCore.css"/>
     <link type="text/css" rel="stylesheet" href="styles/shThemeDefault.css"/>
     <link type="text/css" rel="stylesheet" href="styles/shThemeXQuery.css"/>
-    <script type="text/javascript">
-      SyntaxHighlighter.all()
-    </script>
-    <script type="text/javascript">
-      jQuery(document).ready(function() {
-          $("#documentation").treeview({
-              control: "#treecontrol",
-              animated: "fast",
-              collapsed: true,
-              unique: false,
-              persist: "cookie"
-          });
-        });
-    </script>
-    <script src="http://www.google.com/js/gweb/analytics/autotrack.js";></script>
-    <script>//
-       new gweb.analytics.AutoTrack({profile: 'UA-4281090-1'});
-    //</script>
-  </head>
+<script type="text/javascript">
+//<![CDATA[
+SyntaxHighlighter.all()
+//]]>
+</script>
+    <script type="text/javascript">
+//<![CDATA[
+jQuery(document).ready(function() {
+$("#documentation").treeview({
+control: "#treecontrol",
+animated: "fast",
+collapsed: true,
+unique: false,
+persist: "cookie"
+});
+});
+//]]>
+</script>
+    <script type="text/javascript" src="http://www.google.com/js/gweb/analytics/autotrack.js";></script>
+<script type="text/javascript">
+//<![CDATA[
+new gweb.analytics.AutoTrack({profile: 'UA-4281090-1'});
+//]]>
+</script>
+<style type="text/css">
+/*<![CDATA[*/
+ div.c2 {clear:both;}
+ li.c1 {width:102px !important;}
+/*]]>*/
+</style>
+</head>
   <body>
     <div id="header">
       <div class="innerheader text-left">
@@ -63,8 +75,8 @@
     <div id="main">
       <div id="leftMenu" >
         <div id="treecontrol">
-          <a title="Collapse the entire tree below" href="#"><img src="images/minus.gif" /> Collapse All</a> 
-          <a title="Expand the entire tree below"   href="#"><img src="images/plus.gif" /> Expand All</a>
+          <a title="Collapse the entire tree below" href="#"><img src="images/minus.gif" alt="minus"/> Collapse All</a> 
+          <a title="Expand the entire tree below"   href="#"><img src="images/plus.gif" alt="plus"/> Expand All</a>
         </div>
       </div>
       <div id="rightcontent" />
@@ -89,7 +101,7 @@
                 (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
             })();
         </script>
-        <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript";>comments powered by Disqus.</a></noscript>
+        <noscript><p>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript";>comments powered by Disqus.</a></p></noscript>
         <a href="http://disqus.com"; class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>
       </div>
     </div>

=== modified file 'modules/com/zorba-xquery/www/modules/xqdoc2xhtml/index.xq'
--- modules/com/zorba-xquery/www/modules/xqdoc2xhtml/index.xq	2011-10-26 15:03:03 +0000
+++ modules/com/zorba-xquery/www/modules/xqdoc2xhtml/index.xq	2011-12-16 19:10:30 +0000
@@ -957,22 +957,22 @@
       {if(contains($type, "updating")) then
         <a  href="{$xquSpec}"
             title="updating"
-            target="_blank"><img src="{concat($imagesPath, "Updating.gif")}" /></a>
+            target="_blank"><img src="{concat($imagesPath, "Updating.gif")}" alt="Updating"/></a>
        else ()}
        {if(contains($type, "sequential")) then
         <a  href="{$xqsSpec}"
             title="sequential"
-            target="_blank"><img src="{concat($imagesPath, "Sequential.gif")}" /></a>
+            target="_blank"><img src="{concat($imagesPath, "Sequential.gif")}" alt="Sequential"/></a>
        else ()}
        {if(contains($type, "nondeterministic ")) then
         <a  href="{$ZorbaOptAndAnn}"
             title="%ann:nondeterministic"
-            target="_blank"><img src="{concat($imagesPath, "Nondeterministic.gif")}" /></a>
+            target="_blank"><img src="{concat($imagesPath, "Nondeterministic.gif")}" alt="Nondeterministic"/></a>
        else ()}
        {if(contains($type, "variadic")) then
         <a  title="A function annotated with the http://www.zorba-xquery.com/annotations:variadic annotation is a function of indefinite arity, i.e. one that accepts a variable number of arguments."
             href="{$ZorbaOptAndAnn}"
-            target="_blank"><img src="{concat($imagesPath, "Variadic.gif")}" /></a>
+            target="_blank"><img src="{concat($imagesPath, "Variadic.gif")}" alt="Variadic"/></a>
        else ()}
        {if(contains($type, "streamable")) then
         <a  href="{$ZorbaOptAndAnn}" title="A function annotated with the http://www.zorba-xquery.com/annotations:streamable annotation is
@@ -983,10 +983,10 @@
         However, the disadvantage is that a streamable string can only be consumed exactly once.
         If a streamable string is consumed more than once, an error is raised.
         In order to enable multiple consumers of a streamable string, the string:materialize function can be used
-        to materialize the entire contents in an (regular) xs:string item." target="_blank"><img src="{concat($imagesPath, "Streamable.gif")}" /></a>
+        to materialize the entire contents in an (regular) xs:string item." target="_blank"><img src="{concat($imagesPath, "Streamable.gif")}" alt="Streamable"/></a>
        else ()}
        {if(contains($type, "external")) then
-        <a href="{$xqExternal}" title="external" target="_blank"><img src="{concat($imagesPath, "External.gif")}" /></a>
+        <a href="{$xqExternal}" title="external" target="_blank"><img src="{concat($imagesPath, "External.gif")}" alt="External"/></a>
        else ()}
     </span>
 };
@@ -1374,9 +1374,9 @@
             <td>
               <tt>{
                 if ($isDeprecated) then
-                  <span class="functName"><del><a href="#{$name}-{$param-number}" title="{normalize-space($description)}">{$name}</a></del></span>
+                  <span class="functName"><del><a href="#{$name}-{$param-number}" title="{$shortDescription}">{$name}</a></del></span>
                 else
-                  <span class="functName"><a href="#{$name}-{$param-number}" title="{normalize-space($description)}">{$name}</a></span>
+                  <span class="functName"><a href="#{$name}-{$param-number}" title="{$shortDescription}">{$name}</a></span>
               }{xqdoc2html:split-function-signature($paramsAndReturn)}<br /><span class="padding">{$shortDescription}</span>
               </tt>
             </td>
@@ -1531,7 +1531,7 @@
     if (exists($params)) then
       (<div class="subsubsection">Parameters:</div>,
       <ul>
-      {for $param in $params return <li>{data($param)}</li>}
+      {for $param in $params return <li>{$param/node()}</li>}
       </ul>)
     else ()
 };

Follow ups

[Merge] lp:~zorba-coders/zorba/fixes_xqdoc into lp:zorba
From: Sorin Marian Nasoi, 2011-12-16
Re: [Merge] lp:~zorba-coders/zorba/fixes_xqdoc into lp:zorba
From: Sorin Marian Nasoi, 2011-12-16