Documentation for v0.2.2
This commit is contained in:
parent
91714a63ba
commit
1f41347cbe
11 changed files with 792 additions and 35 deletions
|
@ -8,7 +8,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.entry — pyFeedGen 0.1.s20130505 documentation</title>
|
||||
<title>feedgen.entry — pyFeedGen 0.2.2 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
@ -17,7 +17,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.1.s20130505',
|
||||
VERSION: '0.2.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
@ -27,14 +27,14 @@
|
|||
<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="pyFeedGen 0.1.s20130505 documentation" href="index.html" />
|
||||
<link rel="top" title="pyFeedGen 0.2.2 documentation" href="index.html" />
|
||||
<link rel="up" title="API Documentation" href="api.html" />
|
||||
<link rel="next" title="feedgen.util" href="api.util.html" />
|
||||
<link rel="prev" title="feedgen.feed" href="api.feed.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>pyFeedGen 0.1.s20130505 documentation</span></a></h1>
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.entry</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
|
|
@ -8,7 +8,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.feed — pyFeedGen 0.1.s20130505 documentation</title>
|
||||
<title>feedgen.feed — pyFeedGen 0.2.2 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
@ -17,7 +17,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.1.s20130505',
|
||||
VERSION: '0.2.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
@ -27,14 +27,14 @@
|
|||
<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="pyFeedGen 0.1.s20130505 documentation" href="index.html" />
|
||||
<link rel="top" title="pyFeedGen 0.2.2 documentation" href="index.html" />
|
||||
<link rel="up" title="API Documentation" href="api.html" />
|
||||
<link rel="next" title="feedgen.entry" href="api.entry.html" />
|
||||
<link rel="prev" title="API Documentation" href="api.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>pyFeedGen 0.1.s20130505 documentation</span></a></h1>
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.feed</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
|
8
api.html
8
api.html
|
@ -8,7 +8,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>API Documentation — pyFeedGen 0.1.s20130505 documentation</title>
|
||||
<title>API Documentation — pyFeedGen 0.2.2 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
@ -17,7 +17,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.1.s20130505',
|
||||
VERSION: '0.2.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
@ -27,13 +27,13 @@
|
|||
<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="pyFeedGen 0.1.s20130505 documentation" href="index.html" />
|
||||
<link rel="top" title="pyFeedGen 0.2.2 documentation" href="index.html" />
|
||||
<link rel="next" title="feedgen.feed" href="api.feed.html" />
|
||||
<link rel="prev" title="Feedgenerator" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>pyFeedGen 0.1.s20130505 documentation</span></a></h1>
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>API Documentation</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
|
|
@ -8,7 +8,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.util — pyFeedGen 0.1.s20130505 documentation</title>
|
||||
<title>feedgen.util — pyFeedGen 0.2.2 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
@ -17,7 +17,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.1.s20130505',
|
||||
VERSION: '0.2.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
@ -27,14 +27,14 @@
|
|||
<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="pyFeedGen 0.1.s20130505 documentation" href="index.html" />
|
||||
<link rel="top" title="pyFeedGen 0.2.2 documentation" href="index.html" />
|
||||
<link rel="up" title="API Documentation" href="api.html" />
|
||||
<link rel="next" title="feedgen.ext.base" href="ext/api.ext.base.html" />
|
||||
<link rel="prev" title="feedgen.entry" href="api.entry.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>pyFeedGen 0.1.s20130505 documentation</span></a></h1>
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.util</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
|
135
ext/api.ext.base.html
Normal file
135
ext/api.ext.base.html
Normal file
|
@ -0,0 +1,135 @@
|
|||
|
||||
|
||||
<!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 — pyFeedGen 0.2.2 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.2',
|
||||
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="pyFeedGen 0.2.2 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>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.base</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
||||
<p>
|
||||
«  <a href="../api.util.html">feedgen.util</a>
|
||||
  ::  
|
||||
<a class="uplink" href="../index.html">Contents</a>
|
||||
  ::  
|
||||
<a href="api.ext.podcast.html">feedgen.ext.podcast</a>  »
|
||||
</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 <<a class="reference external" href="mailto:lkiesow%40uos.de">lkiesow<span>@</span>uos<span>.</span>de</a>></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>, <em>doc=None</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> – 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> – 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>
|
||||
«  <a href="../api.util.html">feedgen.util</a>
|
||||
  ::  
|
||||
<a class="uplink" href="../index.html">Contents</a>
|
||||
  ::  
|
||||
<a href="api.ext.podcast.html">feedgen.ext.podcast</a>  »
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013, Lars Kiesow.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
322
ext/api.ext.podcast.html
Normal file
322
ext/api.ext.podcast.html
Normal file
|
@ -0,0 +1,322 @@
|
|||
|
||||
|
||||
<!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.podcast — pyFeedGen 0.2.2 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.2',
|
||||
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="pyFeedGen 0.2.2 documentation" href="../index.html" />
|
||||
<link rel="up" title="API Documentation" href="../api.html" />
|
||||
<link rel="next" title="feedgen.ext.podcast_entry" href="api.ext.podcast_entry.html" />
|
||||
<link rel="prev" title="feedgen.ext.base" href="api.ext.base.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="../index.html">
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.podcast</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.base.html">feedgen.ext.base</a>
|
||||
  ::  
|
||||
<a class="uplink" href="../index.html">Contents</a>
|
||||
  ::  
|
||||
<a href="api.ext.podcast_entry.html">feedgen.ext.podcast_entry</a>  »
|
||||
</p>
|
||||
|
||||
</div>
|
||||
<div class="content">
|
||||
|
||||
|
||||
<div class="apititle"><b>Contents</b></div>
|
||||
<div class="apitoc"></div><span class="target" id="module-feedgen.ext.podcast"></span><div class="section" id="feedgen-ext-podcast">
|
||||
<h1>feedgen.ext.podcast<a class="headerlink" href="#feedgen-ext-podcast" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Extends the FeedGenerator to produce podcasts.</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 <<a class="reference external" href="mailto:lkiesow%40uos.de">lkiesow<span>@</span>uos<span>.</span>de</a>></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.podcast.PodcastExtension">
|
||||
<em class="property">class </em><tt class="descclassname">feedgen.ext.podcast.</tt><tt class="descname">PodcastExtension</tt><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>FeedGenerator extension for podcasts.</p>
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.extend_rss">
|
||||
<tt class="descname">extend_rss</tt><big>(</big><em>rss_feed</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.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">Returns:</th><td class="field-body">Tuple containing the feed root element and the element tree.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_author">
|
||||
<tt class="descname">itunes_author</tt><big>(</big><em>itunes_author=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:author. The content of this tag is shown in the
|
||||
Artist column in iTunes. If the tag is not present, iTunes uses the
|
||||
contents of the <author> tag. If <itunes:author> is not present at the
|
||||
feed level, iTunes will use the contents of <managingEditor>.</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>itunes_author</strong> – The author of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The author of the podcast.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_block">
|
||||
<tt class="descname">itunes_block</tt><big>(</big><em>itunes_block=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the ITunes block attribute. Use this to prevent the entire
|
||||
podcast from appearing in the iTunes podcast directory.</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>itunes_block</strong> – Block the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast is blocked.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_category">
|
||||
<tt class="descname">itunes_category</tt><big>(</big><em>itunes_category=None</em>, <em>itunes_subcategory=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the ITunes category which appears in the category column
|
||||
and in iTunes Store Browser.</p>
|
||||
<p>The (sub-)category has to be one from the values defined at
|
||||
<a class="reference external" href="http://www.apple.com/itunes/podcasts/specs.html#categories">http://www.apple.com/itunes/podcasts/specs.html#categories</a></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"><ul class="first simple">
|
||||
<li><strong>itunes_category</strong> – Category of the podcast.</li>
|
||||
<li><strong>itunes_subcategory</strong> – Subcategory of the podcast.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Category data of the podcast.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_complete">
|
||||
<tt class="descname">itunes_complete</tt><big>(</big><em>itunes_complete=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_complete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:complete value of the podcast. This tag can be
|
||||
used to indicate the completion of a podcast.</p>
|
||||
<p>If you populate this tag with “yes”, you are indicating that no more
|
||||
episodes will be added to the podcast. If the <itunes:complete> tag is
|
||||
present and has any other value (e.g. “no”), it will have no effect on
|
||||
the podcast.</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>itunes_complete</strong> – If the podcast is complete.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast is complete.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_explicit">
|
||||
<tt class="descname">itunes_explicit</tt><big>(</big><em>itunes_explicit=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_explicit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or the the itunes:explicit value of the podcast. This tag should
|
||||
be used to indicate whether your podcast contains explicit material. The
|
||||
three values for this tag are “yes”, “no”, and “clean”.</p>
|
||||
<p>If you populate this tag with “yes”, an “explicit” parental advisory
|
||||
graphic will appear next to your podcast artwork on the iTunes Store and
|
||||
in the Name column in iTunes. If the value is “clean”, the parental
|
||||
advisory type is considered Clean, meaning that no explicit language or
|
||||
adult content is included anywhere in the episodes, and a “clean” graphic
|
||||
will appear. If the explicit tag is present and has any other value
|
||||
(e.g., “no”), you see no indicator — blank is the default advisory type.</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>itunes_explicit</strong> – If the podcast contains explicit material.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast contains explicit material.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_image">
|
||||
<tt class="descname">itunes_image</tt><big>(</big><em>itunes_image=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_image" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the image for the podcast. This tag specifies the artwork
|
||||
for your podcast. Put the URL to the image in the href attribute. iTunes
|
||||
prefers square .jpg images that are at least 1400x1400 pixels, which is
|
||||
different from what is specified for the standard RSS image tag. In order
|
||||
for a podcast to be eligible for an iTunes Store feature, the
|
||||
accompanying image must be at least 1400x1400 pixels.</p>
|
||||
<p>iTunes supports images in JPEG and PNG formats with an RGB color space
|
||||
(CMYK is not supported). The URL must end in ”.jpg” or ”.png”. If the
|
||||
<itunes:image> tag is not present, iTunes will use the contents of the
|
||||
RSS image tag.</p>
|
||||
<p>If you change your podcast’s image, also change the file’s name. iTunes
|
||||
may not change the image if it checks your feed and the image URL is the
|
||||
same. The server hosting your cover art image must allow HTTP head
|
||||
requests for iTS to be able to automatically update your cover art.</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>itunes_image</strong> – Image of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Image of the podcast.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_new_feed_url">
|
||||
<tt class="descname">itunes_new_feed_url</tt><big>(</big><em>itunes_new_feed_url=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_new_feed_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the new-feed-url property of the podcast. This tag allows
|
||||
you to change the URL where the podcast feed is located</p>
|
||||
<p>After adding the tag to your old feed, you should maintain the old feed
|
||||
for 48 hours before retiring it. At that point, iTunes will have updated
|
||||
the directory with the new feed URL.</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>itunes_new_feed_url</strong> – New feed URL.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">New feed URL.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_owner">
|
||||
<tt class="descname">itunes_owner</tt><big>(</big><em>name=None</em>, <em>email=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_owner" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:owner of the podcast. This tag contains
|
||||
information that will be used to contact the owner of the podcast for
|
||||
communication specifically about the podcast. It will not be publicly
|
||||
displayed.</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>itunes_owner</strong> – The owner of the feed.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Data of the owner of the feed.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_subtitle">
|
||||
<tt class="descname">itunes_subtitle</tt><big>(</big><em>itunes_subtitle=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_subtitle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:subtitle value for the podcast. The contents of
|
||||
this tag are shown in the Description column in iTunes. The subtitle
|
||||
displays best if it is only a few words long.</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>itunes_subtitle</strong> – Subtitle of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Subtitle of the podcast.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast.PodcastExtension.itunes_summary">
|
||||
<tt class="descname">itunes_summary</tt><big>(</big><em>itunes_summary=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:summary value for the podcast. The contents of
|
||||
this tag are shown in a separate window that appears when the “circled i”
|
||||
in the Description column is clicked. It also appears on the iTunes page
|
||||
for your podcast. This field can be up to 4000 characters. If
|
||||
<itunes:summary> is not included, the contents of the <description> tag
|
||||
are used.</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>itunes_summary</strong> – Summary of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Summary of the podcast.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.base.html">feedgen.ext.base</a>
|
||||
  ::  
|
||||
<a class="uplink" href="../index.html">Contents</a>
|
||||
  ::  
|
||||
<a href="api.ext.podcast_entry.html">feedgen.ext.podcast_entry</a>  »
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013, Lars Kiesow.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
300
ext/api.ext.podcast_entry.html
Normal file
300
ext/api.ext.podcast_entry.html
Normal file
|
@ -0,0 +1,300 @@
|
|||
|
||||
|
||||
<!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.podcast_entry — pyFeedGen 0.2.2 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.2',
|
||||
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="pyFeedGen 0.2.2 documentation" href="../index.html" />
|
||||
<link rel="up" title="API Documentation" href="../api.html" />
|
||||
<link rel="prev" title="feedgen.ext.podcast" href="api.ext.podcast.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="../index.html">
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.podcast_entry</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.podcast.html">feedgen.ext.podcast</a>
|
||||
  ::  
|
||||
<a class="uplink" href="../index.html">Contents</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
<div class="content">
|
||||
|
||||
|
||||
<div class="apititle"><b>Contents</b></div>
|
||||
<div class="apitoc"></div><span class="target" id="module-feedgen.ext.podcast_entry"></span><div class="section" id="feedgen-ext-podcast-entry">
|
||||
<h1>feedgen.ext.podcast_entry<a class="headerlink" href="#feedgen-ext-podcast-entry" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Extends the feedgen to produce podcasts.</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 <<a class="reference external" href="mailto:lkiesow%40uos.de">lkiesow<span>@</span>uos<span>.</span>de</a>></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.podcast_entry.PodcastEntryExtension">
|
||||
<em class="property">class </em><tt class="descclassname">feedgen.ext.podcast_entry.</tt><tt class="descname">PodcastEntryExtension</tt><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>FeedEntry extension for podcasts.</p>
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.extend_rss">
|
||||
<tt class="descname">extend_rss</tt><big>(</big><em>entry</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.extend_rss" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Add additional fields to an RSS item.</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> – The RSS item XML element to use.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_author">
|
||||
<tt class="descname">itunes_author</tt><big>(</big><em>itunes_author=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:author of the podcast episode. The content of
|
||||
this tag is shown in the Artist column in iTunes. If the tag is not
|
||||
present, iTunes uses the contents of the <author> tag. If <itunes:author>
|
||||
is not present at the feed level, iTunes will use the contents of
|
||||
<managingEditor>.</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>itunes_author</strong> – The author of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The author of the podcast.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_block">
|
||||
<tt class="descname">itunes_block</tt><big>(</big><em>itunes_block=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_block" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the ITunes block attribute. Use this to prevent episodes
|
||||
from appearing in the iTunes podcast directory.</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>itunes_block</strong> – Block podcast episodes.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast episode is blocked.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_duration">
|
||||
<tt class="descname">itunes_duration</tt><big>(</big><em>itunes_duration=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_duration" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the duration of the podcast episode. The content of this
|
||||
tag is shown in the Time column in iTunes.</p>
|
||||
<p>The tag can be formatted HH:MM:SS, H:MM:SS, MM:SS, or M:SS (H = hours,
|
||||
M = minutes, S = seconds). If an integer is provided (no colon present),
|
||||
the value is assumed to be in seconds. If one colon is present, the
|
||||
number to the left is assumed to be minutes, and the number to the right
|
||||
is assumed to be seconds. If more than two colons are present, the
|
||||
numbers farthest to the right are ignored.</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>itunes_duration</strong> – Duration of the podcast episode.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Duration of the podcast episode.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_explicit">
|
||||
<tt class="descname">itunes_explicit</tt><big>(</big><em>itunes_explicit=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_explicit" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or the the itunes:explicit value of the podcast episode. This tag
|
||||
should be used to indicate whether your podcast episode contains explicit
|
||||
material. The three values for this tag are “yes”, “no”, and “clean”.</p>
|
||||
<p>If you populate this tag with “yes”, an “explicit” parental advisory
|
||||
graphic will appear next to your podcast artwork on the iTunes Store and
|
||||
in the Name column in iTunes. If the value is “clean”, the parental
|
||||
advisory type is considered Clean, meaning that no explicit language or
|
||||
adult content is included anywhere in the episodes, and a “clean” graphic
|
||||
will appear. If the explicit tag is present and has any other value
|
||||
(e.g., “no”), you see no indicator — blank is the default advisory type.</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>itunes_explicit</strong> – If the podcast episode contains explicit material.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the podcast episode contains explicit material.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_image">
|
||||
<tt class="descname">itunes_image</tt><big>(</big><em>itunes_image=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_image" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the image for the podcast episode. This tag specifies the
|
||||
artwork for your podcast. Put the URL to the image in the href attribute.
|
||||
iTunes prefers square .jpg images that are at least 1400x1400 pixels,
|
||||
which is different from what is specified for the standard RSS image tag.
|
||||
In order for a podcast to be eligible for an iTunes Store feature, the
|
||||
accompanying image must be at least 1400x1400 pixels.</p>
|
||||
<p>iTunes supports images in JPEG and PNG formats with an RGB color space
|
||||
(CMYK is not supported). The URL must end in ”.jpg” or ”.png”. If the
|
||||
<itunes:image> tag is not present, iTunes will use the contents of the
|
||||
RSS image tag.</p>
|
||||
<p>If you change your podcast’s image, also change the file’s name. iTunes
|
||||
may not change the image if it checks your feed and the image URL is the
|
||||
same. The server hosting your cover art image must allow HTTP head
|
||||
requests for iTS to be able to automatically update your cover art.</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>itunes_image</strong> – Image of the podcast.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Image of the podcast.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_is_closed_captioned">
|
||||
<tt class="descname">itunes_is_closed_captioned</tt><big>(</big><em>itunes_is_closed_captioned=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_is_closed_captioned" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the is_closed_captioned value of the podcast episode. This
|
||||
tag should be used if your podcast includes a video episode with embedded
|
||||
closed captioning support. The two values for this tag are “yes” and
|
||||
“no”.</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>is_closed_captioned</strong> – If the episode has closed captioning support.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">If the episode has closed captioning support.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_order">
|
||||
<tt class="descname">itunes_order</tt><big>(</big><em>itunes_order=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_order" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:order value of the podcast episode. This tag can
|
||||
be used to override the default ordering of episodes on the store.</p>
|
||||
<p>This tag is used at an <item> level by populating with the number value
|
||||
in which you would like the episode to appear on the store. For example,
|
||||
if you would like an <item> to appear as the first episode in the
|
||||
podcast, you would populate the <itunes:order> tag with “1”. If
|
||||
conflicting order values are present in multiple episodes, the store will
|
||||
use default ordering (pubDate).</p>
|
||||
<p>To remove the order from the episode set the order to a value below zero.</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>itunes_order</strong> – The order of the episode.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The order of the episode.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_subtitle">
|
||||
<tt class="descname">itunes_subtitle</tt><big>(</big><em>itunes_subtitle=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_subtitle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:subtitle value for the podcast episode. The
|
||||
contents of this tag are shown in the Description column in iTunes. The
|
||||
subtitle displays best if it is only a few words long.</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>itunes_subtitle</strong> – Subtitle of the podcast episode.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Subtitle of the podcast episode.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_summary">
|
||||
<tt class="descname">itunes_summary</tt><big>(</big><em>itunes_summary=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast_entry.PodcastEntryExtension.itunes_summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the itunes:summary value for the podcast episode. The
|
||||
contents of this tag are shown in a separate window that appears when the
|
||||
“circled i” in the Description column is clicked. It also appears on the
|
||||
iTunes page for your podcast. This field can be up to 4000 characters. If
|
||||
<itunes:summary> is not included, the contents of the <description> tag
|
||||
are used.</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>itunes_summary</strong> – Summary of the podcast episode.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Summary of the podcast episode.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.podcast.html">feedgen.ext.podcast</a>
|
||||
  ::  
|
||||
<a class="uplink" href="../index.html">Contents</a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013, Lars Kiesow.
|
||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
|
@ -10,7 +10,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — pyFeedGen 0.1.s20130505 documentation</title>
|
||||
<title>Index — pyFeedGen 0.2.2 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
@ -19,7 +19,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.1.s20130505',
|
||||
VERSION: '0.2.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
@ -29,11 +29,11 @@
|
|||
<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="pyFeedGen 0.1.s20130505 documentation" href="index.html" />
|
||||
<link rel="top" title="pyFeedGen 0.2.2 documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>pyFeedGen 0.1.s20130505 documentation</span></a></h1>
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Index</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
|
14
index.html
14
index.html
|
@ -8,7 +8,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Feedgenerator — pyFeedGen 0.1.s20130505 documentation</title>
|
||||
<title>Feedgenerator — pyFeedGen 0.2.2 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
@ -17,7 +17,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.1.s20130505',
|
||||
VERSION: '0.2.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
@ -27,12 +27,12 @@
|
|||
<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="pyFeedGen 0.1.s20130505 documentation" href="#" />
|
||||
<link rel="top" title="pyFeedGen 0.2.2 documentation" href="#" />
|
||||
<link rel="next" title="API Documentation" href="api.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="#">
|
||||
<span>pyFeedGen 0.1.s20130505 documentation</span></a></h1>
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Feedgenerator</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
@ -77,15 +77,15 @@ at license.bsd and license.lgpl.</p>
|
|||
<p>If you are running Fedora Linux, Redhat Enterprise Linux, CentOS or Scientific
|
||||
linux you can use one of the following packages:</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://docs.google.com/file/d/0B_bDfxNKSsxpclZUc2hwYnRKSUU/edit?usp=sharing">python-feedgen-0.1-1.fc17.noarch.rpm</a></li>
|
||||
<li><a class="reference external" href="https://docs.google.com/file/d/0B_bDfxNKSsxpNXlKREYyWmhDR0U/edit?usp=sharing">python-feedgen-0.1-1.el6.noarch.rpm</a></li>
|
||||
<li><a class="reference external" href="https://docs.google.com/file/d/0B_bDfxNKSsxpcjQtWm85QXZmbkU/edit?usp=sharing">python-feedgen-0.2.2-1.fc17.noarch.rpm</a></li>
|
||||
<li><a class="reference external" href="https://docs.google.com/file/d/0B_bDfxNKSsxpOVVVWXZ1aDllVWs/edit?usp=sharing">python-feedgen-0.2.2-1.el6.noarch.rpm</a></li>
|
||||
</ul>
|
||||
<p>Simply download the file and run:</p>
|
||||
<div class="highlight-python"><pre>$ yum localinstall python-feedgen-0.1-1.fc17.noarch.rpm</pre>
|
||||
</div>
|
||||
<p>If you want to build RPMs for other distributions you can use the following Source RPM:</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://docs.google.com/file/d/0B_bDfxNKSsxpenJUcmJWWVN0OHM/edit?usp=sharing">python-feedgen-0.1-1.fc17.src.rpm</a></li>
|
||||
<li><a class="reference external" href="https://docs.google.com/file/d/0B_bDfxNKSsxpZHZXbTkzcFZTSlk/edit?usp=sharing">python-feedgen-0.2.2-1.fc17.src.rpm</a></li>
|
||||
</ul>
|
||||
<p><strong>Using pip</strong></p>
|
||||
<p>You can also use pip to install the feedgen module. Simply run:</p>
|
||||
|
|
|
@ -8,7 +8,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Python Module Index — pyFeedGen 0.1.s20130505 documentation</title>
|
||||
<title>Python Module Index — pyFeedGen 0.2.2 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
@ -17,7 +17,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.1.s20130505',
|
||||
VERSION: '0.2.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
@ -27,14 +27,14 @@
|
|||
<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="pyFeedGen 0.1.s20130505 documentation" href="index.html" />
|
||||
<link rel="top" title="pyFeedGen 0.2.2 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>pyFeedGen 0.1.s20130505 documentation</span></a></h1>
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Python Module Index</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
|
|
@ -8,7 +8,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — pyFeedGen 0.1.s20130505 documentation</title>
|
||||
<title>Search — pyFeedGen 0.2.2 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
@ -17,7 +17,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '',
|
||||
VERSION: '0.1.s20130505',
|
||||
VERSION: '0.2.2',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
@ -28,7 +28,7 @@
|
|||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
<script type="text/javascript" src="_static/theme_extras.js"></script>
|
||||
<link rel="top" title="pyFeedGen 0.1.s20130505 documentation" href="index.html" />
|
||||
<link rel="top" title="pyFeedGen 0.2.2 documentation" href="index.html" />
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
@ -37,7 +37,7 @@
|
|||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>pyFeedGen 0.1.s20130505 documentation</span></a></h1>
|
||||
<span>pyFeedGen 0.2.2 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Search</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
|
|
Loading…
Reference in a new issue