python-feedgen/ext/api.ext.base.html
2013-09-23 16:10:44 +02:00

135 lines
No EOL
5.7 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>feedgen.ext.base &mdash; python-feedgen 0.2.6 documentation</title>
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.2.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/theme_extras.js"></script>
<link rel="top" title="python-feedgen 0.2.6 documentation" href="../index.html" />
<link rel="up" title="API Documentation" href="../api.html" />
<link rel="next" title="feedgen.ext.podcast" href="api.ext.podcast.html" />
<link rel="prev" title="feedgen.util" href="../api.util.html" />
</head>
<body>
<div class="header"><h1 class="heading"><a href="../index.html">
<span>python-feedgen 0.2.6 documentation</span></a></h1>
<h2 class="heading"><span>feedgen.ext.base</span></h2>
</div>
<div class="topnav">
<p>
«&#160;&#160;<a href="../api.util.html">feedgen.util</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="api.ext.podcast.html">feedgen.ext.podcast</a>&#160;&#160;»
</p>
</div>
<div class="content">
<div class="apititle"><b>Contents</b></div>
<div class="apitoc"></div><span class="target" id="module-feedgen.ext.base"></span><div class="section" id="feedgen-ext-base">
<h1>feedgen.ext.base<a class="headerlink" href="#feedgen-ext-base" title="Permalink to this headline"></a></h1>
<p>Basic FeedGenerator extension which does nothing but provides all necessary
methods.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">2013, Lars Kiesow &lt;<a class="reference external" href="mailto:lkiesow&#37;&#52;&#48;uos&#46;de">lkiesow<span>&#64;</span>uos<span>&#46;</span>de</a>&gt;</td>
</tr>
<tr class="field-even field"><th class="field-name">license:</th><td class="field-body">FreeBSD and LGPL, see license.* for more details.</td>
</tr>
</tbody>
</table>
<dl class="class">
<dt id="feedgen.ext.base.BaseEntryExtension">
<em class="property">class </em><tt class="descclassname">feedgen.ext.base.</tt><tt class="descname">BaseEntryExtension</tt><a class="headerlink" href="#feedgen.ext.base.BaseEntryExtension" title="Permalink to this definition"></a></dt>
<dd><p>Basic FeedEntry extension.</p>
</dd></dl>
<dl class="class">
<dt id="feedgen.ext.base.BaseExtension">
<em class="property">class </em><tt class="descclassname">feedgen.ext.base.</tt><tt class="descname">BaseExtension</tt><a class="headerlink" href="#feedgen.ext.base.BaseExtension" title="Permalink to this definition"></a></dt>
<dd><p>Basic FeedGenerator extension.</p>
<dl class="method">
<dt id="feedgen.ext.base.BaseExtension.extend_atom">
<tt class="descname">extend_atom</tt><big>(</big><em>feed</em><big>)</big><a class="headerlink" href="#feedgen.ext.base.BaseExtension.extend_atom" title="Permalink to this definition"></a></dt>
<dd><p>Create an ATOM feed xml structure containing all previously set
fields.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>feed</strong> &#8211; The feed xml root element.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The feed root element.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="feedgen.ext.base.BaseExtension.extend_rss">
<tt class="descname">extend_rss</tt><big>(</big><em>feed</em><big>)</big><a class="headerlink" href="#feedgen.ext.base.BaseExtension.extend_rss" title="Permalink to this definition"></a></dt>
<dd><p>Create an RSS feed xml structure containing all previously set fields.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>feed</strong> &#8211; The feed xml root element.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The feed root element.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
</div>
<div class="bottomnav">
<p>
«&#160;&#160;<a href="../api.util.html">feedgen.util</a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="../index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="api.ext.podcast.html">feedgen.ext.podcast</a>&#160;&#160;»
</p>
</div>
<div class="footer">
&copy; Copyright 2013, Lars Kiesow.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>