Changeset 632

Timestamp:

02/26/10 13:14:41 (2 years ago)

Author:

mgalloy

Message:

Added author, copyright, history, and version tags for overview file in rst and IDLdoc formats.

Location:

trunk/idldoc

Files:

• docs/RELEASE (modified) (1 diff)
• Makefile (modified) (3 diffs)
• overview (modified) (4 diffs)
• src/doc_system__define.pro (modified) (10 diffs)
• src/parser/docparidldocformatparser__define.pro (modified) (2 diffs)
• src/parser/docparrstformatparser__define.pro (modified) (2 diffs)
• src/parser/docparrstmarkupparser__define.pro (modified) (1 diff)
• src/templates/overview.tt (modified) (1 diff)

trunk/idldoc/docs/RELEASE

@@ -26 +26 @@
 * Added a link in each routine's details to its source code.
 
-* Added a preformatted markup style which is nearly equivalant to verbatim, 
+* Added a preformatted markup style which is nearly equivalent to verbatim, 
   but also makes HTML output respect line-breaks.
   
+* Added author, copyright, history, and version tags to the overview file
+
 
 IDLdoc 3.2

trunk/idldoc/Makefile

@@ -14 +14 @@
         
 doc:
-        $(IDL) idldoc_build_docs
+        $(IDL) < idldoc_build_docs.pro
 
 book:
@@ -44 +44 @@
         mkdir idldoc-$(VERSION)
         
-        $(IDL) -IDL_STARTUP "" idldoc_build
+        $(IDL) -IDL_STARTUP "" < idldoc_build.pro
         mv idldoc.sav idldoc-$(VERSION)/
         
@@ -70 +70 @@
         rm -rf updates.idldev.com/features/com.idldev.idl.idldoc.feature_$(VERSION)/
 
-        $(IDL) -IDL_STARTUP "" idldoc_build
+        $(IDL) -IDL_STARTUP "" < idldoc_build
 
         mkdir updates.idldev.com/plugins/com.idldev.idl.idldoc_$(VERSION)/

trunk/idldoc/overview

@@ -5 +5 @@
    svn co http://svn.idldev.com/idldoc/trunk/idldoc
     
-Developer: Michael Galloy (http://michaelgalloy.com)
 
 IDLdoc project site at::
 
-       http://idldev.com
+       idldev.com
 
 
+:Author:
+   Michael Galloy, michaelgalloy.com
+
+   
 :Dirs:
    ./ 
@@ -18 +21 @@
   
    analysis
-      routines used to proper scaling for the visualization of data in a `.sav1` file
+      routines used to proper scaling for the visualization of data in a 
+      `.sav` file
       
    cmdline_tools
-      
+      used for the color text output
       
    collection 
@@ -27 +31 @@
       
    dist_tools 
-      Routines for handling distributing applications (imported from mg library).
+      Routines for handling distributing applications (imported from mg 
+      library).
       
    dist_tools/collection
@@ -45 +50 @@
       
    textmarkup
-      Classes to convert a markup tree to a particular markup language (imported 
-      from mg library).
+      Classes to convert a markup tree to a particular markup language 
+      (imported from mg library).
       
    tree

trunk/idldoc/src/doc_system__define.pro

@@ -79 +79 @@
     'system': return, self
     
-    'idldoc_version': return, self.version
+    'idldoc_version': return, self.idldoc_version
     'charset': return, self.charset
     'date': return, systime()
@@ -99 +99 @@
     'output_root': return, self.output
     'relative_root': return, ''
+
+    'has_author_info': return, self.hasAuthorInfo
+    
+    'has_author': return, obj_valid(self.author)
+    'author': return, self->processComments(self.author)
+    'plain_author': return, self->processPlainComments(self.author)
+
+    'has_copyright': return, obj_valid(self.copyright)
+    'copyright': return, self->processComments(self.copyright)
+    
+    'has_history': return, obj_valid(self.history)
+    'history': return, self->processComments(self.history)
+
+    'has_version': return, obj_valid(self.version)
+    'version': return, self->processComments(self.version)
         
     'n_dirs': return, self.directories->count()
@@ -292 +307 @@
 ; Set properties of the system.
 ;-
-pro doc_system::setProperty, overview_comments=overviewComments
+pro doc_system::setProperty, overview_comments=overviewComments, $
+                             author=author, copyright=copyright, $
+                             history=history, version=version
   compile_opt strictarr, hidden
 
@@ -298 +315 @@
     self.overviewComments = overviewComments
   endif
+  
+  ; "author info" attributes
+  if (n_elements(author) gt 0) then begin
+    self.hasAuthorInfo = 1B
+    self.author = author
+  endif
+
+  if (n_elements(copyright) gt 0) then begin
+    self.hasAuthorInfo = 1B
+    self.copyright = copyright
+  endif
+  
+  if (n_elements(history) gt 0) then begin
+    self.hasAuthorInfo = 1B
+    self.history = history
+  endif
+
+  if (n_elements(version) gt 0) then begin
+    self.hasAuthorInfo = 1B
+    self.version = version
+  endif  
 end
 
@@ -377 +415 @@
   compile_opt strictarr, hidden
   
-  msg = ['IDLdoc ' + self.version, $
+  msg = ['IDLdoc ' + self.idldoc_version, $
          '', $
          'Usage:', $
@@ -1158 +1196 @@
   if (nCategories gt 0) then obj_destroy, categoryLists
   obj_destroy, self.categories
-  
+
+  obj_destroy, [self.author, self.copyright, self.history, self.version]
+    
   obj_destroy, self.overviewComments
   
@@ -1273 +1313 @@
   compile_opt strictarr, hidden
   
-  self.version = idldoc_version()
+  self.idldoc_version = idldoc_version()
   
   self.isTty = keyword_set(colorOutputlog) ? 1B : self->_findIfTty()
   
   if (keyword_set(version)) then begin
-    self->print, 'IDLdoc ' + self.version
+    self->print, 'IDLdoc ' + self.idldoc_version
     return, 0
   endif
@@ -1467 +1507 @@
 ;
 ; :Fields:
-;    version
+;    idldoc_version
 ;       IDLdoc version
 ;    root 
@@ -1528 +1568 @@
   
   define = { DOC_System, $
-             version: '', $
+             idldoc_version: '', $
              
              root: '', $
@@ -1539 +1579 @@
              
              sourceLocation: '', $
-             
+
+             hasAuthorInfo: 0B, $
+             author: obj_new(), $
+             copyright: obj_new(), $
+             history: obj_new(), $
+             version: obj_new(), $
+                          
              directories: obj_new(), $ 
               

trunk/idldoc/src/parser/docparidldocformatparser__define.pro

@@ -633 +633 @@
     
     case strlowcase(tag) of
+      'author': system->setProperty, author=markupParser->parse(tagLines)
+      'copyright': system->setProperty, copyright=markupParser->parse(tagLines)
+      'history': system->setProperty, history=markupParser->parse(tagLines)
+      'version': system->setProperty, version=markupParser->parse(tagLines)
+
       'dir': begin
-          re = '^[[:space:]]*([[:alpha:]._$\-\/]+)[[:space:]]+'
+          re = '^[[:space:]]*([[:alnum:]._$\-\/]+)[[:space:]]*'
           argStart = stregex(tagLines[0], re, /subexpr, length=argLength)
           if (argStart[0] eq -1L) then begin
@@ -648 +653 @@
           
           tagLines[0] = strmid(tagLines[0], argStart[1] + argLength[1])
+          self->_removeSpace, tagLines
                     
           for d = 0L, directories->count() - 1L do begin

trunk/idldoc/src/parser/docparrstformatparser__define.pro

@@ -319 +319 @@
         routine->getProperty, file=file
         file->setProperty, is_hidden=1B
-      end
+      end               
     'history': routine->setProperty, history=markupParser->parse(self->_parseTag(lines), file=file)
     'inherits':  begin
@@ -731 +731 @@
     
     case strlowcase(tag) of
+      'author': system->setProperty, author=markupParser->parse(tagLines)
+      'copyright': system->setProperty, copyright=markupParser->parse(tagLines)
+      'history': system->setProperty, history=markupParser->parse(tagLines)
+      'version': system->setProperty, version=markupParser->parse(tagLines)
+      
       'dirs': begin
           system->getProperty, directories=directories

trunk/idldoc/src/parser/docparrstmarkupparser__define.pro

@@ -53 +53 @@
                                               tree=tree, file=file
   compile_opt strictarr, hidden
+  
+  catch, error
+  if (error ne 0L) then begin
+    catch, /cancel
+    self.system->warning, 'unable to handle rst directive ' + directive
+    return
+  endif
   
   fullDirective = strmid(line, pos + 3L, len)

trunk/idldoc/src/templates/overview.tt

@@ -54 +54 @@
       [% END %]
       
+      [% IF has_author_info %]
+      <h2>Author information</h2>
+
+        <dl class="attribute small" summary="Library author information">
+          [% IF has_author %]
+            <dt>Author:</dt>
+            <dd>[% author %]</dd>       
+          [% END %]
+          
+          [% IF has_copyright %]
+            <dt>Copyright:</dt>
+            <dd>[% copyright %]</dd>       
+          [% END %]
+          
+          [% IF has_history %]
+            <dt>History:</dt>
+            <dd>[% history %]</dd>    
+          [% END %]
+
+          [% IF has_version %]
+            <dt>Version:</dt>
+            <dd>[% version %]</dd>     
+          [% END %]              
+        </dl>          
+      [% END %]
+                
+      
       <h2 id="statistics">Project statistics</h2>