Documentation for v0.5.1
Signed-off-by: Lars Kiesow <lkiesow@uos.de>
This commit is contained in:
Lars Kiesow
parent
7e232ce915
commit
1ca4dedc31
30 changed files with 12143 additions and 630 deletions
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -52,6 +52,8 @@ div.sphinxsidebar {
|
|||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
word-wrap: break-word;
|
||||
overflow-wrap : break-word;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
|
|
@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] {
|
|||
width: 170px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
width: 30px;
|
||||
}
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
|
|
@ -187,6 +185,13 @@ div.genindex-jumpbox {
|
|||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
-moz-hyphens: auto;
|
||||
-ms-hyphens: auto;
|
||||
-webkit-hyphens: auto;
|
||||
hyphens: auto;
|
||||
}
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
|
@ -197,7 +202,10 @@ h3:hover > a.headerlink,
|
|||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink {
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
|
|
@ -314,6 +322,13 @@ table.docutils {
|
|||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
|
|
@ -344,6 +359,25 @@ table.citation td {
|
|||
border-bottom: none;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
|
|
@ -406,6 +440,10 @@ dl.glossary dt {
|
|||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
|
@ -456,6 +494,13 @@ pre {
|
|||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
span.pre {
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
-webkit-hyphens: none;
|
||||
hyphens: none;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
padding: 5px 0px;
|
||||
border: 0;
|
||||
|
|
@ -471,22 +516,51 @@ table.highlighttable td {
|
|||
padding: 0 0.5em 0 0.5em;
|
||||
}
|
||||
|
||||
tt.descname {
|
||||
div.code-block-caption {
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
div.code-block-caption + div > div.highlight > pre {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-number {
|
||||
padding: 0.1em 0.3em;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
padding: 1em 1em 0;
|
||||
}
|
||||
|
||||
div.literal-block-wrapper div.highlight {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
tt.descclassname {
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
tt.xref, a tt {
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 164 B After Width: | Height: | Size: 147 B |
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -91,6 +91,30 @@ jQuery.fn.highlightText = function(text, className) {
|
|||
});
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
|
|
@ -100,6 +124,7 @@ var Documentation = {
|
|||
this.fixFirefoxAnchorBug();
|
||||
this.highlightSearchWords();
|
||||
this.initIndexTable();
|
||||
|
||||
},
|
||||
|
||||
/**
|
||||
|
|
@ -152,9 +177,10 @@ var Documentation = {
|
|||
|
||||
/**
|
||||
* workaround a firefox stupidity
|
||||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash && $.browser.mozilla)
|
||||
if (document.location.hash)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
|
|
@ -227,6 +253,29 @@ var Documentation = {
|
|||
});
|
||||
var url = parts.join('/');
|
||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||
},
|
||||
|
||||
initOnKeyListeners: function() {
|
||||
$(document).keyup(function(event) {
|
||||
var activeElementType = document.activeElement.tagName;
|
||||
// don't navigate when in search box or textarea
|
||||
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
|
||||
switch (event.keyCode) {
|
||||
case 37: // left
|
||||
var prevHref = $('link[rel="prev"]').prop('href');
|
||||
if (prevHref) {
|
||||
window.location.href = prevHref;
|
||||
return false;
|
||||
}
|
||||
case 39: // right
|
||||
var nextHref = $('link[rel="next"]').prop('href');
|
||||
if (nextHref) {
|
||||
window.location.href = nextHref;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 368 B After Width: | Height: | Size: 347 B |
BIN
_static/down.png
BIN
_static/down.png
Binary file not shown.
|
Before Width: | Height: | Size: 363 B After Width: | Height: | Size: 347 B |
BIN
_static/file.png
BIN
_static/file.png
Binary file not shown.
|
Before Width: | Height: | Size: 392 B After Width: | Height: | Size: 358 B |
|
|
@ -16,7 +16,7 @@
|
|||
* Braden Ewing <brewin@gmail.com>
|
||||
* Humdinger <humdingerb@gmail.com>
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -307,7 +307,7 @@ td {
|
|||
vertical-align: top;
|
||||
}
|
||||
|
||||
tt {
|
||||
code {
|
||||
background-color: #e2e2e2;
|
||||
font-size: 1.0em;
|
||||
font-family: monospace;
|
||||
|
|
@ -369,3 +369,8 @@ div.viewcode-block:target {
|
|||
margin: -1px -10px;
|
||||
padding: 0 12px;
|
||||
}
|
||||
|
||||
/* math display */
|
||||
div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
10308
_static/jquery-1.11.1.js
vendored
Normal file
10308
_static/jquery-1.11.1.js
vendored
Normal file
File diff suppressed because it is too large
Load diff
6
_static/jquery.js
vendored
6
_static/jquery.js
vendored
File diff suppressed because one or more lines are too long
Binary file not shown.
|
Before Width: | Height: | Size: 199 B After Width: | Height: | Size: 173 B |
BIN
_static/plus.png
BIN
_static/plus.png
Binary file not shown.
|
Before Width: | Height: | Size: 199 B After Width: | Height: | Size: 173 B |
|
|
@ -2,14 +2,15 @@
|
|||
* searchtools.js_t
|
||||
* ~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilties for the full-text search.
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
/* Non-minified version JS is _stemmer.js if file is provided */
|
||||
/**
|
||||
* Porter Stemmer
|
||||
*/
|
||||
|
|
@ -323,7 +324,7 @@ var Search = {
|
|||
var searchterms = [];
|
||||
var excluded = [];
|
||||
var hlterms = [];
|
||||
var tmp = query.split(/\s+/);
|
||||
var tmp = query.split(/\W+/);
|
||||
var objectterms = [];
|
||||
for (i = 0; i < tmp.length; i++) {
|
||||
if (tmp[i] !== "") {
|
||||
|
|
@ -373,8 +374,7 @@ var Search = {
|
|||
}
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
|
||||
.concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
|
||||
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) {
|
||||
|
|
@ -439,7 +439,7 @@ var Search = {
|
|||
dataType: "text",
|
||||
complete: function(jqxhr, textstatus) {
|
||||
var data = jqxhr.responseText;
|
||||
if (data !== '') {
|
||||
if (data !== '' && data !== undefined) {
|
||||
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
|
||||
}
|
||||
Search.output.append(listItem);
|
||||
|
|
@ -538,23 +538,47 @@ var Search = {
|
|||
/**
|
||||
* search for full-text terms in the index
|
||||
*/
|
||||
performTermsSearch : function(searchterms, excluded, terms, score) {
|
||||
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
|
||||
var filenames = this._index.filenames;
|
||||
var titles = this._index.titles;
|
||||
|
||||
var i, j, file, files;
|
||||
var i, j, file;
|
||||
var fileMap = {};
|
||||
var scoreMap = {};
|
||||
var results = [];
|
||||
|
||||
// perform the search on the required terms
|
||||
for (i = 0; i < searchterms.length; i++) {
|
||||
var word = searchterms[i];
|
||||
var files = [];
|
||||
var _o = [
|
||||
{files: terms[word], score: Scorer.term},
|
||||
{files: titleterms[word], score: Scorer.title}
|
||||
];
|
||||
|
||||
// no match but word was a required one
|
||||
if ((files = terms[word]) === undefined)
|
||||
if ($u.every(_o, function(o){return o.files === undefined;})) {
|
||||
break;
|
||||
if (files.length === undefined) {
|
||||
files = [files];
|
||||
}
|
||||
// found search word in contents
|
||||
$u.each(_o, function(o) {
|
||||
var _files = o.files;
|
||||
if (_files === undefined)
|
||||
return
|
||||
|
||||
if (_files.length === undefined)
|
||||
_files = [_files];
|
||||
files = files.concat(_files);
|
||||
|
||||
// set score for the word in each file to Scorer.term
|
||||
for (j = 0; j < _files.length; j++) {
|
||||
file = _files[j];
|
||||
if (!(file in scoreMap))
|
||||
scoreMap[file] = {}
|
||||
scoreMap[file][word] = o.score;
|
||||
}
|
||||
});
|
||||
|
||||
// create the mapping
|
||||
for (j = 0; j < files.length; j++) {
|
||||
file = files[j];
|
||||
|
|
@ -576,7 +600,9 @@ var Search = {
|
|||
// ensure that none of the excluded terms is in the search result
|
||||
for (i = 0; i < excluded.length; i++) {
|
||||
if (terms[excluded[i]] == file ||
|
||||
$u.contains(terms[excluded[i]] || [], file)) {
|
||||
titleterms[excluded[i]] == file ||
|
||||
$u.contains(terms[excluded[i]] || [], file) ||
|
||||
$u.contains(titleterms[excluded[i]] || [], file)) {
|
||||
valid = false;
|
||||
break;
|
||||
}
|
||||
|
|
@ -584,6 +610,9 @@ var Search = {
|
|||
|
||||
// if we have still a valid result we can add it to the result list
|
||||
if (valid) {
|
||||
// select one (max) score for the file.
|
||||
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
|
||||
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
|
||||
results.push([filenames[file], titles[file], '', null, score]);
|
||||
}
|
||||
}
|
||||
|
|
@ -594,7 +623,7 @@ var Search = {
|
|||
* helper function to return a node containing the
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words, hlwords is the list of normal, unstemmed
|
||||
* words. the first one is used to find the occurance, the
|
||||
* words. the first one is used to find the occurrence, the
|
||||
* latter for highlighting it.
|
||||
*/
|
||||
makeSearchSummary : function(text, keywords, hlwords) {
|
||||
|
|
|
|||
999
_static/underscore-1.3.1.js
Normal file
999
_static/underscore-1.3.1.js
Normal file
|
|
@ -0,0 +1,999 @@
|
|||
// Underscore.js 1.3.1
|
||||
// (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc.
|
||||
// Underscore is freely distributable under the MIT license.
|
||||
// Portions of Underscore are inspired or borrowed from Prototype,
|
||||
// Oliver Steele's Functional, and John Resig's Micro-Templating.
|
||||
// For all details and documentation:
|
||||
// http://documentcloud.github.com/underscore
|
||||
|
||||
(function() {
|
||||
|
||||
// Baseline setup
|
||||
// --------------
|
||||
|
||||
// Establish the root object, `window` in the browser, or `global` on the server.
|
||||
var root = this;
|
||||
|
||||
// Save the previous value of the `_` variable.
|
||||
var previousUnderscore = root._;
|
||||
|
||||
// Establish the object that gets returned to break out of a loop iteration.
|
||||
var breaker = {};
|
||||
|
||||
// Save bytes in the minified (but not gzipped) version:
|
||||
var ArrayProto = Array.prototype, ObjProto = Object.prototype, FuncProto = Function.prototype;
|
||||
|
||||
// Create quick reference variables for speed access to core prototypes.
|
||||
var slice = ArrayProto.slice,
|
||||
unshift = ArrayProto.unshift,
|
||||
toString = ObjProto.toString,
|
||||
hasOwnProperty = ObjProto.hasOwnProperty;
|
||||
|
||||
// All **ECMAScript 5** native function implementations that we hope to use
|
||||
// are declared here.
|
||||
var
|
||||
nativeForEach = ArrayProto.forEach,
|
||||
nativeMap = ArrayProto.map,
|
||||
nativeReduce = ArrayProto.reduce,
|
||||
nativeReduceRight = ArrayProto.reduceRight,
|
||||
nativeFilter = ArrayProto.filter,
|
||||
nativeEvery = ArrayProto.every,
|
||||
nativeSome = ArrayProto.some,
|
||||
nativeIndexOf = ArrayProto.indexOf,
|
||||
nativeLastIndexOf = ArrayProto.lastIndexOf,
|
||||
nativeIsArray = Array.isArray,
|
||||
nativeKeys = Object.keys,
|
||||
nativeBind = FuncProto.bind;
|
||||
|
||||
// Create a safe reference to the Underscore object for use below.
|
||||
var _ = function(obj) { return new wrapper(obj); };
|
||||
|
||||
// Export the Underscore object for **Node.js**, with
|
||||
// backwards-compatibility for the old `require()` API. If we're in
|
||||
// the browser, add `_` as a global object via a string identifier,
|
||||
// for Closure Compiler "advanced" mode.
|
||||
if (typeof exports !== 'undefined') {
|
||||
if (typeof module !== 'undefined' && module.exports) {
|
||||
exports = module.exports = _;
|
||||
}
|
||||
exports._ = _;
|
||||
} else {
|
||||
root['_'] = _;
|
||||
}
|
||||
|
||||
// Current version.
|
||||
_.VERSION = '1.3.1';
|
||||
|
||||
// Collection Functions
|
||||
// --------------------
|
||||
|
||||
// The cornerstone, an `each` implementation, aka `forEach`.
|
||||
// Handles objects with the built-in `forEach`, arrays, and raw objects.
|
||||
// Delegates to **ECMAScript 5**'s native `forEach` if available.
|
||||
var each = _.each = _.forEach = function(obj, iterator, context) {
|
||||
if (obj == null) return;
|
||||
if (nativeForEach && obj.forEach === nativeForEach) {
|
||||
obj.forEach(iterator, context);
|
||||
} else if (obj.length === +obj.length) {
|
||||
for (var i = 0, l = obj.length; i < l; i++) {
|
||||
if (i in obj && iterator.call(context, obj[i], i, obj) === breaker) return;
|
||||
}
|
||||
} else {
|
||||
for (var key in obj) {
|
||||
if (_.has(obj, key)) {
|
||||
if (iterator.call(context, obj[key], key, obj) === breaker) return;
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
// Return the results of applying the iterator to each element.
|
||||
// Delegates to **ECMAScript 5**'s native `map` if available.
|
||||
_.map = _.collect = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeMap && obj.map === nativeMap) return obj.map(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
results[results.length] = iterator.call(context, value, index, list);
|
||||
});
|
||||
if (obj.length === +obj.length) results.length = obj.length;
|
||||
return results;
|
||||
};
|
||||
|
||||
// **Reduce** builds up a single result from a list of values, aka `inject`,
|
||||
// or `foldl`. Delegates to **ECMAScript 5**'s native `reduce` if available.
|
||||
_.reduce = _.foldl = _.inject = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduce && obj.reduce === nativeReduce) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduce(iterator, memo) : obj.reduce(iterator);
|
||||
}
|
||||
each(obj, function(value, index, list) {
|
||||
if (!initial) {
|
||||
memo = value;
|
||||
initial = true;
|
||||
} else {
|
||||
memo = iterator.call(context, memo, value, index, list);
|
||||
}
|
||||
});
|
||||
if (!initial) throw new TypeError('Reduce of empty array with no initial value');
|
||||
return memo;
|
||||
};
|
||||
|
||||
// The right-associative version of reduce, also known as `foldr`.
|
||||
// Delegates to **ECMAScript 5**'s native `reduceRight` if available.
|
||||
_.reduceRight = _.foldr = function(obj, iterator, memo, context) {
|
||||
var initial = arguments.length > 2;
|
||||
if (obj == null) obj = [];
|
||||
if (nativeReduceRight && obj.reduceRight === nativeReduceRight) {
|
||||
if (context) iterator = _.bind(iterator, context);
|
||||
return initial ? obj.reduceRight(iterator, memo) : obj.reduceRight(iterator);
|
||||
}
|
||||
var reversed = _.toArray(obj).reverse();
|
||||
if (context && !initial) iterator = _.bind(iterator, context);
|
||||
return initial ? _.reduce(reversed, iterator, memo, context) : _.reduce(reversed, iterator);
|
||||
};
|
||||
|
||||
// Return the first value which passes a truth test. Aliased as `detect`.
|
||||
_.find = _.detect = function(obj, iterator, context) {
|
||||
var result;
|
||||
any(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) {
|
||||
result = value;
|
||||
return true;
|
||||
}
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Return all the elements that pass a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `filter` if available.
|
||||
// Aliased as `select`.
|
||||
_.filter = _.select = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
if (nativeFilter && obj.filter === nativeFilter) return obj.filter(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Return all the elements for which a truth test fails.
|
||||
_.reject = function(obj, iterator, context) {
|
||||
var results = [];
|
||||
if (obj == null) return results;
|
||||
each(obj, function(value, index, list) {
|
||||
if (!iterator.call(context, value, index, list)) results[results.length] = value;
|
||||
});
|
||||
return results;
|
||||
};
|
||||
|
||||
// Determine whether all of the elements match a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `every` if available.
|
||||
// Aliased as `all`.
|
||||
_.every = _.all = function(obj, iterator, context) {
|
||||
var result = true;
|
||||
if (obj == null) return result;
|
||||
if (nativeEvery && obj.every === nativeEvery) return obj.every(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (!(result = result && iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Determine if at least one element in the object matches a truth test.
|
||||
// Delegates to **ECMAScript 5**'s native `some` if available.
|
||||
// Aliased as `any`.
|
||||
var any = _.some = _.any = function(obj, iterator, context) {
|
||||
iterator || (iterator = _.identity);
|
||||
var result = false;
|
||||
if (obj == null) return result;
|
||||
if (nativeSome && obj.some === nativeSome) return obj.some(iterator, context);
|
||||
each(obj, function(value, index, list) {
|
||||
if (result || (result = iterator.call(context, value, index, list))) return breaker;
|
||||
});
|
||||
return !!result;
|
||||
};
|
||||
|
||||
// Determine if a given value is included in the array or object using `===`.
|
||||
// Aliased as `contains`.
|
||||
_.include = _.contains = function(obj, target) {
|
||||
var found = false;
|
||||
if (obj == null) return found;
|
||||
if (nativeIndexOf && obj.indexOf === nativeIndexOf) return obj.indexOf(target) != -1;
|
||||
found = any(obj, function(value) {
|
||||
return value === target;
|
||||
});
|
||||
return found;
|
||||
};
|
||||
|
||||
// Invoke a method (with arguments) on every item in a collection.
|
||||
_.invoke = function(obj, method) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return _.map(obj, function(value) {
|
||||
return (_.isFunction(method) ? method || value : value[method]).apply(value, args);
|
||||
});
|
||||
};
|
||||
|
||||
// Convenience version of a common use case of `map`: fetching a property.
|
||||
_.pluck = function(obj, key) {
|
||||
return _.map(obj, function(value){ return value[key]; });
|
||||
};
|
||||
|
||||
// Return the maximum element or (element-based computation).
|
||||
_.max = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.max.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return -Infinity;
|
||||
var result = {computed : -Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed >= result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Return the minimum element (or element-based computation).
|
||||
_.min = function(obj, iterator, context) {
|
||||
if (!iterator && _.isArray(obj)) return Math.min.apply(Math, obj);
|
||||
if (!iterator && _.isEmpty(obj)) return Infinity;
|
||||
var result = {computed : Infinity};
|
||||
each(obj, function(value, index, list) {
|
||||
var computed = iterator ? iterator.call(context, value, index, list) : value;
|
||||
computed < result.computed && (result = {value : value, computed : computed});
|
||||
});
|
||||
return result.value;
|
||||
};
|
||||
|
||||
// Shuffle an array.
|
||||
_.shuffle = function(obj) {
|
||||
var shuffled = [], rand;
|
||||
each(obj, function(value, index, list) {
|
||||
if (index == 0) {
|
||||
shuffled[0] = value;
|
||||
} else {
|
||||
rand = Math.floor(Math.random() * (index + 1));
|
||||
shuffled[index] = shuffled[rand];
|
||||
shuffled[rand] = value;
|
||||
}
|
||||
});
|
||||
return shuffled;
|
||||
};
|
||||
|
||||
// Sort the object's values by a criterion produced by an iterator.
|
||||
_.sortBy = function(obj, iterator, context) {
|
||||
return _.pluck(_.map(obj, function(value, index, list) {
|
||||
return {
|
||||
value : value,
|
||||
criteria : iterator.call(context, value, index, list)
|
||||
};
|
||||
}).sort(function(left, right) {
|
||||
var a = left.criteria, b = right.criteria;
|
||||
return a < b ? -1 : a > b ? 1 : 0;
|
||||
}), 'value');
|
||||
};
|
||||
|
||||
// Groups the object's values by a criterion. Pass either a string attribute
|
||||
// to group by, or a function that returns the criterion.
|
||||
_.groupBy = function(obj, val) {
|
||||
var result = {};
|
||||
var iterator = _.isFunction(val) ? val : function(obj) { return obj[val]; };
|
||||
each(obj, function(value, index) {
|
||||
var key = iterator(value, index);
|
||||
(result[key] || (result[key] = [])).push(value);
|
||||
});
|
||||
return result;
|
||||
};
|
||||
|
||||
// Use a comparator function to figure out at what index an object should
|
||||
// be inserted so as to maintain order. Uses binary search.
|
||||
_.sortedIndex = function(array, obj, iterator) {
|
||||
iterator || (iterator = _.identity);
|
||||
var low = 0, high = array.length;
|
||||
while (low < high) {
|
||||
var mid = (low + high) >> 1;
|
||||
iterator(array[mid]) < iterator(obj) ? low = mid + 1 : high = mid;
|
||||
}
|
||||
return low;
|
||||
};
|
||||
|
||||
// Safely convert anything iterable into a real, live array.
|
||||
_.toArray = function(iterable) {
|
||||
if (!iterable) return [];
|
||||
if (iterable.toArray) return iterable.toArray();
|
||||
if (_.isArray(iterable)) return slice.call(iterable);
|
||||
if (_.isArguments(iterable)) return slice.call(iterable);
|
||||
return _.values(iterable);
|
||||
};
|
||||
|
||||
// Return the number of elements in an object.
|
||||
_.size = function(obj) {
|
||||
return _.toArray(obj).length;
|
||||
};
|
||||
|
||||
// Array Functions
|
||||
// ---------------
|
||||
|
||||
// Get the first element of an array. Passing **n** will return the first N
|
||||
// values in the array. Aliased as `head`. The **guard** check allows it to work
|
||||
// with `_.map`.
|
||||
_.first = _.head = function(array, n, guard) {
|
||||
return (n != null) && !guard ? slice.call(array, 0, n) : array[0];
|
||||
};
|
||||
|
||||
// Returns everything but the last entry of the array. Especcialy useful on
|
||||
// the arguments object. Passing **n** will return all the values in
|
||||
// the array, excluding the last N. The **guard** check allows it to work with
|
||||
// `_.map`.
|
||||
_.initial = function(array, n, guard) {
|
||||
return slice.call(array, 0, array.length - ((n == null) || guard ? 1 : n));
|
||||
};
|
||||
|
||||
// Get the last element of an array. Passing **n** will return the last N
|
||||
// values in the array. The **guard** check allows it to work with `_.map`.
|
||||
_.last = function(array, n, guard) {
|
||||
if ((n != null) && !guard) {
|
||||
return slice.call(array, Math.max(array.length - n, 0));
|
||||
} else {
|
||||
return array[array.length - 1];
|
||||
}
|
||||
};
|
||||
|
||||
// Returns everything but the first entry of the array. Aliased as `tail`.
|
||||
// Especially useful on the arguments object. Passing an **index** will return
|
||||
// the rest of the values in the array from that index onward. The **guard**
|
||||
// check allows it to work with `_.map`.
|
||||
_.rest = _.tail = function(array, index, guard) {
|
||||
return slice.call(array, (index == null) || guard ? 1 : index);
|
||||
};
|
||||
|
||||
// Trim out all falsy values from an array.
|
||||
_.compact = function(array) {
|
||||
return _.filter(array, function(value){ return !!value; });
|
||||
};
|
||||
|
||||
// Return a completely flattened version of an array.
|
||||
_.flatten = function(array, shallow) {
|
||||
return _.reduce(array, function(memo, value) {
|
||||
if (_.isArray(value)) return memo.concat(shallow ? value : _.flatten(value));
|
||||
memo[memo.length] = value;
|
||||
return memo;
|
||||
}, []);
|
||||
};
|
||||
|
||||
// Return a version of the array that does not contain the specified value(s).
|
||||
_.without = function(array) {
|
||||
return _.difference(array, slice.call(arguments, 1));
|
||||
};
|
||||
|
||||
// Produce a duplicate-free version of the array. If the array has already
|
||||
// been sorted, you have the option of using a faster algorithm.
|
||||
// Aliased as `unique`.
|
||||
_.uniq = _.unique = function(array, isSorted, iterator) {
|
||||
var initial = iterator ? _.map(array, iterator) : array;
|
||||
var result = [];
|
||||
_.reduce(initial, function(memo, el, i) {
|
||||
if (0 == i || (isSorted === true ? _.last(memo) != el : !_.include(memo, el))) {
|
||||
memo[memo.length] = el;
|
||||
result[result.length] = array[i];
|
||||
}
|
||||
return memo;
|
||||
}, []);
|
||||
return result;
|
||||
};
|
||||
|
||||
// Produce an array that contains the union: each distinct element from all of
|
||||
// the passed-in arrays.
|
||||
_.union = function() {
|
||||
return _.uniq(_.flatten(arguments, true));
|
||||
};
|
||||
|
||||
// Produce an array that contains every item shared between all the
|
||||
// passed-in arrays. (Aliased as "intersect" for back-compat.)
|
||||
_.intersection = _.intersect = function(array) {
|
||||
var rest = slice.call(arguments, 1);
|
||||
return _.filter(_.uniq(array), function(item) {
|
||||
return _.every(rest, function(other) {
|
||||
return _.indexOf(other, item) >= 0;
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
// Take the difference between one array and a number of other arrays.
|
||||
// Only the elements present in just the first array will remain.
|
||||
_.difference = function(array) {
|
||||
var rest = _.flatten(slice.call(arguments, 1));
|
||||
return _.filter(array, function(value){ return !_.include(rest, value); });
|
||||
};
|
||||
|
||||
// Zip together multiple lists into a single array -- elements that share
|
||||
// an index go together.
|
||||
_.zip = function() {
|
||||
var args = slice.call(arguments);
|
||||
var length = _.max(_.pluck(args, 'length'));
|
||||
var results = new Array(length);
|
||||
for (var i = 0; i < length; i++) results[i] = _.pluck(args, "" + i);
|
||||
return results;
|
||||
};
|
||||
|
||||
// If the browser doesn't supply us with indexOf (I'm looking at you, **MSIE**),
|
||||
// we need this function. Return the position of the first occurrence of an
|
||||
// item in an array, or -1 if the item is not included in the array.
|
||||
// Delegates to **ECMAScript 5**'s native `indexOf` if available.
|
||||
// If the array is large and already in sort order, pass `true`
|
||||
// for **isSorted** to use binary search.
|
||||
_.indexOf = function(array, item, isSorted) {
|
||||
if (array == null) return -1;
|
||||
var i, l;
|
||||
if (isSorted) {
|
||||
i = _.sortedIndex(array, item);
|
||||
return array[i] === item ? i : -1;
|
||||
}
|
||||
if (nativeIndexOf && array.indexOf === nativeIndexOf) return array.indexOf(item);
|
||||
for (i = 0, l = array.length; i < l; i++) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Delegates to **ECMAScript 5**'s native `lastIndexOf` if available.
|
||||
_.lastIndexOf = function(array, item) {
|
||||
if (array == null) return -1;
|
||||
if (nativeLastIndexOf && array.lastIndexOf === nativeLastIndexOf) return array.lastIndexOf(item);
|
||||
var i = array.length;
|
||||
while (i--) if (i in array && array[i] === item) return i;
|
||||
return -1;
|
||||
};
|
||||
|
||||
// Generate an integer Array containing an arithmetic progression. A port of
|
||||
// the native Python `range()` function. See
|
||||
// [the Python documentation](http://docs.python.org/library/functions.html#range).
|
||||
_.range = function(start, stop, step) {
|
||||
if (arguments.length <= 1) {
|
||||
stop = start || 0;
|
||||
start = 0;
|
||||
}
|
||||
step = arguments[2] || 1;
|
||||
|
||||
var len = Math.max(Math.ceil((stop - start) / step), 0);
|
||||
var idx = 0;
|
||||
var range = new Array(len);
|
||||
|
||||
while(idx < len) {
|
||||
range[idx++] = start;
|
||||
start += step;
|
||||
}
|
||||
|
||||
return range;
|
||||
};
|
||||
|
||||
// Function (ahem) Functions
|
||||
// ------------------
|
||||
|
||||
// Reusable constructor function for prototype setting.
|
||||
var ctor = function(){};
|
||||
|
||||
// Create a function bound to a given object (assigning `this`, and arguments,
|
||||
// optionally). Binding with arguments is also known as `curry`.
|
||||
// Delegates to **ECMAScript 5**'s native `Function.bind` if available.
|
||||
// We check for `func.bind` first, to fail fast when `func` is undefined.
|
||||
_.bind = function bind(func, context) {
|
||||
var bound, args;
|
||||
if (func.bind === nativeBind && nativeBind) return nativeBind.apply(func, slice.call(arguments, 1));
|
||||
if (!_.isFunction(func)) throw new TypeError;
|
||||
args = slice.call(arguments, 2);
|
||||
return bound = function() {
|
||||
if (!(this instanceof bound)) return func.apply(context, args.concat(slice.call(arguments)));
|
||||
ctor.prototype = func.prototype;
|
||||
var self = new ctor;
|
||||
var result = func.apply(self, args.concat(slice.call(arguments)));
|
||||
if (Object(result) === result) return result;
|
||||
return self;
|
||||
};
|
||||
};
|
||||
|
||||
// Bind all of an object's methods to that object. Useful for ensuring that
|
||||
// all callbacks defined on an object belong to it.
|
||||
_.bindAll = function(obj) {
|
||||
var funcs = slice.call(arguments, 1);
|
||||
if (funcs.length == 0) funcs = _.functions(obj);
|
||||
each(funcs, function(f) { obj[f] = _.bind(obj[f], obj); });
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Memoize an expensive function by storing its results.
|
||||
_.memoize = function(func, hasher) {
|
||||
var memo = {};
|
||||
hasher || (hasher = _.identity);
|
||||
return function() {
|
||||
var key = hasher.apply(this, arguments);
|
||||
return _.has(memo, key) ? memo[key] : (memo[key] = func.apply(this, arguments));
|
||||
};
|
||||
};
|
||||
|
||||
// Delays a function for the given number of milliseconds, and then calls
|
||||
// it with the arguments supplied.
|
||||
_.delay = function(func, wait) {
|
||||
var args = slice.call(arguments, 2);
|
||||
return setTimeout(function(){ return func.apply(func, args); }, wait);
|
||||
};
|
||||
|
||||
// Defers a function, scheduling it to run after the current call stack has
|
||||
// cleared.
|
||||
_.defer = function(func) {
|
||||
return _.delay.apply(_, [func, 1].concat(slice.call(arguments, 1)));
|
||||
};
|
||||
|
||||
// Returns a function, that, when invoked, will only be triggered at most once
|
||||
// during a given window of time.
|
||||
_.throttle = function(func, wait) {
|
||||
var context, args, timeout, throttling, more;
|
||||
var whenDone = _.debounce(function(){ more = throttling = false; }, wait);
|
||||
return function() {
|
||||
context = this; args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
if (more) func.apply(context, args);
|
||||
whenDone();
|
||||
};
|
||||
if (!timeout) timeout = setTimeout(later, wait);
|
||||
if (throttling) {
|
||||
more = true;
|
||||
} else {
|
||||
func.apply(context, args);
|
||||
}
|
||||
whenDone();
|
||||
throttling = true;
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function, that, as long as it continues to be invoked, will not
|
||||
// be triggered. The function will be called after it stops being called for
|
||||
// N milliseconds.
|
||||
_.debounce = function(func, wait) {
|
||||
var timeout;
|
||||
return function() {
|
||||
var context = this, args = arguments;
|
||||
var later = function() {
|
||||
timeout = null;
|
||||
func.apply(context, args);
|
||||
};
|
||||
clearTimeout(timeout);
|
||||
timeout = setTimeout(later, wait);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will be executed at most one time, no matter how
|
||||
// often you call it. Useful for lazy initialization.
|
||||
_.once = function(func) {
|
||||
var ran = false, memo;
|
||||
return function() {
|
||||
if (ran) return memo;
|
||||
ran = true;
|
||||
return memo = func.apply(this, arguments);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns the first function passed as an argument to the second,
|
||||
// allowing you to adjust arguments, run code before and after, and
|
||||
// conditionally execute the original function.
|
||||
_.wrap = function(func, wrapper) {
|
||||
return function() {
|
||||
var args = [func].concat(slice.call(arguments, 0));
|
||||
return wrapper.apply(this, args);
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that is the composition of a list of functions, each
|
||||
// consuming the return value of the function that follows.
|
||||
_.compose = function() {
|
||||
var funcs = arguments;
|
||||
return function() {
|
||||
var args = arguments;
|
||||
for (var i = funcs.length - 1; i >= 0; i--) {
|
||||
args = [funcs[i].apply(this, args)];
|
||||
}
|
||||
return args[0];
|
||||
};
|
||||
};
|
||||
|
||||
// Returns a function that will only be executed after being called N times.
|
||||
_.after = function(times, func) {
|
||||
if (times <= 0) return func();
|
||||
return function() {
|
||||
if (--times < 1) { return func.apply(this, arguments); }
|
||||
};
|
||||
};
|
||||
|
||||
// Object Functions
|
||||
// ----------------
|
||||
|
||||
// Retrieve the names of an object's properties.
|
||||
// Delegates to **ECMAScript 5**'s native `Object.keys`
|
||||
_.keys = nativeKeys || function(obj) {
|
||||
if (obj !== Object(obj)) throw new TypeError('Invalid object');
|
||||
var keys = [];
|
||||
for (var key in obj) if (_.has(obj, key)) keys[keys.length] = key;
|
||||
return keys;
|
||||
};
|
||||
|
||||
// Retrieve the values of an object's properties.
|
||||
_.values = function(obj) {
|
||||
return _.map(obj, _.identity);
|
||||
};
|
||||
|
||||
// Return a sorted list of the function names available on the object.
|
||||
// Aliased as `methods`
|
||||
_.functions = _.methods = function(obj) {
|
||||
var names = [];
|
||||
for (var key in obj) {
|
||||
if (_.isFunction(obj[key])) names.push(key);
|
||||
}
|
||||
return names.sort();
|
||||
};
|
||||
|
||||
// Extend a given object with all the properties in passed-in object(s).
|
||||
_.extend = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Fill in a given object with default properties.
|
||||
_.defaults = function(obj) {
|
||||
each(slice.call(arguments, 1), function(source) {
|
||||
for (var prop in source) {
|
||||
if (obj[prop] == null) obj[prop] = source[prop];
|
||||
}
|
||||
});
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Create a (shallow-cloned) duplicate of an object.
|
||||
_.clone = function(obj) {
|
||||
if (!_.isObject(obj)) return obj;
|
||||
return _.isArray(obj) ? obj.slice() : _.extend({}, obj);
|
||||
};
|
||||
|
||||
// Invokes interceptor with the obj, and then returns obj.
|
||||
// The primary purpose of this method is to "tap into" a method chain, in
|
||||
// order to perform operations on intermediate results within the chain.
|
||||
_.tap = function(obj, interceptor) {
|
||||
interceptor(obj);
|
||||
return obj;
|
||||
};
|
||||
|
||||
// Internal recursive comparison function.
|
||||
function eq(a, b, stack) {
|
||||
// Identical objects are equal. `0 === -0`, but they aren't identical.
|
||||
// See the Harmony `egal` proposal: http://wiki.ecmascript.org/doku.php?id=harmony:egal.
|
||||
if (a === b) return a !== 0 || 1 / a == 1 / b;
|
||||
// A strict comparison is necessary because `null == undefined`.
|
||||
if (a == null || b == null) return a === b;
|
||||
// Unwrap any wrapped objects.
|
||||
if (a._chain) a = a._wrapped;
|
||||
if (b._chain) b = b._wrapped;
|
||||
// Invoke a custom `isEqual` method if one is provided.
|
||||
if (a.isEqual && _.isFunction(a.isEqual)) return a.isEqual(b);
|
||||
if (b.isEqual && _.isFunction(b.isEqual)) return b.isEqual(a);
|
||||
// Compare `[[Class]]` names.
|
||||
var className = toString.call(a);
|
||||
if (className != toString.call(b)) return false;
|
||||
switch (className) {
|
||||
// Strings, numbers, dates, and booleans are compared by value.
|
||||
case '[object String]':
|
||||
// Primitives and their corresponding object wrappers are equivalent; thus, `"5"` is
|
||||
// equivalent to `new String("5")`.
|
||||
return a == String(b);
|
||||
case '[object Number]':
|
||||
// `NaN`s are equivalent, but non-reflexive. An `egal` comparison is performed for
|
||||
// other numeric values.
|
||||
return a != +a ? b != +b : (a == 0 ? 1 / a == 1 / b : a == +b);
|
||||
case '[object Date]':
|
||||
case '[object Boolean]':
|
||||
// Coerce dates and booleans to numeric primitive values. Dates are compared by their
|
||||
// millisecond representations. Note that invalid dates with millisecond representations
|
||||
// of `NaN` are not equivalent.
|
||||
return +a == +b;
|
||||
// RegExps are compared by their source patterns and flags.
|
||||
case '[object RegExp]':
|
||||
return a.source == b.source &&
|
||||
a.global == b.global &&
|
||||
a.multiline == b.multiline &&
|
||||
a.ignoreCase == b.ignoreCase;
|
||||
}
|
||||
if (typeof a != 'object' || typeof b != 'object') return false;
|
||||
// Assume equality for cyclic structures. The algorithm for detecting cyclic
|
||||
// structures is adapted from ES 5.1 section 15.12.3, abstract operation `JO`.
|
||||
var length = stack.length;
|
||||
while (length--) {
|
||||
// Linear search. Performance is inversely proportional to the number of
|
||||
// unique nested structures.
|
||||
if (stack[length] == a) return true;
|
||||
}
|
||||
// Add the first object to the stack of traversed objects.
|
||||
stack.push(a);
|
||||
var size = 0, result = true;
|
||||
// Recursively compare objects and arrays.
|
||||
if (className == '[object Array]') {
|
||||
// Compare array lengths to determine if a deep comparison is necessary.
|
||||
size = a.length;
|
||||
result = size == b.length;
|
||||
if (result) {
|
||||
// Deep compare the contents, ignoring non-numeric properties.
|
||||
while (size--) {
|
||||
// Ensure commutative equality for sparse arrays.
|
||||
if (!(result = size in a == size in b && eq(a[size], b[size], stack))) break;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Objects with different constructors are not equivalent.
|
||||
if ('constructor' in a != 'constructor' in b || a.constructor != b.constructor) return false;
|
||||
// Deep compare objects.
|
||||
for (var key in a) {
|
||||
if (_.has(a, key)) {
|
||||
// Count the expected number of properties.
|
||||
size++;
|
||||
// Deep compare each member.
|
||||
if (!(result = _.has(b, key) && eq(a[key], b[key], stack))) break;
|
||||
}
|
||||
}
|
||||
// Ensure that both objects contain the same number of properties.
|
||||
if (result) {
|
||||
for (key in b) {
|
||||
if (_.has(b, key) && !(size--)) break;
|
||||
}
|
||||
result = !size;
|
||||
}
|
||||
}
|
||||
// Remove the first object from the stack of traversed objects.
|
||||
stack.pop();
|
||||
return result;
|
||||
}
|
||||
|
||||
// Perform a deep comparison to check if two objects are equal.
|
||||
_.isEqual = function(a, b) {
|
||||
return eq(a, b, []);
|
||||
};
|
||||
|
||||
// Is a given array, string, or object empty?
|
||||
// An "empty" object has no enumerable own-properties.
|
||||
_.isEmpty = function(obj) {
|
||||
if (_.isArray(obj) || _.isString(obj)) return obj.length === 0;
|
||||
for (var key in obj) if (_.has(obj, key)) return false;
|
||||
return true;
|
||||
};
|
||||
|
||||
// Is a given value a DOM element?
|
||||
_.isElement = function(obj) {
|
||||
return !!(obj && obj.nodeType == 1);
|
||||
};
|
||||
|
||||
// Is a given value an array?
|
||||
// Delegates to ECMA5's native Array.isArray
|
||||
_.isArray = nativeIsArray || function(obj) {
|
||||
return toString.call(obj) == '[object Array]';
|
||||
};
|
||||
|
||||
// Is a given variable an object?
|
||||
_.isObject = function(obj) {
|
||||
return obj === Object(obj);
|
||||
};
|
||||
|
||||
// Is a given variable an arguments object?
|
||||
_.isArguments = function(obj) {
|
||||
return toString.call(obj) == '[object Arguments]';
|
||||
};
|
||||
if (!_.isArguments(arguments)) {
|
||||
_.isArguments = function(obj) {
|
||||
return !!(obj && _.has(obj, 'callee'));
|
||||
};
|
||||
}
|
||||
|
||||
// Is a given value a function?
|
||||
_.isFunction = function(obj) {
|
||||
return toString.call(obj) == '[object Function]';
|
||||
};
|
||||
|
||||
// Is a given value a string?
|
||||
_.isString = function(obj) {
|
||||
return toString.call(obj) == '[object String]';
|
||||
};
|
||||
|
||||
// Is a given value a number?
|
||||
_.isNumber = function(obj) {
|
||||
return toString.call(obj) == '[object Number]';
|
||||
};
|
||||
|
||||
// Is the given value `NaN`?
|
||||
_.isNaN = function(obj) {
|
||||
// `NaN` is the only value for which `===` is not reflexive.
|
||||
return obj !== obj;
|
||||
};
|
||||
|
||||
// Is a given value a boolean?
|
||||
_.isBoolean = function(obj) {
|
||||
return obj === true || obj === false || toString.call(obj) == '[object Boolean]';
|
||||
};
|
||||
|
||||
// Is a given value a date?
|
||||
_.isDate = function(obj) {
|
||||
return toString.call(obj) == '[object Date]';
|
||||
};
|
||||
|
||||
// Is the given value a regular expression?
|
||||
_.isRegExp = function(obj) {
|
||||
return toString.call(obj) == '[object RegExp]';
|
||||
};
|
||||
|
||||
// Is a given value equal to null?
|
||||
_.isNull = function(obj) {
|
||||
return obj === null;
|
||||
};
|
||||
|
||||
// Is a given variable undefined?
|
||||
_.isUndefined = function(obj) {
|
||||
return obj === void 0;
|
||||
};
|
||||
|
||||
// Has own property?
|
||||
_.has = function(obj, key) {
|
||||
return hasOwnProperty.call(obj, key);
|
||||
};
|
||||
|
||||
// Utility Functions
|
||||
// -----------------
|
||||
|
||||
// Run Underscore.js in *noConflict* mode, returning the `_` variable to its
|
||||
// previous owner. Returns a reference to the Underscore object.
|
||||
_.noConflict = function() {
|
||||
root._ = previousUnderscore;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Keep the identity function around for default iterators.
|
||||
_.identity = function(value) {
|
||||
return value;
|
||||
};
|
||||
|
||||
// Run a function **n** times.
|
||||
_.times = function (n, iterator, context) {
|
||||
for (var i = 0; i < n; i++) iterator.call(context, i);
|
||||
};
|
||||
|
||||
// Escape a string for HTML interpolation.
|
||||
_.escape = function(string) {
|
||||
return (''+string).replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>').replace(/"/g, '"').replace(/'/g, ''').replace(/\//g,'/');
|
||||
};
|
||||
|
||||
// Add your own custom functions to the Underscore object, ensuring that
|
||||
// they're correctly added to the OOP wrapper as well.
|
||||
_.mixin = function(obj) {
|
||||
each(_.functions(obj), function(name){
|
||||
addToWrapper(name, _[name] = obj[name]);
|
||||
});
|
||||
};
|
||||
|
||||
// Generate a unique integer id (unique within the entire client session).
|
||||
// Useful for temporary DOM ids.
|
||||
var idCounter = 0;
|
||||
_.uniqueId = function(prefix) {
|
||||
var id = idCounter++;
|
||||
return prefix ? prefix + id : id;
|
||||
};
|
||||
|
||||
// By default, Underscore uses ERB-style template delimiters, change the
|
||||
// following template settings to use alternative delimiters.
|
||||
_.templateSettings = {
|
||||
evaluate : /<%([\s\S]+?)%>/g,
|
||||
interpolate : /<%=([\s\S]+?)%>/g,
|
||||
escape : /<%-([\s\S]+?)%>/g
|
||||
};
|
||||
|
||||
// When customizing `templateSettings`, if you don't want to define an
|
||||
// interpolation, evaluation or escaping regex, we need one that is
|
||||
// guaranteed not to match.
|
||||
var noMatch = /.^/;
|
||||
|
||||
// Within an interpolation, evaluation, or escaping, remove HTML escaping
|
||||
// that had been previously added.
|
||||
var unescape = function(code) {
|
||||
return code.replace(/\\\\/g, '\\').replace(/\\'/g, "'");
|
||||
};
|
||||
|
||||
// JavaScript micro-templating, similar to John Resig's implementation.
|
||||
// Underscore templating handles arbitrary delimiters, preserves whitespace,
|
||||
// and correctly escapes quotes within interpolated code.
|
||||
_.template = function(str, data) {
|
||||
var c = _.templateSettings;
|
||||
var tmpl = 'var __p=[],print=function(){__p.push.apply(__p,arguments);};' +
|
||||
'with(obj||{}){__p.push(\'' +
|
||||
str.replace(/\\/g, '\\\\')
|
||||
.replace(/'/g, "\\'")
|
||||
.replace(c.escape || noMatch, function(match, code) {
|
||||
return "',_.escape(" + unescape(code) + "),'";
|
||||
})
|
||||
.replace(c.interpolate || noMatch, function(match, code) {
|
||||
return "'," + unescape(code) + ",'";
|
||||
})
|
||||
.replace(c.evaluate || noMatch, function(match, code) {
|
||||
return "');" + unescape(code).replace(/[\r\n\t]/g, ' ') + ";__p.push('";
|
||||
})
|
||||
.replace(/\r/g, '\\r')
|
||||
.replace(/\n/g, '\\n')
|
||||
.replace(/\t/g, '\\t')
|
||||
+ "');}return __p.join('');";
|
||||
var func = new Function('obj', '_', tmpl);
|
||||
if (data) return func(data, _);
|
||||
return function(data) {
|
||||
return func.call(this, data, _);
|
||||
};
|
||||
};
|
||||
|
||||
// Add a "chain" function, which will delegate to the wrapper.
|
||||
_.chain = function(obj) {
|
||||
return _(obj).chain();
|
||||
};
|
||||
|
||||
// The OOP Wrapper
|
||||
// ---------------
|
||||
|
||||
// If Underscore is called as a function, it returns a wrapped object that
|
||||
// can be used OO-style. This wrapper holds altered versions of all the
|
||||
// underscore functions. Wrapped objects may be chained.
|
||||
var wrapper = function(obj) { this._wrapped = obj; };
|
||||
|
||||
// Expose `wrapper.prototype` as `_.prototype`
|
||||
_.prototype = wrapper.prototype;
|
||||
|
||||
// Helper function to continue chaining intermediate results.
|
||||
var result = function(obj, chain) {
|
||||
return chain ? _(obj).chain() : obj;
|
||||
};
|
||||
|
||||
// A method to easily add functions to the OOP wrapper.
|
||||
var addToWrapper = function(name, func) {
|
||||
wrapper.prototype[name] = function() {
|
||||
var args = slice.call(arguments);
|
||||
unshift.call(args, this._wrapped);
|
||||
return result(func.apply(_, args), this._chain);
|
||||
};
|
||||
};
|
||||
|
||||
// Add all of the Underscore functions to the wrapper object.
|
||||
_.mixin(_);
|
||||
|
||||
// Add all mutator Array functions to the wrapper.
|
||||
each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
var wrapped = this._wrapped;
|
||||
method.apply(wrapped, arguments);
|
||||
var length = wrapped.length;
|
||||
if ((name == 'shift' || name == 'splice') && length === 0) delete wrapped[0];
|
||||
return result(wrapped, this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Add all accessor Array functions to the wrapper.
|
||||
each(['concat', 'join', 'slice'], function(name) {
|
||||
var method = ArrayProto[name];
|
||||
wrapper.prototype[name] = function() {
|
||||
return result(method.apply(this._wrapped, arguments), this._chain);
|
||||
};
|
||||
});
|
||||
|
||||
// Start chaining a wrapped Underscore object.
|
||||
wrapper.prototype.chain = function() {
|
||||
this._chain = true;
|
||||
return this;
|
||||
};
|
||||
|
||||
// Extracts the result from a wrapped and chained object.
|
||||
wrapper.prototype.value = function() {
|
||||
return this._wrapped;
|
||||
};
|
||||
|
||||
}).call(this);
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 372 B After Width: | Height: | Size: 345 B |
BIN
_static/up.png
BIN
_static/up.png
Binary file not shown.
|
Before Width: | Height: | Size: 363 B After Width: | Height: | Size: 345 B |
|
|
@ -2,9 +2,9 @@
|
|||
* websupport.js
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* sphinx.websupport utilties for all documentation.
|
||||
* sphinx.websupport utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
|
@ -50,51 +50,51 @@
|
|||
}
|
||||
|
||||
function initEvents() {
|
||||
$('a.comment-close').live("click", function(event) {
|
||||
$(document).on("click", 'a.comment-close', function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.vote').live("click", function(event) {
|
||||
$(document).on("click", 'a.vote', function(event) {
|
||||
event.preventDefault();
|
||||
handleVote($(this));
|
||||
});
|
||||
$('a.reply').live("click", function(event) {
|
||||
$(document).on("click", 'a.reply', function(event) {
|
||||
event.preventDefault();
|
||||
openReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.close-reply').live("click", function(event) {
|
||||
$(document).on("click", 'a.close-reply', function(event) {
|
||||
event.preventDefault();
|
||||
closeReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.sort-option').live("click", function(event) {
|
||||
$(document).on("click", 'a.sort-option', function(event) {
|
||||
event.preventDefault();
|
||||
handleReSort($(this));
|
||||
});
|
||||
$('a.show-proposal').live("click", function(event) {
|
||||
$(document).on("click", 'a.show-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
showProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.hide-proposal').live("click", function(event) {
|
||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.show-propose-change').live("click", function(event) {
|
||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
showProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.hide-propose-change').live("click", function(event) {
|
||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.accept-comment').live("click", function(event) {
|
||||
$(document).on("click", 'a.accept-comment', function(event) {
|
||||
event.preventDefault();
|
||||
acceptComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.delete-comment').live("click", function(event) {
|
||||
$(document).on("click", 'a.delete-comment', function(event) {
|
||||
event.preventDefault();
|
||||
deleteComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$('a.comment-markup').live("click", function(event) {
|
||||
$(document).on("click", 'a.comment-markup', function(event) {
|
||||
event.preventDefault();
|
||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
||||
});
|
||||
|
|
@ -700,8 +700,8 @@
|
|||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
||||
<div class="comment-markup-box" id="mb<%id%>">\
|
||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
||||
<tt>``code``</tt>, \
|
||||
code blocks: <tt>::</tt> and an indented block after blank line</div>\
|
||||
<code>``code``</code>, \
|
||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<p class="propose-button">\
|
||||
|
|
|
|||
176
api.entry.html
176
api.entry.html
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.entry — python-feedgen 0.4.0 documentation</title>
|
||||
<title>feedgen.entry — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,17 +23,19 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="index.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 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>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.entry</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.feed.html">feedgen.feed</a>
|
||||
|
|
@ -63,21 +65,21 @@
|
|||
</table>
|
||||
<dl class="class">
|
||||
<dt id="feedgen.entry.FeedEntry">
|
||||
<em class="property">class </em><tt class="descclassname">feedgen.entry.</tt><tt class="descname">FeedEntry</tt><a class="headerlink" href="#feedgen.entry.FeedEntry" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.entry.</code><code class="descname">FeedEntry</code><a class="headerlink" href="#feedgen.entry.FeedEntry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>FeedEntry call representing an ATOM feeds entry node or an RSS feeds item
|
||||
node.</p>
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.atom_entry">
|
||||
<tt class="descname">atom_entry</tt><big>(</big><em>extensions=True</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.atom_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">atom_entry</code><span class="sig-paren">(</span><em>extensions=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.atom_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create an ATOM entry and return it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.author">
|
||||
<tt class="descname">author</tt><big>(</big><em>author=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set autor data. An author element is a dict containing a name,
|
||||
an email adress and a uri. Name is mandatory for ATOM, email is mandatory
|
||||
for RSS.</p>
|
||||
<code class="descname">author</code><span class="sig-paren">(</span><em>author=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set autor data. An author element is a dict containing a
|
||||
name, an email adress and a uri. Name is mandatory for ATOM, email is
|
||||
mandatory for RSS.</p>
|
||||
<p>This method can be called with:
|
||||
- the fields of an author as keyword arguments
|
||||
- the fields of an author as a dictionary
|
||||
|
|
@ -99,14 +101,14 @@ for RSS.</p>
|
|||
</tbody>
|
||||
</table>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">author</span><span class="p">(</span> <span class="p">{</span> <span class="s1">'name'</span><span class="p">:</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">:</span><span class="s1">'jdoe@example.com'</span> <span class="p">}</span> <span class="p">)</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">author</span><span class="p">({</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">:</span><span class="s1">'jdoe@example.com'</span><span class="p">})</span>
|
||||
<span class="go">[{'name':'John Doe','email':'jdoe@example.com'}]</span>
|
||||
|
||||
<span class="gp">>>> </span><span class="n">author</span><span class="p">([{</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'Mr. X'</span><span class="p">},{</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'Max'</span><span class="p">}])</span>
|
||||
<span class="gp">>>> </span><span class="n">author</span><span class="p">([{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Mr. X'</span><span class="p">},</span> <span class="p">{</span><span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Max'</span><span class="p">}])</span>
|
||||
<span class="go">[{'name':'John Doe','email':'jdoe@example.com'},</span>
|
||||
<span class="go"> {'name':'John Doe'}, {'name':'Max'}]</span>
|
||||
|
||||
<span class="gp">>>> </span><span class="n">author</span><span class="p">(</span> <span class="n">name</span><span class="o">=</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="n">email</span><span class="o">=</span><span class="s1">'jdoe@example.com'</span><span class="p">,</span> <span class="n">replace</span><span class="o">=</span><span class="bp">True</span> <span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">author</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="n">email</span><span class="o">=</span><span class="s1">'jdoe@example.com'</span><span class="p">,</span> <span class="n">replace</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="go">[{'name':'John Doe','email':'jdoe@example.com'}]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
@ -114,7 +116,7 @@ for RSS.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.category">
|
||||
<tt class="descname">category</tt><big>(</big><em>category=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.category" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">category</code><span class="sig-paren">(</span><em>category=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set categories that the entry belongs to.</p>
|
||||
<p>This method can be called with:
|
||||
- the fields of a category as keyword arguments
|
||||
|
|
@ -124,8 +126,8 @@ for RSS.</p>
|
|||
- <em>term</em> identifies the category
|
||||
- <em>scheme</em> identifies the categorization scheme via a URI.
|
||||
- <em>label</em> provides a human-readable label for display</p>
|
||||
<p>If a label is present it is used for the RSS feeds. Otherwise the term is
|
||||
used. The scheme is used for the domain attribute in RSS.</p>
|
||||
<p>If a label is present it is used for the RSS feeds. Otherwise the term
|
||||
is used. The scheme is used for the domain attribute in RSS.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -145,9 +147,9 @@ used. The scheme is used for the domain attribute in RSS.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.comments">
|
||||
<tt class="descname">comments</tt><big>(</big><em>comments=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.comments" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the the value of comments which is the url of the comments
|
||||
page for the item. This is a RSS only value.</p>
|
||||
<code class="descname">comments</code><span class="sig-paren">(</span><em>comments=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.comments" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the the value of comments which is the url of the
|
||||
comments page for the item. This is a RSS only value.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -162,11 +164,11 @@ page for the item. This is a RSS only value.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.content">
|
||||
<tt class="descname">content</tt><big>(</big><em>content=None</em>, <em>src=None</em>, <em>type=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.content" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">content</code><span class="sig-paren">(</span><em>content=None</em>, <em>src=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.content" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the cntent of the entry which contains or links to the
|
||||
complete content of the entry. Content must be provided for ATOM entries
|
||||
if there is no alternate link, and should be provided if there is no
|
||||
summary. If the content is set (not linked) it will also set
|
||||
complete content of the entry. Content must be provided for ATOM
|
||||
entries if there is no alternate link, and should be provided if there
|
||||
is no summary. If the content is set (not linked) it will also set
|
||||
rss:description.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -188,7 +190,7 @@ rss:description.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.contributor">
|
||||
<tt class="descname">contributor</tt><big>(</big><em>contributor=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.contributor" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">contributor</code><span class="sig-paren">(</span><em>contributor=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.contributor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the contributor data of the feed. This is an ATOM only
|
||||
value.</p>
|
||||
<p>This method can be called with:
|
||||
|
|
@ -204,7 +206,8 @@ value.</p>
|
|||
<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>contributor</strong> – Dictionary or list of dictionaries with contributor data.</li>
|
||||
<li><strong>contributor</strong> – Dictionary or list of dictionaries with contributor
|
||||
data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
|
|
@ -218,18 +221,19 @@ value.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.description">
|
||||
<tt class="descname">description</tt><big>(</big><em>description=None</em>, <em>isSummary=False</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.description" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">description</code><span class="sig-paren">(</span><em>description=None</em>, <em>isSummary=False</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the description value which is the item synopsis.
|
||||
Description is an RSS only element. For ATOM feeds it is split in summary
|
||||
and content. The isSummary parameter can be used to control which ATOM
|
||||
value is set when setting description.</p>
|
||||
Description is an RSS only element. For ATOM feeds it is split in
|
||||
summary and content. The isSummary parameter can be used to control
|
||||
which ATOM value is set when setting description.</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>description</strong> – Description of the entry.</li>
|
||||
<li><strong>isSummary</strong> – If the description should be used as content or summary.</li>
|
||||
<li><strong>isSummary</strong> – If the description should be used as content or
|
||||
summary.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -242,13 +246,13 @@ value is set when setting description.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.enclosure">
|
||||
<tt class="descname">enclosure</tt><big>(</big><em>url=None</em>, <em>length=None</em>, <em>type=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.enclosure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the value of enclosure which describes a media object that
|
||||
is attached to the item. This is a RSS only value which is represented by
|
||||
link(rel=enclosure) in ATOM. ATOM feeds can furthermore contain several
|
||||
enclosures while RSS may contain only one. That is why this method, if
|
||||
repeatedly called, will add more than one enclosures to the feed.
|
||||
However, only the last one is used for RSS.</p>
|
||||
<code class="descname">enclosure</code><span class="sig-paren">(</span><em>url=None</em>, <em>length=None</em>, <em>type=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.enclosure" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the value of enclosure which describes a media object
|
||||
that is attached to the item. This is a RSS only value which is
|
||||
represented by link(rel=enclosure) in ATOM. ATOM feeds can furthermore
|
||||
contain several enclosures while RSS may contain only one. That is why
|
||||
this method, if repeatedly called, will add more than one enclosures to
|
||||
the feed. However, only the last one is used for RSS.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -269,9 +273,9 @@ However, only the last one is used for RSS.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.guid">
|
||||
<tt class="descname">guid</tt><big>(</big><em>guid=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.guid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the entries guid which is a string that uniquely identifies
|
||||
the item. This will also set atom:id.</p>
|
||||
<code class="descname">guid</code><span class="sig-paren">(</span><em>guid=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.guid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the entries guid which is a string that uniquely
|
||||
identifies the item. This will also set atom:id.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -286,11 +290,12 @@ the item. This will also set atom:id.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.id">
|
||||
<tt class="descname">id</tt><big>(</big><em>id=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the entry id which identifies the entry using a universally
|
||||
unique and permanent URI. Two entries in a feed can have the same value
|
||||
for id if they represent the same entry at different points in time. This
|
||||
method will also set rss:guid. Id is mandatory for an ATOM entry.</p>
|
||||
<code class="descname">id</code><span class="sig-paren">(</span><em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the entry id which identifies the entry using a
|
||||
universally unique and permanent URI. Two entries in a feed can have
|
||||
the same value for id if they represent the same entry at different
|
||||
points in time. This method will also set rss:guid. Id is mandatory
|
||||
for an ATOM entry.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -305,9 +310,10 @@ method will also set rss:guid. Id is mandatory for an ATOM entry.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.link">
|
||||
<tt class="descname">link</tt><big>(</big><em>link=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.link" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set link data. An link element is a dict with the fields href,
|
||||
rel, type, hreflang, title, and length. Href is mandatory for ATOM.</p>
|
||||
<code class="descname">link</code><span class="sig-paren">(</span><em>link=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.link" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set link data. An link element is a dict with the fields
|
||||
href, rel, type, hreflang, title, and length. Href is mandatory for
|
||||
ATOM.</p>
|
||||
<p>This method can be called with:
|
||||
- the fields of a link as keyword arguments
|
||||
- the fields of a link as a dictionary
|
||||
|
|
@ -321,8 +327,8 @@ or one of the following predefined values (default=alternate):</p>
|
|||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><em>alternate</em> an alternate representation of the entry or feed, for
|
||||
example a permalink to the html version of the entry, or the front
|
||||
page of the weblog.</li>
|
||||
example a permalink to the html version of the entry, or the
|
||||
front page of the weblog.</li>
|
||||
<li><em>enclosure</em> a related resource which is potentially large in size
|
||||
and might require special handling, for example an audio or video
|
||||
recording.</li>
|
||||
|
|
@ -344,9 +350,9 @@ display purposes.</p>
|
|||
</ul>
|
||||
<p>RSS only supports one link with nothing but a URL. So for the RSS link
|
||||
element the last link with rel=alternate is used.</p>
|
||||
<p>RSS also supports one enclusure element per entry which is covered by the
|
||||
link element in ATOM feed entries. So for the RSS enclusure element the
|
||||
last link with rel=enclosure is used.</p>
|
||||
<p>RSS also supports one enclusure element per entry which is covered by
|
||||
the link element in ATOM feed entries. So for the RSS enclusure element
|
||||
the last link with rel=enclosure is used.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -366,7 +372,7 @@ last link with rel=enclosure is used.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.load_extension">
|
||||
<tt class="descname">load_extension</tt><big>(</big><em>name</em>, <em>atom=True</em>, <em>rss=True</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.load_extension" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">load_extension</code><span class="sig-paren">(</span><em>name</em>, <em>atom=True</em>, <em>rss=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.load_extension" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load a specific extension by name.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -385,19 +391,19 @@ last link with rel=enclosure is used.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.pubdate">
|
||||
<tt class="descname">pubdate</tt><big>(</big><em>pubDate=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.pubdate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the pubDate of the entry which indicates when the entry was
|
||||
published. This method is just another name for the published(...)
|
||||
<code class="descname">pubdate</code><span class="sig-paren">(</span><em>pubDate=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.pubdate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the pubDate of the entry which indicates when the entry
|
||||
was published. This method is just another name for the published(...)
|
||||
method.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.published">
|
||||
<tt class="descname">published</tt><big>(</big><em>published=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.published" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">published</code><span class="sig-paren">(</span><em>published=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.published" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the published value which contains the time of the initial
|
||||
creation or first availability of the entry.</p>
|
||||
<p>The value can either be a string which will automatically be parsed or a
|
||||
datetime.datetime object. In any case it is necessary that the value
|
||||
<p>The value can either be a string which will automatically be parsed or
|
||||
a datetime.datetime object. In any case it is necessary that the value
|
||||
include timezone information.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -413,7 +419,7 @@ include timezone information.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.register_extension">
|
||||
<tt class="descname">register_extension</tt><big>(</big><em>namespace</em>, <em>extension_class_entry=None</em>, <em>atom=True</em>, <em>rss=True</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.register_extension" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">register_extension</code><span class="sig-paren">(</span><em>namespace</em>, <em>extension_class_entry=None</em>, <em>atom=True</em>, <em>rss=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.register_extension" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Register a specific extension by classes to a namespace.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -433,10 +439,10 @@ include timezone information.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.rights">
|
||||
<tt class="descname">rights</tt><big>(</big><em>rights=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.rights" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">rights</code><span class="sig-paren">(</span><em>rights=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.rights" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the rights value of the entry which conveys information
|
||||
about rights, e.g. copyrights, held in and over the entry. This ATOM value
|
||||
will also set rss:copyright.</p>
|
||||
about rights, e.g. copyrights, held in and over the entry. This ATOM
|
||||
value will also set rss:copyright.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -451,20 +457,20 @@ will also set rss:copyright.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.rss_entry">
|
||||
<tt class="descname">rss_entry</tt><big>(</big><em>extensions=True</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.rss_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">rss_entry</code><span class="sig-paren">(</span><em>extensions=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.rss_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Create a RSS item and return it.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.summary">
|
||||
<tt class="descname">summary</tt><big>(</big><em>summary=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.summary" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">summary</code><span class="sig-paren">(</span><em>summary=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.summary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the summary element of an entry which conveys a short
|
||||
summary, abstract, or excerpt of the entry. Summary is an ATOM only
|
||||
element and should be provided if there either is no content provided for
|
||||
the entry, or that content is not inline (i.e., contains a src
|
||||
attribute), or if the content is encoded in base64.
|
||||
This method will also set the rss:description field if it wasn’t
|
||||
previously set or contains the old value of summary.</p>
|
||||
element and should be provided if there either is no content provided
|
||||
for the entry, or that content is not inline (i.e., contains a src
|
||||
attribute), or if the content is encoded in base64. This method will
|
||||
also set the rss:description field if it wasn’t previously set or
|
||||
contains the old value of summary.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -479,7 +485,7 @@ previously set or contains the old value of summary.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.title">
|
||||
<tt class="descname">title</tt><big>(</big><em>title=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.title" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">title</code><span class="sig-paren">(</span><em>title=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the title value of the entry. It should contain a human
|
||||
readable title for the entry. Title is mandatory for both ATOM and RSS
|
||||
and should not be blank.</p>
|
||||
|
|
@ -497,10 +503,10 @@ and should not be blank.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.ttl">
|
||||
<tt class="descname">ttl</tt><big>(</big><em>ttl=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.ttl" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">ttl</code><span class="sig-paren">(</span><em>ttl=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.ttl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the ttl value. It is an RSS only element. ttl stands for
|
||||
time to live. It’s a number of minutes that indicates how long a channel
|
||||
can be cached before refreshing from the source.</p>
|
||||
time to live. It’s a number of minutes that indicates how long a
|
||||
channel can be cached before refreshing from the source.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -515,11 +521,11 @@ can be cached before refreshing from the source.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.entry.FeedEntry.updated">
|
||||
<tt class="descname">updated</tt><big>(</big><em>updated=None</em><big>)</big><a class="headerlink" href="#feedgen.entry.FeedEntry.updated" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">updated</code><span class="sig-paren">(</span><em>updated=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.entry.FeedEntry.updated" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the updated value which indicates the last time the entry
|
||||
was modified in a significant way.</p>
|
||||
<p>The value can either be a string which will automatically be parsed or a
|
||||
datetime.datetime object. In any case it is necessary that the value
|
||||
<p>The value can either be a string which will automatically be parsed or
|
||||
a datetime.datetime object. In any case it is necessary that the value
|
||||
include timezone information.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -539,7 +545,7 @@ include timezone information.</p>
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.feed.html">feedgen.feed</a>
|
||||
|
|
@ -551,9 +557,9 @@ include timezone information.</p>
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
264
api.feed.html
264
api.feed.html
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.feed — python-feedgen 0.4.0 documentation</title>
|
||||
<title>feedgen.feed — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,17 +23,19 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="index.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 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>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.feed</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.html">API Documentation</a>
|
||||
|
|
@ -55,7 +57,7 @@
|
|||
<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 class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">2013-2016, 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>
|
||||
|
|
@ -63,14 +65,14 @@
|
|||
</table>
|
||||
<dl class="class">
|
||||
<dt id="feedgen.feed.FeedGenerator">
|
||||
<em class="property">class </em><tt class="descclassname">feedgen.feed.</tt><tt class="descname">FeedGenerator</tt><a class="headerlink" href="#feedgen.feed.FeedGenerator" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.feed.</code><code class="descname">FeedGenerator</code><a class="headerlink" href="#feedgen.feed.FeedGenerator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>FeedGenerator for generating ATOM and RSS feeds.</p>
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.add_entry">
|
||||
<tt class="descname">add_entry</tt><big>(</big><em>feedEntry=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.add_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">add_entry</code><span class="sig-paren">(</span><em>feedEntry=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.add_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will add a new entry to the feed. If the feedEntry
|
||||
argument is omittet a new Entry object is created automatically. This is
|
||||
the prefered way to add new entries to a feed.</p>
|
||||
argument is omittet a new Entry object is created automatically. This
|
||||
is the prefered way to add new entries to a feed.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -82,16 +84,16 @@ the prefered way to add new entries to a feed.</p>
|
|||
</tbody>
|
||||
</table>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span>...
|
||||
>>> entry = feedgen.add_entry()
|
||||
>>> entry.title('First feed entry')
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">...</span>
|
||||
<span class="o">>>></span> <span class="n">entry</span> <span class="o">=</span> <span class="n">feedgen</span><span class="o">.</span><span class="n">add_entry</span><span class="p">()</span>
|
||||
<span class="o">>>></span> <span class="n">entry</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s1">'First feed entry'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.add_item">
|
||||
<tt class="descname">add_item</tt><big>(</big><em>item=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.add_item" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">add_item</code><span class="sig-paren">(</span><em>item=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.add_item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>This method will add a new item to the feed. If the item argument is
|
||||
omittet a new FeedEntry object is created automatically. This is just
|
||||
another name for add_entry(...)</p>
|
||||
|
|
@ -99,14 +101,14 @@ another name for add_entry(...)</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.atom_file">
|
||||
<tt class="descname">atom_file</tt><big>(</big><em>filename</em>, <em>extensions=True</em>, <em>pretty=False</em>, <em>encoding='UTF-8'</em>, <em>xml_declaration=True</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.atom_file" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">atom_file</code><span class="sig-paren">(</span><em>filename</em>, <em>extensions=True</em>, <em>pretty=False</em>, <em>encoding='UTF-8'</em>, <em>xml_declaration=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.atom_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generates an ATOM feed and write the resulting XML to a file.</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 last simple">
|
||||
<li><strong>filename</strong> – Name of file to write, or a file-like object, or a URL.</li>
|
||||
<li><strong>filename</strong> – Name of file to write or a file-like object or a URL.</li>
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
generation (default: enabled).</li>
|
||||
<li><strong>pretty</strong> – If the feed should be split into multiple lines and
|
||||
|
|
@ -123,7 +125,7 @@ output (Default: enabled).</li>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.atom_str">
|
||||
<tt class="descname">atom_str</tt><big>(</big><em>pretty=False</em>, <em>extensions=True</em>, <em>encoding='UTF-8'</em>, <em>xml_declaration=True</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.atom_str" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">atom_str</code><span class="sig-paren">(</span><em>pretty=False</em>, <em>extensions=True</em>, <em>encoding='UTF-8'</em>, <em>xml_declaration=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.atom_str" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generates an ATOM feed and returns the feed XML as string.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -146,16 +148,16 @@ output (Default: enabled).</li>
|
|||
</tbody>
|
||||
</table>
|
||||
<p><strong>Return type:</strong> The return type may vary between different Python
|
||||
versions and your encoding parameters passed to this method. For details
|
||||
have a look at the <a class="reference external" href="https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring">lxml documentation</a></p>
|
||||
versions and your encoding parameters passed to this method. For
|
||||
details have a look at the <a class="reference external" href="https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring">lxml documentation</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.author">
|
||||
<tt class="descname">author</tt><big>(</big><em>author=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set author data. An author element is a dictionary containing a name,
|
||||
an email address and a URI. Name is mandatory for ATOM, email is mandatory
|
||||
for RSS.</p>
|
||||
<code class="descname">author</code><span class="sig-paren">(</span><em>author=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.author" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set author data. An author element is a dictionary containing
|
||||
a name, an email address and a URI. Name is mandatory for ATOM, email
|
||||
is mandatory for RSS.</p>
|
||||
<p>This method can be called with:</p>
|
||||
<ul class="simple">
|
||||
<li>the fields of an author as keyword arguments</li>
|
||||
|
|
@ -184,14 +186,15 @@ for RSS.</p>
|
|||
</tbody>
|
||||
</table>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">feedgen</span><span class="o">.</span><span class="n">author</span><span class="p">(</span> <span class="p">{</span> <span class="s1">'name'</span><span class="p">:</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">:</span><span class="s1">'jdoe@example.com'</span> <span class="p">}</span> <span class="p">)</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">feedgen</span><span class="o">.</span><span class="n">author</span><span class="p">({</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">:</span><span class="s1">'jdoe@example.com'</span><span class="p">})</span>
|
||||
<span class="go">[{'name':'John Doe','email':'jdoe@example.com'}]</span>
|
||||
|
||||
<span class="gp">>>> </span><span class="n">feedgen</span><span class="o">.</span><span class="n">author</span><span class="p">([{</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'Mr. X'</span><span class="p">},{</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'Max'</span><span class="p">}])</span>
|
||||
<span class="go">[{'name':'John Doe','email':'jdoe@example.com'},</span>
|
||||
<span class="go"> {'name':'John Doe'}, {'name':'Max'}]</span>
|
||||
|
||||
<span class="gp">>>> </span><span class="n">feedgen</span><span class="o">.</span><span class="n">author</span><span class="p">(</span> <span class="n">name</span><span class="o">=</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="n">email</span><span class="o">=</span><span class="s1">'jdoe@example.com'</span><span class="p">,</span> <span class="n">replace</span><span class="o">=</span><span class="bp">True</span> <span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">feedgen</span><span class="o">.</span><span class="n">author</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="n">email</span><span class="o">=</span><span class="s1">'jdoe@example.com'</span><span class="p">,</span>
|
||||
<span class="go"> replace=True)</span>
|
||||
<span class="go">[{'name':'John Doe','email':'jdoe@example.com'}]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
@ -199,7 +202,7 @@ for RSS.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.category">
|
||||
<tt class="descname">category</tt><big>(</big><em>category=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.category" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">category</code><span class="sig-paren">(</span><em>category=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.category" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set categories that the feed belongs to.</p>
|
||||
<p>This method can be called with:</p>
|
||||
<ul class="simple">
|
||||
|
|
@ -213,8 +216,8 @@ for RSS.</p>
|
|||
<li><em>scheme</em> identifies the categorization scheme via a URI.</li>
|
||||
<li><em>label</em> provides a human-readable label for display</li>
|
||||
</ul>
|
||||
<p>If a label is present it is used for the RSS feeds. Otherwise the term is
|
||||
used. The scheme is used for the domain attribute in RSS.</p>
|
||||
<p>If a label is present it is used for the RSS feeds. Otherwise the term
|
||||
is used. The scheme is used for the domain attribute in RSS.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -234,10 +237,10 @@ used. The scheme is used for the domain attribute in RSS.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.cloud">
|
||||
<tt class="descname">cloud</tt><big>(</big><em>domain=None</em>, <em>port=None</em>, <em>path=None</em>, <em>registerProcedure=None</em>, <em>protocol=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.cloud" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the cloud data of the feed. It is an RSS only attribute. It
|
||||
specifies a web service that supports the rssCloud interface which can be
|
||||
implemented in HTTP-POST, XML-RPC or SOAP 1.1.</p>
|
||||
<code class="descname">cloud</code><span class="sig-paren">(</span><em>domain=None</em>, <em>port=None</em>, <em>path=None</em>, <em>registerProcedure=None</em>, <em>protocol=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.cloud" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the cloud data of the feed. It is an RSS only attribute.
|
||||
It specifies a web service that supports the rssCloud interface which
|
||||
can be implemented in HTTP-POST, XML-RPC or SOAP 1.1.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -260,7 +263,7 @@ implemented in HTTP-POST, XML-RPC or SOAP 1.1.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.contributor">
|
||||
<tt class="descname">contributor</tt><big>(</big><em>contributor=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.contributor" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">contributor</code><span class="sig-paren">(</span><em>contributor=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.contributor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the contributor data of the feed. This is an ATOM only
|
||||
value.</p>
|
||||
<p>This method can be called with:
|
||||
|
|
@ -276,7 +279,8 @@ value.</p>
|
|||
<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>contributor</strong> – Dictionary or list of dictionaries with contributor data.</li>
|
||||
<li><strong>contributor</strong> – Dictionary or list of dictionaries with contributor
|
||||
data.</li>
|
||||
<li><strong>replace</strong> – Add or replace old data.</li>
|
||||
</ul>
|
||||
</td>
|
||||
|
|
@ -290,7 +294,7 @@ value.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.copyright">
|
||||
<tt class="descname">copyright</tt><big>(</big><em>copyright=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.copyright" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">copyright</code><span class="sig-paren">(</span><em>copyright=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.copyright" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the copyright notice for content in the channel. This RSS
|
||||
value will also set the atom:rights value.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -307,11 +311,11 @@ value will also set the atom:rights value.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.description">
|
||||
<tt class="descname">description</tt><big>(</big><em>description=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.description" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">description</code><span class="sig-paren">(</span><em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.description" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set and get the description of the feed. This is an RSS only element
|
||||
which is a phrase or sentence describing the channel. It is mandatory for
|
||||
RSS feeds. It is roughly the same as atom:subtitle. Thus setting this
|
||||
will also set atom:subtitle.</p>
|
||||
which is a phrase or sentence describing the channel. It is mandatory
|
||||
for RSS feeds. It is roughly the same as atom:subtitle. Thus setting
|
||||
this will also set atom:subtitle.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -326,12 +330,12 @@ will also set atom:subtitle.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.docs">
|
||||
<tt class="descname">docs</tt><big>(</big><em>docs=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.docs" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">docs</code><span class="sig-paren">(</span><em>docs=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.docs" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the docs value of the feed. This is an RSS only value. It
|
||||
is a URL that points to the documentation for the format used in the RSS
|
||||
file. It is probably a pointer to [1]. It is for people who might stumble
|
||||
across an RSS file on a Web server 25 years from now and wonder what it
|
||||
is.</p>
|
||||
is a URL that points to the documentation for the format used in the
|
||||
RSS file. It is probably a pointer to [1]. It is for people who might
|
||||
stumble across an RSS file on a Web server 25 years from now and wonder
|
||||
what it is.</p>
|
||||
<p>[1]: <a class="reference external" href="http://www.rssboard.org/rss-specification">http://www.rssboard.org/rss-specification</a></p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -347,7 +351,7 @@ is.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.entry">
|
||||
<tt class="descname">entry</tt><big>(</big><em>entry=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">entry</code><span class="sig-paren">(</span><em>entry=None</em>, <em>replace=False</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set feed entries. Use the add_entry() method instead to
|
||||
automatically create the FeedEntry objects.</p>
|
||||
<p>This method takes both a single FeedEntry object or a list of objects.</p>
|
||||
|
|
@ -365,10 +369,11 @@ automatically create the FeedEntry objects.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.generator">
|
||||
<tt class="descname">generator</tt><big>(</big><em>generator=None</em>, <em>version=None</em>, <em>uri=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.generator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or the generator of the feed which identifies the software used to
|
||||
generate the feed, for debugging and other purposes. Both the uri and
|
||||
version attributes are optional and only available in the ATOM feed.</p>
|
||||
<code class="descname">generator</code><span class="sig-paren">(</span><em>generator=None</em>, <em>version=None</em>, <em>uri=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.generator" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or the generator of the feed which identifies the software used
|
||||
to generate the feed, for debugging and other purposes. Both the uri
|
||||
and version attributes are optional and only available in the ATOM
|
||||
feed.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -386,10 +391,10 @@ version attributes are optional and only available in the ATOM feed.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.icon">
|
||||
<tt class="descname">icon</tt><big>(</big><em>icon=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.icon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the icon of the feed which is a small image which provides
|
||||
iconic visual identification for the feed. Icons should be square. This
|
||||
is an ATOM only value.</p>
|
||||
<code class="descname">icon</code><span class="sig-paren">(</span><em>icon=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.icon" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the icon of the feed which is a small image which
|
||||
provides iconic visual identification for the feed. Icons should be
|
||||
square. This is an ATOM only value.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -404,7 +409,7 @@ is an ATOM only value.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.id">
|
||||
<tt class="descname">id</tt><big>(</big><em>id=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.id" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">id</code><span class="sig-paren">(</span><em>id=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.id" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the feed id which identifies the feed using a universally
|
||||
unique and permanent URI. If you have a long-term, renewable lease on
|
||||
your Internet domain name, then you can feel free to use your website’s
|
||||
|
|
@ -423,7 +428,7 @@ address. This field is for ATOM only. It is mandatory for ATOM.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.image">
|
||||
<tt class="descname">image</tt><big>(</big><em>url=None</em>, <em>title=None</em>, <em>link=None</em>, <em>width=None</em>, <em>height=None</em>, <em>description=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.image" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">image</code><span class="sig-paren">(</span><em>url=None</em>, <em>title=None</em>, <em>link=None</em>, <em>width=None</em>, <em>height=None</em>, <em>description=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.image" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the image of the feed. This element is roughly equivalent to
|
||||
atom:logo.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -432,7 +437,8 @@ atom:logo.</p>
|
|||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>url</strong> – The URL of a GIF, JPEG or PNG image.</li>
|
||||
<li><strong>title</strong> – Describes the image. The default value is the feeds title.</li>
|
||||
<li><strong>title</strong> – Describes the image. The default value is the feeds
|
||||
title.</li>
|
||||
<li><strong>link</strong> – URL of the site the image will link to. The default is to
|
||||
use the feeds first altertate link.</li>
|
||||
<li><strong>width</strong> – Width of the image in pixel. The maximum is 144.</li>
|
||||
|
|
@ -450,18 +456,18 @@ use the feeds first altertate link.</li>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.item">
|
||||
<tt class="descname">item</tt><big>(</big><em>item=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.item" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">item</code><span class="sig-paren">(</span><em>item=None</em>, <em>replace=False</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set feed items. This is just another name for entry(...)</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.language">
|
||||
<tt class="descname">language</tt><big>(</big><em>language=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.language" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">language</code><span class="sig-paren">(</span><em>language=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.language" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the language of the feed. It indicates the language the
|
||||
channel is written in. This allows aggregators to group all Italian
|
||||
language sites, for example, on a single page. This is an RSS only field.
|
||||
However, this value will also be used to set the xml:lang property of the
|
||||
ATOM feed node.
|
||||
language sites, for example, on a single page. This is an RSS only
|
||||
field. However, this value will also be used to set the xml:lang
|
||||
property of the ATOM feed node.
|
||||
The value should be an IETF language tag.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -477,11 +483,11 @@ The value should be an IETF language tag.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.lastBuildDate">
|
||||
<tt class="descname">lastBuildDate</tt><big>(</big><em>lastBuildDate=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.lastBuildDate" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">lastBuildDate</code><span class="sig-paren">(</span><em>lastBuildDate=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.lastBuildDate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the lastBuildDate value which indicates the last time the
|
||||
content of the channel changed.</p>
|
||||
<p>The value can either be a string which will automatically be parsed or a
|
||||
datetime.datetime object. In any case it is necessary that the value
|
||||
<p>The value can either be a string which will automatically be parsed or
|
||||
a datetime.datetime object. In any case it is necessary that the value
|
||||
include timezone information.</p>
|
||||
<p>This will set both atom:updated and rss:lastBuildDate.</p>
|
||||
<dl class="docutils">
|
||||
|
|
@ -502,9 +508,10 @@ include timezone information.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.link">
|
||||
<tt class="descname">link</tt><big>(</big><em>link=None</em>, <em>replace=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.link" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set link data. An link element is a dict with the fields href,
|
||||
rel, type, hreflang, title, and length. Href is mandatory for ATOM.</p>
|
||||
<code class="descname">link</code><span class="sig-paren">(</span><em>link=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.link" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set link data. An link element is a dict with the fields
|
||||
href, rel, type, hreflang, title, and length. Href is mandatory for
|
||||
ATOM.</p>
|
||||
<p>This method can be called with:</p>
|
||||
<ul class="simple">
|
||||
<li>the fields of a link as keyword arguments</li>
|
||||
|
|
@ -520,8 +527,8 @@ or one of the following predefined values (default=alternate):</p>
|
|||
<blockquote>
|
||||
<div><ul class="simple">
|
||||
<li><em>alternate</em> an alternate representation of the entry or feed, for
|
||||
example a permalink to the html version of the entry, or the front
|
||||
page of the weblog.</li>
|
||||
example a permalink to the html version of the entry, or the
|
||||
front page of the weblog.</li>
|
||||
<li><em>enclosure</em> a related resource which is potentially large in size
|
||||
and might require special handling, for example an audio or video
|
||||
recording.</li>
|
||||
|
|
@ -558,7 +565,7 @@ display purposes.</p>
|
|||
</tbody>
|
||||
</table>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">feedgen</span><span class="o">.</span><span class="n">link</span><span class="p">(</span> <span class="n">href</span><span class="o">=</span><span class="s1">'http://example.com/'</span><span class="p">,</span> <span class="n">rel</span><span class="o">=</span><span class="s1">'self'</span><span class="p">)</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">feedgen</span><span class="o">.</span><span class="n">link</span><span class="p">(</span> <span class="n">href</span><span class="o">=</span><span class="s1">'http://example.com/'</span><span class="p">,</span> <span class="n">rel</span><span class="o">=</span><span class="s1">'self'</span><span class="p">)</span>
|
||||
<span class="go">[{'href':'http://example.com/', 'rel':'self'}]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
@ -566,7 +573,7 @@ display purposes.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.load_extension">
|
||||
<tt class="descname">load_extension</tt><big>(</big><em>name</em>, <em>atom=True</em>, <em>rss=True</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.load_extension" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">load_extension</code><span class="sig-paren">(</span><em>name</em>, <em>atom=True</em>, <em>rss=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.load_extension" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Load a specific extension by name.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -585,11 +592,11 @@ display purposes.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.logo">
|
||||
<tt class="descname">logo</tt><big>(</big><em>logo=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.logo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the logo of the feed which is a larger image which provides
|
||||
visual identification for the feed. Images should be twice as wide as
|
||||
they are tall. This is an ATOM value but will also set the rss:image
|
||||
value.</p>
|
||||
<code class="descname">logo</code><span class="sig-paren">(</span><em>logo=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.logo" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the logo of the feed which is a larger image which
|
||||
provides visual identification for the feed. Images should be twice as
|
||||
wide as they are tall. This is an ATOM value but will also set the
|
||||
rss:image value.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -604,9 +611,10 @@ value.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.managingEditor">
|
||||
<tt class="descname">managingEditor</tt><big>(</big><em>managingEditor=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.managingEditor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the value for managingEditor which is the email address for
|
||||
person responsible for editorial content. This is a RSS only value.</p>
|
||||
<code class="descname">managingEditor</code><span class="sig-paren">(</span><em>managingEditor=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.managingEditor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the value for managingEditor which is the email address
|
||||
for person responsible for editorial content. This is a RSS only
|
||||
value.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -621,13 +629,13 @@ person responsible for editorial content. This is a RSS only value.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.pubDate">
|
||||
<tt class="descname">pubDate</tt><big>(</big><em>pubDate=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.pubDate" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">pubDate</code><span class="sig-paren">(</span><em>pubDate=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.pubDate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the publication date for the content in the channel. For
|
||||
example, the New York Times publishes on a daily basis, the publication
|
||||
date flips once every 24 hours. That’s when the pubDate of the channel
|
||||
changes.</p>
|
||||
<p>The value can either be a string which will automatically be parsed or a
|
||||
datetime.datetime object. In any case it is necessary that the value
|
||||
<p>The value can either be a string which will automatically be parsed or
|
||||
a datetime.datetime object. In any case it is necessary that the value
|
||||
include timezone information.</p>
|
||||
<p>This will set both atom:updated and rss:lastBuildDate.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -644,14 +652,14 @@ include timezone information.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.rating">
|
||||
<tt class="descname">rating</tt><big>(</big><em>rating=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.rating" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">rating</code><span class="sig-paren">(</span><em>rating=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.rating" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set and get the PICS rating for the channel. It is an RSS only
|
||||
value.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.register_extension">
|
||||
<tt class="descname">register_extension</tt><big>(</big><em>namespace</em>, <em>extension_class_feed=None</em>, <em>extension_class_entry=None</em>, <em>atom=True</em>, <em>rss=True</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.register_extension" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">register_extension</code><span class="sig-paren">(</span><em>namespace</em>, <em>extension_class_feed=None</em>, <em>extension_class_entry=None</em>, <em>atom=True</em>, <em>rss=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.register_extension" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Registers an extension by class.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -672,7 +680,7 @@ value.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.remove_entry">
|
||||
<tt class="descname">remove_entry</tt><big>(</big><em>entry</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.remove_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">remove_entry</code><span class="sig-paren">(</span><em>entry</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.remove_entry" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove a single entry from the feed. This method accepts both the
|
||||
FeedEntry object to remove or the index of the entry as argument.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -687,17 +695,17 @@ FeedEntry object to remove or the index of the entry as argument.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.remove_item">
|
||||
<tt class="descname">remove_item</tt><big>(</big><em>item</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.remove_item" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">remove_item</code><span class="sig-paren">(</span><em>item</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.remove_item" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Remove a single item from the feed. This is another name for
|
||||
remove_entry.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.rights">
|
||||
<tt class="descname">rights</tt><big>(</big><em>rights=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.rights" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">rights</code><span class="sig-paren">(</span><em>rights=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.rights" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the rights value of the feed which conveys information
|
||||
about rights, e.g. copyrights, held in and over the feed. This ATOM value
|
||||
will also set rss:copyright.</p>
|
||||
about rights, e.g. copyrights, held in and over the feed. This ATOM
|
||||
value will also set rss:copyright.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -710,14 +718,14 @@ will also set rss:copyright.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.rss_file">
|
||||
<tt class="descname">rss_file</tt><big>(</big><em>filename</em>, <em>extensions=True</em>, <em>pretty=False</em>, <em>encoding='UTF-8'</em>, <em>xml_declaration=True</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.rss_file" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">rss_file</code><span class="sig-paren">(</span><em>filename</em>, <em>extensions=True</em>, <em>pretty=False</em>, <em>encoding='UTF-8'</em>, <em>xml_declaration=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.rss_file" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generates an RSS feed and write the resulting XML to a file.</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 last simple">
|
||||
<li><strong>filename</strong> – Name of file to write, or a file-like object, or a URL.</li>
|
||||
<li><strong>filename</strong> – Name of file to write or a file-like object or a URL.</li>
|
||||
<li><strong>extensions</strong> – Enable or disable the loaded extensions for the xml
|
||||
generation (default: enabled).</li>
|
||||
<li><strong>pretty</strong> – If the feed should be split into multiple lines and
|
||||
|
|
@ -734,7 +742,7 @@ output (Default: enabled).</li>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.rss_str">
|
||||
<tt class="descname">rss_str</tt><big>(</big><em>pretty=False</em>, <em>extensions=True</em>, <em>encoding='UTF-8'</em>, <em>xml_declaration=True</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.rss_str" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">rss_str</code><span class="sig-paren">(</span><em>pretty=False</em>, <em>extensions=True</em>, <em>encoding='UTF-8'</em>, <em>xml_declaration=True</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.rss_str" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Generates an RSS feed and returns the feed XML as string.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -757,17 +765,17 @@ output (Default: enabled).</li>
|
|||
</tbody>
|
||||
</table>
|
||||
<p><strong>Return type:</strong> The return type may vary between different Python
|
||||
versions and your encoding parameters passed to this method. For details
|
||||
have a look at the <a class="reference external" href="https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring">lxml documentation</a></p>
|
||||
versions and your encoding parameters passed to this method. For
|
||||
details have a look at the <a class="reference external" href="https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.tostring">lxml documentation</a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.skipDays">
|
||||
<tt class="descname">skipDays</tt><big>(</big><em>days=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.skipDays" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the value of skipDays, a hint for aggregators telling them
|
||||
which days they can skip This is an RSS only value.</p>
|
||||
<p>This method can be called with a day name or a list of day names. The days are
|
||||
represented as strings from ‘Monday’ to ‘Sunday’.</p>
|
||||
<code class="descname">skipDays</code><span class="sig-paren">(</span><em>days=None</em>, <em>replace=False</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.skipDays" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the value of skipDays, a hint for aggregators telling
|
||||
them which days they can skip This is an RSS only value.</p>
|
||||
<p>This method can be called with a day name or a list of day names. The
|
||||
days are represented as strings from ‘Monday’ to ‘Sunday’.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -787,11 +795,11 @@ represented as strings from ‘Monday’ to ‘Sunday’.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.skipHours">
|
||||
<tt class="descname">skipHours</tt><big>(</big><em>hours=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.skipHours" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the value of skipHours, a hint for aggregators telling them
|
||||
which hours they can skip. This is an RSS only value.</p>
|
||||
<p>This method can be called with an hour or a list of hours. The hours are
|
||||
represented as integer values from 0 to 23.</p>
|
||||
<code class="descname">skipHours</code><span class="sig-paren">(</span><em>hours=None</em>, <em>replace=False</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.skipHours" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the value of skipHours, a hint for aggregators telling
|
||||
them which hours they can skip. This is an RSS only value.</p>
|
||||
<p>This method can be called with an hour or a list of hours. The hours
|
||||
are represented as integer values from 0 to 23.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -811,7 +819,7 @@ represented as integer values from 0 to 23.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.subtitle">
|
||||
<tt class="descname">subtitle</tt><big>(</big><em>subtitle=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.subtitle" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">subtitle</code><span class="sig-paren">(</span><em>subtitle=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.subtitle" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the subtitle value of the cannel which contains a
|
||||
human-readable description or subtitle for the feed. This ATOM property
|
||||
will also set the value for rss:description.</p>
|
||||
|
|
@ -829,10 +837,10 @@ will also set the value for rss:description.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.textInput">
|
||||
<tt class="descname">textInput</tt><big>(</big><em>title=None</em>, <em>description=None</em>, <em>name=None</em>, <em>link=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.textInput" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">textInput</code><span class="sig-paren">(</span><em>title=None</em>, <em>description=None</em>, <em>name=None</em>, <em>link=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.textInput" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the value of textInput. This is an RSS only field. The
|
||||
purpose of the <textInput> element is something of a mystery. You can use
|
||||
it to specify a search engine box. Or to allow a reader to provide
|
||||
purpose of the <textInput> element is something of a mystery. You can
|
||||
use it to specify a search engine box. Or to allow a reader to provide
|
||||
feedback. Most aggregators ignore it.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -842,7 +850,8 @@ feedback. Most aggregators ignore it.</p>
|
|||
<li><strong>title</strong> – The label of the Submit button in the text input area.</li>
|
||||
<li><strong>description</strong> – Explains the text input area.</li>
|
||||
<li><strong>name</strong> – The name of the text object in the text input area.</li>
|
||||
<li><strong>link</strong> – The URL of the CGI script that processes text input requests.</li>
|
||||
<li><strong>link</strong> – The URL of the CGI script that processes text input
|
||||
requests.</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -855,7 +864,7 @@ feedback. Most aggregators ignore it.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.title">
|
||||
<tt class="descname">title</tt><big>(</big><em>title=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.title" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">title</code><span class="sig-paren">(</span><em>title=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.title" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the title value of the feed. It should contain a human
|
||||
readable title for the feed. Often the same as the title of the
|
||||
associated website. Title is mandatory for both ATOM and RSS and should
|
||||
|
|
@ -874,15 +883,16 @@ not be blank.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.ttl">
|
||||
<tt class="descname">ttl</tt><big>(</big><em>ttl=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.ttl" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">ttl</code><span class="sig-paren">(</span><em>ttl=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.ttl" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the ttl value. It is an RSS only element. ttl stands for
|
||||
time to live. It’s a number of minutes that indicates how long a channel
|
||||
can be cached before refreshing from the source.</p>
|
||||
time to live. It’s a number of minutes that indicates how long a
|
||||
channel can be cached before refreshing from the source.</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>ttl</strong> – Integer value indicating how long the channel may be cached.</td>
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ttl</strong> – Integer value indicating how long the channel may be
|
||||
cached.</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Time to live.</td>
|
||||
</tr>
|
||||
|
|
@ -892,11 +902,11 @@ can be cached before refreshing from the source.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.updated">
|
||||
<tt class="descname">updated</tt><big>(</big><em>updated=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.updated" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">updated</code><span class="sig-paren">(</span><em>updated=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.updated" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set or get the updated value which indicates the last time the feed
|
||||
was modified in a significant way.</p>
|
||||
<p>The value can either be a string which will automatically be parsed or a
|
||||
datetime.datetime object. In any case it is necessary that the value
|
||||
<p>The value can either be a string which will automatically be parsed or
|
||||
a datetime.datetime object. In any case it is necessary that the value
|
||||
include timezone information.</p>
|
||||
<p>This will set both atom:updated and rss:lastBuildDate.</p>
|
||||
<dl class="docutils">
|
||||
|
|
@ -917,10 +927,10 @@ include timezone information.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.feed.FeedGenerator.webMaster">
|
||||
<tt class="descname">webMaster</tt><big>(</big><em>webMaster=None</em><big>)</big><a class="headerlink" href="#feedgen.feed.FeedGenerator.webMaster" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get and set the value of webMaster, which represents the email address
|
||||
for the person responsible for technical issues relating to the feed.
|
||||
This is an RSS only value.</p>
|
||||
<code class="descname">webMaster</code><span class="sig-paren">(</span><em>webMaster=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.feed.FeedGenerator.webMaster" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get and set the value of webMaster, which represents the email
|
||||
address for the person responsible for technical issues relating to the
|
||||
feed. This is an RSS only value.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -939,7 +949,7 @@ This is an RSS only value.</p>
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.html">API Documentation</a>
|
||||
|
|
@ -951,9 +961,9 @@ This is an RSS only value.</p>
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
63
api.html
63
api.html
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>API Documentation — python-feedgen 0.4.0 documentation</title>
|
||||
<title>API Documentation — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,16 +23,18 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="index.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 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>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>API Documentation</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="index.html">Feedgenerator</a>
|
||||
|
|
@ -67,7 +69,7 @@ produce Podcasts.</p>
|
|||
<h3>Create a Feed<a class="headerlink" href="#create-a-feed" title="Permalink to this headline">¶</a></h3>
|
||||
<p>To create a feed simply instanciate the FeedGenerator class and insert some
|
||||
data:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="kn">import</span> <span class="n">FeedGenerator</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="k">import</span> <span class="n">FeedGenerator</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span> <span class="o">=</span> <span class="n">FeedGenerator</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">id</span><span class="p">(</span><span class="s1">'http://lernfunk.de/media/654321'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s1">'Some Testfeed'</span><span class="p">)</span>
|
||||
|
|
@ -87,17 +89,18 @@ a feed you can use all of the following ways to provide data:</p>
|
|||
<li>Provide a list of dictionaries with the data for several elements</li>
|
||||
</ul>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">contributor</span><span class="p">(</span> <span class="n">name</span><span class="o">=</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="n">email</span><span class="o">=</span><span class="s1">'jdoe@example.com'</span> <span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">contributor</span><span class="p">({</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">:</span><span class="s1">'jdoe@example.com'</span><span class="p">})</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">contributor</span><span class="p">([{</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">:</span><span class="s1">'jdoe@example.com'</span><span class="p">},</span> <span class="o">...</span><span class="p">])</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span>>>> fg.contributor(name='John Doe', email='jdoe@example.com' )
|
||||
>>> fg.contributor({'name':'John Doe', 'email':'jdoe@example.com'})
|
||||
>>> fg.contributor([{'name':'John', 'email':'jdoe@example.com'}, …])
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="generate-the-feed">
|
||||
<h3>Generate the Feed<a class="headerlink" href="#generate-the-feed" title="Permalink to this headline">¶</a></h3>
|
||||
<p>After that you can generate both RSS or ATOM by calling the respective method:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">atomfeed</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">atom_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> <span class="c1"># Get the ATOM feed as string</span>
|
||||
<span class="gp">>>> </span><span class="n">rssfeed</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">rss_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> <span class="c1"># Get the RSS feed as string</span>
|
||||
<p>After that you can generate both RSS or ATOM by calling the respective
|
||||
method:</p>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">atomfeed</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">atom_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># Get the ATOM feed as string</span>
|
||||
<span class="gp">>>> </span><span class="n">rssfeed</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">rss_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># Get the RSS feed as string</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">atom_file</span><span class="p">(</span><span class="s1">'atom.xml'</span><span class="p">)</span> <span class="c1"># Write the ATOM feed to a file</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_file</span><span class="p">(</span><span class="s1">'rss.xml'</span><span class="p">)</span> <span class="c1"># Write the RSS feed to a file</span>
|
||||
</pre></div>
|
||||
|
|
@ -109,7 +112,7 @@ a feed you can use all of the following ways to provide data:</p>
|
|||
and append them to the list of entries in the FeedGenerator. The most
|
||||
convenient way to go is to use the FeedGenerator itself for the
|
||||
instantiation of the FeedEntry object:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fe</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">add_entry</span><span class="p">()</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fe</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">add_entry</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">fe</span><span class="o">.</span><span class="n">id</span><span class="p">(</span><span class="s1">'http://lernfunk.de/media/654321/1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fe</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s1">'The First Episode'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
|
|
@ -121,9 +124,9 @@ added.</p>
|
|||
</div>
|
||||
<div class="section" id="extensions">
|
||||
<h3>Extensions<a class="headerlink" href="#extensions" title="Permalink to this headline">¶</a></h3>
|
||||
<p>The FeedGenerator supports extension to include additional data into the XML
|
||||
structure of the feeds. Extensions can be loaded like this:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">load_extension</span><span class="p">(</span><span class="s1">'someext'</span><span class="p">,</span> <span class="n">atom</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">rss</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
<p>The FeedGenerator supports extension to include additional data into the
|
||||
XML structure of the feeds. Extensions can be loaded like this:</p>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">load_extension</span><span class="p">(</span><span class="s1">'someext'</span><span class="p">,</span> <span class="n">atom</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">rss</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>This will try to load the extension “someext” from the file
|
||||
|
|
@ -136,20 +139,20 @@ strongly suggested to use BaseExtension from <cite>ext/base.py</cite> as supercl
|
|||
located either in the same file as SomextExtension or in
|
||||
<cite>ext/someext_entry.py</cite> which is suggested especially for large extensions.</p>
|
||||
<p>The parameters <cite>atom</cite> and <cite>rss</cite> tell the FeedGenerator if the extensions
|
||||
should only be used for either ATOM or RSS feeds. The default value for both
|
||||
parameters is true which means that the extension would be used for both
|
||||
kinds of feeds.</p>
|
||||
should only be used for either ATOM or RSS feeds. The default value for
|
||||
both parameters is true which means that the extension would be used for
|
||||
both kinds of feeds.</p>
|
||||
<p><strong>Example: Produceing a Podcast</strong></p>
|
||||
<p>One extension already provided is the podcast extension. A podcast is an RSS
|
||||
feed with some additional elements for ITunes.</p>
|
||||
<p>One extension already provided is the podcast extension. A podcast is an
|
||||
RSS feed with some additional elements for ITunes.</p>
|
||||
<p>To produce a podcast simply load the <cite>podcast</cite> extension:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="kn">import</span> <span class="n">FeedGenerator</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="k">import</span> <span class="n">FeedGenerator</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span> <span class="o">=</span> <span class="n">FeedGenerator</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">load_extension</span><span class="p">(</span><span class="s1">'podcast'</span><span class="p">)</span>
|
||||
<span class="gp">...</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">podcast</span><span class="o">.</span><span class="n">itunes_category</span><span class="p">(</span><span class="s1">'Technology'</span><span class="p">,</span> <span class="s1">'Podcasting'</span><span class="p">)</span>
|
||||
<span class="gp">...</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_file</span><span class="p">(</span><span class="s1">'podcast.xml'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
@ -166,7 +169,7 @@ This can be done by calling the generating method with the keyword argument
|
|||
<div class="section" id="testing-the-generator">
|
||||
<h3>Testing the Generator<a class="headerlink" href="#testing-the-generator" title="Permalink to this headline">¶</a></h3>
|
||||
<p>You can test the module by simply executing:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span>$ python -m feedgen
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span>$ python -m feedgen
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
@ -188,7 +191,7 @@ This can be done by calling the generating method with the keyword argument
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="index.html">Feedgenerator</a>
|
||||
|
|
@ -200,9 +203,9 @@ This can be done by calling the generating method with the keyword argument
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.util — python-feedgen 0.4.0 documentation</title>
|
||||
<title>feedgen.util — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,17 +23,19 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="index.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 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>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.util</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.entry.html">feedgen.entry</a>
|
||||
|
|
@ -64,7 +66,7 @@
|
|||
</table>
|
||||
<dl class="function">
|
||||
<dt id="feedgen.util.ensure_format">
|
||||
<tt class="descclassname">feedgen.util.</tt><tt class="descname">ensure_format</tt><big>(</big><em>val</em>, <em>allowed</em>, <em>required</em>, <em>allowed_values=None</em>, <em>defaults=None</em><big>)</big><a class="headerlink" href="#feedgen.util.ensure_format" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">feedgen.util.</code><code class="descname">ensure_format</code><span class="sig-paren">(</span><em>val</em>, <em>allowed</em>, <em>required</em>, <em>allowed_values=None</em>, <em>defaults=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.util.ensure_format" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Takes a dictionary or a list of dictionaries and check if all keys are in
|
||||
the set of allowed keys, if all required keys are present and if the values
|
||||
of a specific key are ok.</p>
|
||||
|
|
@ -76,7 +78,8 @@ of a specific key are ok.</p>
|
|||
<li><strong>val</strong> – Dictionaries to check.</li>
|
||||
<li><strong>allowed</strong> – Set of allowed keys.</li>
|
||||
<li><strong>required</strong> – Set of required keys.</li>
|
||||
<li><strong>allowed_values</strong> – Dictionary with keys and sets of their allowed values.</li>
|
||||
<li><strong>allowed_values</strong> – Dictionary with keys and sets of their allowed
|
||||
values.</li>
|
||||
<li><strong>defaults</strong> – Dictionary with default values.</li>
|
||||
</ul>
|
||||
</td>
|
||||
|
|
@ -90,7 +93,7 @@ of a specific key are ok.</p>
|
|||
|
||||
<dl class="function">
|
||||
<dt id="feedgen.util.formatRFC2822">
|
||||
<tt class="descclassname">feedgen.util.</tt><tt class="descname">formatRFC2822</tt><big>(</big><em>d</em><big>)</big><a class="headerlink" href="#feedgen.util.formatRFC2822" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descclassname">feedgen.util.</code><code class="descname">formatRFC2822</code><span class="sig-paren">(</span><em>d</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.util.formatRFC2822" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Make sure the locale setting do not interfere with the time format.</p>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -98,7 +101,7 @@ of a specific key are ok.</p>
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.entry.html">feedgen.entry</a>
|
||||
|
|
@ -110,9 +113,9 @@ of a specific key are ok.</p>
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.base — python-feedgen 0.4.0 documentation</title>
|
||||
<title>feedgen.ext.base — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,17 +23,19 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="../index.html" />
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="API Documentation" href="../api.html" />
|
||||
<link rel="next" title="feedgen.ext.dc" href="api.ext.dc.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.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.base</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="../api.util.html">feedgen.util</a>
|
||||
|
|
@ -65,17 +67,17 @@ methods.</p>
|
|||
</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>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.base.</code><code class="descname">BaseEntryExtension</code><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>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.base.</code><code class="descname">BaseExtension</code><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>
|
||||
<code class="descname">extend_atom</code><span class="sig-paren">(</span><em>feed</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.base.BaseExtension.extend_atom" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Extend an ATOM feed xml structure containing all previously set
|
||||
fields.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -92,13 +94,13 @@ fields.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.base.BaseExtension.extend_ns">
|
||||
<tt class="descname">extend_ns</tt><big>(</big><big>)</big><a class="headerlink" href="#feedgen.ext.base.BaseExtension.extend_ns" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">extend_ns</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.base.BaseExtension.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="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>
|
||||
<code class="descname">extend_rss</code><span class="sig-paren">(</span><em>feed</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.base.BaseExtension.extend_rss" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Extend a RSS feed xml structure containing all previously set fields.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -118,7 +120,7 @@ fields.</p>
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="../api.util.html">feedgen.util</a>
|
||||
|
|
@ -130,9 +132,9 @@ fields.</p>
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.dc — python-feedgen 0.4.0 documentation</title>
|
||||
<title>feedgen.ext.dc — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,17 +23,19 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="../index.html" />
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 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.ext.base" href="api.ext.base.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.dc</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.base.html">feedgen.ext.base</a>
|
||||
|
|
@ -58,7 +60,7 @@
|
|||
<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 class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">2013-2016, 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>
|
||||
|
|
@ -66,11 +68,11 @@
|
|||
</table>
|
||||
<dl class="class">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension">
|
||||
<em class="property">class </em><tt class="descclassname">feedgen.ext.dc.</tt><tt class="descname">DcBaseExtension</tt><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.dc.</code><code class="descname">DcBaseExtension</code><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="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_contributor">
|
||||
<tt class="descname">dc_contributor</tt><big>(</big><em>contributor=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_contributor" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_contributor</code><span class="sig-paren">(</span><em>contributor=None</em>, <em>replace=False</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:
|
||||
|
|
@ -94,19 +96,20 @@ making contributions to the resource.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_coverage">
|
||||
<tt class="descname">dc_coverage</tt><big>(</big><em>coverage=None</em>, <em>replace=True</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_coverage" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_coverage</code><span class="sig-paren">(</span><em>coverage=None</em>, <em>replace=True</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>
|
||||
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
|
||||
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>
|
||||
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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
|
|
@ -126,9 +129,9 @@ such as sets of coordinates or date ranges.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_creator">
|
||||
<tt class="descname">dc_creator</tt><big>(</big><em>creator=None</em>, <em>replace=False</em><big>)</big><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>
|
||||
<code class="descname">dc_creator</code><span class="sig-paren">(</span><em>creator=None</em>, <em>replace=False</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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -150,7 +153,7 @@ making the resource.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_date">
|
||||
<tt class="descname">dc_date</tt><big>(</big><em>date=None</em>, <em>replace=True</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_date" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_date</code><span class="sig-paren">(</span><em>date=None</em>, <em>replace=True</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:
|
||||
|
|
@ -174,7 +177,7 @@ associated with an event in the lifecycle of the resource.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_description">
|
||||
<tt class="descname">dc_description</tt><big>(</big><em>description=None</em>, <em>replace=True</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_description" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_description</code><span class="sig-paren">(</span><em>description=None</em>, <em>replace=True</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>
|
||||
|
|
@ -197,7 +200,7 @@ associated with an event in the lifecycle of the resource.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_format">
|
||||
<tt class="descname">dc_format</tt><big>(</big><em>format=None</em>, <em>replace=True</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_format" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_format</code><span class="sig-paren">(</span><em>format=None</em>, <em>replace=True</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:
|
||||
|
|
@ -221,9 +224,9 @@ medium, or dimensions of the resource.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_identifier">
|
||||
<tt class="descname">dc_identifier</tt><big>(</big><em>identifier=None</em>, <em>replace=True</em><big>)</big><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>
|
||||
<code class="descname">dc_identifier</code><span class="sig-paren">(</span><em>identifier=None</em>, <em>replace=True</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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -245,8 +248,9 @@ to the resource within a given context.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_language">
|
||||
<tt class="descname">dc_language</tt><big>(</big><em>language=None</em>, <em>replace=True</em><big>)</big><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>
|
||||
<code class="descname">dc_language</code><span class="sig-paren">(</span><em>language=None</em>, <em>replace=True</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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -268,9 +272,9 @@ to the resource within a given context.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_publisher">
|
||||
<tt class="descname">dc_publisher</tt><big>(</big><em>publisher=None</em>, <em>replace=False</em><big>)</big><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>
|
||||
<code class="descname">dc_publisher</code><span class="sig-paren">(</span><em>publisher=None</em>, <em>replace=False</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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -292,7 +296,7 @@ the resource available.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_relation">
|
||||
<tt class="descname">dc_relation</tt><big>(</big><em>relation=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_relation" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_relation</code><span class="sig-paren">(</span><em>relation=None</em>, <em>replace=False</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 ressource.</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>
|
||||
|
|
@ -315,7 +319,7 @@ the resource available.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_rights">
|
||||
<tt class="descname">dc_rights</tt><big>(</big><em>rights=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_rights" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_rights</code><span class="sig-paren">(</span><em>rights=None</em>, <em>replace=False</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:
|
||||
|
|
@ -339,12 +343,13 @@ held in and over the resource.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_source">
|
||||
<tt class="descname">dc_source</tt><big>(</big><em>source=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_source" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_source</code><span class="sig-paren">(</span><em>source=None</em>, <em>replace=False</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>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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -366,7 +371,7 @@ by means of a string conforming to a formal identification system.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_subject">
|
||||
<tt class="descname">dc_subject</tt><big>(</big><em>subject=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_subject" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_subject</code><span class="sig-paren">(</span><em>subject=None</em>, <em>replace=False</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>
|
||||
|
|
@ -389,7 +394,7 @@ by means of a string conforming to a formal identification system.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_title">
|
||||
<tt class="descname">dc_title</tt><big>(</big><em>title=None</em>, <em>replace=True</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_title" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_title</code><span class="sig-paren">(</span><em>title=None</em>, <em>replace=True</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>
|
||||
|
|
@ -412,7 +417,7 @@ by means of a string conforming to a formal identification system.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.dc_type">
|
||||
<tt class="descname">dc_type</tt><big>(</big><em>type=None</em>, <em>replace=False</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.dc_type" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">dc_type</code><span class="sig-paren">(</span><em>type=None</em>, <em>replace=False</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:
|
||||
|
|
@ -436,7 +441,7 @@ resource.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.extend_atom">
|
||||
<tt class="descname">extend_atom</tt><big>(</big><em>atom_feed</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.extend_atom" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">extend_atom</code><span class="sig-paren">(</span><em>atom_feed</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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -452,7 +457,7 @@ resource.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcBaseExtension.extend_rss">
|
||||
<tt class="descname">extend_rss</tt><big>(</big><em>rss_feed</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcBaseExtension.extend_rss" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">extend_rss</code><span class="sig-paren">(</span><em>rss_feed</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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -470,11 +475,11 @@ resource.</p>
|
|||
|
||||
<dl class="class">
|
||||
<dt id="feedgen.ext.dc.DcEntryExtension">
|
||||
<em class="property">class </em><tt class="descclassname">feedgen.ext.dc.</tt><tt class="descname">DcEntryExtension</tt><a class="headerlink" href="#feedgen.ext.dc.DcEntryExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.dc.</code><code class="descname">DcEntryExtension</code><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="method">
|
||||
<dt id="feedgen.ext.dc.DcEntryExtension.extend_atom">
|
||||
<tt class="descname">extend_atom</tt><big>(</big><em>entry</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcEntryExtension.extend_atom" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">extend_atom</code><span class="sig-paren">(</span><em>entry</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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -490,7 +495,7 @@ resource.</p>
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.dc.DcEntryExtension.extend_rss">
|
||||
<tt class="descname">extend_rss</tt><big>(</big><em>item</em><big>)</big><a class="headerlink" href="#feedgen.ext.dc.DcEntryExtension.extend_rss" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">extend_rss</code><span class="sig-paren">(</span><em>item</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>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -508,7 +513,7 @@ resource.</p>
|
|||
|
||||
<dl class="class">
|
||||
<dt id="feedgen.ext.dc.DcExtension">
|
||||
<em class="property">class </em><tt class="descclassname">feedgen.ext.dc.</tt><tt class="descname">DcExtension</tt><a class="headerlink" href="#feedgen.ext.dc.DcExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.dc.</code><code class="descname">DcExtension</code><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>
|
||||
|
||||
|
|
@ -516,7 +521,7 @@ resource.</p>
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.base.html">feedgen.ext.base</a>
|
||||
|
|
@ -528,9 +533,9 @@ resource.</p>
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.podcast — python-feedgen 0.4.0 documentation</title>
|
||||
<title>feedgen.ext.podcast — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,17 +23,19 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="../index.html" />
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 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.dc" href="api.ext.dc.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.podcast</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.dc.html">feedgen.ext.dc</a>
|
||||
|
|
@ -64,11 +66,11 @@
|
|||
</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>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.podcast.</code><code class="descname">PodcastExtension</code><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>
|
||||
<code class="descname">extend_rss</code><span class="sig-paren">(</span><em>rss_feed</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.extend_rss" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Extend an RSS feed root with set itunes fields.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -82,9 +84,9 @@
|
|||
|
||||
<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
|
||||
<code class="descname">itunes_author</code><span class="sig-paren">(</span><em>itunes_author=None</em><span class="sig-paren">)</span><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">
|
||||
|
|
@ -101,9 +103,9 @@ feed level, iTunes will use the contents of <managingEditor>.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_block</code><span class="sig-paren">(</span><em>itunes_block=None</em><span class="sig-paren">)</span><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" />
|
||||
|
|
@ -118,7 +120,7 @@ podcast from appearing in the iTunes podcast directory.</p>
|
|||
|
||||
<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>replace=False</em>, <em>**kwargs</em><big>)</big><a class="headerlink" href="#feedgen.ext.podcast.PodcastExtension.itunes_category" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">itunes_category</code><span class="sig-paren">(</span><em>itunes_category=None</em>, <em>replace=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><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
|
||||
|
|
@ -137,14 +139,14 @@ and in iTunes Store Browser.</p>
|
|||
<p>If a podcast has more than one subcategory from the same category, the
|
||||
category is called more than once.</p>
|
||||
<p>Likei the parameter:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="p">[{</span><span class="s2">"cat"</span><span class="p">:</span><span class="s2">"Arts"</span><span class="p">,</span><span class="s2">"sub"</span><span class="p">:</span><span class="s2">"Design"</span><span class="p">},{</span><span class="s2">"cat"</span><span class="p">:</span><span class="s2">"Arts"</span><span class="p">,</span><span class="s2">"sub"</span><span class="p">:</span><span class="s2">"Food"</span><span class="p">}]</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[{</span><span class="s2">"cat"</span><span class="p">:</span><span class="s2">"Arts"</span><span class="p">,</span><span class="s2">"sub"</span><span class="p">:</span><span class="s2">"Design"</span><span class="p">},{</span><span class="s2">"cat"</span><span class="p">:</span><span class="s2">"Arts"</span><span class="p">,</span><span class="s2">"sub"</span><span class="p">:</span><span class="s2">"Food"</span><span class="p">}]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>…would become:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><itunes:category text="Arts">
|
||||
<itunes:category text="Design"/>
|
||||
<itunes:category text="Food"/>
|
||||
</itunes:category>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">itunes</span><span class="p">:</span><span class="n">category</span> <span class="n">text</span><span class="o">=</span><span class="s2">"Arts"</span><span class="o">></span>
|
||||
<span class="o"><</span><span class="n">itunes</span><span class="p">:</span><span class="n">category</span> <span class="n">text</span><span class="o">=</span><span class="s2">"Design"</span><span class="o">/></span>
|
||||
<span class="o"><</span><span class="n">itunes</span><span class="p">:</span><span class="n">category</span> <span class="n">text</span><span class="o">=</span><span class="s2">"Food"</span><span class="o">/></span>
|
||||
<span class="o"></</span><span class="n">itunes</span><span class="p">:</span><span class="n">category</span><span class="o">></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
|
|
@ -164,16 +166,16 @@ itunes_category data.</li>
|
|||
</tbody>
|
||||
</table>
|
||||
<p>—</p>
|
||||
<p><strong>Important note about deprecated parameter syntax:</strong> Old version of the
|
||||
feedgen did only support one category plus one subcategory which would be
|
||||
passed to this ducntion as first two parameters. For compatibility
|
||||
reasons, this still works but should not be used any may be removed at
|
||||
any time.</p>
|
||||
<p><strong>Important note about deprecated parameter syntax:</strong> Old version of
|
||||
the feedgen did only support one category plus one subcategory which
|
||||
would be passed to this ducntion as first two parameters. For
|
||||
compatibility reasons, this still works but should not be used any may
|
||||
be removed at any time.</p>
|
||||
</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>
|
||||
<code class="descname">itunes_complete</code><span class="sig-paren">(</span><em>itunes_complete=None</em><span class="sig-paren">)</span><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
|
||||
|
|
@ -194,17 +196,18 @@ the podcast.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_explicit</code><span class="sig-paren">(</span><em>itunes_explicit=None</em><span class="sig-paren">)</span><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>
|
||||
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
|
||||
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>
|
||||
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" />
|
||||
|
|
@ -219,20 +222,20 @@ will appear. If the explicit tag is present and has any other value
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_image</code><span class="sig-paren">(</span><em>itunes_image=None</em><span class="sig-paren">)</span><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>
|
||||
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
|
||||
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" />
|
||||
|
|
@ -248,12 +251,12 @@ requests for iTS to be able to automatically update your cover art.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_new_feed_url</code><span class="sig-paren">(</span><em>itunes_new_feed_url=None</em><span class="sig-paren">)</span><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>
|
||||
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" />
|
||||
|
|
@ -268,7 +271,7 @@ the directory with the new feed URL.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_owner</code><span class="sig-paren">(</span><em>name=None</em>, <em>email=None</em><span class="sig-paren">)</span><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
|
||||
|
|
@ -287,7 +290,7 @@ displayed.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_subtitle</code><span class="sig-paren">(</span><em>itunes_subtitle=None</em><span class="sig-paren">)</span><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>
|
||||
|
|
@ -305,13 +308,13 @@ displays best if it is only a few words long.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_summary</code><span class="sig-paren">(</span><em>itunes_summary=None</em><span class="sig-paren">)</span><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>
|
||||
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
|
||||
<cite><itunes:summary></cite> 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" />
|
||||
|
|
@ -330,7 +333,7 @@ are used.</p>
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.dc.html">feedgen.ext.dc</a>
|
||||
|
|
@ -342,9 +345,9 @@ are used.</p>
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.podcast_entry — python-feedgen 0.4.0 documentation</title>
|
||||
<title>feedgen.ext.podcast_entry — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,17 +23,19 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="../index.html" />
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="API Documentation" href="../api.html" />
|
||||
<link rel="next" title="feedgen.ext.torrent" href="api.ext.torrent.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>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.podcast_entry</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.podcast.html">feedgen.ext.podcast</a>
|
||||
|
|
@ -56,7 +58,7 @@
|
|||
<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 class="field-odd field"><th class="field-name">copyright:</th><td class="field-body">2013-2016, 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>
|
||||
|
|
@ -64,11 +66,11 @@
|
|||
</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>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.podcast_entry.</code><code class="descname">PodcastEntryExtension</code><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>
|
||||
<code class="descname">extend_rss</code><span class="sig-paren">(</span><em>entry</em><span class="sig-paren">)</span><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" />
|
||||
|
|
@ -82,12 +84,12 @@
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_author</code><span class="sig-paren">(</span><em>itunes_author=None</em><span class="sig-paren">)</span><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>
|
||||
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" />
|
||||
|
|
@ -102,7 +104,7 @@ is not present at the feed level, iTunes will use the contents of
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_block</code><span class="sig-paren">(</span><em>itunes_block=None</em><span class="sig-paren">)</span><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">
|
||||
|
|
@ -119,15 +121,15 @@ from appearing in the iTunes podcast directory.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_duration</code><span class="sig-paren">(</span><em>itunes_duration=None</em><span class="sig-paren">)</span><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>
|
||||
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" />
|
||||
|
|
@ -142,22 +144,25 @@ numbers farthest to the right are ignored.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_explicit</code><span class="sig-paren">(</span><em>itunes_explicit=None</em><span class="sig-paren">)</span><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
|
||||
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>
|
||||
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 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>
|
||||
|
|
@ -167,20 +172,21 @@ will appear. If the explicit tag is present and has any other value
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_image</code><span class="sig-paren">(</span><em>itunes_image=None</em><span class="sig-paren">)</span><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>
|
||||
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
|
||||
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" />
|
||||
|
|
@ -196,16 +202,17 @@ requests for iTS to be able to automatically update your cover art.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_is_closed_captioned</code><span class="sig-paren">(</span><em>itunes_is_closed_captioned=None</em><span class="sig-paren">)</span><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 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>
|
||||
|
|
@ -215,16 +222,17 @@ closed captioning support. The two values for this tag are “yes” and
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_order</code><span class="sig-paren">(</span><em>itunes_order=None</em><span class="sig-paren">)</span><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>
|
||||
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" />
|
||||
|
|
@ -239,7 +247,7 @@ use default ordering (pubDate).</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_subtitle</code><span class="sig-paren">(</span><em>itunes_subtitle=None</em><span class="sig-paren">)</span><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>
|
||||
|
|
@ -257,13 +265,13 @@ subtitle displays best if it is only a few words long.</p>
|
|||
|
||||
<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>
|
||||
<code class="descname">itunes_summary</code><span class="sig-paren">(</span><em>itunes_summary=None</em><span class="sig-paren">)</span><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>
|
||||
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" />
|
||||
|
|
@ -282,7 +290,7 @@ are used.</p>
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.podcast.html">feedgen.ext.podcast</a>
|
||||
|
|
@ -294,9 +302,9 @@ are used.</p>
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>feedgen.ext.torrent — python-feedgen 0.4.0 documentation</title>
|
||||
<title>feedgen.ext.torrent — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="../_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: '../',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,16 +23,18 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="../index.html" />
|
||||
<link rel="index" title="Index" href="../genindex.html" />
|
||||
<link rel="search" title="Search" href="../search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 documentation" href="../index.html" />
|
||||
<link rel="up" title="API Documentation" href="../api.html" />
|
||||
<link rel="prev" title="feedgen.ext.podcast_entry" href="api.ext.podcast_entry.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="../index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>feedgen.ext.torrent</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.podcast_entry.html">feedgen.ext.podcast_entry</a>
|
||||
|
|
@ -61,11 +63,11 @@
|
|||
</table>
|
||||
<dl class="class">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension">
|
||||
<em class="property">class </em><tt class="descclassname">feedgen.ext.torrent.</tt><tt class="descname">TorrentEntryExtension</tt><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.torrent.</code><code class="descname">TorrentEntryExtension</code><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>FeedEntry extention for torrent feeds</p>
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension.contentlength">
|
||||
<tt class="descname">contentlength</tt><big>(</big><em>torrent_contentlength=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.contentlength" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">contentlength</code><span class="sig-paren">(</span><em>torrent_contentlength=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.contentlength" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the size of the target file.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -81,7 +83,7 @@
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension.extend_rss">
|
||||
<tt class="descname">extend_rss</tt><big>(</big><em>entry</em><big>)</big><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.extend_rss" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">extend_rss</code><span class="sig-paren">(</span><em>entry</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.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" />
|
||||
|
|
@ -95,7 +97,7 @@
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension.filename">
|
||||
<tt class="descname">filename</tt><big>(</big><em>torrent_filename=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.filename" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">filename</code><span class="sig-paren">(</span><em>torrent_filename=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.filename" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the name of the torrent file.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -111,7 +113,7 @@
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension.infohash">
|
||||
<tt class="descname">infohash</tt><big>(</big><em>torrent_infohash=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.infohash" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">infohash</code><span class="sig-paren">(</span><em>torrent_infohash=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.infohash" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the hash of the target file.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -127,7 +129,7 @@
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension.peers">
|
||||
<tt class="descname">peers</tt><big>(</big><em>torrent_peers=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.peers" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">peers</code><span class="sig-paren">(</span><em>torrent_peers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.peers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the number od peers</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -143,7 +145,7 @@
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension.seeds">
|
||||
<tt class="descname">seeds</tt><big>(</big><em>torrent_seeds=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.seeds" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">seeds</code><span class="sig-paren">(</span><em>torrent_seeds=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.seeds" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the number of seeds.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -159,7 +161,7 @@
|
|||
|
||||
<dl class="method">
|
||||
<dt id="feedgen.ext.torrent.TorrentEntryExtension.verified">
|
||||
<tt class="descname">verified</tt><big>(</big><em>torrent_verified=None</em><big>)</big><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.verified" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="descname">verified</code><span class="sig-paren">(</span><em>torrent_verified=None</em><span class="sig-paren">)</span><a class="headerlink" href="#feedgen.ext.torrent.TorrentEntryExtension.verified" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Get or set the number of verified peers.</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
|
|
@ -177,7 +179,7 @@
|
|||
|
||||
<dl class="class">
|
||||
<dt id="feedgen.ext.torrent.TorrentExtension">
|
||||
<em class="property">class </em><tt class="descclassname">feedgen.ext.torrent.</tt><tt class="descname">TorrentExtension</tt><a class="headerlink" href="#feedgen.ext.torrent.TorrentExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="descclassname">feedgen.ext.torrent.</code><code class="descname">TorrentExtension</code><a class="headerlink" href="#feedgen.ext.torrent.TorrentExtension" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>FeedGenerator extension for torrent feeds.</p>
|
||||
</dd></dl>
|
||||
|
||||
|
|
@ -185,7 +187,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
«  <a href="api.ext.podcast_entry.html">feedgen.ext.podcast_entry</a>
|
||||
|
|
@ -195,9 +197,9 @@
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — python-feedgen 0.4.0 documentation</title>
|
||||
<title>Index — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -15,7 +15,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,14 +24,16 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="index.html" />
|
||||
<link rel="index" title="Index" href="#" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 documentation" href="index.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Index</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="index.html">Contents</a>
|
||||
|
|
@ -139,12 +141,12 @@
|
|||
<dt><a href="api.entry.html#feedgen.entry.FeedEntry.comments">comments() (feedgen.entry.FeedEntry method)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="api.entry.html#feedgen.entry.FeedEntry.content">content() (feedgen.entry.FeedEntry method)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="ext/api.ext.torrent.html#feedgen.ext.torrent.TorrentEntryExtension.contentlength">contentlength() (feedgen.ext.torrent.TorrentEntryExtension method)</a>
|
||||
</dt>
|
||||
|
|
@ -275,8 +277,6 @@
|
|||
<dt><a href="api.feed.html#feedgen.feed.FeedGenerator.entry">entry() (feedgen.feed.FeedGenerator method)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="ext/api.ext.base.html#feedgen.ext.base.BaseExtension.extend_atom">extend_atom() (feedgen.ext.base.BaseExtension method)</a>
|
||||
</dt>
|
||||
|
|
@ -291,6 +291,8 @@
|
|||
</dt>
|
||||
|
||||
</dl></dd>
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="ext/api.ext.base.html#feedgen.ext.base.BaseExtension.extend_ns">extend_ns() (feedgen.ext.base.BaseExtension method)</a>
|
||||
</dt>
|
||||
|
|
@ -351,12 +353,12 @@
|
|||
<dt><a href="ext/api.ext.podcast.html#module-feedgen.ext.podcast">feedgen.ext.podcast (module)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="ext/api.ext.podcast_entry.html#module-feedgen.ext.podcast_entry">feedgen.ext.podcast_entry (module)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="ext/api.ext.torrent.html#module-feedgen.ext.torrent">feedgen.ext.torrent (module)</a>
|
||||
</dt>
|
||||
|
|
@ -667,12 +669,12 @@
|
|||
<dt><a href="api.feed.html#feedgen.feed.FeedGenerator.skipDays">skipDays() (feedgen.feed.FeedGenerator method)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="api.feed.html#feedgen.feed.FeedGenerator.skipHours">skipHours() (feedgen.feed.FeedGenerator method)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="api.feed.html#feedgen.feed.FeedGenerator.subtitle">subtitle() (feedgen.feed.FeedGenerator method)</a>
|
||||
</dt>
|
||||
|
|
@ -701,12 +703,12 @@
|
|||
</dt>
|
||||
|
||||
</dl></dd>
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="ext/api.ext.torrent.html#feedgen.ext.torrent.TorrentEntryExtension">TorrentEntryExtension (class in feedgen.ext.torrent)</a>
|
||||
</dt>
|
||||
|
||||
</dl></td>
|
||||
<td style="width: 33%" valign="top"><dl>
|
||||
|
||||
<dt><a href="ext/api.ext.torrent.html#feedgen.ext.torrent.TorrentExtension">TorrentExtension (class in feedgen.ext.torrent)</a>
|
||||
</dt>
|
||||
|
|
@ -763,7 +765,7 @@
|
|||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="index.html">Contents</a>
|
||||
|
|
@ -771,9 +773,9 @@
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
107
index.html
107
index.html
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Feedgenerator — python-feedgen 0.4.0 documentation</title>
|
||||
<title>Feedgenerator — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,15 +23,17 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="#" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 documentation" href="#" />
|
||||
<link rel="next" title="API Documentation" href="api.html" />
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="#">
|
||||
<span>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="#">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Feedgenerator</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="#">Contents</a>
|
||||
|
|
@ -46,26 +48,24 @@
|
|||
<div class="contents topic" id="table-of-contents">
|
||||
<p class="topic-title first">Table of Contents</p>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#feedgenerator" id="id3">Feedgenerator</a><ul>
|
||||
<li><a class="reference internal" href="#installation" id="id4">Installation</a></li>
|
||||
<li><a class="reference internal" href="#create-a-feed" id="id5">Create a Feed</a></li>
|
||||
<li><a class="reference internal" href="#generate-the-feed" id="id6">Generate the Feed</a></li>
|
||||
<li><a class="reference internal" href="#add-feed-entries" id="id7">Add Feed Entries</a></li>
|
||||
<li><a class="reference internal" href="#extensions" id="id8">Extensions</a></li>
|
||||
<li><a class="reference internal" href="#testing-the-generator" id="id9">Testing the Generator</a></li>
|
||||
<li><a class="reference internal" href="#feedgenerator" id="id1">Feedgenerator</a><ul>
|
||||
<li><a class="reference internal" href="#installation" id="id2">Installation</a></li>
|
||||
<li><a class="reference internal" href="#create-a-feed" id="id3">Create a Feed</a></li>
|
||||
<li><a class="reference internal" href="#generate-the-feed" id="id4">Generate the Feed</a></li>
|
||||
<li><a class="reference internal" href="#add-feed-entries" id="id5">Add Feed Entries</a></li>
|
||||
<li><a class="reference internal" href="#extensions" id="id6">Extensions</a></li>
|
||||
<li><a class="reference internal" href="#testing-the-generator" id="id7">Testing the Generator</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#module-documentation" id="id10">Module documentation</a></li>
|
||||
<li><a class="reference internal" href="#indices-and-tables" id="id11">Indices and tables</a></li>
|
||||
<li><a class="reference internal" href="#module-documentation" id="id8">Module documentation</a></li>
|
||||
<li><a class="reference internal" href="#indices-and-tables" id="id9">Indices and tables</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="feedgenerator">
|
||||
<h1><a class="toc-backref" href="#id3">Feedgenerator</a><a class="headerlink" href="#feedgenerator" title="Permalink to this headline">¶</a></h1>
|
||||
<p><a class="reference external" href="https://travis-ci.org/lkiesow/python-feedgen.svg?branch=master">![Build Status</a>
|
||||
](<a class="reference external" href="https://travis-ci.org/lkiesow/python-feedgen">https://travis-ci.org/lkiesow/python-feedgen</a>)</p>
|
||||
<h1><a class="toc-backref" href="#id1">Feedgenerator</a><a class="headerlink" href="#feedgenerator" title="Permalink to this headline">¶</a></h1>
|
||||
<a class="reference external image-reference" href="https://travis-ci.org/lkiesow/python-feedgen"><img alt="Build Status" src="https://travis-ci.org/lkiesow/python-feedgen.svg?branch=master" /></a>
|
||||
<p>This module can be used to generate web feeds in both ATOM and RSS format. It
|
||||
has support for extensions. Included is for example an extension to produce
|
||||
Podcasts.</p>
|
||||
has support for extensions. Included is for example an extension to produce Podcasts.</p>
|
||||
<p>It is licensed under the terms of both, the FreeBSD license and the LGPLv3+.
|
||||
Choose the one which is more convenient for you. For more details have a look
|
||||
at license.bsd and license.lgpl.</p>
|
||||
|
|
@ -76,31 +76,30 @@ at license.bsd and license.lgpl.</p>
|
|||
<li>Python Package Index: <a class="reference external" href="https://pypi.python.org/pypi/feedgen/">https://pypi.python.org/pypi/feedgen/</a></li>
|
||||
</ul>
|
||||
<div class="section" id="installation">
|
||||
<h2><a class="toc-backref" href="#id4">Installation</a><a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id2">Installation</a><a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
|
||||
<p><strong>Prebuild packages</strong></p>
|
||||
<p>If you are running Fedora Linux, RedHat Enterprise Linux, CentOS or Scientific
|
||||
Linux you can use the RPM Copr repostiory:</p>
|
||||
<dl class="docutils">
|
||||
<dt><a href="#id1"><span class="problematic" id="id2">`</span></a><a class="reference external" href="http://copr.fedoraproject.org/coprs/lkiesow/python-feedgen/">http://copr.fedoraproject.org/coprs/lkiesow/python-feedgen/</a></dt>
|
||||
<dd><<a class="reference external" href="http://copr.fedoraproject.org/coprs/lkiesow/python-feedgen/">http://copr.fedoraproject.org/coprs/lkiesow/python-feedgen/</a>>`_</dd>
|
||||
</dl>
|
||||
<p><a class="reference external" href="http://copr.fedoraproject.org/coprs/lkiesow/python-feedgen/">http://copr.fedoraproject.org/coprs/lkiesow/python-feedgen/</a></p>
|
||||
<p>Simply enable the repository and run:</p>
|
||||
<blockquote>
|
||||
<div>$ yum install python-feedgen</div></blockquote>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span>$ yum install python-feedgen
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>or for the Python 3 package:</p>
|
||||
<blockquote>
|
||||
<div>$ yum install python3-feedgen</div></blockquote>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span>$ yum install python3-feedgen
|
||||
</pre></div>
|
||||
</div>
|
||||
<p><strong>Using pip</strong></p>
|
||||
<p>You can also use pip to install the feedgen module. Simply run:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span>$ pip install feedgen
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install feedgen
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="create-a-feed">
|
||||
<h2><a class="toc-backref" href="#id5">Create a Feed</a><a class="headerlink" href="#create-a-feed" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id3">Create a Feed</a><a class="headerlink" href="#create-a-feed" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To create a feed simply instanciate the FeedGenerator class and insert some
|
||||
data:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="kn">import</span> <span class="n">FeedGenerator</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="k">import</span> <span class="n">FeedGenerator</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span> <span class="o">=</span> <span class="n">FeedGenerator</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">id</span><span class="p">(</span><span class="s1">'http://lernfunk.de/media/654321'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s1">'Some Testfeed'</span><span class="p">)</span>
|
||||
|
|
@ -120,29 +119,29 @@ feed you can use all of the following ways to provide data:</p>
|
|||
<li>Provide a list of dictionaries with the data for several elements</li>
|
||||
</ul>
|
||||
<p>Example:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">contributor</span><span class="p">(</span> <span class="n">name</span><span class="o">=</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="n">email</span><span class="o">=</span><span class="s1">'jdoe@example.com'</span> <span class="p">)</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">contributor</span><span class="p">(</span> <span class="n">name</span><span class="o">=</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="n">email</span><span class="o">=</span><span class="s1">'jdoe@example.com'</span> <span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">contributor</span><span class="p">({</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">:</span><span class="s1">'jdoe@example.com'</span><span class="p">})</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">contributor</span><span class="p">([{</span><span class="s1">'name'</span><span class="p">:</span><span class="s1">'John Doe'</span><span class="p">,</span> <span class="s1">'email'</span><span class="p">:</span><span class="s1">'jdoe@example.com'</span><span class="p">},</span> <span class="o">...</span><span class="p">])</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="generate-the-feed">
|
||||
<h2><a class="toc-backref" href="#id6">Generate the Feed</a><a class="headerlink" href="#generate-the-feed" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id4">Generate the Feed</a><a class="headerlink" href="#generate-the-feed" title="Permalink to this headline">¶</a></h2>
|
||||
<p>After that you can generate both RSS or ATOM by calling the respective method:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">atomfeed</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">atom_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> <span class="c1"># Get the ATOM feed as string</span>
|
||||
<span class="gp">>>> </span><span class="n">rssfeed</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">rss_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> <span class="c1"># Get the RSS feed as string</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">atomfeed</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">atom_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># Get the ATOM feed as string</span>
|
||||
<span class="gp">>>> </span><span class="n">rssfeed</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">rss_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># Get the RSS feed as string</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">atom_file</span><span class="p">(</span><span class="s1">'atom.xml'</span><span class="p">)</span> <span class="c1"># Write the ATOM feed to a file</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_file</span><span class="p">(</span><span class="s1">'rss.xml'</span><span class="p">)</span> <span class="c1"># Write the RSS feed to a file</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="add-feed-entries">
|
||||
<h2><a class="toc-backref" href="#id7">Add Feed Entries</a><a class="headerlink" href="#add-feed-entries" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id5">Add Feed Entries</a><a class="headerlink" href="#add-feed-entries" title="Permalink to this headline">¶</a></h2>
|
||||
<p>To add entries (items) to a feed you need to create new FeedEntry objects and
|
||||
append them to the list of entries in the FeedGenerator. The most convenient
|
||||
way to go is to use the FeedGenerator itself for the instantiation of the
|
||||
FeedEntry object:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fe</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">add_entry</span><span class="p">()</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fe</span> <span class="o">=</span> <span class="n">fg</span><span class="o">.</span><span class="n">add_entry</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">fe</span><span class="o">.</span><span class="n">id</span><span class="p">(</span><span class="s1">'http://lernfunk.de/media/654321/1'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fe</span><span class="o">.</span><span class="n">title</span><span class="p">(</span><span class="s1">'The First Episode'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
|
|
@ -152,10 +151,10 @@ automatically generate a new FeedEntry object, append it to the feeds internal
|
|||
list of entries and return it, so that additional data can be added.</p>
|
||||
</div>
|
||||
<div class="section" id="extensions">
|
||||
<h2><a class="toc-backref" href="#id8">Extensions</a><a class="headerlink" href="#extensions" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id6">Extensions</a><a class="headerlink" href="#extensions" title="Permalink to this headline">¶</a></h2>
|
||||
<p>The FeedGenerator supports extension to include additional data into the XML
|
||||
structure of the feeds. Extensions can be loaded like this:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">load_extension</span><span class="p">(</span><span class="s1">'someext'</span><span class="p">,</span> <span class="n">atom</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">rss</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">load_extension</span><span class="p">(</span><span class="s1">'someext'</span><span class="p">,</span> <span class="n">atom</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">rss</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>This will try to load the extension “someext” from the file <cite>ext/someext.py</cite>.
|
||||
|
|
@ -174,7 +173,7 @@ meaning the extension is used for both kinds of feeds.</p>
|
|||
<p>One extension already provided is the podcast extension. A podcast is an RSS
|
||||
feed with some additional elements for ITunes.</p>
|
||||
<p>To produce a podcast simply load the <cite>podcast</cite> extension:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="kn">import</span> <span class="n">FeedGenerator</span>
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">feedgen.feed</span> <span class="k">import</span> <span class="n">FeedGenerator</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span> <span class="o">=</span> <span class="n">FeedGenerator</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">load_extension</span><span class="p">(</span><span class="s1">'podcast'</span><span class="p">)</span>
|
||||
<span class="gp">...</span>
|
||||
|
|
@ -186,7 +185,7 @@ feed with some additional elements for ITunes.</p>
|
|||
<span class="gp">>>> </span><span class="n">fe</span><span class="o">.</span><span class="n">description</span><span class="p">(</span><span class="s1">'Enjoy our first episode.'</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fe</span><span class="o">.</span><span class="n">enclosure</span><span class="p">(</span><span class="s1">'http://lernfunk.de/media/654321/1/file.mp3'</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="s1">'audio/mpeg'</span><span class="p">)</span>
|
||||
<span class="gp">...</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_str</span><span class="p">(</span><span class="n">pretty</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
|
||||
<span class="gp">>>> </span><span class="n">fg</span><span class="o">.</span><span class="n">rss_file</span><span class="p">(</span><span class="s1">'podcast.xml'</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
|
|
@ -206,9 +205,9 @@ pass the classes for the feed and the entry extension to this method meaning
|
|||
that you can define them everywhere.</p>
|
||||
</div>
|
||||
<div class="section" id="testing-the-generator">
|
||||
<h2><a class="toc-backref" href="#id9">Testing the Generator</a><a class="headerlink" href="#testing-the-generator" title="Permalink to this headline">¶</a></h2>
|
||||
<h2><a class="toc-backref" href="#id7">Testing the Generator</a><a class="headerlink" href="#testing-the-generator" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can test the module by simply executing:</p>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span></span>$ python -m feedgen
|
||||
<div class="highlight-default"><div class="highlight"><pre><span></span>$ python -m feedgen
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>If you want to have a look at the code for this test to have a working code
|
||||
|
|
@ -217,7 +216,7 @@ example for a whole feed generation process, you can find it in the
|
|||
<hr /></div>
|
||||
</div>
|
||||
<div class="section" id="module-documentation">
|
||||
<h1><a class="toc-backref" href="#id10">Module documentation</a><a class="headerlink" href="#module-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<h1><a class="toc-backref" href="#id8">Module documentation</a><a class="headerlink" href="#module-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="api.html">API Documentation</a><ul>
|
||||
|
|
@ -236,17 +235,17 @@ example for a whole feed generation process, you can find it in the
|
|||
</div>
|
||||
</div>
|
||||
<div class="section" id="indices-and-tables">
|
||||
<h1><a class="toc-backref" href="#id11">Indices and tables</a><a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<h1><a class="toc-backref" href="#id9">Indices and tables</a><a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
|
||||
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
|
||||
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
|
||||
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
|
||||
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
|
||||
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="#">Contents</a>
|
||||
|
|
@ -256,9 +255,9 @@ example for a whole feed generation process, you can find it in the
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Python Module Index — python-feedgen 0.4.0 documentation</title>
|
||||
<title>Python Module Index — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -23,17 +23,19 @@
|
|||
<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>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="index.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 documentation" href="index.html" />
|
||||
|
||||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Python Module Index</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="index.html">Contents</a>
|
||||
|
|
@ -51,60 +53,60 @@
|
|||
</div>
|
||||
|
||||
<table class="indextable modindextable" cellspacing="0" cellpadding="2">
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-f"><td></td><td>
|
||||
<strong>f</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td><img src="_static/minus.png" class="toggler"
|
||||
id="toggle-1" style="display: none" alt="-" /></td>
|
||||
<td>
|
||||
<a href="api.html#module-feedgen"><tt class="xref">feedgen</tt></a></td><td>
|
||||
<a href="api.html#module-feedgen"><code class="xref">feedgen</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="api.entry.html#module-feedgen.entry"><tt class="xref">feedgen.entry</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="api.entry.html#module-feedgen.entry"><code class="xref">feedgen.entry</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="ext/api.ext.base.html#module-feedgen.ext.base"><tt class="xref">feedgen.ext.base</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="ext/api.ext.base.html#module-feedgen.ext.base"><code class="xref">feedgen.ext.base</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="ext/api.ext.dc.html#module-feedgen.ext.dc"><tt class="xref">feedgen.ext.dc</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="ext/api.ext.dc.html#module-feedgen.ext.dc"><code class="xref">feedgen.ext.dc</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="ext/api.ext.podcast.html#module-feedgen.ext.podcast"><tt class="xref">feedgen.ext.podcast</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="ext/api.ext.podcast.html#module-feedgen.ext.podcast"><code class="xref">feedgen.ext.podcast</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="ext/api.ext.podcast_entry.html#module-feedgen.ext.podcast_entry"><tt class="xref">feedgen.ext.podcast_entry</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="ext/api.ext.podcast_entry.html#module-feedgen.ext.podcast_entry"><code class="xref">feedgen.ext.podcast_entry</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="ext/api.ext.torrent.html#module-feedgen.ext.torrent"><tt class="xref">feedgen.ext.torrent</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="ext/api.ext.torrent.html#module-feedgen.ext.torrent"><code class="xref">feedgen.ext.torrent</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="api.feed.html#module-feedgen.feed"><tt class="xref">feedgen.feed</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="api.feed.html#module-feedgen.feed"><code class="xref">feedgen.feed</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="cg-1">
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="api.util.html#module-feedgen.util"><tt class="xref">feedgen.util</tt></a></td><td>
|
||||
<td>   
|
||||
<a href="api.util.html#module-feedgen.util"><code class="xref">feedgen.util</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="index.html">Contents</a>
|
||||
|
|
@ -112,9 +114,9 @@
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
24
search.html
24
search.html
|
|
@ -6,7 +6,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — python-feedgen 0.4.0 documentation</title>
|
||||
<title>Search — python-feedgen 0.5.1 documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/lernfunk.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
|
@ -14,7 +14,7 @@
|
|||
<script type="text/javascript">
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: './',
|
||||
VERSION: '0.4.0',
|
||||
VERSION: '0.5.1',
|
||||
COLLAPSE_INDEX: false,
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true
|
||||
|
|
@ -24,7 +24,9 @@
|
|||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/searchtools.js"></script>
|
||||
<link rel="top" title="python-feedgen 0.4.0 documentation" href="index.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="#" />
|
||||
<link rel="top" title="python-feedgen 0.5.1 documentation" href="index.html" />
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
|
@ -33,12 +35,12 @@
|
|||
|
||||
|
||||
</head>
|
||||
<body>
|
||||
<div class="header"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.4.0 documentation</span></a></h1>
|
||||
<body role="document">
|
||||
<div class="header" role="banner"><h1 class="heading"><a href="index.html">
|
||||
<span>python-feedgen 0.5.1 documentation</span></a></h1>
|
||||
<h2 class="heading"><span>Search</span></h2>
|
||||
</div>
|
||||
<div class="topnav">
|
||||
<div class="topnav" role="navigation" aria-label="top navigation">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="index.html">Contents</a>
|
||||
|
|
@ -73,7 +75,7 @@
|
|||
</div>
|
||||
|
||||
</div>
|
||||
<div class="bottomnav">
|
||||
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
|
||||
|
||||
<p>
|
||||
<a class="uplink" href="index.html">Contents</a>
|
||||
|
|
@ -81,9 +83,9 @@
|
|||
|
||||
</div>
|
||||
|
||||
<div class="footer">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2013-2016, Lars Kiesow.
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.8.
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue