Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F120417201
Pyblio.Format.DSL-module.html
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Fri, Jul 4, 05:49
Size
12 KB
Mime Type
text/xml
Expires
Sun, Jul 6, 05:49 (2 d)
Engine
blob
Format
Raw Data
Handle
27177327
Attached To
R3596 pybliographer
Pyblio.Format.DSL-module.html
View Options
<?xml version="1.0" encoding="iso-8859-1"?>
<!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.DSL</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="Pyblio-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer 1.3.3
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="Pyblio-module.html">Package Pyblio</a> ::
<a href="Pyblio.Format-module.html">Package Format</a> ::
Module DSL
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[show private | <a href="../public/Pyblio.Format.DSL-module.html">hide private</a>]</font></td></tr>
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="Pyblio.Format.DSL-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module Pyblio.Format.DSL</h2>
<p>Basic syntactic elements used to format a citation.</p>
This module defines the base syntax elements providing the formatting
domain specific language.
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="Pyblio.Format.DSL.all-class.html"><code>all</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="Pyblio.Format.DSL.Glue-class.html"><code>Glue</code></a></b></td>
<td>A base class that known how to join together multiple fragments of DSL
code.</td></tr>
<tr><td width="15%">
<b><a href="Pyblio.Format.DSL.i18n-class.html"><code>i18n</code></a></b></td>
<td>Translatable content.</td></tr>
<tr><td width="15%">
<b><a href="Pyblio.Format.DSL.one-class.html"><code>one</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="Pyblio.Format.DSL.switch-class.html"><code>switch</code></a></b></td>
<td>The switch operator helps in bringing together multiple citation
parts, according to the value of a Txo.</td></tr>
<tr><td width="15%">
<b><a href="../private/Pyblio.Format.DSL._Join-class.html"><code>_Join</code></a></b></td>
<td>The join operator is used to join together multiple fragments of
records:</td></tr>
<tr><td width="15%">
<b><a href="../private/Pyblio.Format.DSL._Or-class.html"><code>_Or</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="../private/Pyblio.Format.DSL._Proto-class.html"><code>_Proto</code></a></b></td>
<td>Proto is a string subclass.</td></tr>
<tr><td width="15%">
<b><a href="../private/Pyblio.Format.DSL._record_key-class.html"><code>_record_key</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="../private/Pyblio.Format.DSL._S1T-class.html"><code>_S1T</code></a></b></td>
<td>This is a stage 1 text, ie a text that returns a stage 2 text when
called.</td></tr>
<tr><td width="15%">
<b><a href="../private/Pyblio.Format.DSL._Sum-class.html"><code>_Sum</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="../private/Pyblio.Format.DSL._SynTag-class.html"><code>_SynTag</code></a></b></td>
<td>This is a layout tag before its [] marker.</td></tr>
<tr><td width="15%">
<b><a href="../private/Pyblio.Format.DSL._Tag-class.html"><code>_Tag</code></a></b></td>
<td>This is a layout tag after its [] marker, but before the
compilation.</td></tr>
<tr><td width="15%">
<b><a href="../private/Pyblio.Format.DSL._Validated-class.html"><code>_Validated</code></a></b></td>
<td>Base class for attribute accessors, providing some checks for stage
2.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="join"></a><span class="summary-sig"><span class="summary-sig-name">join</span>(<span class=summary-sig-arg>middle</span>,
<span class=summary-sig-arg>last</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="Pyblio.Format.DSL-module.html#lazy" class="summary-sig-name"><code>lazy</code></a>(<span class=summary-sig-arg>fn</span>)</span></code>
<br />
Transform a simple function into a lazy function lifted in the
formatting system.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="../private/Pyblio.Format.DSL-module.html#_deferredText" class="summary-sig-name"><code>_deferredText</code></a>(<span class=summary-sig-arg>text</span>)</span></code>
<br />
Ensure the parameter is a stage 1 object.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>_Tag</code></font></td>
<td><b><a href="Pyblio.Format.DSL-module.html#BR"><code>BR</code></a></b> = <span title="DSL.Tag('br', children=[_S1T('')])"><code>DSL.Tag('br', children=[_S1T('')]) </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="Pyblio.Format.DSL-module.html#glob"><code>glob</code></a></b> = <span title="{'all': <class 'Pyblio.Format.DSL.all'>, 'Span': 'Span', 'S2': <module 'Pyblio.Format.S2' from '/home/fred/devel/pyblio/1.3/Pyblio/Format/S2.pyc'>, '_Validated': <class 'Pyblio.Format.DSL._Validated'>, 'one': <class 'Pyblio.Format.DSL.one'>, 'Small': 'Small', 'BR': DSL.Tag('br', children=[_S1T('')]), '_Proto': <class 'Pyblio.Format.DSL._Proto'>, 'Missing': <class Pyblio.Format.Base.Missing at 0xa7b3d59c>, '_Join': <class 'Pyblio.Format.DSL._Join'>, 'I': 'I', '_Sum': <class 'Pyblio.Format.DSL._Sum'>, '__doc__': '\nBasic syntactic elements used to format a citation.\n\nThis module defines the..."><code>{'all': <class 'Pyblio.Format.DSL.all'>, 'Span': <span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>_record_key</code></font></td>
<td><b><a href="Pyblio.Format.DSL-module.html#record_key"><code>record_key</code></a></b> = <span title="<Pyblio.Format.DSL._record_key object at 0xa786f44c>"><code><Pyblio.Format.DSL._record_key object at 0x<span class="variable-ellipsis">...</span></code>
</span></td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="lazy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">lazy</span>(<span class=sig-arg>fn</span>)</span>
</h3>
<p>Transform a simple function into a lazy function lifted in the
formatting system.</p>
This is only sugar : the initial function must be aware that every
argument must be made strict by calling them before use.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_deferredText"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_deferredText</span>(<span class=sig-arg>text</span>)</span>
</h3>
Ensure the parameter is a stage 1 object.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="BR"></a>
<h3>BR</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>_Tag</code>
</dd>
<span title="DSL.Tag('br', children=[_S1T('')])"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
DSL.Tag('br', children=[_S1T('')]) </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="glob"></a>
<h3>glob</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'all': <class 'Pyblio.Format.DSL.all'>, 'Span': 'Span', 'S2': <module 'Pyblio.Format.S2' from '/home/fred/devel/pyblio/1.3/Pyblio/Format/S2.pyc'>, '_Validated': <class 'Pyblio.Format.DSL._Validated'>, 'one': <class 'Pyblio.Format.DSL.one'>, 'Small': 'Small', 'BR': DSL.Tag('br', children=[_S1T('')]), '_Proto': <class 'Pyblio.Format.DSL._Proto'>, 'Missing': <class Pyblio.Format.Base.Missing at 0xa7b3d59c>, '_Join': <class 'Pyblio.Format.DSL._Join'>, 'I': 'I', '_Sum': <class 'Pyblio.Format.DSL._Sum'>, '__doc__': '\nBasic syntactic elements used to format a citation.\n\nThis module defines the..."> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'A': 'A',
'B': 'B',
'BR': DSL.Tag('br', children=[_S1T('')]),
'Glue': <class 'Pyblio.Format.DSL.Glue'>,
'I': 'I',
'Missing': <class Pyblio.Format.Base.Missing at 0xa7b3d59c>,
'S2': <module 'Pyblio.Format.S2' from '/home/fred/devel/pyblio/1.3/Py<span class="variable-linewrap">\</span>
blio/Format/S2.pyc'>,
<span class="variable-ellipsis">...</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="record_key"></a>
<h3>record_key</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>_record_key</code>
</dd>
<span title="<Pyblio.Format.DSL._record_key object at 0xa786f44c>"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<Pyblio.Format.DSL._record_key object at 0xa786f44c> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="Pyblio-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
pybliographer 1.3.3
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Sun Sep 24 23:52:43 2006</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
Event Timeline
Log In to Comment