466 lines
32 KiB
HTML
466 lines
32 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||
|
||
<title>feedgen.ext.dc — python-feedgen 1.0.0 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="../_static/lernfunk.css" />
|
||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
<script src="../_static/jquery.js"></script>
|
||
<script src="../_static/underscore.js"></script>
|
||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||
<script src="../_static/doctools.js"></script>
|
||
<script src="../_static/sphinx_highlight.js"></script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="next" title="feedgen.ext.podcast" href="api.ext.podcast.html" />
|
||
<link rel="prev" title="feedgen.ext.base" href="api.ext.base.html" />
|
||
</head><body>
|
||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||
<span>python-feedgen 1.0.0 documentation</span></a></h1>
|
||
<h2 class="heading"><span>feedgen.ext.dc</span></h2>
|
||
</div>
|
||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||
|
||
<p>
|
||
«  <a href="api.ext.base.html">feedgen.ext.base</a>
|
||
  ::  
|
||
<a class="uplink" href="../index.html">Contents</a>
|
||
  ::  
|
||
<a href="api.ext.podcast.html">feedgen.ext.podcast</a>  »
|
||
</p>
|
||
|
||
</div>
|
||
<div class="content" role="main">
|
||
|
||
|
||
<script type=application/javascript src=_static/theme_extras.js></script>
|
||
<div class="apititle"><b>Contents</b></div>
|
||
<div class="apitoc"></div><span class="target" id="module-feedgen.ext.dc"></span><section id="feedgen-ext-dc">
|
||
<h1>feedgen.ext.dc<a class="headerlink" href="#feedgen-ext-dc" title="Permalink to this heading">¶</a></h1>
|
||
<p>Extends the FeedGenerator to add Dubline Core Elements to the feeds.</p>
|
||
<p>Descriptions partly taken from
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-coverage">http://dublincore.org/documents/dcmi-terms/#elements-coverage</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">copyright<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>2013-2017, Lars Kiesow <<a class="reference external" href="mailto:lkiesow%40uos.de">lkiesow<span>@</span>uos<span>.</span>de</a>></p>
|
||
</dd>
|
||
<dt class="field-even">license<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>FreeBSD and LGPL, see license.* for more details.</p>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feedgen.ext.dc.</span></span><span class="sig-name descname"><span class="pre">DcBaseExtension</span></span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Dublin Core Elements extension for podcasts.</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_contributor">
|
||
<span class="sig-name descname"><span class="pre">dc_contributor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">contributor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_contributor" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:contributor which is an entity responsible for
|
||
making contributions to the resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-contributor">http://dublincore.org/documents/dcmi-terms/#elements-contributor</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>contributor</strong> – Contributor or list of contributors.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set contributors (default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of contributors.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_coverage">
|
||
<span class="sig-name descname"><span class="pre">dc_coverage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coverage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_coverage" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:coverage which indicated the spatial or temporal
|
||
topic of the resource, the spatial applicability of the resource, or
|
||
the jurisdiction under which the resource is relevant.</p>
|
||
<p>Spatial topic and spatial applicability may be a named place or a
|
||
location specified by its geographic coordinates. Temporal topic may be
|
||
a named period, date, or date range. A jurisdiction may be a named
|
||
administrative entity or a geographic place to which the resource
|
||
applies. Recommended best practice is to use a controlled vocabulary
|
||
such as the Thesaurus of Geographic Names [TGN]. Where appropriate,
|
||
named places or time periods can be used in preference to numeric
|
||
identifiers such as sets of coordinates or date ranges.</p>
|
||
<p>References:
|
||
[TGN] <a class="reference external" href="http://www.getty.edu/research/tools/vocabulary/tgn/index.html">http://www.getty.edu/research/tools/vocabulary/tgn/index.html</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>coverage</strong> – Coverage of the feed.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set coverage (default: True).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Coverage of the feed.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_creator">
|
||
<span class="sig-name descname"><span class="pre">dc_creator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">creator</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_creator" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:creator which is an entity primarily responsible
|
||
for making the resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-creator">http://dublincore.org/documents/dcmi-terms/#elements-creator</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>creator</strong> – Creator or list of creators.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set creators (default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of creators.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_date">
|
||
<span class="sig-name descname"><span class="pre">dc_date</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_date" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:date which describes a point or period of time
|
||
associated with an event in the lifecycle of the resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-date">http://dublincore.org/documents/dcmi-terms/#elements-date</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>date</strong> – Date or list of dates.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set dates (default: True).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of dates.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_description">
|
||
<span class="sig-name descname"><span class="pre">dc_description</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:description which is an account of the resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-description">http://dublincore.org/documents/dcmi-terms/#elements-description</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>description</strong> – Description or list of descriptions.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set descriptions (default: True).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of descriptions.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_format">
|
||
<span class="sig-name descname"><span class="pre">dc_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_format" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:format which describes the file format, physical
|
||
medium, or dimensions of the resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-format">http://dublincore.org/documents/dcmi-terms/#elements-format</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>format</strong> – Format of the resource or list of formats.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set format (default: True).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Format of the resource.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_identifier">
|
||
<span class="sig-name descname"><span class="pre">dc_identifier</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">identifier</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_identifier" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:identifier which should be an unambiguous
|
||
reference to the resource within a given context.</p>
|
||
<p>For more inidentifierion see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-identifier">http://dublincore.org/documents/dcmi-terms/#elements-identifier</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>identifier</strong> – Identifier of the resource or list of identifiers.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set identifier (default: True).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Identifiers of the resource.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_language">
|
||
<span class="sig-name descname"><span class="pre">dc_language</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_language" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:language which describes a language of the
|
||
resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-language">http://dublincore.org/documents/dcmi-terms/#elements-language</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>language</strong> – Language or list of languages.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set languages (default: True).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of languages.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_publisher">
|
||
<span class="sig-name descname"><span class="pre">dc_publisher</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">publisher</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_publisher" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:publisher which is an entity responsible for
|
||
making the resource available.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-publisher">http://dublincore.org/documents/dcmi-terms/#elements-publisher</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>publisher</strong> – Publisher or list of publishers.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set publishers (default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of publishers.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_relation">
|
||
<span class="sig-name descname"><span class="pre">dc_relation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">relation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_relation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:relation which describes a related resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-relation">http://dublincore.org/documents/dcmi-terms/#elements-relation</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>relation</strong> – Relation or list of relations.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set relations (default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of relations.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_rights">
|
||
<span class="sig-name descname"><span class="pre">dc_rights</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rights</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_rights" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:rights which may contain information about rights
|
||
held in and over the resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-rights">http://dublincore.org/documents/dcmi-terms/#elements-rights</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>rights</strong> – Rights information or list of rights information.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set rights (default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of rights information.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_source">
|
||
<span class="sig-name descname"><span class="pre">dc_source</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_source" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:source which is a related resource from which the
|
||
described resource is derived.</p>
|
||
<p>The described resource may be derived from the related resource in
|
||
whole or in part. Recommended best practice is to identify the related
|
||
resource by means of a string conforming to a formal identification
|
||
system.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-source">http://dublincore.org/documents/dcmi-terms/#elements-source</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>source</strong> – Source or list of sources.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set sources (default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of sources.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_subject">
|
||
<span class="sig-name descname"><span class="pre">dc_subject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_subject" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:subject which describes the topic of the resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-subject">http://dublincore.org/documents/dcmi-terms/#elements-subject</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>subject</strong> – Subject or list of subjects.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set subjects (default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of subjects.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_title">
|
||
<span class="sig-name descname"><span class="pre">dc_title</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_title" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:title which is a name given to the resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-title">http://dublincore.org/documents/dcmi-terms/#elements-title</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>title</strong> – Title or list of titles.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set titles (default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of titles.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.dc_type">
|
||
<span class="sig-name descname"><span class="pre">dc_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_type" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get or set the dc:type which describes the nature or genre of the
|
||
resource.</p>
|
||
<p>For more information see:
|
||
<a class="reference external" href="http://dublincore.org/documents/dcmi-terms/#elements-type">http://dublincore.org/documents/dcmi-terms/#elements-type</a></p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>type</strong> – Type or list of types.</p></li>
|
||
<li><p><strong>replace</strong> – Replace already set types (default: False).</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>List of types.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.extend_atom">
|
||
<span class="sig-name descname"><span class="pre">extend_atom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">atom_feed</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.extend_atom" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Extend an Atom feed with the set DC fields.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>atom_feed</strong> – The feed root element</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The feed root element</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.extend_ns">
|
||
<span class="sig-name descname"><span class="pre">extend_ns</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.extend_ns" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a dict that will be used in the namespace map for the feed.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcBaseExtension.extend_rss">
|
||
<span class="sig-name descname"><span class="pre">extend_rss</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">rss_feed</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.extend_rss" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Extend a RSS feed with the set DC fields.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>rss_feed</strong> – The feed root element</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The feed root element.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcEntryExtension">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feedgen.ext.dc.</span></span><span class="sig-name descname"><span class="pre">DcEntryExtension</span></span><a class="headerlink" href="#feedgen.ext.dc.DcEntryExtension" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Dublin Core Elements extension for podcasts.</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcEntryExtension.extend_atom">
|
||
<span class="sig-name descname"><span class="pre">extend_atom</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">entry</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcEntryExtension.extend_atom" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add dc elements to an atom item. Alters the item itself.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>entry</strong> – An atom entry element.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The entry element.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcEntryExtension.extend_rss">
|
||
<span class="sig-name descname"><span class="pre">extend_rss</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">item</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.dc.DcEntryExtension.extend_rss" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add dc elements to a RSS item. Alters the item itself.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>item</strong> – A RSS item element.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The item element.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="feedgen.ext.dc.DcExtension">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feedgen.ext.dc.</span></span><span class="sig-name descname"><span class="pre">DcExtension</span></span><a class="headerlink" href="#feedgen.ext.dc.DcExtension" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Dublin Core Elements extension for podcasts.</p>
|
||
</dd></dl>
|
||
|
||
|
||
|
||
</div>
|
||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||
|
||
<p>
|
||
«  <a href="api.ext.base.html">feedgen.ext.base</a>
|
||
  ::  
|
||
<a class="uplink" href="../index.html">Contents</a>
|
||
  ::  
|
||
<a href="api.ext.podcast.html">feedgen.ext.podcast</a>  »
|
||
</p>
|
||
|
||
</div>
|
||
|
||
<div class="footer" role="contentinfo">
|
||
© Copyright 2013-2016, Lars Kiesow.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
|
||
</div>
|
||
</body>
|
||
</html> |