r10689 - /1.3/info.py -- February 11, 2010 - 14:26

Author: bugman
Date: Thu Feb 11 14:26:13 2010
New Revision: 10689

URL: http://svn.gna.org/viewcvs/relax?rev=10689&view=rev
Log:
Added the cite_html() method to the citation base class to produce a HTML 
formatted citation.


Modified:
    1.3/info.py

Modified: 1.3/info.py
URL: 
http://svn.gna.org/viewcvs/relax/1.3/info.py?rev=10689&r1=10688&r2=10689&view=diff
==============================================================================
--- 1.3/info.py (original)
+++ 1.3/info.py Thu Feb 11 14:26:13 2010
@@ -171,6 +171,58 @@
         return cite
 
 
+    def cite_html(self, author=True, title=True, journal=True, volume=True, 
number=True, pages=True, year=True, doi=True, url=True):
+        """Compile a citation for HTML display.
+
+        @keyword author:    The author flag.
+        @type author:       bool
+        @keyword title:     The title flag.
+        @type title:        bool
+        @keyword journal:   The journal flag.
+        @type journal:      bool
+        @keyword volume:    The volume flag.
+        @type volume:       bool
+        @keyword number:    The number flag.
+        @type number:       bool
+        @keyword pages:     The pages flag.
+        @type pages:        bool
+        @keyword year:      The year flag.
+        @type year:         bool
+        @keyword doi:       The doi flag.
+        @type doi:          bool
+        @return:            The full citation.
+        @rtype:             str
+        """
+
+        # Build the citation.
+        cite = ''
+        if author and hasattr(self, 'author'):
+            cite = cite + self.author
+        if year and hasattr(self, 'year'):
+            cite = cite + ' (' + repr(self.year) + ').'
+        if title and hasattr(self, 'title'):
+            cite = cite + ' ' + self.title
+        if journal and hasattr(self, 'journal'):
+            cite = cite + ' <em>' + self.journal + '<em>,'
+        if volume and hasattr(self, 'volume'):
+            cite = cite + ' <strong>' + self.volume + '</strong>'
+        if number and hasattr(self, 'number'):
+            cite = cite + '(' + self.number + '),'
+        if pages and hasattr(self, 'pages'):
+            cite = cite + ' ' + self.pages
+        if doi and hasattr(self, 'doi'):
+            cite = cite + ' (<a href="http://dx.doi.org/%s>abstract</a>)' % 
self.doi
+        if url and hasattr(self, 'url'):
+            cite = cite + ' ('+self.url + ')'
+
+        # End.
+        if cite[-1] != '.':
+            cite = cite + '.'
+
+        # Return the citation.
+        return cite
+
+
 
 class Clore90(Ref):
     """Bibliography container."""