Page MenuHomec4science
Files F120418565

Pyblio.Format-pysrc.html
No OneTemporary
Actions

File Metadata

Created
Fri, Jul 4, 06:03

Pyblio.Format-pysrc.html
View Options

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Pyblio.Format</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="Pyblio-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>pyblio-core 1.3.4</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="Pyblio-module.html">Package&nbsp;Pyblio</a> ::
Package&nbsp;Format
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="Pyblio.Format-pysrc.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="Pyblio.Format-module.html">Package Pyblio.Format</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># This file is part of pybliographer</tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># </tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Copyright (C) 1998-2006 Frederic GOBRY</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Email : gobry@pybliographer.org</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># </tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># This program is free software; you can redistribute it and/or</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># modify it under the terms of the GNU General Public License</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># as published by the Free Software Foundation; either version 2 </tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># of the License, or (at your option) any later version.</tt> </tt>
<a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># </tt> </tt>
<a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># This program is distributed in the hope that it will be useful,</tt> </tt>
<a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># but WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt>
<a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</tt> </tt>
<a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># GNU General Public License for more details. </tt> </tt>
<a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># </tt> </tt>
<a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># You should have received a copy of the GNU General Public License</tt> </tt>
<a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># along with this program; if not, write to the Free Software</tt> </tt>
<a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment"># Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.</tt> </tt>
<a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#</tt> </tt>
<a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L21"></a><tt class="py-lineno">21</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L22"></a><tt class="py-lineno">22</tt> <tt class="py-line"><tt class="py-docstring">Citation formatting layer.</tt> </tt>
<a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"><tt class="py-docstring">Rationale: the difficult part in formatting the records is not how the</tt> </tt>
<a name="L25"></a><tt class="py-lineno">25</tt> <tt class="py-line"><tt class="py-docstring">records are actually laid out on a page, the keys,... but rather the</tt> </tt>
<a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"><tt class="py-docstring">actual layout of the authors, the publication information,...</tt> </tt>
<a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"><tt class="py-docstring">especially given that all the records are not complete.</tt> </tt>
<a name="L28"></a><tt class="py-lineno">28</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"><tt class="py-docstring">So, this module is only intended to handle I{this specific aspect},</tt> </tt>
<a name="L30"></a><tt class="py-lineno">30</tt> <tt class="py-line"><tt class="py-docstring">not to compose a whole page.</tt> </tt>
<a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"><tt class="py-docstring">The code here allows the writing of citation styles with a convenient</tt> </tt>
<a name="L33"></a><tt class="py-lineno">33</tt> <tt class="py-line"><tt class="py-docstring">syntax:</tt> </tt>
<a name="L34"></a><tt class="py-lineno">34</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L35"></a><tt class="py-lineno">35</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; authors = lastFirst(all('author'))</tt> </tt>
<a name="L36"></a><tt class="py-lineno">36</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L37"></a><tt class="py-lineno">37</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; location = join(', ')['vol. ' + one ('volume'),</tt> </tt>
<a name="L38"></a><tt class="py-lineno">38</tt> <tt class="py-line"><tt class="py-docstring"> ... 'num. ' + one ('number'), ]</tt> </tt>
<a name="L39"></a><tt class="py-lineno">39</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
<a name="L40"></a><tt class="py-lineno">40</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; citation = join(', ')[ authors , I[one('title') | 'untitled'] ]</tt> </tt>
<a name="L41"></a><tt class="py-lineno">41</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L42"></a><tt class="py-lineno">42</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L43"></a><tt class="py-lineno">43</tt> <tt class="py-line"><tt class="py-docstring">Citing a reference is a multi-stage operation:</tt> </tt>
<a name="L44"></a><tt class="py-lineno">44</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L45"></a><tt class="py-lineno">45</tt> <tt class="py-line"><tt class="py-docstring"> - B{stage 1:} the citation is written by the programmer in a</tt> </tt>
<a name="L46"></a><tt class="py-lineno">46</tt> <tt class="py-line"><tt class="py-docstring"> convenient Domain Specific Language (DSL)</tt> </tt>
<a name="L47"></a><tt class="py-lineno">47</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L48"></a><tt class="py-lineno">48</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; citation = join(', ')['vol. ' + one('volume'),</tt> </tt>
<a name="L49"></a><tt class="py-lineno">49</tt> <tt class="py-line"><tt class="py-docstring"> ... 'num. ' + one('number')]</tt> </tt>
<a name="L50"></a><tt class="py-lineno">50</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L51"></a><tt class="py-lineno">51</tt> <tt class="py-line"><tt class="py-docstring"> - B{stage 2:} the formatter of stage 1 is 'compiled' on a specific</tt> </tt>
<a name="L52"></a><tt class="py-lineno">52</tt> <tt class="py-line"><tt class="py-docstring"> database (which allows for some initial checks (existence of the</tt> </tt>
<a name="L53"></a><tt class="py-lineno">53</tt> <tt class="py-line"><tt class="py-docstring"> requested fields and txo for instance)</tt> </tt>
<a name="L54"></a><tt class="py-lineno">54</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L55"></a><tt class="py-lineno">55</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; formatter = citation(db)</tt> </tt>
<a name="L56"></a><tt class="py-lineno">56</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L57"></a><tt class="py-lineno">57</tt> <tt class="py-line"><tt class="py-docstring"> - B{stage 3:} the compiled formatter can accept records, and return an</tt> </tt>
<a name="L58"></a><tt class="py-lineno">58</tt> <tt class="py-line"><tt class="py-docstring"> abstract representation of the citation, with style indications</tt> </tt>
<a name="L59"></a><tt class="py-lineno">59</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L60"></a><tt class="py-lineno">60</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; cited = formatter(record)</tt> </tt>
<a name="L61"></a><tt class="py-lineno">61</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L62"></a><tt class="py-lineno">62</tt> <tt class="py-line"><tt class="py-docstring"> - B{stage 4:} the abstract representation is turned into a concrete</tt> </tt>
<a name="L63"></a><tt class="py-lineno">63</tt> <tt class="py-line"><tt class="py-docstring"> representations (plain text, HTML,...)</tt> </tt>
<a name="L64"></a><tt class="py-lineno">64</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L65"></a><tt class="py-lineno">65</tt> <tt class="py-line"><tt class="py-docstring"> &gt;&gt;&gt; html = HTML.generate(cited)</tt> </tt>
<a name="L66"></a><tt class="py-lineno">66</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L67"></a><tt class="py-lineno">67</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L68"></a><tt class="py-lineno">68</tt> <tt class="py-line"><tt class="py-docstring">The ideas for the syntax have been heavily borrowed from nevow's stan.</tt> </tt>
<a name="L69"></a><tt class="py-lineno">69</tt> <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L70"></a><tt class="py-lineno">70</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L71"></a><tt class="py-lineno">71</tt> <tt class="py-line"> </tt>
<a name="L72"></a><tt class="py-lineno">72</tt> <tt class="py-line"> </tt>
<a name="L73"></a><tt class="py-lineno">73</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package Pyblio=Pyblio-module.html"><a title="Pyblio" class="py-name" href="#" onclick="return doclink('link-0', 'Pyblio', 'link-0');">Pyblio</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Package Pyblio.Format=Pyblio.Format-module.html"><a title="Pyblio.Format" class="py-name" href="#" onclick="return doclink('link-1', 'Format', 'link-1');">Format</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module Pyblio.Format.DSL=Pyblio.Format.DSL-module.html"><a title="Pyblio.Format.DSL" class="py-name" href="#" onclick="return doclink('link-2', 'DSL', 'link-2');">DSL</a></tt> <tt class="py-keyword">import</tt> <tt id="link-3" class="py-name" targets="Function Pyblio.Format.DSL.join()=Pyblio.Format.DSL-module.html#join,Method Pyblio.Parsers.Syntax.BibTeX.Parser.Block.join()=Pyblio.Parsers.Syntax.BibTeX.Parser.Block-class.html#join,Method Pyblio.Parsers.Syntax.BibTeX.Parser.Join.join()=Pyblio.Parsers.Syntax.BibTeX.Parser.Join-class.html#join"><a title="Pyblio.Format.DSL.join
Pyblio.Parsers.Syntax.BibTeX.Parser.Block.join
Pyblio.Parsers.Syntax.BibTeX.Parser.Join.join" class="py-name" href="#" onclick="return doclink('link-3', 'join', 'link-3');">join</a></tt><tt class="py-op">,</tt> <tt id="link-4" class="py-name" targets="Class Pyblio.Format.DSL.one=Pyblio.Format.DSL.one-class.html"><a title="Pyblio.Format.DSL.one" class="py-name" href="#" onclick="return doclink('link-4', 'one', 'link-4');">one</a></tt><tt class="py-op">,</tt> <tt id="link-5" class="py-name" targets="Class Pyblio.Format.DSL.all=Pyblio.Format.DSL.all-class.html"><a title="Pyblio.Format.DSL.all" class="py-name" href="#" onclick="return doclink('link-5', 'all', 'link-5');">all</a></tt><tt class="py-op">,</tt> <tt id="link-6" class="py-name" targets="Class Pyblio.Format.DSL.switch=Pyblio.Format.DSL.switch-class.html"><a title="Pyblio.Format.DSL.switch" class="py-name" href="#" onclick="return doclink('link-6', 'switch', 'link-6');">switch</a></tt><tt class="py-op">,</tt> <tt id="link-7" class="py-name" targets="Class Pyblio.Format.DSL.i18n=Pyblio.Format.DSL.i18n-class.html"><a title="Pyblio.Format.DSL.i18n" class="py-name" href="#" onclick="return doclink('link-7', 'i18n', 'link-7');">i18n</a></tt><tt class="py-op">,</tt> <tt id="link-8" class="py-name" targets="Variable Pyblio.Format.DSL.record_key=Pyblio.Format.DSL-module.html#record_key"><a title="Pyblio.Format.DSL.record_key" class="py-name" href="#" onclick="return doclink('link-8', 'record_key', 'link-8');">record_key</a></tt> </tt>
<a name="L74"></a><tt class="py-lineno">74</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-9" class="py-name"><a title="Pyblio" class="py-name" href="#" onclick="return doclink('link-9', 'Pyblio', 'link-0');">Pyblio</a></tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="Pyblio.Format" class="py-name" href="#" onclick="return doclink('link-10', 'Format', 'link-1');">Format</a></tt><tt class="py-op">.</tt><tt id="link-11" class="py-name"><a title="Pyblio.Format.DSL" class="py-name" href="#" onclick="return doclink('link-11', 'DSL', 'link-2');">DSL</a></tt> <tt class="py-keyword">import</tt> <tt id="link-12" class="py-name" targets="Variable Pyblio.Format.DSL.A=Pyblio.Format.DSL-module.html#A"><a title="Pyblio.Format.DSL.A" class="py-name" href="#" onclick="return doclink('link-12', 'A', 'link-12');">A</a></tt><tt class="py-op">,</tt> <tt id="link-13" class="py-name" targets="Variable Pyblio.Format.DSL.B=Pyblio.Format.DSL-module.html#B"><a title="Pyblio.Format.DSL.B" class="py-name" href="#" onclick="return doclink('link-13', 'B', 'link-13');">B</a></tt><tt class="py-op">,</tt> <tt id="link-14" class="py-name" targets="Variable Pyblio.Format.DSL.I=Pyblio.Format.DSL-module.html#I"><a title="Pyblio.Format.DSL.I" class="py-name" href="#" onclick="return doclink('link-14', 'I', 'link-14');">I</a></tt><tt class="py-op">,</tt> <tt id="link-15" class="py-name" targets="Variable Pyblio.Format.DSL.BR=Pyblio.Format.DSL-module.html#BR"><a title="Pyblio.Format.DSL.BR" class="py-name" href="#" onclick="return doclink('link-15', 'BR', 'link-15');">BR</a></tt><tt class="py-op">,</tt> <tt id="link-16" class="py-name" targets="Variable Pyblio.Format.DSL.Small=Pyblio.Format.DSL-module.html#Small"><a title="Pyblio.Format.DSL.Small" class="py-name" href="#" onclick="return doclink('link-16', 'Small', 'link-16');">Small</a></tt><tt class="py-op">,</tt> <tt id="link-17" class="py-name" targets="Variable Pyblio.Format.DSL.Span=Pyblio.Format.DSL-module.html#Span"><a title="Pyblio.Format.DSL.Span" class="py-name" href="#" onclick="return doclink('link-17', 'Span', 'link-17');">Span</a></tt> </tt>
<a name="L75"></a><tt class="py-lineno">75</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-18" class="py-name"><a title="Pyblio" class="py-name" href="#" onclick="return doclink('link-18', 'Pyblio', 'link-0');">Pyblio</a></tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="Pyblio.Format" class="py-name" href="#" onclick="return doclink('link-19', 'Format', 'link-1');">Format</a></tt><tt class="py-op">.</tt><tt id="link-20" class="py-name"><a title="Pyblio.Format.DSL" class="py-name" href="#" onclick="return doclink('link-20', 'DSL', 'link-2');">DSL</a></tt> <tt class="py-keyword">import</tt> <tt id="link-21" class="py-name" targets="Class Pyblio.Format.Base.Missing=Pyblio.Format.Base.Missing-class.html"><a title="Pyblio.Format.Base.Missing" class="py-name" href="#" onclick="return doclink('link-21', 'Missing', 'link-21');">Missing</a></tt><tt class="py-op">,</tt> <tt id="link-22" class="py-name" targets="Function Pyblio.Format.DSL.lazy()=Pyblio.Format.DSL-module.html#lazy"><a title="Pyblio.Format.DSL.lazy" class="py-name" href="#" onclick="return doclink('link-22', 'lazy', 'link-22');">lazy</a></tt> </tt>
<a name="L76"></a><tt class="py-lineno">76</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="Pyblio-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>pyblio-core 1.3.4</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Thu Sep 13 21:54:24 2007
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>

Event Timeline

c4science · Help