r5356 - in trunk: gnue-common/utils/helpers www/docs www/utils/webhelpers www/web/shared

[jcater]

Author: jcater
Date: 2004-03-18 20:52:55 -0600 (Thu, 18 Mar 2004)
New Revision: 5356

Modified:
   trunk/gnue-common/utils/helpers/files.py
   trunk/gnue-common/utils/helpers/tools.py
   trunk/www/docs/common.txt
   trunk/www/docs/forms.txt
   trunk/www/utils/webhelpers/tools.py
   trunk/www/web/shared/base.css
Log:
added doc index page

Modified: trunk/gnue-common/utils/helpers/files.py
===================================================================
--- trunk/gnue-common/utils/helpers/files.py    2004-03-19 01:07:57 UTC (rev 
5355)
+++ trunk/gnue-common/utils/helpers/files.py    2004-03-19 02:52:55 UTC (rev 
5356)
@@ -5,8 +5,6 @@
 SVN_BASE=os.path.abspath(os.path.join(os.path.dirname(__file__),'../../..'))
 
 def htmlify(text, source=""):
-  if source[0] == ':':
-    raise
 
   errors = []
   html = _htmlify("\n\n" + text + "\n\n", errors).to_html(1)
@@ -131,4 +129,4 @@
   for name, tool in links.items():
     if tool != exclude:
       html = html.replace('\n',' ').replace('  ',' ').replace(name,'<a 
href="%s/%s/">%s</a>' % (base, tool, name))
-  return html
\ No newline at end of file
+  return html

Modified: trunk/gnue-common/utils/helpers/tools.py
===================================================================
--- trunk/gnue-common/utils/helpers/tools.py    2004-03-19 01:07:57 UTC (rev 
5355)
+++ trunk/gnue-common/utils/helpers/tools.py    2004-03-19 02:52:55 UTC (rev 
5356)
@@ -305,7 +305,6 @@
       files = []
       if dest[-1] == '/':
         dest = dest[:-1]
-      print dest+props['location'] + '.*'
       for file in glob.glob(dest+props['location'] + '.*'):
         files.append(file[len(dest):])
       if not files:
@@ -347,7 +346,7 @@
         elif ext == 'PS':
           ext = 'Postscript'
         if compressed:
-          ext += ' (Compressed)'
+          ext = 'Compressed '+ ext
         results.append((file, ext))
       else:
         # No extension, assume it's HTML

Modified: trunk/www/docs/common.txt
===================================================================
--- trunk/www/docs/common.txt   2004-03-19 01:07:57 UTC (rev 5355)
+++ trunk/www/docs/common.txt   2004-03-19 02:52:55 UTC (rev 5356)
@@ -4,11 +4,11 @@
 Location: /tools/common/docs/Developers-Guide
 AutoExtensions: Yes
 
-This guide will lead developers throught the various features provided
-by gnue-common.  Sample applications will be presented along with detailed
-information on each featurer.  If you wish to learn how to use gnue-common
-in your applications then this guide, in conjuction with the
-API reference, would be the one to use.
+This guide details the various features provided by GNUe Common.
+Sample applications are be presented along with detailed
+information on each feature.  If you wish to learn how to use
+GNUe Common in your applications, then this guide, in conjunction
+with the API reference, is for you.
 
 [API Reference]
 Name: API Reference

Modified: trunk/www/docs/forms.txt
===================================================================
--- trunk/www/docs/forms.txt    2004-03-19 01:07:57 UTC (rev 5355)
+++ trunk/www/docs/forms.txt    2004-03-19 02:52:55 UTC (rev 5356)
@@ -6,7 +6,7 @@
 
 This guide will lead developers through the creation of their own forms via
 GNUe Designer. Sample forms will be presented along with detailed
-information on each feature.  An appendix of commonly used triggers recipies
+information on each feature.  An appendix of commonly used trigger recipes
 is also provided.
 
 [API Reference]
@@ -15,5 +15,4 @@
 Location: /tools/forms/docs/api
 AutoExtensions: No
 
-API documentation automatically updated daily.  GNUe uses epydoc 
(http://epydoc.sourceforge.net/)
-to create this guide.
+API documentation automatically updated daily.  GNUe uses epydoc 
(http://epydoc.sourceforge.net/) to create this guide.

Modified: trunk/www/utils/webhelpers/tools.py
===================================================================
--- trunk/www/utils/webhelpers/tools.py 2004-03-19 01:07:57 UTC (rev 5355)
+++ trunk/www/utils/webhelpers/tools.py 2004-03-19 02:52:55 UTC (rev 5356)
@@ -143,20 +143,29 @@
     html += '<h2>Documentation</h2>\n<ul>'   #TODO
     html += '<li>Frequently Asked Questions: <a 
href="docs/faq.php">HTML</a></li>\n'
 
+    html2 = "<h1>%s Documentation</h1>\n" % package.replace('GNUe-','')
+    html2 += "<p>This pages contains various documentation for %s.</p>" % name
+
     for fileset, descr in (
-                (mod.docs.userfiles, 'User'),
-                (mod.docs.devfiles,'Designer/Developer') ):
+                (mod.docs.userfiles, 'End User'),
+                (mod.docs.devfiles,'End Developer') ):
       if fileset:
         html += '<li>%s Documentation:</p><ul>\n' % descr
+        html2 += '<h2>%s Documentation</h2>\n' % descr
         for props, text in fileset:
           all = []
           for file, type in mod.docs.getTypes(props, DEST):
-            all.append('<a href="../../%s">%s</a>' % (file, type))
+            all.append('<a href="../..%s">%s</a>' % (file, type))
           html += '  <li>%s: %s</li>\n' % (props['name'], string.join(all,' | 
'))
+          html2 += '<div class="docgroup"><div 
class="docheader"><b>%s</b>&nbsp;&nbsp;&nbsp; ( %s )</div>\n' % (props['name'], 
string.join(all,' | '))
+          html2 += 
addToolLinks(htmlify(string.join(text,'\n'),'www/docs/%s.txt' % tool),
+            toolUrlHints,'../..',tool) + "</div>\n"
         html += '</ul></li>\n'
 
-    html += '</ul>'
+    html += '<li><a href="docs/">All Available Documentation</a></li></ul>'
 
+    phpWrapper('tools/%s/docs/index.php' % tool, html2, name + ' 
Documentation')
+
     ##
     ## Release History
     ##

Modified: trunk/www/web/shared/base.css
===================================================================
--- trunk/www/web/shared/base.css       2004-03-19 01:07:57 UTC (rev 5355)
+++ trunk/www/web/shared/base.css       2004-03-19 02:52:55 UTC (rev 5356)
@@ -350,3 +350,16 @@
   border-style: none none solid none;
 }
 
+/* Documentation */
+
+div.docgroup div.docheader {
+  font-size: 12px;
+  text-decoration: none;
+  margin-top: 10px;
+}
+
+div.docgroup p {
+  margin-top: 0px;
+  margin-bottom: 10px;
+  margin-left: 10px;
+}