commit e3359d922e8866c91e325b64e852db79ec74a3b2 Author: Lars Kiesow Date: Sun May 5 22:12:47 2013 +0200 First commit of HTML docs diff --git a/_static/ajax-loader.gif b/_static/ajax-loader.gif new file mode 100644 index 0000000..61faf8c Binary files /dev/null and b/_static/ajax-loader.gif differ diff --git a/_static/alert_info_32.png b/_static/alert_info_32.png new file mode 100644 index 0000000..05b4fe8 Binary files /dev/null and b/_static/alert_info_32.png differ diff --git a/_static/alert_warning_32.png b/_static/alert_warning_32.png new file mode 100644 index 0000000..f13611c Binary files /dev/null and b/_static/alert_warning_32.png differ diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 0000000..43e8baf --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,540 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 170px; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + width: 30px; +} + +img { + border: 0; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li div.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable dl, table.indextable dd { + margin-top: 0; + margin-bottom: 0; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- general body styles --------------------------------------------------- */ + +a.headerlink { + visibility: hidden; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.field-list ul { + padding-left: 1em; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px 7px 0 7px; + background-color: #ffe; + width: 40%; + float: right; +} + +p.sidebar-title { + font-weight: bold; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px 7px 0 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +div.admonition dl { + margin-bottom: 0; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + border: 0; + border-collapse: collapse; +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.field-list td, table.field-list th { + border: 0 !important; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +dl { + margin-bottom: 15px; +} + +dd p { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dt:target, .highlighted { + background-color: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.refcount { + color: #060; +} + +.optional { + font-size: 1.3em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +td.linenos pre { + padding: 5px 0px; + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + margin-left: 0.5em; +} + +table.highlighttable td { + padding: 0 0.5em 0 0.5em; +} + +tt.descname { + background-color: transparent; + font-weight: bold; + font-size: 1.2em; +} + +tt.descclassname { + background-color: transparent; +} + +tt.xref, a tt { + background-color: transparent; + font-weight: bold; +} + +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/bg-page.png b/_static/bg-page.png new file mode 100644 index 0000000..c6f3bc4 Binary files /dev/null and b/_static/bg-page.png differ diff --git a/_static/bullet_orange.png b/_static/bullet_orange.png new file mode 100644 index 0000000..ad5d02f Binary files /dev/null and b/_static/bullet_orange.png differ diff --git a/_static/comment-bright.png b/_static/comment-bright.png new file mode 100644 index 0000000..551517b Binary files /dev/null and b/_static/comment-bright.png differ diff --git a/_static/comment-close.png b/_static/comment-close.png new file mode 100644 index 0000000..09b54be Binary files /dev/null and b/_static/comment-close.png differ diff --git a/_static/comment.png b/_static/comment.png new file mode 100644 index 0000000..92feb52 Binary files /dev/null and b/_static/comment.png differ diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 0000000..d4619fd --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,247 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + */ +jQuery.urldecode = function(x) { + return decodeURIComponent(x).replace(/\+/g, ' '); +} + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s == 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * small function to check if an array contains + * a given item. + */ +jQuery.contains = function(arr, item) { + for (var i = 0; i < arr.length; i++) { + if (arr[i] == item) + return true; + } + return false; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node) { + if (node.nodeType == 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { + var span = document.createElement("span"); + span.className = className; + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this); + }); + } + } + return this.each(function() { + highlight(this); + }); +}; + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated == 'undefined') + return string; + return (typeof translated == 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated == 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) == 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this == '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/_static/down-pressed.png b/_static/down-pressed.png new file mode 100644 index 0000000..6f7ad78 Binary files /dev/null and b/_static/down-pressed.png differ diff --git a/_static/down.png b/_static/down.png new file mode 100644 index 0000000..3003a88 Binary files /dev/null and b/_static/down.png differ diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 0000000..d18082e Binary files /dev/null and b/_static/file.png differ diff --git a/_static/haiku.css b/_static/haiku.css new file mode 100644 index 0000000..1b7c261 --- /dev/null +++ b/_static/haiku.css @@ -0,0 +1,371 @@ +/* + * haiku.css_t + * ~~~~~~~~~~~ + * + * Sphinx stylesheet -- haiku theme. + * + * Adapted from http://haiku-os.org/docs/Haiku-doc.css. + * Original copyright message: + * + * Copyright 2008-2009, Haiku. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Francois Revol + * Stephan Assmus + * Braden Ewing + * Humdinger + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +@import url("basic.css"); + +html { + margin: 0px; + padding: 0px; + background: #FFF url(bg-page.png) top left repeat-x; +} + +body { + line-height: 1.5; + margin: auto; + padding: 0px; + font-family: "DejaVu Sans", Arial, Helvetica, sans-serif; + min-width: 59em; + max-width: 70em; + color: #333333; +} + +div.footer { + padding: 8px; + font-size: 11px; + text-align: center; + letter-spacing: 0.5px; +} + +/* link colors and text decoration */ + +a:link { + font-weight: bold; + text-decoration: none; + color: #dc3c01; +} + +a:visited { + font-weight: bold; + text-decoration: none; + color: #892601; +} + +a:hover, a:active { + text-decoration: underline; + color: #ff4500; +} + +/* Some headers act as anchors, don't give them a hover effect */ + +h1 a:hover, a:active { + text-decoration: none; + color: #0c3762; +} + +h2 a:hover, a:active { + text-decoration: none; + color: #0c3762; +} + +h3 a:hover, a:active { + text-decoration: none; + color: #0c3762; +} + +h4 a:hover, a:active { + text-decoration: none; + color: #0c3762; +} + +a.headerlink { + color: #a7ce38; + padding-left: 5px; +} + +a.headerlink:hover { + color: #a7ce38; +} + +/* basic text elements */ + +div.content { + margin-top: 20px; + margin-left: 40px; + margin-right: 40px; + margin-bottom: 50px; + font-size: 0.9em; +} + +/* heading and navigation */ + +div.header { + position: relative; + left: 0px; + top: 0px; + height: 85px; + /* background: #eeeeee; */ + padding: 0 40px; +} +div.header h1 { + font-size: 1.6em; + font-weight: normal; + letter-spacing: 1px; + color: #0c3762; + border: 0; + margin: 0; + padding-top: 15px; +} +div.header h1 a { + font-weight: normal; + color: #0c3762; +} +div.header h2 { + font-size: 1.3em; + font-weight: normal; + letter-spacing: 1px; + text-transform: uppercase; + color: #aaa; + border: 0; + margin-top: -3px; + padding: 0; +} + +div.header img.rightlogo { + float: right; +} + + +div.title { + font-size: 1.3em; + font-weight: bold; + color: #0c3762; + border-bottom: dotted thin #e0e0e0; + margin-bottom: 25px; +} +div.topnav { + /* background: #e0e0e0; */ +} +div.topnav p { + margin-top: 0; + margin-left: 40px; + margin-right: 40px; + margin-bottom: 0px; + text-align: right; + font-size: 0.8em; +} +div.bottomnav { + background: #eeeeee; +} +div.bottomnav p { + margin-right: 40px; + text-align: right; + font-size: 0.8em; +} + +a.uplink { + font-weight: normal; +} + + +/* contents box */ + +table.index { + margin: 0px 0px 30px 30px; + padding: 1px; + border-width: 1px; + border-style: dotted; + border-color: #e0e0e0; +} +table.index tr.heading { + background-color: #e0e0e0; + text-align: center; + font-weight: bold; + font-size: 1.1em; +} +table.index tr.index { + background-color: #eeeeee; +} +table.index td { + padding: 5px 20px; +} + +table.index a:link, table.index a:visited { + font-weight: normal; + text-decoration: none; + color: #dc3c01; +} +table.index a:hover, table.index a:active { + text-decoration: underline; + color: #ff4500; +} + + +/* Haiku User Guide styles and layout */ + +/* Rounded corner boxes */ +/* Common declarations */ +div.admonition { + -webkit-border-radius: 10px; + -khtml-border-radius: 10px; + -moz-border-radius: 10px; + border-radius: 10px; + border-style: dotted; + border-width: thin; + border-color: #dcdcdc; + padding: 10px 15px 10px 15px; + margin-bottom: 15px; + margin-top: 15px; +} +div.note { + padding: 10px 15px 10px 80px; + background: #e4ffde url(alert_info_32.png) 15px 15px no-repeat; + min-height: 42px; +} +div.warning { + padding: 10px 15px 10px 80px; + background: #fffbc6 url(alert_warning_32.png) 15px 15px no-repeat; + min-height: 42px; +} +div.seealso { + background: #e4ffde; +} + +/* More layout and styles */ +h1 { + font-size: 1.3em; + font-weight: bold; + color: #0c3762; + border-bottom: dotted thin #e0e0e0; + margin-top: 30px; +} + +h2 { + font-size: 1.2em; + font-weight: normal; + color: #0c3762; + border-bottom: dotted thin #e0e0e0; + margin-top: 30px; +} + +h3 { + font-size: 1.1em; + font-weight: normal; + color: #0c3762; + margin-top: 30px; +} + +h4 { + font-size: 1.0em; + font-weight: normal; + color: #0c3762; + margin-top: 30px; +} + +p { + text-align: justify; +} + +p.last { + margin-bottom: 0; +} + +ol { + padding-left: 20px; +} + +ul { + padding-left: 5px; + margin-top: 3px; +} + +li { + line-height: 1.3; +} + +div.content ul > li { + -moz-background-clip:border; + -moz-background-inline-policy:continuous; + -moz-background-origin:padding; + background: transparent url(bullet_orange.png) no-repeat scroll left 0.45em; + list-style-image: none; + list-style-type: none; + padding: 0 0 0 1.666em; + margin-bottom: 3px; +} + +td { + vertical-align: top; +} + +tt { + background-color: #e2e2e2; + font-size: 1.0em; + font-family: monospace; +} + +pre { + border-color: #0c3762; + border-style: dotted; + border-width: thin; + margin: 0 0 12px 0; + padding: 0.8em; + background-color: #f0f0f0; +} + +hr { + border-top: 1px solid #ccc; + border-bottom: 0; + border-right: 0; + border-left: 0; + margin-bottom: 10px; + margin-top: 20px; +} + +/* printer only pretty stuff */ +@media print { + .noprint { + display: none; + } + /* for acronyms we want their definitions inlined at print time */ + acronym[title]:after { + font-size: small; + content: " (" attr(title) ")"; + font-style: italic; + } + /* and not have mozilla dotted underline */ + acronym { + border: none; + } + div.topnav, div.bottomnav, div.header, table.index { + display: none; + } + div.content { + margin: 0px; + padding: 0px; + } + html { + background: #FFF; + } +} + +.viewcode-back { + font-family: "DejaVu Sans", Arial, Helvetica, sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; + margin: -1px -12px; + padding: 0 12px; +} \ No newline at end of file diff --git a/_static/jquery.js b/_static/jquery.js new file mode 100644 index 0000000..7c24308 --- /dev/null +++ b/_static/jquery.js @@ -0,0 +1,154 @@ +/*! + * jQuery JavaScript Library v1.4.2 + * http://jquery.com/ + * + * Copyright 2010, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2010, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Sat Feb 13 22:33:48 2010 -0500 + */ +(function(A,w){function ma(){if(!c.isReady){try{s.documentElement.doScroll("left")}catch(a){setTimeout(ma,1);return}c.ready()}}function Qa(a,b){b.src?c.ajax({url:b.src,async:false,dataType:"script"}):c.globalEval(b.text||b.textContent||b.innerHTML||"");b.parentNode&&b.parentNode.removeChild(b)}function X(a,b,d,f,e,j){var i=a.length;if(typeof b==="object"){for(var o in b)X(a,o,b[o],f,e,d);return a}if(d!==w){f=!j&&f&&c.isFunction(d);for(o=0;o)[^>]*$|^#([\w-]+)$/,Ua=/^.[^:#\[\.,]*$/,Va=/\S/, +Wa=/^(\s|\u00A0)+|(\s|\u00A0)+$/g,Xa=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,P=navigator.userAgent,xa=false,Q=[],L,$=Object.prototype.toString,aa=Object.prototype.hasOwnProperty,ba=Array.prototype.push,R=Array.prototype.slice,ya=Array.prototype.indexOf;c.fn=c.prototype={init:function(a,b){var d,f;if(!a)return this;if(a.nodeType){this.context=this[0]=a;this.length=1;return this}if(a==="body"&&!b){this.context=s;this[0]=s.body;this.selector="body";this.length=1;return this}if(typeof a==="string")if((d=Ta.exec(a))&& +(d[1]||!b))if(d[1]){f=b?b.ownerDocument||b:s;if(a=Xa.exec(a))if(c.isPlainObject(b)){a=[s.createElement(a[1])];c.fn.attr.call(a,b,true)}else a=[f.createElement(a[1])];else{a=sa([d[1]],[f]);a=(a.cacheable?a.fragment.cloneNode(true):a.fragment).childNodes}return c.merge(this,a)}else{if(b=s.getElementById(d[2])){if(b.id!==d[2])return T.find(a);this.length=1;this[0]=b}this.context=s;this.selector=a;return this}else if(!b&&/^\w+$/.test(a)){this.selector=a;this.context=s;a=s.getElementsByTagName(a);return c.merge(this, +a)}else return!b||b.jquery?(b||T).find(a):c(b).find(a);else if(c.isFunction(a))return T.ready(a);if(a.selector!==w){this.selector=a.selector;this.context=a.context}return c.makeArray(a,this)},selector:"",jquery:"1.4.2",length:0,size:function(){return this.length},toArray:function(){return R.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this.slice(a)[0]:this[a]},pushStack:function(a,b,d){var f=c();c.isArray(a)?ba.apply(f,a):c.merge(f,a);f.prevObject=this;f.context=this.context;if(b=== +"find")f.selector=this.selector+(this.selector?" ":"")+d;else if(b)f.selector=this.selector+"."+b+"("+d+")";return f},each:function(a,b){return c.each(this,a,b)},ready:function(a){c.bindReady();if(c.isReady)a.call(s,c);else Q&&Q.push(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(R.apply(this,arguments),"slice",R.call(arguments).join(","))},map:function(a){return this.pushStack(c.map(this, +function(b,d){return a.call(b,d,b)}))},end:function(){return this.prevObject||c(null)},push:ba,sort:[].sort,splice:[].splice};c.fn.init.prototype=c.fn;c.extend=c.fn.extend=function(){var a=arguments[0]||{},b=1,d=arguments.length,f=false,e,j,i,o;if(typeof a==="boolean"){f=a;a=arguments[1]||{};b=2}if(typeof a!=="object"&&!c.isFunction(a))a={};if(d===b){a=this;--b}for(;b
a"; +var e=d.getElementsByTagName("*"),j=d.getElementsByTagName("a")[0];if(!(!e||!e.length||!j)){c.support={leadingWhitespace:d.firstChild.nodeType===3,tbody:!d.getElementsByTagName("tbody").length,htmlSerialize:!!d.getElementsByTagName("link").length,style:/red/.test(j.getAttribute("style")),hrefNormalized:j.getAttribute("href")==="/a",opacity:/^0.55$/.test(j.style.opacity),cssFloat:!!j.style.cssFloat,checkOn:d.getElementsByTagName("input")[0].value==="on",optSelected:s.createElement("select").appendChild(s.createElement("option")).selected, +parentNode:d.removeChild(d.appendChild(s.createElement("div"))).parentNode===null,deleteExpando:true,checkClone:false,scriptEval:false,noCloneEvent:true,boxModel:null};b.type="text/javascript";try{b.appendChild(s.createTextNode("window."+f+"=1;"))}catch(i){}a.insertBefore(b,a.firstChild);if(A[f]){c.support.scriptEval=true;delete A[f]}try{delete b.test}catch(o){c.support.deleteExpando=false}a.removeChild(b);if(d.attachEvent&&d.fireEvent){d.attachEvent("onclick",function k(){c.support.noCloneEvent= +false;d.detachEvent("onclick",k)});d.cloneNode(true).fireEvent("onclick")}d=s.createElement("div");d.innerHTML="";a=s.createDocumentFragment();a.appendChild(d.firstChild);c.support.checkClone=a.cloneNode(true).cloneNode(true).lastChild.checked;c(function(){var k=s.createElement("div");k.style.width=k.style.paddingLeft="1px";s.body.appendChild(k);c.boxModel=c.support.boxModel=k.offsetWidth===2;s.body.removeChild(k).style.display="none"});a=function(k){var n= +s.createElement("div");k="on"+k;var r=k in n;if(!r){n.setAttribute(k,"return;");r=typeof n[k]==="function"}return r};c.support.submitBubbles=a("submit");c.support.changeBubbles=a("change");a=b=d=e=j=null}})();c.props={"for":"htmlFor","class":"className",readonly:"readOnly",maxlength:"maxLength",cellspacing:"cellSpacing",rowspan:"rowSpan",colspan:"colSpan",tabindex:"tabIndex",usemap:"useMap",frameborder:"frameBorder"};var G="jQuery"+J(),Ya=0,za={};c.extend({cache:{},expando:G,noData:{embed:true,object:true, +applet:true},data:function(a,b,d){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var f=a[G],e=c.cache;if(!f&&typeof b==="string"&&d===w)return null;f||(f=++Ya);if(typeof b==="object"){a[G]=f;e[f]=c.extend(true,{},b)}else if(!e[f]){a[G]=f;e[f]={}}a=e[f];if(d!==w)a[b]=d;return typeof b==="string"?a[b]:a}},removeData:function(a,b){if(!(a.nodeName&&c.noData[a.nodeName.toLowerCase()])){a=a==A?za:a;var d=a[G],f=c.cache,e=f[d];if(b){if(e){delete e[b];c.isEmptyObject(e)&&c.removeData(a)}}else{if(c.support.deleteExpando)delete a[c.expando]; +else a.removeAttribute&&a.removeAttribute(c.expando);delete f[d]}}}});c.fn.extend({data:function(a,b){if(typeof a==="undefined"&&this.length)return c.data(this[0]);else if(typeof a==="object")return this.each(function(){c.data(this,a)});var d=a.split(".");d[1]=d[1]?"."+d[1]:"";if(b===w){var f=this.triggerHandler("getData"+d[1]+"!",[d[0]]);if(f===w&&this.length)f=c.data(this[0],a);return f===w&&d[1]?this.data(d[0]):f}else return this.trigger("setData"+d[1]+"!",[d[0],b]).each(function(){c.data(this, +a,b)})},removeData:function(a){return this.each(function(){c.removeData(this,a)})}});c.extend({queue:function(a,b,d){if(a){b=(b||"fx")+"queue";var f=c.data(a,b);if(!d)return f||[];if(!f||c.isArray(d))f=c.data(a,b,c.makeArray(d));else f.push(d);return f}},dequeue:function(a,b){b=b||"fx";var d=c.queue(a,b),f=d.shift();if(f==="inprogress")f=d.shift();if(f){b==="fx"&&d.unshift("inprogress");f.call(a,function(){c.dequeue(a,b)})}}});c.fn.extend({queue:function(a,b){if(typeof a!=="string"){b=a;a="fx"}if(b=== +w)return c.queue(this[0],a);return this.each(function(){var d=c.queue(this,a,b);a==="fx"&&d[0]!=="inprogress"&&c.dequeue(this,a)})},dequeue:function(a){return this.each(function(){c.dequeue(this,a)})},delay:function(a,b){a=c.fx?c.fx.speeds[a]||a:a;b=b||"fx";return this.queue(b,function(){var d=this;setTimeout(function(){c.dequeue(d,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])}});var Aa=/[\n\t]/g,ca=/\s+/,Za=/\r/g,$a=/href|src|style/,ab=/(button|input)/i,bb=/(button|input|object|select|textarea)/i, +cb=/^(a|area)$/i,Ba=/radio|checkbox/;c.fn.extend({attr:function(a,b){return X(this,a,b,true,c.attr)},removeAttr:function(a){return this.each(function(){c.attr(this,a,"");this.nodeType===1&&this.removeAttribute(a)})},addClass:function(a){if(c.isFunction(a))return this.each(function(n){var r=c(this);r.addClass(a.call(this,n,r.attr("class")))});if(a&&typeof a==="string")for(var b=(a||"").split(ca),d=0,f=this.length;d-1)return true;return false},val:function(a){if(a===w){var b=this[0];if(b){if(c.nodeName(b,"option"))return(b.attributes.value||{}).specified?b.value:b.text;if(c.nodeName(b,"select")){var d=b.selectedIndex,f=[],e=b.options;b=b.type==="select-one";if(d<0)return null;var j=b?d:0;for(d=b?d+1:e.length;j=0;else if(c.nodeName(this,"select")){var u=c.makeArray(r);c("option",this).each(function(){this.selected= +c.inArray(c(this).val(),u)>=0});if(!u.length)this.selectedIndex=-1}else this.value=r}})}});c.extend({attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(a,b,d,f){if(!a||a.nodeType===3||a.nodeType===8)return w;if(f&&b in c.attrFn)return c(a)[b](d);f=a.nodeType!==1||!c.isXMLDoc(a);var e=d!==w;b=f&&c.props[b]||b;if(a.nodeType===1){var j=$a.test(b);if(b in a&&f&&!j){if(e){b==="type"&&ab.test(a.nodeName)&&a.parentNode&&c.error("type property can't be changed"); +a[b]=d}if(c.nodeName(a,"form")&&a.getAttributeNode(b))return a.getAttributeNode(b).nodeValue;if(b==="tabIndex")return(b=a.getAttributeNode("tabIndex"))&&b.specified?b.value:bb.test(a.nodeName)||cb.test(a.nodeName)&&a.href?0:w;return a[b]}if(!c.support.style&&f&&b==="style"){if(e)a.style.cssText=""+d;return a.style.cssText}e&&a.setAttribute(b,""+d);a=!c.support.hrefNormalized&&f&&j?a.getAttribute(b,2):a.getAttribute(b);return a===null?w:a}return c.style(a,b,d)}});var O=/\.(.*)$/,db=function(a){return a.replace(/[^\w\s\.\|`]/g, +function(b){return"\\"+b})};c.event={add:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){if(a.setInterval&&a!==A&&!a.frameElement)a=A;var e,j;if(d.handler){e=d;d=e.handler}if(!d.guid)d.guid=c.guid++;if(j=c.data(a)){var i=j.events=j.events||{},o=j.handle;if(!o)j.handle=o=function(){return typeof c!=="undefined"&&!c.event.triggered?c.event.handle.apply(o.elem,arguments):w};o.elem=a;b=b.split(" ");for(var k,n=0,r;k=b[n++];){j=e?c.extend({},e):{handler:d,data:f};if(k.indexOf(".")>-1){r=k.split("."); +k=r.shift();j.namespace=r.slice(0).sort().join(".")}else{r=[];j.namespace=""}j.type=k;j.guid=d.guid;var u=i[k],z=c.event.special[k]||{};if(!u){u=i[k]=[];if(!z.setup||z.setup.call(a,f,r,o)===false)if(a.addEventListener)a.addEventListener(k,o,false);else a.attachEvent&&a.attachEvent("on"+k,o)}if(z.add){z.add.call(a,j);if(!j.handler.guid)j.handler.guid=d.guid}u.push(j);c.event.global[k]=true}a=null}}},global:{},remove:function(a,b,d,f){if(!(a.nodeType===3||a.nodeType===8)){var e,j=0,i,o,k,n,r,u,z=c.data(a), +C=z&&z.events;if(z&&C){if(b&&b.type){d=b.handler;b=b.type}if(!b||typeof b==="string"&&b.charAt(0)==="."){b=b||"";for(e in C)c.event.remove(a,e+b)}else{for(b=b.split(" ");e=b[j++];){n=e;i=e.indexOf(".")<0;o=[];if(!i){o=e.split(".");e=o.shift();k=new RegExp("(^|\\.)"+c.map(o.slice(0).sort(),db).join("\\.(?:.*\\.)?")+"(\\.|$)")}if(r=C[e])if(d){n=c.event.special[e]||{};for(B=f||0;B=0){a.type= +e=e.slice(0,-1);a.exclusive=true}if(!d){a.stopPropagation();c.event.global[e]&&c.each(c.cache,function(){this.events&&this.events[e]&&c.event.trigger(a,b,this.handle.elem)})}if(!d||d.nodeType===3||d.nodeType===8)return w;a.result=w;a.target=d;b=c.makeArray(b);b.unshift(a)}a.currentTarget=d;(f=c.data(d,"handle"))&&f.apply(d,b);f=d.parentNode||d.ownerDocument;try{if(!(d&&d.nodeName&&c.noData[d.nodeName.toLowerCase()]))if(d["on"+e]&&d["on"+e].apply(d,b)===false)a.result=false}catch(j){}if(!a.isPropagationStopped()&& +f)c.event.trigger(a,b,f,true);else if(!a.isDefaultPrevented()){f=a.target;var i,o=c.nodeName(f,"a")&&e==="click",k=c.event.special[e]||{};if((!k._default||k._default.call(d,a)===false)&&!o&&!(f&&f.nodeName&&c.noData[f.nodeName.toLowerCase()])){try{if(f[e]){if(i=f["on"+e])f["on"+e]=null;c.event.triggered=true;f[e]()}}catch(n){}if(i)f["on"+e]=i;c.event.triggered=false}}},handle:function(a){var b,d,f,e;a=arguments[0]=c.event.fix(a||A.event);a.currentTarget=this;b=a.type.indexOf(".")<0&&!a.exclusive; +if(!b){d=a.type.split(".");a.type=d.shift();f=new RegExp("(^|\\.)"+d.slice(0).sort().join("\\.(?:.*\\.)?")+"(\\.|$)")}e=c.data(this,"events");d=e[a.type];if(e&&d){d=d.slice(0);e=0;for(var j=d.length;e-1?c.map(a.options,function(f){return f.selected}).join("-"):"";else if(a.nodeName.toLowerCase()==="select")d=a.selectedIndex;return d},fa=function(a,b){var d=a.target,f,e;if(!(!da.test(d.nodeName)||d.readOnly)){f=c.data(d,"_change_data");e=Fa(d);if(a.type!=="focusout"||d.type!=="radio")c.data(d,"_change_data", +e);if(!(f===w||e===f))if(f!=null||e){a.type="change";return c.event.trigger(a,b,d)}}};c.event.special.change={filters:{focusout:fa,click:function(a){var b=a.target,d=b.type;if(d==="radio"||d==="checkbox"||b.nodeName.toLowerCase()==="select")return fa.call(this,a)},keydown:function(a){var b=a.target,d=b.type;if(a.keyCode===13&&b.nodeName.toLowerCase()!=="textarea"||a.keyCode===32&&(d==="checkbox"||d==="radio")||d==="select-multiple")return fa.call(this,a)},beforeactivate:function(a){a=a.target;c.data(a, +"_change_data",Fa(a))}},setup:function(){if(this.type==="file")return false;for(var a in ea)c.event.add(this,a+".specialChange",ea[a]);return da.test(this.nodeName)},teardown:function(){c.event.remove(this,".specialChange");return da.test(this.nodeName)}};ea=c.event.special.change.filters}s.addEventListener&&c.each({focus:"focusin",blur:"focusout"},function(a,b){function d(f){f=c.event.fix(f);f.type=b;return c.event.handle.call(this,f)}c.event.special[b]={setup:function(){this.addEventListener(a, +d,true)},teardown:function(){this.removeEventListener(a,d,true)}}});c.each(["bind","one"],function(a,b){c.fn[b]=function(d,f,e){if(typeof d==="object"){for(var j in d)this[b](j,f,d[j],e);return this}if(c.isFunction(f)){e=f;f=w}var i=b==="one"?c.proxy(e,function(k){c(this).unbind(k,i);return e.apply(this,arguments)}):e;if(d==="unload"&&b!=="one")this.one(d,f,e);else{j=0;for(var o=this.length;j0){y=t;break}}t=t[g]}m[q]=y}}}var f=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^[\]]*\]|['"][^'"]*['"]|[^[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g, +e=0,j=Object.prototype.toString,i=false,o=true;[0,0].sort(function(){o=false;return 0});var k=function(g,h,l,m){l=l||[];var q=h=h||s;if(h.nodeType!==1&&h.nodeType!==9)return[];if(!g||typeof g!=="string")return l;for(var p=[],v,t,y,S,H=true,M=x(h),I=g;(f.exec(""),v=f.exec(I))!==null;){I=v[3];p.push(v[1]);if(v[2]){S=v[3];break}}if(p.length>1&&r.exec(g))if(p.length===2&&n.relative[p[0]])t=ga(p[0]+p[1],h);else for(t=n.relative[p[0]]?[h]:k(p.shift(),h);p.length;){g=p.shift();if(n.relative[g])g+=p.shift(); +t=ga(g,t)}else{if(!m&&p.length>1&&h.nodeType===9&&!M&&n.match.ID.test(p[0])&&!n.match.ID.test(p[p.length-1])){v=k.find(p.shift(),h,M);h=v.expr?k.filter(v.expr,v.set)[0]:v.set[0]}if(h){v=m?{expr:p.pop(),set:z(m)}:k.find(p.pop(),p.length===1&&(p[0]==="~"||p[0]==="+")&&h.parentNode?h.parentNode:h,M);t=v.expr?k.filter(v.expr,v.set):v.set;if(p.length>0)y=z(t);else H=false;for(;p.length;){var D=p.pop();v=D;if(n.relative[D])v=p.pop();else D="";if(v==null)v=h;n.relative[D](y,v,M)}}else y=[]}y||(y=t);y||k.error(D|| +g);if(j.call(y)==="[object Array]")if(H)if(h&&h.nodeType===1)for(g=0;y[g]!=null;g++){if(y[g]&&(y[g]===true||y[g].nodeType===1&&E(h,y[g])))l.push(t[g])}else for(g=0;y[g]!=null;g++)y[g]&&y[g].nodeType===1&&l.push(t[g]);else l.push.apply(l,y);else z(y,l);if(S){k(S,q,l,m);k.uniqueSort(l)}return l};k.uniqueSort=function(g){if(B){i=o;g.sort(B);if(i)for(var h=1;h":function(g,h){var l=typeof h==="string";if(l&&!/\W/.test(h)){h=h.toLowerCase();for(var m=0,q=g.length;m=0))l||m.push(v);else if(l)h[p]=false;return false},ID:function(g){return g[1].replace(/\\/g,"")},TAG:function(g){return g[1].toLowerCase()}, +CHILD:function(g){if(g[1]==="nth"){var h=/(-?)(\d*)n((?:\+|-)?\d*)/.exec(g[2]==="even"&&"2n"||g[2]==="odd"&&"2n+1"||!/\D/.test(g[2])&&"0n+"+g[2]||g[2]);g[2]=h[1]+(h[2]||1)-0;g[3]=h[3]-0}g[0]=e++;return g},ATTR:function(g,h,l,m,q,p){h=g[1].replace(/\\/g,"");if(!p&&n.attrMap[h])g[1]=n.attrMap[h];if(g[2]==="~=")g[4]=" "+g[4]+" ";return g},PSEUDO:function(g,h,l,m,q){if(g[1]==="not")if((f.exec(g[3])||"").length>1||/^\w/.test(g[3]))g[3]=k(g[3],null,null,h);else{g=k.filter(g[3],h,l,true^q);l||m.push.apply(m, +g);return false}else if(n.match.POS.test(g[0])||n.match.CHILD.test(g[0]))return true;return g},POS:function(g){g.unshift(true);return g}},filters:{enabled:function(g){return g.disabled===false&&g.type!=="hidden"},disabled:function(g){return g.disabled===true},checked:function(g){return g.checked===true},selected:function(g){return g.selected===true},parent:function(g){return!!g.firstChild},empty:function(g){return!g.firstChild},has:function(g,h,l){return!!k(l[3],g).length},header:function(g){return/h\d/i.test(g.nodeName)}, +text:function(g){return"text"===g.type},radio:function(g){return"radio"===g.type},checkbox:function(g){return"checkbox"===g.type},file:function(g){return"file"===g.type},password:function(g){return"password"===g.type},submit:function(g){return"submit"===g.type},image:function(g){return"image"===g.type},reset:function(g){return"reset"===g.type},button:function(g){return"button"===g.type||g.nodeName.toLowerCase()==="button"},input:function(g){return/input|select|textarea|button/i.test(g.nodeName)}}, +setFilters:{first:function(g,h){return h===0},last:function(g,h,l,m){return h===m.length-1},even:function(g,h){return h%2===0},odd:function(g,h){return h%2===1},lt:function(g,h,l){return hl[3]-0},nth:function(g,h,l){return l[3]-0===h},eq:function(g,h,l){return l[3]-0===h}},filter:{PSEUDO:function(g,h,l,m){var q=h[1],p=n.filters[q];if(p)return p(g,l,h,m);else if(q==="contains")return(g.textContent||g.innerText||a([g])||"").indexOf(h[3])>=0;else if(q==="not"){h= +h[3];l=0;for(m=h.length;l=0}},ID:function(g,h){return g.nodeType===1&&g.getAttribute("id")===h},TAG:function(g,h){return h==="*"&&g.nodeType===1||g.nodeName.toLowerCase()===h},CLASS:function(g,h){return(" "+(g.className||g.getAttribute("class"))+" ").indexOf(h)>-1},ATTR:function(g,h){var l=h[1];g=n.attrHandle[l]?n.attrHandle[l](g):g[l]!=null?g[l]:g.getAttribute(l);l=g+"";var m=h[2];h=h[4];return g==null?m==="!=":m=== +"="?l===h:m==="*="?l.indexOf(h)>=0:m==="~="?(" "+l+" ").indexOf(h)>=0:!h?l&&g!==false:m==="!="?l!==h:m==="^="?l.indexOf(h)===0:m==="$="?l.substr(l.length-h.length)===h:m==="|="?l===h||l.substr(0,h.length+1)===h+"-":false},POS:function(g,h,l,m){var q=n.setFilters[h[2]];if(q)return q(g,l,h,m)}}},r=n.match.POS;for(var u in n.match){n.match[u]=new RegExp(n.match[u].source+/(?![^\[]*\])(?![^\(]*\))/.source);n.leftMatch[u]=new RegExp(/(^(?:.|\r|\n)*?)/.source+n.match[u].source.replace(/\\(\d+)/g,function(g, +h){return"\\"+(h-0+1)}))}var z=function(g,h){g=Array.prototype.slice.call(g,0);if(h){h.push.apply(h,g);return h}return g};try{Array.prototype.slice.call(s.documentElement.childNodes,0)}catch(C){z=function(g,h){h=h||[];if(j.call(g)==="[object Array]")Array.prototype.push.apply(h,g);else if(typeof g.length==="number")for(var l=0,m=g.length;l";var l=s.documentElement;l.insertBefore(g,l.firstChild);if(s.getElementById(h)){n.find.ID=function(m,q,p){if(typeof q.getElementById!=="undefined"&&!p)return(q=q.getElementById(m[1]))?q.id===m[1]||typeof q.getAttributeNode!=="undefined"&& +q.getAttributeNode("id").nodeValue===m[1]?[q]:w:[]};n.filter.ID=function(m,q){var p=typeof m.getAttributeNode!=="undefined"&&m.getAttributeNode("id");return m.nodeType===1&&p&&p.nodeValue===q}}l.removeChild(g);l=g=null})();(function(){var g=s.createElement("div");g.appendChild(s.createComment(""));if(g.getElementsByTagName("*").length>0)n.find.TAG=function(h,l){l=l.getElementsByTagName(h[1]);if(h[1]==="*"){h=[];for(var m=0;l[m];m++)l[m].nodeType===1&&h.push(l[m]);l=h}return l};g.innerHTML=""; +if(g.firstChild&&typeof g.firstChild.getAttribute!=="undefined"&&g.firstChild.getAttribute("href")!=="#")n.attrHandle.href=function(h){return h.getAttribute("href",2)};g=null})();s.querySelectorAll&&function(){var g=k,h=s.createElement("div");h.innerHTML="

";if(!(h.querySelectorAll&&h.querySelectorAll(".TEST").length===0)){k=function(m,q,p,v){q=q||s;if(!v&&q.nodeType===9&&!x(q))try{return z(q.querySelectorAll(m),p)}catch(t){}return g(m,q,p,v)};for(var l in g)k[l]=g[l];h=null}}(); +(function(){var g=s.createElement("div");g.innerHTML="
";if(!(!g.getElementsByClassName||g.getElementsByClassName("e").length===0)){g.lastChild.className="e";if(g.getElementsByClassName("e").length!==1){n.order.splice(1,0,"CLASS");n.find.CLASS=function(h,l,m){if(typeof l.getElementsByClassName!=="undefined"&&!m)return l.getElementsByClassName(h[1])};g=null}}})();var E=s.compareDocumentPosition?function(g,h){return!!(g.compareDocumentPosition(h)&16)}: +function(g,h){return g!==h&&(g.contains?g.contains(h):true)},x=function(g){return(g=(g?g.ownerDocument||g:0).documentElement)?g.nodeName!=="HTML":false},ga=function(g,h){var l=[],m="",q;for(h=h.nodeType?[h]:h;q=n.match.PSEUDO.exec(g);){m+=q[0];g=g.replace(n.match.PSEUDO,"")}g=n.relative[g]?g+"*":g;q=0;for(var p=h.length;q=0===d})};c.fn.extend({find:function(a){for(var b=this.pushStack("","find",a),d=0,f=0,e=this.length;f0)for(var j=d;j0},closest:function(a,b){if(c.isArray(a)){var d=[],f=this[0],e,j= +{},i;if(f&&a.length){e=0;for(var o=a.length;e-1:c(f).is(e)){d.push({selector:i,elem:f});delete j[i]}}f=f.parentNode}}return d}var k=c.expr.match.POS.test(a)?c(a,b||this.context):null;return this.map(function(n,r){for(;r&&r.ownerDocument&&r!==b;){if(k?k.index(r)>-1:c(r).is(a))return r;r=r.parentNode}return null})},index:function(a){if(!a||typeof a=== +"string")return c.inArray(this[0],a?c(a):this.parent().children());return c.inArray(a.jquery?a[0]:a,this)},add:function(a,b){a=typeof a==="string"?c(a,b||this.context):c.makeArray(a);b=c.merge(this.get(),a);return this.pushStack(qa(a[0])||qa(b[0])?b:c.unique(b))},andSelf:function(){return this.add(this.prevObject)}});c.each({parent:function(a){return(a=a.parentNode)&&a.nodeType!==11?a:null},parents:function(a){return c.dir(a,"parentNode")},parentsUntil:function(a,b,d){return c.dir(a,"parentNode", +d)},next:function(a){return c.nth(a,2,"nextSibling")},prev:function(a){return c.nth(a,2,"previousSibling")},nextAll:function(a){return c.dir(a,"nextSibling")},prevAll:function(a){return c.dir(a,"previousSibling")},nextUntil:function(a,b,d){return c.dir(a,"nextSibling",d)},prevUntil:function(a,b,d){return c.dir(a,"previousSibling",d)},siblings:function(a){return c.sibling(a.parentNode.firstChild,a)},children:function(a){return c.sibling(a.firstChild)},contents:function(a){return c.nodeName(a,"iframe")? +a.contentDocument||a.contentWindow.document:c.makeArray(a.childNodes)}},function(a,b){c.fn[a]=function(d,f){var e=c.map(this,b,d);eb.test(a)||(f=d);if(f&&typeof f==="string")e=c.filter(f,e);e=this.length>1?c.unique(e):e;if((this.length>1||gb.test(f))&&fb.test(a))e=e.reverse();return this.pushStack(e,a,R.call(arguments).join(","))}});c.extend({filter:function(a,b,d){if(d)a=":not("+a+")";return c.find.matches(a,b)},dir:function(a,b,d){var f=[];for(a=a[b];a&&a.nodeType!==9&&(d===w||a.nodeType!==1||!c(a).is(d));){a.nodeType=== +1&&f.push(a);a=a[b]}return f},nth:function(a,b,d){b=b||1;for(var f=0;a;a=a[d])if(a.nodeType===1&&++f===b)break;return a},sibling:function(a,b){for(var d=[];a;a=a.nextSibling)a.nodeType===1&&a!==b&&d.push(a);return d}});var Ja=/ jQuery\d+="(?:\d+|null)"/g,V=/^\s+/,Ka=/(<([\w:]+)[^>]*?)\/>/g,hb=/^(?:area|br|col|embed|hr|img|input|link|meta|param)$/i,La=/<([\w:]+)/,ib=/"},F={option:[1,""],legend:[1,"
","
"],thead:[1,"","
"],tr:[2,"","
"],td:[3,"","
"],col:[2,"","
"],area:[1,"",""],_default:[0,"",""]};F.optgroup=F.option;F.tbody=F.tfoot=F.colgroup=F.caption=F.thead;F.th=F.td;if(!c.support.htmlSerialize)F._default=[1,"div
","
"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d= +c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this}, +wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})}, +prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b, +this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild); +return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja, +""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b0||e.cacheable||this.length>1?k.cloneNode(true):k)}o.length&&c.each(o,Qa)}return this}});c.fragments={};c.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){c.fn[a]=function(d){var f=[];d=c(d);var e=this.length===1&&this[0].parentNode;if(e&&e.nodeType===11&&e.childNodes.length===1&&d.length===1){d[b](this[0]); +return this}else{e=0;for(var j=d.length;e0?this.clone(true):this).get();c.fn[b].apply(c(d[e]),i);f=f.concat(i)}return this.pushStack(f,a,d.selector)}}});c.extend({clean:function(a,b,d,f){b=b||s;if(typeof b.createElement==="undefined")b=b.ownerDocument||b[0]&&b[0].ownerDocument||s;for(var e=[],j=0,i;(i=a[j])!=null;j++){if(typeof i==="number")i+="";if(i){if(typeof i==="string"&&!jb.test(i))i=b.createTextNode(i);else if(typeof i==="string"){i=i.replace(Ka,Ma);var o=(La.exec(i)||["", +""])[1].toLowerCase(),k=F[o]||F._default,n=k[0],r=b.createElement("div");for(r.innerHTML=k[1]+i+k[2];n--;)r=r.lastChild;if(!c.support.tbody){n=ib.test(i);o=o==="table"&&!n?r.firstChild&&r.firstChild.childNodes:k[1]===""&&!n?r.childNodes:[];for(k=o.length-1;k>=0;--k)c.nodeName(o[k],"tbody")&&!o[k].childNodes.length&&o[k].parentNode.removeChild(o[k])}!c.support.leadingWhitespace&&V.test(i)&&r.insertBefore(b.createTextNode(V.exec(i)[0]),r.firstChild);i=r.childNodes}if(i.nodeType)e.push(i);else e= +c.merge(e,i)}}if(d)for(j=0;e[j];j++)if(f&&c.nodeName(e[j],"script")&&(!e[j].type||e[j].type.toLowerCase()==="text/javascript"))f.push(e[j].parentNode?e[j].parentNode.removeChild(e[j]):e[j]);else{e[j].nodeType===1&&e.splice.apply(e,[j+1,0].concat(c.makeArray(e[j].getElementsByTagName("script"))));d.appendChild(e[j])}return e},cleanData:function(a){for(var b,d,f=c.cache,e=c.event.special,j=c.support.deleteExpando,i=0,o;(o=a[i])!=null;i++)if(d=o[c.expando]){b=f[d];if(b.events)for(var k in b.events)e[k]? +c.event.remove(o,k):Ca(o,k,b.handle);if(j)delete o[c.expando];else o.removeAttribute&&o.removeAttribute(c.expando);delete f[d]}}});var kb=/z-?index|font-?weight|opacity|zoom|line-?height/i,Na=/alpha\([^)]*\)/,Oa=/opacity=([^)]*)/,ha=/float/i,ia=/-([a-z])/ig,lb=/([A-Z])/g,mb=/^-?\d+(?:px)?$/i,nb=/^-?\d/,ob={position:"absolute",visibility:"hidden",display:"block"},pb=["Left","Right"],qb=["Top","Bottom"],rb=s.defaultView&&s.defaultView.getComputedStyle,Pa=c.support.cssFloat?"cssFloat":"styleFloat",ja= +function(a,b){return b.toUpperCase()};c.fn.css=function(a,b){return X(this,a,b,true,function(d,f,e){if(e===w)return c.curCSS(d,f);if(typeof e==="number"&&!kb.test(f))e+="px";c.style(d,f,e)})};c.extend({style:function(a,b,d){if(!a||a.nodeType===3||a.nodeType===8)return w;if((b==="width"||b==="height")&&parseFloat(d)<0)d=w;var f=a.style||a,e=d!==w;if(!c.support.opacity&&b==="opacity"){if(e){f.zoom=1;b=parseInt(d,10)+""==="NaN"?"":"alpha(opacity="+d*100+")";a=f.filter||c.curCSS(a,"filter")||"";f.filter= +Na.test(a)?a.replace(Na,b):b}return f.filter&&f.filter.indexOf("opacity=")>=0?parseFloat(Oa.exec(f.filter)[1])/100+"":""}if(ha.test(b))b=Pa;b=b.replace(ia,ja);if(e)f[b]=d;return f[b]},css:function(a,b,d,f){if(b==="width"||b==="height"){var e,j=b==="width"?pb:qb;function i(){e=b==="width"?a.offsetWidth:a.offsetHeight;f!=="border"&&c.each(j,function(){f||(e-=parseFloat(c.curCSS(a,"padding"+this,true))||0);if(f==="margin")e+=parseFloat(c.curCSS(a,"margin"+this,true))||0;else e-=parseFloat(c.curCSS(a, +"border"+this+"Width",true))||0})}a.offsetWidth!==0?i():c.swap(a,ob,i);return Math.max(0,Math.round(e))}return c.curCSS(a,b,d)},curCSS:function(a,b,d){var f,e=a.style;if(!c.support.opacity&&b==="opacity"&&a.currentStyle){f=Oa.test(a.currentStyle.filter||"")?parseFloat(RegExp.$1)/100+"":"";return f===""?"1":f}if(ha.test(b))b=Pa;if(!d&&e&&e[b])f=e[b];else if(rb){if(ha.test(b))b="float";b=b.replace(lb,"-$1").toLowerCase();e=a.ownerDocument.defaultView;if(!e)return null;if(a=e.getComputedStyle(a,null))f= +a.getPropertyValue(b);if(b==="opacity"&&f==="")f="1"}else if(a.currentStyle){d=b.replace(ia,ja);f=a.currentStyle[b]||a.currentStyle[d];if(!mb.test(f)&&nb.test(f)){b=e.left;var j=a.runtimeStyle.left;a.runtimeStyle.left=a.currentStyle.left;e.left=d==="fontSize"?"1em":f||0;f=e.pixelLeft+"px";e.left=b;a.runtimeStyle.left=j}}return f},swap:function(a,b,d){var f={};for(var e in b){f[e]=a.style[e];a.style[e]=b[e]}d.call(a);for(e in b)a.style[e]=f[e]}});if(c.expr&&c.expr.filters){c.expr.filters.hidden=function(a){var b= +a.offsetWidth,d=a.offsetHeight,f=a.nodeName.toLowerCase()==="tr";return b===0&&d===0&&!f?true:b>0&&d>0&&!f?false:c.curCSS(a,"display")==="none"};c.expr.filters.visible=function(a){return!c.expr.filters.hidden(a)}}var sb=J(),tb=//gi,ub=/select|textarea/i,vb=/color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week/i,N=/=\?(&|$)/,ka=/\?/,wb=/(\?|&)_=.*?(&|$)/,xb=/^(\w+:)?\/\/([^\/?#]+)/,yb=/%20/g,zb=c.fn.load;c.fn.extend({load:function(a,b,d){if(typeof a!== +"string")return zb.call(this,a);else if(!this.length)return this;var f=a.indexOf(" ");if(f>=0){var e=a.slice(f,a.length);a=a.slice(0,f)}f="GET";if(b)if(c.isFunction(b)){d=b;b=null}else if(typeof b==="object"){b=c.param(b,c.ajaxSettings.traditional);f="POST"}var j=this;c.ajax({url:a,type:f,dataType:"html",data:b,complete:function(i,o){if(o==="success"||o==="notmodified")j.html(e?c("
").append(i.responseText.replace(tb,"")).find(e):i.responseText);d&&j.each(d,[i.responseText,o,i])}});return this}, +serialize:function(){return c.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?c.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||ub.test(this.nodeName)||vb.test(this.type))}).map(function(a,b){a=c(this).val();return a==null?null:c.isArray(a)?c.map(a,function(d){return{name:b.name,value:d}}):{name:b.name,value:a}}).get()}});c.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "), +function(a,b){c.fn[b]=function(d){return this.bind(b,d)}});c.extend({get:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b=null}return c.ajax({type:"GET",url:a,data:b,success:d,dataType:f})},getScript:function(a,b){return c.get(a,null,b,"script")},getJSON:function(a,b,d){return c.get(a,b,d,"json")},post:function(a,b,d,f){if(c.isFunction(b)){f=f||d;d=b;b={}}return c.ajax({type:"POST",url:a,data:b,success:d,dataType:f})},ajaxSetup:function(a){c.extend(c.ajaxSettings,a)},ajaxSettings:{url:location.href, +global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,xhr:A.XMLHttpRequest&&(A.location.protocol!=="file:"||!A.ActiveXObject)?function(){return new A.XMLHttpRequest}:function(){try{return new A.ActiveXObject("Microsoft.XMLHTTP")}catch(a){}},accepts:{xml:"application/xml, text/xml",html:"text/html",script:"text/javascript, application/javascript",json:"application/json, text/javascript",text:"text/plain",_default:"*/*"}},lastModified:{},etag:{},ajax:function(a){function b(){e.success&& +e.success.call(k,o,i,x);e.global&&f("ajaxSuccess",[x,e])}function d(){e.complete&&e.complete.call(k,x,i);e.global&&f("ajaxComplete",[x,e]);e.global&&!--c.active&&c.event.trigger("ajaxStop")}function f(q,p){(e.context?c(e.context):c.event).trigger(q,p)}var e=c.extend(true,{},c.ajaxSettings,a),j,i,o,k=a&&a.context||e,n=e.type.toUpperCase();if(e.data&&e.processData&&typeof e.data!=="string")e.data=c.param(e.data,e.traditional);if(e.dataType==="jsonp"){if(n==="GET")N.test(e.url)||(e.url+=(ka.test(e.url)? +"&":"?")+(e.jsonp||"callback")+"=?");else if(!e.data||!N.test(e.data))e.data=(e.data?e.data+"&":"")+(e.jsonp||"callback")+"=?";e.dataType="json"}if(e.dataType==="json"&&(e.data&&N.test(e.data)||N.test(e.url))){j=e.jsonpCallback||"jsonp"+sb++;if(e.data)e.data=(e.data+"").replace(N,"="+j+"$1");e.url=e.url.replace(N,"="+j+"$1");e.dataType="script";A[j]=A[j]||function(q){o=q;b();d();A[j]=w;try{delete A[j]}catch(p){}z&&z.removeChild(C)}}if(e.dataType==="script"&&e.cache===null)e.cache=false;if(e.cache=== +false&&n==="GET"){var r=J(),u=e.url.replace(wb,"$1_="+r+"$2");e.url=u+(u===e.url?(ka.test(e.url)?"&":"?")+"_="+r:"")}if(e.data&&n==="GET")e.url+=(ka.test(e.url)?"&":"?")+e.data;e.global&&!c.active++&&c.event.trigger("ajaxStart");r=(r=xb.exec(e.url))&&(r[1]&&r[1]!==location.protocol||r[2]!==location.host);if(e.dataType==="script"&&n==="GET"&&r){var z=s.getElementsByTagName("head")[0]||s.documentElement,C=s.createElement("script");C.src=e.url;if(e.scriptCharset)C.charset=e.scriptCharset;if(!j){var B= +false;C.onload=C.onreadystatechange=function(){if(!B&&(!this.readyState||this.readyState==="loaded"||this.readyState==="complete")){B=true;b();d();C.onload=C.onreadystatechange=null;z&&C.parentNode&&z.removeChild(C)}}}z.insertBefore(C,z.firstChild);return w}var E=false,x=e.xhr();if(x){e.username?x.open(n,e.url,e.async,e.username,e.password):x.open(n,e.url,e.async);try{if(e.data||a&&a.contentType)x.setRequestHeader("Content-Type",e.contentType);if(e.ifModified){c.lastModified[e.url]&&x.setRequestHeader("If-Modified-Since", +c.lastModified[e.url]);c.etag[e.url]&&x.setRequestHeader("If-None-Match",c.etag[e.url])}r||x.setRequestHeader("X-Requested-With","XMLHttpRequest");x.setRequestHeader("Accept",e.dataType&&e.accepts[e.dataType]?e.accepts[e.dataType]+", */*":e.accepts._default)}catch(ga){}if(e.beforeSend&&e.beforeSend.call(k,x,e)===false){e.global&&!--c.active&&c.event.trigger("ajaxStop");x.abort();return false}e.global&&f("ajaxSend",[x,e]);var g=x.onreadystatechange=function(q){if(!x||x.readyState===0||q==="abort"){E|| +d();E=true;if(x)x.onreadystatechange=c.noop}else if(!E&&x&&(x.readyState===4||q==="timeout")){E=true;x.onreadystatechange=c.noop;i=q==="timeout"?"timeout":!c.httpSuccess(x)?"error":e.ifModified&&c.httpNotModified(x,e.url)?"notmodified":"success";var p;if(i==="success")try{o=c.httpData(x,e.dataType,e)}catch(v){i="parsererror";p=v}if(i==="success"||i==="notmodified")j||b();else c.handleError(e,x,i,p);d();q==="timeout"&&x.abort();if(e.async)x=null}};try{var h=x.abort;x.abort=function(){x&&h.call(x); +g("abort")}}catch(l){}e.async&&e.timeout>0&&setTimeout(function(){x&&!E&&g("timeout")},e.timeout);try{x.send(n==="POST"||n==="PUT"||n==="DELETE"?e.data:null)}catch(m){c.handleError(e,x,null,m);d()}e.async||g();return x}},handleError:function(a,b,d,f){if(a.error)a.error.call(a.context||a,b,d,f);if(a.global)(a.context?c(a.context):c.event).trigger("ajaxError",[b,a,f])},active:0,httpSuccess:function(a){try{return!a.status&&location.protocol==="file:"||a.status>=200&&a.status<300||a.status===304||a.status=== +1223||a.status===0}catch(b){}return false},httpNotModified:function(a,b){var d=a.getResponseHeader("Last-Modified"),f=a.getResponseHeader("Etag");if(d)c.lastModified[b]=d;if(f)c.etag[b]=f;return a.status===304||a.status===0},httpData:function(a,b,d){var f=a.getResponseHeader("content-type")||"",e=b==="xml"||!b&&f.indexOf("xml")>=0;a=e?a.responseXML:a.responseText;e&&a.documentElement.nodeName==="parsererror"&&c.error("parsererror");if(d&&d.dataFilter)a=d.dataFilter(a,b);if(typeof a==="string")if(b=== +"json"||!b&&f.indexOf("json")>=0)a=c.parseJSON(a);else if(b==="script"||!b&&f.indexOf("javascript")>=0)c.globalEval(a);return a},param:function(a,b){function d(i,o){if(c.isArray(o))c.each(o,function(k,n){b||/\[\]$/.test(i)?f(i,n):d(i+"["+(typeof n==="object"||c.isArray(n)?k:"")+"]",n)});else!b&&o!=null&&typeof o==="object"?c.each(o,function(k,n){d(i+"["+k+"]",n)}):f(i,o)}function f(i,o){o=c.isFunction(o)?o():o;e[e.length]=encodeURIComponent(i)+"="+encodeURIComponent(o)}var e=[];if(b===w)b=c.ajaxSettings.traditional; +if(c.isArray(a)||a.jquery)c.each(a,function(){f(this.name,this.value)});else for(var j in a)d(j,a[j]);return e.join("&").replace(yb,"+")}});var la={},Ab=/toggle|show|hide/,Bb=/^([+-]=)?([\d+-.]+)(.*)$/,W,va=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]];c.fn.extend({show:function(a,b){if(a||a===0)return this.animate(K("show",3),a,b);else{a=0;for(b=this.length;a").appendTo("body");f=e.css("display");if(f==="none")f="block";e.remove();la[d]=f}c.data(this[a],"olddisplay",f)}}a=0;for(b=this.length;a=0;f--)if(d[f].elem===this){b&&d[f](true);d.splice(f,1)}});b||this.dequeue();return this}});c.each({slideDown:K("show",1),slideUp:K("hide",1),slideToggle:K("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"}},function(a,b){c.fn[a]=function(d,f){return this.animate(b,d,f)}});c.extend({speed:function(a,b,d){var f=a&&typeof a==="object"?a:{complete:d||!d&&b||c.isFunction(a)&&a,duration:a,easing:d&&b||b&&!c.isFunction(b)&&b};f.duration=c.fx.off?0:typeof f.duration=== +"number"?f.duration:c.fx.speeds[f.duration]||c.fx.speeds._default;f.old=f.complete;f.complete=function(){f.queue!==false&&c(this).dequeue();c.isFunction(f.old)&&f.old.call(this)};return f},easing:{linear:function(a,b,d,f){return d+f*a},swing:function(a,b,d,f){return(-Math.cos(a*Math.PI)/2+0.5)*f+d}},timers:[],fx:function(a,b,d){this.options=b;this.elem=a;this.prop=d;if(!b.orig)b.orig={}}});c.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this);(c.fx.step[this.prop]|| +c.fx.step._default)(this);if((this.prop==="height"||this.prop==="width")&&this.elem.style)this.elem.style.display="block"},cur:function(a){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];return(a=parseFloat(c.css(this.elem,this.prop,a)))&&a>-10000?a:parseFloat(c.curCSS(this.elem,this.prop))||0},custom:function(a,b,d){function f(j){return e.step(j)}this.startTime=J();this.start=a;this.end=b;this.unit=d||this.unit||"px";this.now=this.start; +this.pos=this.state=0;var e=this;f.elem=this.elem;if(f()&&c.timers.push(f)&&!W)W=setInterval(c.fx.tick,13)},show:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.show=true;this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur());c(this.elem).show()},hide:function(){this.options.orig[this.prop]=c.style(this.elem,this.prop);this.options.hide=true;this.custom(this.cur(),0)},step:function(a){var b=J(),d=true;if(a||b>=this.options.duration+this.startTime){this.now= +this.end;this.pos=this.state=1;this.update();this.options.curAnim[this.prop]=true;for(var f in this.options.curAnim)if(this.options.curAnim[f]!==true)d=false;if(d){if(this.options.display!=null){this.elem.style.overflow=this.options.overflow;a=c.data(this.elem,"olddisplay");this.elem.style.display=a?a:this.options.display;if(c.css(this.elem,"display")==="none")this.elem.style.display="block"}this.options.hide&&c(this.elem).hide();if(this.options.hide||this.options.show)for(var e in this.options.curAnim)c.style(this.elem, +e,this.options.orig[e]);this.options.complete.call(this.elem)}return false}else{e=b-this.startTime;this.state=e/this.options.duration;a=this.options.easing||(c.easing.swing?"swing":"linear");this.pos=c.easing[this.options.specialEasing&&this.options.specialEasing[this.prop]||a](this.state,e,0,1,this.options.duration);this.now=this.start+(this.end-this.start)*this.pos;this.update()}return true}};c.extend(c.fx,{tick:function(){for(var a=c.timers,b=0;b
"; +a.insertBefore(b,a.firstChild);d=b.firstChild;f=d.firstChild;e=d.nextSibling.firstChild.firstChild;this.doesNotAddBorder=f.offsetTop!==5;this.doesAddBorderForTableAndCells=e.offsetTop===5;f.style.position="fixed";f.style.top="20px";this.supportsFixedPosition=f.offsetTop===20||f.offsetTop===15;f.style.position=f.style.top="";d.style.overflow="hidden";d.style.position="relative";this.subtractsBorderForOverflowNotVisible=f.offsetTop===-5;this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==j;a.removeChild(b); +c.offset.initialize=c.noop},bodyOffset:function(a){var b=a.offsetTop,d=a.offsetLeft;c.offset.initialize();if(c.offset.doesNotIncludeMarginInBodyOffset){b+=parseFloat(c.curCSS(a,"marginTop",true))||0;d+=parseFloat(c.curCSS(a,"marginLeft",true))||0}return{top:b,left:d}},setOffset:function(a,b,d){if(/static/.test(c.curCSS(a,"position")))a.style.position="relative";var f=c(a),e=f.offset(),j=parseInt(c.curCSS(a,"top",true),10)||0,i=parseInt(c.curCSS(a,"left",true),10)||0;if(c.isFunction(b))b=b.call(a, +d,e);d={top:b.top-e.top+j,left:b.left-e.left+i};"using"in b?b.using.call(a,d):f.css(d)}};c.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),d=this.offset(),f=/^body|html$/i.test(b[0].nodeName)?{top:0,left:0}:b.offset();d.top-=parseFloat(c.curCSS(a,"marginTop",true))||0;d.left-=parseFloat(c.curCSS(a,"marginLeft",true))||0;f.top+=parseFloat(c.curCSS(b[0],"borderTopWidth",true))||0;f.left+=parseFloat(c.curCSS(b[0],"borderLeftWidth",true))||0;return{top:d.top- +f.top,left:d.left-f.left}},offsetParent:function(){return this.map(function(){for(var a=this.offsetParent||s.body;a&&!/^body|html$/i.test(a.nodeName)&&c.css(a,"position")==="static";)a=a.offsetParent;return a})}});c.each(["Left","Top"],function(a,b){var d="scroll"+b;c.fn[d]=function(f){var e=this[0],j;if(!e)return null;if(f!==w)return this.each(function(){if(j=wa(this))j.scrollTo(!a?f:c(j).scrollLeft(),a?f:c(j).scrollTop());else this[d]=f});else return(j=wa(e))?"pageXOffset"in j?j[a?"pageYOffset": +"pageXOffset"]:c.support.boxModel&&j.document.documentElement[d]||j.document.body[d]:e[d]}});c.each(["Height","Width"],function(a,b){var d=b.toLowerCase();c.fn["inner"+b]=function(){return this[0]?c.css(this[0],d,false,"padding"):null};c.fn["outer"+b]=function(f){return this[0]?c.css(this[0],d,false,f?"margin":"border"):null};c.fn[d]=function(f){var e=this[0];if(!e)return f==null?null:this;if(c.isFunction(f))return this.each(function(j){var i=c(this);i[d](f.call(this,j,i[d]()))});return"scrollTo"in +e&&e.document?e.document.compatMode==="CSS1Compat"&&e.document.documentElement["client"+b]||e.document.body["client"+b]:e.nodeType===9?Math.max(e.documentElement["client"+b],e.body["scroll"+b],e.documentElement["scroll"+b],e.body["offset"+b],e.documentElement["offset"+b]):f===w?c.css(e,d):this.css(d,typeof f==="string"?f:f+"px")}});A.jQuery=A.$=c})(window); diff --git a/_static/lernfunk.css b/_static/lernfunk.css new file mode 100644 index 0000000..592129e --- /dev/null +++ b/_static/lernfunk.css @@ -0,0 +1,91 @@ +@import url("haiku.css"); + +dl.function > dt, dl.method > dt,dl.attribute > dt, dl.class > dt, dl.get > dt, dl.post > dt, dl.put > dt, dl.delete > dt, dl.data > dt, div.apititle { + padding: 5px; + padding-left: 15px; + border-radius: 3px; + border-top: 1px solid gray; + background-color: silver; +} + +dl.class { + border-left: 5px solid silver; + padding-bottom: 10px; + margin-bottom: 30px; +} + +table.docutils td, table.docutils th, table.docutils tr { + border: none; +} + +table.docutils thead tr { + border-bottom: 1px solid gray; +} + +table.docutils { + border-top: 2px solid gray; + border-bottom: 2px solid gray; +} + +div.apitoc { + border-bottom: 2px solid silver; + border-left: 10px solid silver; +} + +div.apitoc a { + display: block; + padding: 0px; + padding-left: 10px; + color: black; +} + +div.apitoc a:hover { + background-color: #eee; +} + +div.apitoc a.second { + padding-left: 25px; +} + +div.apitoc a.partOfClass { + padding-left: 25px; + border-left: 3px solid silver; + margin-left: 25px; +} + +div.apitoc span.apilnclassname, div.apitoc big, div.apitoc em { + font-weight: lighter; +} + +div.apitoc big, div.apitoc em { + color: #666; +} + +div.apitoc span.apilnname { + font-weight: bold; +} + + +a.headerlink { + color: gray; +} + +/* +li.toctree-l3 { + display: inline-block; + min-width: 200px; + padding: 0px; + margin: 0px; +} + +li.toctree-l3 a { + display: block; + margin: 1px 10px; + padding: 3px 10px; + border-radius: 3px; +} + +li.toctree-l3 a:hover { + background-color: #eee; +} +*/ diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 0000000..da1c562 Binary files /dev/null and b/_static/minus.png differ diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 0000000..b3cb374 Binary files /dev/null and b/_static/plus.png differ diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 0000000..1a14f2a --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,62 @@ +.highlight .hll { background-color: #ffffcc } +.highlight { background: #eeffcc; } +.highlight .c { color: #408090; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #007020; font-weight: bold } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #007020 } /* Comment.Preproc */ +.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #303030 } /* Generic.Output */ +.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0040D0 } /* Generic.Traceback */ +.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #007020 } /* Keyword.Pseudo */ +.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #902000 } /* Keyword.Type */ +.highlight .m { color: #208050 } /* Literal.Number */ +.highlight .s { color: #4070a0 } /* Literal.String */ +.highlight .na { color: #4070a0 } /* Name.Attribute */ +.highlight .nb { color: #007020 } /* Name.Builtin */ +.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ +.highlight .no { color: #60add5 } /* Name.Constant */ +.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ +.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #007020 } /* Name.Exception */ +.highlight .nf { color: #06287e } /* Name.Function */ +.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ +.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #bb60d5 } /* Name.Variable */ +.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #208050 } /* Literal.Number.Float */ +.highlight .mh { color: #208050 } /* Literal.Number.Hex */ +.highlight .mi { color: #208050 } /* Literal.Number.Integer */ +.highlight .mo { color: #208050 } /* Literal.Number.Oct */ +.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ +.highlight .sc { color: #4070a0 } /* Literal.String.Char */ +.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4070a0 } /* Literal.String.Double */ +.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ +.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ +.highlight .sx { color: #c65d09 } /* Literal.String.Other */ +.highlight .sr { color: #235388 } /* Literal.String.Regex */ +.highlight .s1 { color: #4070a0 } /* Literal.String.Single */ +.highlight .ss { color: #517918 } /* Literal.String.Symbol */ +.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ +.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ +.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ +.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 0000000..663be4c --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,560 @@ +/* + * searchtools.js_t + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilties for the full-text search. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * 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 + * latter for highlighting it. + */ + +jQuery.makeSearchSummary = function(text, keywords, hlwords) { + var textLower = text.toLowerCase(); + var start = 0; + $.each(keywords, function() { + var i = textLower.indexOf(this.toLowerCase()); + if (i > -1) + start = i; + }); + start = Math.max(start - 120, 0); + var excerpt = ((start > 0) ? '...' : '') + + $.trim(text.substr(start, 240)) + + ((start + 240 - text.length) ? '...' : ''); + var rv = $('
').text(excerpt); + $.each(hlwords, function() { + rv = rv.highlightText(this, 'highlighted'); + }); + return rv; +} + + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + + +/** + * Search Module + */ +var Search = { + + _index : null, + _queued_query : null, + _pulse_status : -1, + + init : function() { + var params = $.getQueryParameters(); + if (params.q) { + var query = params.q[0]; + $('input[name="q"]')[0].value = query; + this.performSearch(query); + } + }, + + loadIndex : function(url) { + $.ajax({type: "GET", url: url, data: null, success: null, + dataType: "script", cache: true}); + }, + + setIndex : function(index) { + var q; + this._index = index; + if ((q = this._queued_query) !== null) { + this._queued_query = null; + Search.query(q); + } + }, + + hasIndex : function() { + return this._index !== null; + }, + + deferQuery : function(query) { + this._queued_query = query; + }, + + stopPulse : function() { + this._pulse_status = 0; + }, + + startPulse : function() { + if (this._pulse_status >= 0) + return; + function pulse() { + Search._pulse_status = (Search._pulse_status + 1) % 4; + var dotString = ''; + for (var i = 0; i < Search._pulse_status; i++) + dotString += '.'; + Search.dots.text(dotString); + if (Search._pulse_status > -1) + window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something + */ + performSearch : function(query) { + // create the required interface elements + this.out = $('#search-results'); + this.title = $('

' + _('Searching') + '

').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('

').appendTo(this.out); + this.output = $('
    ').appendTo(this.out); + + $('#search-progress').text(_('Preparing search...')); + this.startPulse(); + + // index already loaded, the browser was quick! + if (this.hasIndex()) + this.query(query); + else + this.deferQuery(query); + }, + + query : function(query) { + var stopwords = ["and","then","into","it","as","are","in","if","for","no","there","their","was","is","be","to","that","but","they","not","such","with","by","a","on","these","of","will","this","near","the","or","at"]; + + // Stem the searchterms and add them to the correct list + var stemmer = new Stemmer(); + var searchterms = []; + var excluded = []; + var hlterms = []; + var tmp = query.split(/\s+/); + var objectterms = []; + for (var i = 0; i < tmp.length; i++) { + if (tmp[i] != "") { + objectterms.push(tmp[i].toLowerCase()); + } + + if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || + tmp[i] == "") { + // skip this "word" + continue; + } + // stem the word + var word = stemmer.stemWord(tmp[i]).toLowerCase(); + // select the correct list + if (word[0] == '-') { + var toAppend = excluded; + word = word.substr(1); + } + else { + var toAppend = searchterms; + hlterms.push(tmp[i].toLowerCase()); + } + // only add if not already in the list + if (!$.contains(toAppend, word)) + toAppend.push(word); + }; + var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); + + // console.debug('SEARCH: searching for:'); + // console.info('required: ', searchterms); + // console.info('excluded: ', excluded); + + // prepare search + var filenames = this._index.filenames; + var titles = this._index.titles; + var terms = this._index.terms; + var fileMap = {}; + var files = null; + // different result priorities + var importantResults = []; + var objectResults = []; + var regularResults = []; + var unimportantResults = []; + $('#search-progress').empty(); + + // lookup as object + for (var i = 0; i < objectterms.length; i++) { + var others = [].concat(objectterms.slice(0,i), + objectterms.slice(i+1, objectterms.length)) + var results = this.performObjectSearch(objectterms[i], others); + // Assume first word is most likely to be the object, + // other words more likely to be in description. + // Therefore put matches for earlier words first. + // (Results are eventually used in reverse order). + objectResults = results[0].concat(objectResults); + importantResults = results[1].concat(importantResults); + unimportantResults = results[2].concat(unimportantResults); + } + + // perform the search on the required terms + for (var i = 0; i < searchterms.length; i++) { + var word = searchterms[i]; + // no match but word was a required one + if ((files = terms[word]) == null) + break; + if (files.length == undefined) { + files = [files]; + } + // create the mapping + for (var j = 0; j < files.length; j++) { + var file = files[j]; + if (file in fileMap) + fileMap[file].push(word); + else + fileMap[file] = [word]; + } + } + + // now check if the files don't contain excluded terms + for (var file in fileMap) { + var valid = true; + + // check if all requirements are matched + if (fileMap[file].length != searchterms.length) + continue; + + // ensure that none of the excluded terms is in the + // search result. + for (var i = 0; i < excluded.length; i++) { + if (terms[excluded[i]] == file || + $.contains(terms[excluded[i]] || [], file)) { + valid = false; + break; + } + } + + // if we have still a valid result we can add it + // to the result list + if (valid) + regularResults.push([filenames[file], titles[file], '', null]); + } + + // delete unused variables in order to not waste + // memory until list is retrieved completely + delete filenames, titles, terms; + + // now sort the regular results descending by title + regularResults.sort(function(a, b) { + var left = a[1].toLowerCase(); + var right = b[1].toLowerCase(); + return (left > right) ? -1 : ((left < right) ? 1 : 0); + }); + + // combine all results + var results = unimportantResults.concat(regularResults) + .concat(objectResults).concat(importantResults); + + // print the results + var resultCount = results.length; + function displayNextItem() { + // results left, load the summary and display it + if (results.length) { + var item = results.pop(); + var listItem = $('
  • '); + if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { + // dirhtml builder + var dirname = item[0] + '/'; + if (dirname.match(/\/index\/$/)) { + dirname = dirname.substring(0, dirname.length-6); + } else if (dirname == 'index/') { + dirname = ''; + } + listItem.append($('').attr('href', + DOCUMENTATION_OPTIONS.URL_ROOT + dirname + + highlightstring + item[2]).html(item[1])); + } else { + // normal html builders + listItem.append($('').attr('href', + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + + highlightstring + item[2]).html(item[1])); + } + if (item[3]) { + listItem.append($(' (' + item[3] + ')')); + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { + $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + + item[0] + '.txt', function(data) { + if (data != '') { + listItem.append($.makeSearchSummary(data, searchterms, hlterms)); + Search.output.append(listItem); + } + listItem.slideDown(5, function() { + displayNextItem(); + }); + }, "text"); + } else { + // no source available, just display title + Search.output.append(listItem); + listItem.slideDown(5, function() { + displayNextItem(); + }); + } + } + // search finished, update title and status message + else { + Search.stopPulse(); + Search.title.text(_('Search Results')); + if (!resultCount) + Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); + else + Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); + Search.status.fadeIn(500); + } + } + displayNextItem(); + }, + + performObjectSearch : function(object, otherterms) { + var filenames = this._index.filenames; + var objects = this._index.objects; + var objnames = this._index.objnames; + var titles = this._index.titles; + + var importantResults = []; + var objectResults = []; + var unimportantResults = []; + + for (var prefix in objects) { + for (var name in objects[prefix]) { + var fullname = (prefix ? prefix + '.' : '') + name; + if (fullname.toLowerCase().indexOf(object) > -1) { + var match = objects[prefix][name]; + var objname = objnames[match[1]][2]; + var title = titles[match[0]]; + // If more than one term searched for, we require other words to be + // found in the name/title/description + if (otherterms.length > 0) { + var haystack = (prefix + ' ' + name + ' ' + + objname + ' ' + title).toLowerCase(); + var allfound = true; + for (var i = 0; i < otherterms.length; i++) { + if (haystack.indexOf(otherterms[i]) == -1) { + allfound = false; + break; + } + } + if (!allfound) { + continue; + } + } + var descr = objname + _(', in ') + title; + anchor = match[3]; + if (anchor == '') + anchor = fullname; + else if (anchor == '-') + anchor = objnames[match[1]][1] + '-' + fullname; + result = [filenames[match[0]], fullname, '#'+anchor, descr]; + switch (match[2]) { + case 1: objectResults.push(result); break; + case 0: importantResults.push(result); break; + case 2: unimportantResults.push(result); break; + } + } + } + } + + // sort results descending + objectResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + importantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + unimportantResults.sort(function(a, b) { + return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); + }); + + return [importantResults, objectResults, unimportantResults] + } +} + +$(document).ready(function() { + Search.init(); +}); \ No newline at end of file diff --git a/_static/theme_extras.js b/_static/theme_extras.js new file mode 100644 index 0000000..d9129ae --- /dev/null +++ b/_static/theme_extras.js @@ -0,0 +1,28 @@ +$(document).ready(function() { + $('.headerlink').each(function( index ) { + var type = $(this).parent().get(0).nodeName + if (type == 'H1') { + var name = $(this).parent().get(0).childNodes[0].data; + var ln = $(this).attr('href'); + $('div.apitoc').append(''+name+''); + } else if (type == 'H2') { + var name = $(this).parent().get(0).childNodes[0].data; + var ln = $(this).attr('href'); + $('div.apitoc').append(''+name+''); + } else if (type == 'DT') { + //var name = $(this).parent().text().replace('¶', ''); + var name = $(this).parent().html().replace(//g, '') + .replace(//g, ''); + var ln = $(this).attr('href'); + var p = $(this).parent().parent(); + if ( p.hasClass('method') || p.hasClass('attribute') ) { + $('div.apitoc').append(''+name+''); + } else { + $('div.apitoc').append(''+name+''); + } + } else { + alert( type ); + } + }); +}); diff --git a/_static/underscore.js b/_static/underscore.js new file mode 100644 index 0000000..5d89914 --- /dev/null +++ b/_static/underscore.js @@ -0,0 +1,23 @@ +// Underscore.js 0.5.5 +// (c) 2009 Jeremy Ashkenas, DocumentCloud Inc. +// Underscore is freely distributable under the terms of the MIT license. +// Portions of Underscore are inspired by or borrowed from Prototype.js, +// Oliver Steele's Functional, and John Resig's Micro-Templating. +// For all details and documentation: +// http://documentcloud.github.com/underscore/ +(function(){var j=this,n=j._,i=function(a){this._wrapped=a},m=typeof StopIteration!=="undefined"?StopIteration:"__break__",b=j._=function(a){return new i(a)};if(typeof exports!=="undefined")exports._=b;var k=Array.prototype.slice,o=Array.prototype.unshift,p=Object.prototype.toString,q=Object.prototype.hasOwnProperty,r=Object.prototype.propertyIsEnumerable;b.VERSION="0.5.5";b.each=function(a,c,d){try{if(a.forEach)a.forEach(c,d);else if(b.isArray(a)||b.isArguments(a))for(var e=0,f=a.length;e=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;gf?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); +return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); +var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; +if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== +0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& +a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, +" ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); +o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); diff --git a/_static/up-pressed.png b/_static/up-pressed.png new file mode 100644 index 0000000..8bd587a Binary files /dev/null and b/_static/up-pressed.png differ diff --git a/_static/up.png b/_static/up.png new file mode 100644 index 0000000..b946256 Binary files /dev/null and b/_static/up.png differ diff --git a/_static/websupport.js b/_static/websupport.js new file mode 100644 index 0000000..e9bd1b8 --- /dev/null +++ b/_static/websupport.js @@ -0,0 +1,808 @@ +/* + * websupport.js + * ~~~~~~~~~~~~~ + * + * sphinx.websupport utilties for all documentation. + * + * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +(function($) { + $.fn.autogrow = function() { + return this.each(function() { + var textarea = this; + + $.fn.autogrow.resize(textarea); + + $(textarea) + .focus(function() { + textarea.interval = setInterval(function() { + $.fn.autogrow.resize(textarea); + }, 500); + }) + .blur(function() { + clearInterval(textarea.interval); + }); + }); + }; + + $.fn.autogrow.resize = function(textarea) { + var lineHeight = parseInt($(textarea).css('line-height'), 10); + var lines = textarea.value.split('\n'); + var columns = textarea.cols; + var lineCount = 0; + $.each(lines, function() { + lineCount += Math.ceil(this.length / columns) || 1; + }); + var height = lineHeight * (lineCount + 1); + $(textarea).css('height', height); + }; +})(jQuery); + +(function($) { + var comp, by; + + function init() { + initEvents(); + initComparator(); + } + + function initEvents() { + $('a.comment-close').live("click", function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }); + $('a.vote').live("click", function(event) { + event.preventDefault(); + handleVote($(this)); + }); + $('a.reply').live("click", function(event) { + event.preventDefault(); + openReply($(this).attr('id').substring(2)); + }); + $('a.close-reply').live("click", function(event) { + event.preventDefault(); + closeReply($(this).attr('id').substring(2)); + }); + $('a.sort-option').live("click", function(event) { + event.preventDefault(); + handleReSort($(this)); + }); + $('a.show-proposal').live("click", function(event) { + event.preventDefault(); + showProposal($(this).attr('id').substring(2)); + }); + $('a.hide-proposal').live("click", function(event) { + event.preventDefault(); + hideProposal($(this).attr('id').substring(2)); + }); + $('a.show-propose-change').live("click", function(event) { + event.preventDefault(); + showProposeChange($(this).attr('id').substring(2)); + }); + $('a.hide-propose-change').live("click", function(event) { + event.preventDefault(); + hideProposeChange($(this).attr('id').substring(2)); + }); + $('a.accept-comment').live("click", function(event) { + event.preventDefault(); + acceptComment($(this).attr('id').substring(2)); + }); + $('a.delete-comment').live("click", function(event) { + event.preventDefault(); + deleteComment($(this).attr('id').substring(2)); + }); + $('a.comment-markup').live("click", function(event) { + event.preventDefault(); + toggleCommentMarkupBox($(this).attr('id').substring(2)); + }); + } + + /** + * Set comp, which is a comparator function used for sorting and + * inserting comments into the list. + */ + function setComparator() { + // If the first three letters are "asc", sort in ascending order + // and remove the prefix. + if (by.substring(0,3) == 'asc') { + var i = by.substring(3); + comp = function(a, b) { return a[i] - b[i]; }; + } else { + // Otherwise sort in descending order. + comp = function(a, b) { return b[by] - a[by]; }; + } + + // Reset link styles and format the selected sort option. + $('a.sel').attr('href', '#').removeClass('sel'); + $('a.by' + by).removeAttr('href').addClass('sel'); + } + + /** + * Create a comp function. If the user has preferences stored in + * the sortBy cookie, use those, otherwise use the default. + */ + function initComparator() { + by = 'rating'; // Default to sort by rating. + // If the sortBy cookie is set, use that instead. + if (document.cookie.length > 0) { + var start = document.cookie.indexOf('sortBy='); + if (start != -1) { + start = start + 7; + var end = document.cookie.indexOf(";", start); + if (end == -1) { + end = document.cookie.length; + by = unescape(document.cookie.substring(start, end)); + } + } + } + setComparator(); + } + + /** + * Show a comment div. + */ + function show(id) { + $('#ao' + id).hide(); + $('#ah' + id).show(); + var context = $.extend({id: id}, opts); + var popup = $(renderTemplate(popupTemplate, context)).hide(); + popup.find('textarea[name="proposal"]').hide(); + popup.find('a.by' + by).addClass('sel'); + var form = popup.find('#cf' + id); + form.submit(function(event) { + event.preventDefault(); + addComment(form); + }); + $('#s' + id).after(popup); + popup.slideDown('fast', function() { + getComments(id); + }); + } + + /** + * Hide a comment div. + */ + function hide(id) { + $('#ah' + id).hide(); + $('#ao' + id).show(); + var div = $('#sc' + id); + div.slideUp('fast', function() { + div.remove(); + }); + } + + /** + * Perform an ajax request to get comments for a node + * and insert the comments into the comments tree. + */ + function getComments(id) { + $.ajax({ + type: 'GET', + url: opts.getCommentsURL, + data: {node: id}, + success: function(data, textStatus, request) { + var ul = $('#cl' + id); + var speed = 100; + $('#cf' + id) + .find('textarea[name="proposal"]') + .data('source', data.source); + + if (data.comments.length === 0) { + ul.html('
  • No comments yet.
    • '); + ul.data('empty', true); + } else { + // If there are comments, sort them and put them in the list. + var comments = sortComments(data.comments); + speed = data.comments.length * 100; + appendComments(comments, ul); + ul.data('empty', false); + } + $('#cn' + id).slideUp(speed + 200); + ul.slideDown(speed); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem retrieving the comments.'); + }, + dataType: 'json' + }); + } + + /** + * Add a comment via ajax and insert the comment into the comment tree. + */ + function addComment(form) { + var node_id = form.find('input[name="node"]').val(); + var parent_id = form.find('input[name="parent"]').val(); + var text = form.find('textarea[name="comment"]').val(); + var proposal = form.find('textarea[name="proposal"]').val(); + + if (text == '') { + showError('Please enter a comment.'); + return; + } + + // Disable the form that is being submitted. + form.find('textarea,input').attr('disabled', 'disabled'); + + // Send the comment to the server. + $.ajax({ + type: "POST", + url: opts.addCommentURL, + dataType: 'json', + data: { + node: node_id, + parent: parent_id, + text: text, + proposal: proposal + }, + success: function(data, textStatus, error) { + // Reset the form. + if (node_id) { + hideProposeChange(node_id); + } + form.find('textarea') + .val('') + .add(form.find('input')) + .removeAttr('disabled'); + var ul = $('#cl' + (node_id || parent_id)); + if (ul.data('empty')) { + $(ul).empty(); + ul.data('empty', false); + } + insertComment(data.comment); + var ao = $('#ao' + node_id); + ao.find('img').attr({'src': opts.commentBrightImage}); + if (node_id) { + // if this was a "root" comment, remove the commenting box + // (the user can get it back by reopening the comment popup) + $('#ca' + node_id).slideUp(); + } + }, + error: function(request, textStatus, error) { + form.find('textarea,input').removeAttr('disabled'); + showError('Oops, there was a problem adding the comment.'); + } + }); + } + + /** + * Recursively append comments to the main comment list and children + * lists, creating the comment tree. + */ + function appendComments(comments, ul) { + $.each(comments, function() { + var div = createCommentDiv(this); + ul.append($(document.createElement('li')).html(div)); + appendComments(this.children, div.find('ul.comment-children')); + // To avoid stagnating data, don't store the comments children in data. + this.children = null; + div.data('comment', this); + }); + } + + /** + * After adding a new comment, it must be inserted in the correct + * location in the comment tree. + */ + function insertComment(comment) { + var div = createCommentDiv(comment); + + // To avoid stagnating data, don't store the comments children in data. + comment.children = null; + div.data('comment', comment); + + var ul = $('#cl' + (comment.node || comment.parent)); + var siblings = getChildren(ul); + + var li = $(document.createElement('li')); + li.hide(); + + // Determine where in the parents children list to insert this comment. + for(i=0; i < siblings.length; i++) { + if (comp(comment, siblings[i]) <= 0) { + $('#cd' + siblings[i].id) + .parent() + .before(li.html(div)); + li.slideDown('fast'); + return; + } + } + + // If we get here, this comment rates lower than all the others, + // or it is the only comment in the list. + ul.append(li.html(div)); + li.slideDown('fast'); + } + + function acceptComment(id) { + $.ajax({ + type: 'POST', + url: opts.acceptCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + $('#cm' + id).fadeOut('fast'); + $('#cd' + id).removeClass('moderate'); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem accepting the comment.'); + } + }); + } + + function deleteComment(id) { + $.ajax({ + type: 'POST', + url: opts.deleteCommentURL, + data: {id: id}, + success: function(data, textStatus, request) { + var div = $('#cd' + id); + if (data == 'delete') { + // Moderator mode: remove the comment and all children immediately + div.slideUp('fast', function() { + div.remove(); + }); + return; + } + // User mode: only mark the comment as deleted + div + .find('span.user-id:first') + .text('[deleted]').end() + .find('div.comment-text:first') + .text('[deleted]').end() + .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id + + ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id) + .remove(); + var comment = div.data('comment'); + comment.username = '[deleted]'; + comment.text = '[deleted]'; + div.data('comment', comment); + }, + error: function(request, textStatus, error) { + showError('Oops, there was a problem deleting the comment.'); + } + }); + } + + function showProposal(id) { + $('#sp' + id).hide(); + $('#hp' + id).show(); + $('#pr' + id).slideDown('fast'); + } + + function hideProposal(id) { + $('#hp' + id).hide(); + $('#sp' + id).show(); + $('#pr' + id).slideUp('fast'); + } + + function showProposeChange(id) { + $('#pc' + id).hide(); + $('#hc' + id).show(); + var textarea = $('#pt' + id); + textarea.val(textarea.data('source')); + $.fn.autogrow.resize(textarea[0]); + textarea.slideDown('fast'); + } + + function hideProposeChange(id) { + $('#hc' + id).hide(); + $('#pc' + id).show(); + var textarea = $('#pt' + id); + textarea.val('').removeAttr('disabled'); + textarea.slideUp('fast'); + } + + function toggleCommentMarkupBox(id) { + $('#mb' + id).toggle(); + } + + /** Handle when the user clicks on a sort by link. */ + function handleReSort(link) { + var classes = link.attr('class').split(/\s+/); + for (var i=0; iThank you! Your comment will show up ' + + 'once it is has been approved by a moderator.'); + } + // Prettify the comment rating. + comment.pretty_rating = comment.rating + ' point' + + (comment.rating == 1 ? '' : 's'); + // Make a class (for displaying not yet moderated comments differently) + comment.css_class = comment.displayed ? '' : ' moderate'; + // Create a div for this comment. + var context = $.extend({}, opts, comment); + var div = $(renderTemplate(commentTemplate, context)); + + // If the user has voted on this comment, highlight the correct arrow. + if (comment.vote) { + var direction = (comment.vote == 1) ? 'u' : 'd'; + div.find('#' + direction + 'v' + comment.id).hide(); + div.find('#' + direction + 'u' + comment.id).show(); + } + + if (opts.moderator || comment.text != '[deleted]') { + div.find('a.reply').show(); + if (comment.proposal_diff) + div.find('#sp' + comment.id).show(); + if (opts.moderator && !comment.displayed) + div.find('#cm' + comment.id).show(); + if (opts.moderator || (opts.username == comment.username)) + div.find('#dc' + comment.id).show(); + } + return div; + } + + /** + * A simple template renderer. Placeholders such as <%id%> are replaced + * by context['id'] with items being escaped. Placeholders such as <#id#> + * are not escaped. + */ + function renderTemplate(template, context) { + var esc = $(document.createElement('div')); + + function handle(ph, escape) { + var cur = context; + $.each(ph.split('.'), function() { + cur = cur[this]; + }); + return escape ? esc.text(cur || "").html() : cur; + } + + return template.replace(/<([%#])([\w\.]*)\1>/g, function() { + return handle(arguments[2], arguments[1] == '%' ? true : false); + }); + } + + /** Flash an error message briefly. */ + function showError(message) { + $(document.createElement('div')).attr({'class': 'popup-error'}) + .append($(document.createElement('div')) + .attr({'class': 'error-message'}).text(message)) + .appendTo('body') + .fadeIn("slow") + .delay(2000) + .fadeOut("slow"); + } + + /** Add a link the user uses to open the comments popup. */ + $.fn.comment = function() { + return this.each(function() { + var id = $(this).attr('id').substring(1); + var count = COMMENT_METADATA[id]; + var title = count + ' comment' + (count == 1 ? '' : 's'); + var image = count > 0 ? opts.commentBrightImage : opts.commentImage; + var addcls = count == 0 ? ' nocomment' : ''; + $(this) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-open' + addcls, + id: 'ao' + id + }) + .append($(document.createElement('img')).attr({ + src: image, + alt: 'comment', + title: title + })) + .click(function(event) { + event.preventDefault(); + show($(this).attr('id').substring(2)); + }) + ) + .append( + $(document.createElement('a')).attr({ + href: '#', + 'class': 'sphinx-comment-close hidden', + id: 'ah' + id + }) + .append($(document.createElement('img')).attr({ + src: opts.closeCommentImage, + alt: 'close', + title: 'close' + })) + .click(function(event) { + event.preventDefault(); + hide($(this).attr('id').substring(2)); + }) + ); + }); + }; + + var opts = { + processVoteURL: '/_process_vote', + addCommentURL: '/_add_comment', + getCommentsURL: '/_get_comments', + acceptCommentURL: '/_accept_comment', + deleteCommentURL: '/_delete_comment', + commentImage: '/static/_static/comment.png', + closeCommentImage: '/static/_static/comment-close.png', + loadingImage: '/static/_static/ajax-loader.gif', + commentBrightImage: '/static/_static/comment-bright.png', + upArrow: '/static/_static/up.png', + downArrow: '/static/_static/down.png', + upArrowPressed: '/static/_static/up-pressed.png', + downArrowPressed: '/static/_static/down-pressed.png', + voting: false, + moderator: false + }; + + if (typeof COMMENT_OPTIONS != "undefined") { + opts = jQuery.extend(opts, COMMENT_OPTIONS); + } + + var popupTemplate = '\ +
    \ +

    \ + Sort by:\ + best rated\ + newest\ + oldest\ +

    \ +
    Comments
    \ +
    \ + loading comments...
    \ +
      \ +
      \ +

      Add a comment\ + (markup):

      \ +
      \ + reStructured text markup: *emph*, **strong**, \ + ``code``, \ + code blocks: :: and an indented block after blank line
      \ +
      \ + \ +

      \ + \ + Propose a change ▹\ + \ + \ + Propose a change ▿\ + \ +

      \ + \ + \ + \ + \ +
      \ +
      \ +
      '; + + var commentTemplate = '\ +
      \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ + \ + \ + \ + \ + \ + \ +
      \ +
      \ +
      \ +

      \ + <%username%>\ + <%pretty_rating%>\ + <%time.delta%>\ +

      \ +
      <#text#>
      \ +

      \ + \ + reply ▿\ + proposal ▹\ + proposal ▿\ + \ + \ +

      \ + 
      \
+<#proposal_diff#>\
+
      \ +
        \ +
        \ +
        \ +
        \ + '; + + var replyTemplate = '\ +
      • \ +
        \ +
        \ + \ + \ + \ + \ + \ +
        \ +
        \ +
        • '; + + $(document).ready(function() { + init(); + }); +})(jQuery); + +$(document).ready(function() { + // add comment anchors for all paragraphs that are commentable + $('.sphinx-has-comment').comment(); + + // highlight search words in search results + $("div.context").each(function() { + var params = $.getQueryParameters(); + var terms = (params.q) ? params.q[0].split(/\s+/) : []; + var result = $(this); + $.each(terms, function() { + result.highlightText(this.toLowerCase(), 'highlighted'); + }); + }); + + // directly open comment window if requested + var anchor = document.location.hash; + if (anchor.substring(0, 9) == '#comment-') { + $('#ao' + anchor.substring(9)).click(); + document.location.hash = '#s' + anchor.substring(9); + } +}); diff --git a/api.entry.html b/api.entry.html new file mode 100644 index 0000000..bdb8942 --- /dev/null +++ b/api.entry.html @@ -0,0 +1,559 @@ + + + + + + + + + + feedgen.entry — pyFeedGen 0.1.s20130505 documentation + + + + + + + + + + + + + + + + +

        + pyFeedGen 0.1.s20130505 documentation

        +

        feedgen.entry

        +
        +
        + +

        + «  feedgen.feed +   ::   + Contents +   ::   + feedgen.util  » +

        + +
        +
        + + +
        Contents
        +
        +

        feedgen.entry

        + +++ + + + + + +
        copyright:2013, Lars Kiesow <lkiesow@uos.de>
        license:FreeBSD and LGPL, see license.* for more details.
        +
        +
        +class feedgen.entry.FeedEntry
        +

        FeedEntry call representing an ATOM feeds entry node or an RSS feeds item +node.

        +
        +
        +atom_entry(feed, extensions=True)
        +

        Insert an ATOM entry into a existing XML structure. Normally you +would pass the feed node of an ATOM feed XML to this function.

        + +++ + + + +
        Parameters:feed – The XML element to use as parent node for the element.
        +
        + +
        +
        +author(author=None, replace=False, **kwargs)
        +

        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.

        +

        This method can be called with: +- the fields of an author as keyword arguments +- the fields of an author as a dictionary +- a list of dictionaries containing the author fields

        +

        An author has the following fields: +- name conveys a human-readable name for the person. +- uri contains a home page for the person. +- email contains an email address for the person.

        + +++ + + + +
        Parameters:
          +
        • author – Dict or list of dicts with author data.
          • +
        • replace – Add or replace old data.
          • +
        +
        +

        Example:

        +
        >>> author( { 'name':'John Doe', 'email':'jdoe@example.com' } )
+[{'name':'John Doe','email':'jdoe@example.com'}]
+
+>>> author([{'name':'Mr. X'},{'name':'Max'}])
+[{'name':'John Doe','email':'jdoe@example.com'},
+        {'name':'John Doe'}, {'name':'Max'}]
+
+>>> author( name='John Doe', email='jdoe@example.com', replace=True )
+[{'name':'John Doe','email':'jdoe@example.com'}]
+
        +
        +
        + +
        +
        +category(category=None, replace=False, **kwargs)
        +

        Get or set categories that the entry belongs to.

        +

        This method can be called with: +- the fields of a category as keyword arguments +- the fields of a category as a dictionary +- a list of dictionaries containing the category fields

        +

        A categories has the following fields: +- term identifies the category +- scheme identifies the categorization scheme via a URI. +- label provides a human-readable label for display

        +

        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.

        + +++ + + + + + +
        Parameters:
          +
        • link – Dict or list of dicts with data.
          • +
        • replace – Add or replace old data.
          • +
        +
        Returns:

        List of category data.

        +
        +
        + +
        +
        +comments(comments=None)
        +

        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.

        + +++ + + + + + +
        Parameters:comments – URL to the comments page.
        Returns:URL to the comments page.
        +
        + +
        +
        +content(content=None, src=None)
        +

        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 +rss:description.

        + +++ + + + + + +
        Parameters:
          +
        • content – The content of the feed entry.
          • +
        • src – Link to the entries content.
          • +
        +
        Returns:

        Content element of the entry.

        +
        +
        + +
        +
        +contributor(contributor=None, replace=False, **kwargs)
        +

        Get or set the contributor data of the feed. This is an ATOM only +value.

        +

        This method can be called with: +- the fields of an contributor as keyword arguments +- the fields of an contributor as a dictionary +- a list of dictionaries containing the contributor fields

        +

        An contributor has the following fields: +- name conveys a human-readable name for the person. +- uri contains a home page for the person. +- email contains an email address for the person.

        + +++ + + + + + +
        Parameters:
          +
        • contributor – Dictionary or list of dictionaries with contributor data.
          • +
        • replace – Add or replace old data.
          • +
        +
        Returns:

        List of contributors as dictionaries.

        +
        +
        + +
        +
        +description(description=None, isSummary=False)
        +

        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.

        + +++ + + + + + +
        Parameters:
          +
        • description – Description of the entry.
          • +
        • isSummary – If the description should be used as content or summary.
          • +
        +
        Returns:

        The entries description.

        +
        +
        + +
        +
        +enclosure(url=None, length=None, type=None)
        +

        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.

        + +++ + + + + + +
        Parameters:
          +
        • url – URL of the media object.
          • +
        • length – Size of the media in bytes.
          • +
        • type – Mimetype of the linked media.
          • +
        +
        Returns:

        Data of the enclosure element.

        +
        +
        + +
        +
        +guid(guid=None)
        +

        Get or set the entries guid which is a string that uniquely identifies +the item. This will also set atom:id.

        + +++ + + + + + +
        Parameters:guid – Id of the entry.
        Returns:Id of the entry.
        +
        + +
        +
        +id(id=None)
        +

        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.

        + +++ + + + + + +
        Parameters:id – New Id of the entry.
        Returns:Id of the entry.
        +
        + +
        + +

        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.

        +

        This method can be called with: +- the fields of a link as keyword arguments +- the fields of a link as a dictionary +- a list of dictionaries containing the link fields

        +

        A link has the following fields:

        +
          +

        • href is the URI of the referenced resource (typically a Web page)

          +
          • +

        • rel contains a single link relationship type. It can be a full URI, +or one of the following predefined values (default=alternate):

          +
          +
            +
          • alternate 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.
            • +
          • enclosure a related resource which is potentially large in size +and might require special handling, for example an audio or video +recording.
            • +
          • related an document related to the entry or feed.
            • +
          • self the feed itself.
            • +
          • via the source of the information provided in the entry.
            • +
          +
          +
          • +

        • type indicates the media type of the resource.

          +
          • +

        • hreflang indicates the language of the referenced resource.

          +
          • +

        • title human readable information about the link, typically for +display purposes.

          +
          • +

        • length the length of the resource, in bytes.

          +
          • +
        +

        RSS only supports one link with nothing but a URL. So for the RSS link +element the last link with rel=alternate is used.

        +

        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.

        + +++ + + + + + +
        Parameters:
          +
        • link – Dict or list of dicts with data.
          • +
        • replace – Add or replace old data.
          • +
        +
        Returns:

        List of link data.

        +
        +
        + +
        +
        +load_extension(name, atom=True, rss=True)
        +

        Load a specific extension by name.

        + +++ + + + +
        Parameters:
          +
        • name – Name of the extension to load.
          • +
        • atom – If the extension should be used for ATOM feeds.
          • +
        • rss – If the extension should be used for RSS feeds.
          • +
        +
        +
        + +
        +
        +pubdate(pubDate=None)
        +

        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.

        +
        + +
        +
        +published(published=None)
        +

        Set or get the published value which ontains the time of the initial +creation or first availability of the entry.

        +

        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.

        + +++ + + + + + +
        Parameters:published – The creation date.
        Returns:Creation date as datetime.datetime
        +
        + +
        +
        +rights(rights=None)
        +

        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.

        + +++ + + + + + +
        Parameters:rights – Rights information of the feed.
        Returns:Rights information of the feed.
        +
        + +
        +
        +rss_entry(feed, extensions=True)
        +

        Insert an RSS item into a existing XML structure. Normally you +would pass the channel node of an RSS feed XML to this function.

        + +++ + + + +
        Parameters:feed – The XML element to use as parent node for the item.
        +
        + +
        +
        +summary(summary=None)
        +

        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.

        + +++ + + + + + +
        Parameters:summary – Summary of the entries contents.
        Returns:Summary of the entries contents.
        +
        + +
        +
        +title(title=None)
        +

        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.

        + +++ + + + + + +
        Parameters:title – The new title of the entry.
        Returns:The entriess title.
        +
        + +
        +
        +ttl(ttl=None)
        +

        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.

        + +++ + + + + + +
        Parameters:ttl – Integer value representing the time to live.
        Returns:Time to live of of the entry.
        +
        + +
        +
        +updated(updated=None)
        +

        Set or get the updated value which indicates the last time the entry +was modified in a significant way.

        +

        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.

        + +++ + + + + + +
        Parameters:updated – The modification date.
        Returns:Modification date as datetime.datetime
        +
        + +
        + +
        + + +
        +
        + +

        + «  feedgen.feed +   ::   + Contents +   ::   + feedgen.util  » +

        + +
        + +
        + © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
        + + \ No newline at end of file diff --git a/api.feed.html b/api.feed.html new file mode 100644 index 0000000..9c04bdb --- /dev/null +++ b/api.feed.html @@ -0,0 +1,897 @@ + + + + + + + + + + feedgen.feed — pyFeedGen 0.1.s20130505 documentation + + + + + + + + + + + + + + + + +

        + pyFeedGen 0.1.s20130505 documentation

        +

        feedgen.feed

        +
        +
        + +

        + «  API Documentation +   ::   + Contents +   ::   + feedgen.entry  » +

        + +
        +
        + + +
        Contents
        +
        +

        feedgen.feed

        + +++ + + + + + +
        copyright:2013, Lars Kiesow <lkiesow@uos.de>
        license:FreeBSD and LGPL, see license.* for more details.
        +
        +
        +class feedgen.feed.FeedGenerator
        +

        FeedGenerator for generating ATOM and RSS feeds.

        +
        +
        +add_entry(feedEntry=None)
        +

        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.

        + +++ + + + + + +
        Parameters:feedEntry – FeedEntry object to add.
        Returns:FeedEntry object created or passed to this function.
        +

        Example:

        +
        ...
+>>> entry = feedgen.add_entry()
+>>> entry.title('First feed entry')
        +
        +
        + +
        +
        +add_item(item=None)
        +

        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(...)

        +
        + +
        +
        +atom_file(filename, extensions=True)
        +

        Generates an ATOM feed and write the resulting XML to a file.

        + +++ + + + +
        Parameters:
          +
        • filename – Name of file to write.
          • +
        • extensions – Enable or disable the loaded extensions for the xml +generation (default: enabled).
          • +
        +
        +
        + +
        +
        +atom_str(pretty=False, extensions=True)
        +

        Generates an ATOM feed and returns the feed XML as string.

        + +++ + + + + + +
        Parameters:
          +
        • pretty – If the feed should be split into multiple lines and +properly indented.
          • +
        • extensions – Enable or disable the loaded extensions for the xml +generation (default: enabled).
          • +
        +
        Returns:

        String representation of the ATOM feed.

        +
        +
        + +
        +
        +author(author=None, replace=False, **kwargs)
        +

        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.

        +

        This method can be called with: +- the fields of an author as keyword arguments +- the fields of an author as a dictionary +- a list of dictionaries containing the author fields

        +

        An author has the following fields: +- name conveys a human-readable name for the person. +- uri contains a home page for the person. +- email contains an email address for the person.

        + +++ + + + + + +
        Parameters:
          +
        • author – Dictionary or list of dictionaries with author data.
          • +
        • replace – Add or replace old data.
          • +
        +
        Returns:

        List of authors as dictionaries.

        +
        +

        Example:

        +
        >>> feedgen.author( { 'name':'John Doe', 'email':'jdoe@example.com' } )
+[{'name':'John Doe','email':'jdoe@example.com'}]
+
+>>> feedgen.author([{'name':'Mr. X'},{'name':'Max'}])
+[{'name':'John Doe','email':'jdoe@example.com'},
+        {'name':'John Doe'}, {'name':'Max'}]
+
+>>> feedgen.author( name='John Doe', email='jdoe@example.com', replace=True )
+[{'name':'John Doe','email':'jdoe@example.com'}]
+
        +
        +
        + +
        +
        +category(category=None, replace=False, **kwargs)
        +

        Get or set categories that the feed belongs to.

        +

        This method can be called with: +- the fields of a category as keyword arguments +- the fields of a category as a dictionary +- a list of dictionaries containing the category fields

        +

        A categories has the following fields: +- term identifies the category +- scheme identifies the categorization scheme via a URI. +- label provides a human-readable label for display

        +

        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.

        + +++ + + + + + +
        Parameters:
          +
        • link – Dict or list of dicts with data.
          • +
        • replace – Add or replace old data.
          • +
        +
        Returns:

        List of category data.

        +
        +
        + +
        +
        +cloud(domain=None, port=None, path=None, registerProcedure=None, protocol=None)
        +

        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.

        + +++ + + + + + +
        Parameters:
          +
        • domain – The domain where the webservice can be found.
          • +
        • port – The port the webservice listens to.
          • +
        • path – The path of the webservice.
          • +
        • registerProcedure – The procedure to call.
          • +
        • protocol – Can be either HTTP-POST, XML-RPC or SOAP 1.1.
          • +
        +
        Returns:

        Dictionary containing the cloud data.

        +
        +
        + +
        +
        +contributor(contributor=None, replace=False, **kwargs)
        +

        Get or set the contributor data of the feed. This is an ATOM only +value.

        +

        This method can be called with: +- the fields of an contributor as keyword arguments +- the fields of an contributor as a dictionary +- a list of dictionaries containing the contributor fields

        +

        An contributor has the following fields: +- name conveys a human-readable name for the person. +- uri contains a home page for the person. +- email contains an email address for the person.

        + +++ + + + + + +
        Parameters:
          +
        • contributor – Dictionary or list of dictionaries with contributor data.
          • +
        • replace – Add or replace old data.
          • +
        +
        Returns:

        List of contributors as dictionaries.

        +
        +
        + +
        +
        +copyright(copyright=None)
        +

        Get or set the copyright notice for content in the channel. This RSS +value will also set the atom:rights value.

        + +++ + + + + + +
        Parameters:copyright – The copyright notice.
        Returns:The copyright notice.
        +
        + +
        +
        +description(description=None)
        +

        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.

        + +++ + + + + + +
        Parameters:description – Description of the channel.
        Returns:Description of the channel.
        +
        + +
        +
        +docs(docs=None)
        +

        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.

        +

        [1]: http://www.rssboard.org/rss-specification

        + +++ + + + + + +
        Parameters:docs – URL of the format documentation.
        Returns:URL of the format documentation.
        +
        + +
        +
        +entry(entry=None, replace=False)
        +

        Get or set feed entries. Use the add_entry() method instead to +automatically create the FeedEntry objects.

        +

        This method takes both a single FeedEntry object or a list of objects.

        + +++ + + + + + +
        Parameters:entry – FeedEntry object or list of FeedEntry objects.
        Returns:List ob all feed entries.
        +
        + +
        +
        +generator(generator=None, version=None, uri=None)
        +

        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.

        + +++ + + + +
        Parameters:
          +
        • generator – Software used to create the feed.
          • +
        • version – Version of the software.
          • +
        • uri – URI the software can be found.
          • +
        +
        +
        + +
        +
        +icon(icon=None)
        +

        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.

        + +++ + + + + + +
        Parameters:icon – URI of the feeds icon.
        Returns:URI of the feeds icon.
        +
        + +
        +
        +id(id=None)
        +

        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 +address. This field is for ATOM only. It is mandatory for ATOM.

        + +++ + + + + + +
        Parameters:id – New Id of the ATOM feed.
        Returns:Id of the feed.
        +
        + +
        +
        +image(url=None, title=None, link=None, width=None, height=None, description=None)
        +

        Set the image of the feed. This element is roughly equivalent to +atom:logo.

        + +++ + + + + + +
        Parameters:
          +
        • url – The URL of a GIF, JPEG or PNG image.
          • +
        • title – Describes the image. The default value is the feeds title.
          • +
        • link – URL of the site the image will link to. The default is to +use the feeds first altertate link.
          • +
        • width – Width of the image in pixel. The maximum is 144.
          • +
        • height – The height of the image. The maximum is 400.
          • +
        • description – Title of the link.
          • +
        +
        Returns:

        Data of the image as dictionary.

        +
        +
        + +
        +
        +item(item=None, replace=False)
        +

        Get or set feed items. This is just another name for entry(...)

        +
        + +
        +
        +language(language=None)
        +

        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. +The value should be an IETF language tag.

        + +++ + + + + + +
        Parameters:language – Language of the feed.
        Returns:Language of the feed.
        +
        + +
        +
        +lastBuildDate(lastBuildDate=None)
        +

        Set or get the lastBuildDate value which indicates the last time the +content of the channel changed.

        +

        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.

        +

        This will set both atom:updated and rss:lastBuildDate.

        + +++ + + + + + +
        Parameters:lastBuildDate – The modification date.
        Returns:Modification date as datetime.datetime
        +
        + +
        + +

        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.

        +

        This method can be called with: +- the fields of a link as keyword arguments +- the fields of a link as a dictionary +- a list of dictionaries containing the link fields

        +

        A link has the following fields:

        +
          +

        • href is the URI of the referenced resource (typically a Web page)

          +
          • +

        • rel contains a single link relationship type. It can be a full URI, +or one of the following predefined values (default=alternate):

          +
          +
            +
          • alternate 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.
            • +
          • enclosure a related resource which is potentially large in size +and might require special handling, for example an audio or video +recording.
            • +
          • related an document related to the entry or feed.
            • +
          • self the feed itself.
            • +
          • via the source of the information provided in the entry.
            • +
          +
          +
          • +

        • type indicates the media type of the resource.

          +
          • +

        • hreflang indicates the language of the referenced resource.

          +
          • +

        • title human readable information about the link, typically for +display purposes.

          +
          • +

        • length the length of the resource, in bytes.

          +
          • +
        +

        RSS only supports one link with URL only.

        + +++ + + + +
        Parameters:
          +
        • link – Dict or list of dicts with data.
          • +
        • replace – Add or replace old data.
          • +
        +
        +

        Example:

        +
        >>> feedgen.link( href='http://example.com/', rel='self')
+[{'href':'http://example.com/', 'rel':'self'}]
+
        +
        +
        + +
        +
        +load_extension(name, atom=True, rss=True)
        +

        Load a specific extension by name.

        + +++ + + + +
        Parameters:
          +
        • name – Name of the extension to load.
          • +
        • atom – If the extension should be used for ATOM feeds.
          • +
        • rss – If the extension should be used for RSS feeds.
          • +
        +
        +
        + +
        + +

        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.

        + +++ + + + + + +
        Parameters:logo – Logo of the feed.
        Returns:Logo of the feed.
        +
        + +
        +
        +managingEditor(managingEditor=None)
        +

        Set or get the value for managingEditor which is the email address for +person responsible for editorial content. This is a RSS only value.

        + +++ + + + + + +
        Parameters:managingEditor – Email adress of the managing editor.
        Returns:Email adress of the managing editor.
        +
        + +
        +
        +pubDate(pubDate=None)
        +

        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.

        +

        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.

        +

        This will set both atom:updated and rss:lastBuildDate.

        + +++ + + + + + +
        Parameters:pubDate – The publication date.
        Returns:Publication date as datetime.datetime
        +
        + +
        +
        +rating(rating=None)
        +

        Set and get the PICS rating for the channel. It is an RSS only +value.

        +
        + +
        +
        +remove_entry(entry)
        +

        Remove a single entry from the feed. This method accepts both the +FeedEntry object to remove or the index of the entry as argument.

        + +++ + + + +
        Parameters:entry – Entry or index of entry to remove.
        +
        + +
        +
        +remove_item(item)
        +

        Remove a single item from the feed. This is another name for +remove_entry.

        +
        + +
        +
        +rights(rights=None)
        +

        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.

        + +++ + + + +
        Parameters:rights – Rights information of the feed.
        +
        + +
        +
        +rss_file(filename, extensions=True)
        +

        Generates an RSS feed and write the resulting XML to a file.

        + +++ + + + +
        Parameters:
          +
        • filename – Name of file to write.
          • +
        • extensions – Enable or disable the loaded extensions for the xml +generation (default: enabled).
          • +
        +
        +
        + +
        +
        +rss_str(pretty=False, extensions=True)
        +

        Generates an RSS feed and returns the feed XML as string.

        + +++ + + + + + +
        Parameters:
          +
        • pretty – If the feed should be split into multiple lines and +properly indented.
          • +
        • extensions – Enable or disable the loaded extensions for the xml +generation (default: enabled).
          • +
        +
        Returns:

        String representation of the RSS feed.

        +
        +
        + +
        +
        +skipDays(days=None, replace=False)
        +

        Set or get the value of skipDays, a hint for aggregators telling them +which days they can skip This is an RSS only value.

        +

        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’.

        + +++ + + + + + +
        Parameters:
          +
        • hours – List of days the feedreaders should not check the feed.
          • +
        • replace – Add or replace old data.
          • +
        +
        Returns:

        List of days the feedreaders should not check the feed.

        +
        +
        + +
        +
        +skipHours(hours=None, replace=False)
        +

        Set or get the value of skipHours, a hint for aggregators telling them +which hours they can skip. This is an RSS only value.

        +

        This method can be called with an hour or a list of hours. The hours are +represented as integer values from 0 to 23.

        + +++ + + + + + +
        Parameters:
          +
        • hours – List of hours the feedreaders should not check the feed.
          • +
        • replace – Add or replace old data.
          • +
        +
        Returns:

        List of hours the feedreaders should not check the feed.

        +
        +
        + +
        +
        +subtitle(subtitle=None)
        +

        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.

        + +++ + + + + + +
        Parameters:subtitle – The subtitle of the feed.
        Returns:The subtitle of the feed.
        +
        + +
        +
        +textInput(title=None, description=None, name=None, link=None)
        +

        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 +feedback. Most aggregators ignore it.

        + +++ + + + + + +
        Parameters:
          +
        • title – The label of the Submit button in the text input area.
          • +
        • description – Explains the text input area.
          • +
        • name – The name of the text object in the text input area.
          • +
        • link – The URL of the CGI script that processes text input requests.
          • +
        +
        Returns:

        Dictionary containing textInput values.

        +
        +
        + +
        +
        +title(title=None)
        +

        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 +not be blank.

        + +++ + + + + + +
        Parameters:title – The new title of the feed.
        Returns:The feeds title.
        +
        + +
        +
        +ttl(ttl=None)
        +

        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.

        + +++ + + + + + +
        Parameters:ttl – Integer value indicating how long the channel may be cached.
        Returns:Time to live.
        +
        + +
        +
        +updated(updated=None)
        +

        Set or get the updated value which indicates the last time the feed +was modified in a significant way.

        +

        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.

        +

        This will set both atom:updated and rss:lastBuildDate.

        + +++ + + + + + +
        Parameters:updated – The modification date.
        Returns:Modification date as datetime.datetime
        +
        + +
        +
        +webMaster(webMaster=None)
        +

        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.

        + +++ + + + + + +
        Parameters:webMaster – Email address of the webmaster.
        Returns:Email address of the webmaster.
        +
        + +
        + +
        + + +
        +
        + +

        + «  API Documentation +   ::   + Contents +   ::   + feedgen.entry  » +

        + +
        + +
        + © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
        + + \ No newline at end of file diff --git a/api.html b/api.html new file mode 100644 index 0000000..052e2ee --- /dev/null +++ b/api.html @@ -0,0 +1,209 @@ + + + + + + + + + + API Documentation — pyFeedGen 0.1.s20130505 documentation + + + + + + + + + + + + + + + +

        + pyFeedGen 0.1.s20130505 documentation

        +

        API Documentation

        +
        +
        + +

        + «  Feedgenerator +   ::   + Contents +   ::   + feedgen.feed  » +

        + +
        +
        + + +
        +

        API Documentation

        +
        +

        feedgen

        +

        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.

        + +++ + + + + + +
        copyright:2013 by Lars Kiesow
        license:FreeBSD and LGPL, see license.* for more details.
        +
        +

        Create a Feed

        +

        To create a feed simply instanciate the FeedGenerator class and insert some +data:

        +
        >>> from feedgen.feed import FeedGenerator
+>>> fg = FeedGenerator()
+>>> fg.id('http://lernfunk.de/media/654321')
+>>> fg.title('Some Testfeed')
+>>> fg.author( {'name':'John Doe','email':'john@example.de'} )
+>>> fg.link( href='http://example.com', rel='alternate' )
+>>> fg.logo('http://ex.com/logo.jpg')
+>>> fg.subtitle('This is a cool feed!')
+>>> fg.link( href='http://larskiesow.de/test.atom', rel='self' )
+>>> fg.language('en')
+
        +
        +

        Note that for the methods which set fields that can occur more than once in +a feed you can use all of the following ways to provide data:

        +
          +
        • Provide the data for that element as keyword arguments
          • +
        • Provide the data for that element as dictionary
          • +
        • Provide a list of dictionaries with the data for several elements
          • +
        +

        Example:

        +
        >>> fg.contributor( name='John Doe', email='jdoe@example.com' )
+>>> fg.contributor({'name':'John Doe', 'email':'jdoe@example.com'})
+>>> fg.contributor([{'name':'John Doe', 'email':'jdoe@example.com'}, ...])
+
        +
        +
        +
        +

        Generate the Feed

        +

        After that you can generate both RSS or ATOM by calling the respective method:

        +
        >>> atomfeed = fg.atom_str(pretty=True) # Get the ATOM feed as string
+>>> rssfeed  = fg.rss_str(pretty=True) # Get the RSS feed as string
+>>> fg.atom_file('atom.xml') # Write the ATOM feed to a file
+>>> fg.rss_file('rss.xml') # Write the RSS feed to a file
+
        +
        +
        +
        +

        Add Feed Entries

        +

        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:

        +
        >>> fe = fg.add_entry()
+>>> fe.id('http://lernfunk.de/media/654321/1')
+>>> fe.title('The First Episode')
+
        +
        +

        The FeedGenerators method add_entry(...) without argument provides will +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.

        +
        +
        +

        Extensions

        +

        The FeedGenerator supports extension to include additional data into the XML +structure of the feeds. Extensions can be loaded like this:

        +
        >>> fg.load_extension('someext', atom=True, rss=True)
+
        +
        +

        This will try to load the extension “someext” from the file +ext/someext.py. It is required that someext.py contains a class named +“SomextExtension” which is required to have at least the two methods +extend_rss(...) and extend_atom(...). Although not required, it is +strongly suggested to use BaseExtension from ext/base.py as superclass.

        +

        load_extension(‘someext’, ...) will also try to load a class named +“SomextEntryExtension” for every entry of the feed. This class can be +located either in the same file as SomextExtension or in +ext/someext_entry.py which is suggested especially for large extensions.

        +

        The parameters atom and rss 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.

        +

        Example: Produceing a Podcast

        +

        One extension already provided is the podcast extension. A podcast is an RSS +feed with some additional elements for ITunes.

        +

        To produce a podcast simply load the podcast extension:

        +
        >>> from feedgen.feed import FeedGenerator
+>>> fg = FeedGenerator()
+>>> fg.load_extension('podcast')
+...
+>>> fg.podcast.itunes_category('Technology', 'Podcasting')
+...
+>>> fg.rss_str(pretty=True)
+>>> fg.rss_file('podcast.xml')
+
        +
        +

        Of cause the extension has to be loaded for the FeedEntry objects as well +but this is done automatically by the FeedGenerator for every feed entry if +the extension is loaded for the whole feed. You can, however, load an +extension for a specific FeedEntry by calling load_extension(...) on that +entry. But this is a rather uncommon use.

        +

        Of cause you can still produce a normal ATOM or RSS feed, even if you have +loaded some plugins by temporary disabling them during the feed generation. +This can be done by calling the generating method with the keyword argument +extensions set to False.

        +
        +
        +

        Testing the Generator

        +

        You can test the module by simply executing:

        +
        $ pythom -m feedgen
        +
        +
        +
        +

        Contents:

        +
        + +
        +
        + + +
        +
        + +

        + «  Feedgenerator +   ::   + Contents +   ::   + feedgen.feed  » +

        + +
        + +
        + © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
        + + \ No newline at end of file diff --git a/api.util.html b/api.util.html new file mode 100644 index 0000000..5e6f0f8 --- /dev/null +++ b/api.util.html @@ -0,0 +1,114 @@ + + + + + + + + + + feedgen.util — pyFeedGen 0.1.s20130505 documentation + + + + + + + + + + + + + + + + +

        + pyFeedGen 0.1.s20130505 documentation

        +

        feedgen.util

        +
        +
        + +

        + «  feedgen.entry +   ::   + Contents +   ::   + feedgen.ext.base  » +

        + +
        +
        + + +
        Contents
        +
        +

        feedgen.util

        +

        This file contains helper functions for the feed generator module.

        + +++ + + + + + +
        copyright:2013, Lars Kiesow <lkiesow@uos.de>
        license:FreeBSD and LGPL, see license.* for more details.
        +
        +
        +feedgen.util.ensure_format(val, allowed, required, allowed_values={})
        +

        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.

        + +++ + + + + + +
        Parameters:
          +
        • val – Dictionaries to check.
          • +
        • allowed – Set of allowed keys.
          • +
        • required – Set of required keys.
          • +
        • allowed_values – Dictionary with keys and sets of their allowed values.
          • +
        +
        Returns:

        List of checked dictionaries.

        +
        +
        + +
        + + +
        +
        + +

        + «  feedgen.entry +   ::   + Contents +   ::   + feedgen.ext.base  » +

        + +
        + +
        + © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
        + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 0000000..96b2fa7 --- /dev/null +++ b/genindex.html @@ -0,0 +1,625 @@ + + + + + + + + + + + + Index — pyFeedGen 0.1.s20130505 documentation + + + + + + + + + + + + + +

        + pyFeedGen 0.1.s20130505 documentation

        +

        Index

        +
        +
        + +

        + Contents +

        + +
        +
        + + + +

        Index

        + +
        + A + | B + | C + | D + | E + | F + | G + | I + | L + | M + | P + | R + | S + | T + | U + | W + +
        +

        A

        + + + +
        + +
        add_entry() (feedgen.feed.FeedGenerator method) +
        + + +
        add_item() (feedgen.feed.FeedGenerator method) +
        + + +
        atom_entry() (feedgen.entry.FeedEntry method) +
        + +
        + +
        atom_file() (feedgen.feed.FeedGenerator method) +
        + + +
        atom_str() (feedgen.feed.FeedGenerator method) +
        + + +
        author() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        +
        + +

        B

        + + + +
        + +
        BaseEntryExtension (class in feedgen.ext.base) +
        + +
        + +
        BaseExtension (class in feedgen.ext.base) +
        + +
        + +

        C

        + + + +
        + +
        category() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        + +
        cloud() (feedgen.feed.FeedGenerator method) +
        + + +
        comments() (feedgen.entry.FeedEntry method) +
        + +
        + +
        content() (feedgen.entry.FeedEntry method) +
        + + +
        contributor() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        + +
        copyright() (feedgen.feed.FeedGenerator method) +
        + +
        + +

        D

        + + + +
        + +
        description() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        +
        + +
        docs() (feedgen.feed.FeedGenerator method) +
        + +
        + +

        E

        + + + +
        + +
        enclosure() (feedgen.entry.FeedEntry method) +
        + + +
        ensure_format() (in module feedgen.util) +
        + + +
        entry() (feedgen.feed.FeedGenerator method) +
        + +
        + +
        extend_atom() (feedgen.ext.base.BaseExtension method) +
        + + +
        extend_rss() (feedgen.ext.base.BaseExtension method) +
        + +
        + +
        (feedgen.ext.podcast.PodcastExtension method) +
        + + +
        (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + +
        +
        + +

        F

        + + + +
        + +
        FeedEntry (class in feedgen.entry) +
        + + +
        feedgen (module) +
        + + +
        feedgen.entry (module) +
        + + +
        feedgen.ext.base (module) +
        + + +
        feedgen.ext.podcast (module) +
        + +
        + +
        feedgen.ext.podcast_entry (module) +
        + + +
        feedgen.feed (module) +
        + + +
        feedgen.util (module) +
        + + +
        FeedGenerator (class in feedgen.feed) +
        + +
        + +

        G

        + + + +
        + +
        generator() (feedgen.feed.FeedGenerator method) +
        + +
        + +
        guid() (feedgen.entry.FeedEntry method) +
        + +
        + +

        I

        + + + +
        + +
        icon() (feedgen.feed.FeedGenerator method) +
        + + +
        id() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        + +
        image() (feedgen.feed.FeedGenerator method) +
        + + +
        item() (feedgen.feed.FeedGenerator method) +
        + + +
        itunes_author() (feedgen.ext.podcast.PodcastExtension method) +
        + +
        + +
        (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + +
        + +
        itunes_block() (feedgen.ext.podcast.PodcastExtension method) +
        + +
        + +
        (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + +
        + +
        itunes_category() (feedgen.ext.podcast.PodcastExtension method) +
        + + +
        itunes_complete() (feedgen.ext.podcast.PodcastExtension method) +
        + + +
        itunes_duration() (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + +
        + +
        itunes_explicit() (feedgen.ext.podcast.PodcastExtension method) +
        + +
        + +
        (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + +
        + +
        itunes_image() (feedgen.ext.podcast.PodcastExtension method) +
        + +
        + +
        (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + +
        + +
        itunes_is_closed_captioned() (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + + +
        itunes_new_feed_url() (feedgen.ext.podcast.PodcastExtension method) +
        + + +
        itunes_order() (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + + +
        itunes_owner() (feedgen.ext.podcast.PodcastExtension method) +
        + + +
        itunes_subtitle() (feedgen.ext.podcast.PodcastExtension method) +
        + +
        + +
        (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + +
        + +
        itunes_summary() (feedgen.ext.podcast.PodcastExtension method) +
        + +
        + +
        (feedgen.ext.podcast_entry.PodcastEntryExtension method) +
        + +
        +
        + +

        L

        + + + +
        + +
        language() (feedgen.feed.FeedGenerator method) +
        + + +
        lastBuildDate() (feedgen.feed.FeedGenerator method) +
        + + +
        link() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        +
        + +
        load_extension() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        + +
        logo() (feedgen.feed.FeedGenerator method) +
        + +
        + +

        M

        + + +
        + +
        managingEditor() (feedgen.feed.FeedGenerator method) +
        + +
        + +

        P

        + + + +
        + +
        PodcastEntryExtension (class in feedgen.ext.podcast_entry) +
        + + +
        PodcastExtension (class in feedgen.ext.podcast) +
        + + +
        pubdate() (feedgen.entry.FeedEntry method) +
        + +
        + +
        pubDate() (feedgen.feed.FeedGenerator method) +
        + + +
        published() (feedgen.entry.FeedEntry method) +
        + +
        + +

        R

        + + + +
        + +
        rating() (feedgen.feed.FeedGenerator method) +
        + + +
        remove_entry() (feedgen.feed.FeedGenerator method) +
        + + +
        remove_item() (feedgen.feed.FeedGenerator method) +
        + + +
        rights() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        +
        + +
        rss_entry() (feedgen.entry.FeedEntry method) +
        + + +
        rss_file() (feedgen.feed.FeedGenerator method) +
        + + +
        rss_str() (feedgen.feed.FeedGenerator method) +
        + +
        + +

        S

        + + + +
        + +
        skipDays() (feedgen.feed.FeedGenerator method) +
        + + +
        skipHours() (feedgen.feed.FeedGenerator method) +
        + +
        + +
        subtitle() (feedgen.feed.FeedGenerator method) +
        + + +
        summary() (feedgen.entry.FeedEntry method) +
        + +
        + +

        T

        + + + +
        + +
        textInput() (feedgen.feed.FeedGenerator method) +
        + + +
        title() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        +
        + +
        ttl() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        +
        + +

        U

        + + +
        + +
        updated() (feedgen.entry.FeedEntry method) +
        + +
        + +
        (feedgen.feed.FeedGenerator method) +
        + +
        +
        + +

        W

        + + +
        + +
        webMaster() (feedgen.feed.FeedGenerator method) +
        + +
        + + + +
        +
        + +

        + Contents +

        + +
        + +
        + © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
        + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..874c0e7 --- /dev/null +++ b/index.html @@ -0,0 +1,247 @@ + + + + + + + + + + Feedgenerator — pyFeedGen 0.1.s20130505 documentation + + + + + + + + + + + + + + +

        + pyFeedGen 0.1.s20130505 documentation

        +

        Feedgenerator

        +
        +
        + +

        + Contents +   ::   + API Documentation  » +

        + +
        +
        + + + +
        +

        Feedgenerator

        +

        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.

        +

        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.

        +
        +

        Installation

        +

        Prebuild packages

        +

        If you are running Fedora Linux, Redhat Enterprise Linux, CentOS or Scientific +linux you can use one of the following packages:

        + +

        Simply download the file and run:

        +
        $ yum localinstall python-feedgen-0.1-1.fc17.noarch.rpm
        +
        +

        If you want to build RPMs for other distributions you can use the following Source RPM:

        + +

        Using pip

        +

        You can also use pip to install the feedgen module. Simply run:

        +
        $ pip install feedgen
        +
        +
        +
        +

        Create a Feed

        +

        To create a feed simply instanciate the FeedGenerator class and insert some +data:

        +
        >>> from feedgen.feed import FeedGenerator
+>>> fg = FeedGenerator()
+>>> fg.id('http://lernfunk.de/media/654321')
+>>> fg.title('Some Testfeed')
+>>> fg.author( {'name':'John Doe','email':'john@example.de'} )
+>>> fg.link( href='http://example.com', rel='alternate' )
+>>> fg.logo('http://ex.com/logo.jpg')
+>>> fg.subtitle('This is a cool feed!')
+>>> fg.link( href='http://larskiesow.de/test.atom', rel='self' )
+>>> fg.language('en')
+
        +
        +

        Note that for the methods which set fields that can occur more than once in a +feed you can use all of the following ways to provide data:

        +
          +
        • Provide the data for that element as keyword arguments
          • +
        • Provide the data for that element as dictionary
          • +
        • Provide a list of dictionaries with the data for several elements
          • +
        +

        Example:

        +
        >>> fg.contributor( name='John Doe', email='jdoe@example.com' )
+>>> fg.contributor({'name':'John Doe', 'email':'jdoe@example.com'})
+>>> fg.contributor([{'name':'John Doe', 'email':'jdoe@example.com'}, ...])
+
        +
        +
        +
        +

        Generate the Feed

        +

        After that you can generate both RSS or ATOM by calling the respective method:

        +
        >>> atomfeed = fg.atom_str(pretty=True) # Get the ATOM feed as string
+>>> rssfeed  = fg.rss_str(pretty=True) # Get the RSS feed as string
+>>> fg.atom_file('atom.xml') # Write the ATOM feed to a file
+>>> fg.rss_file('rss.xml') # Write the RSS feed to a file
+
        +
        +
        +
        +

        Add Feed Entries

        +

        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:

        +
        >>> fe = fg.add_entry()
+>>> fe.id('http://lernfunk.de/media/654321/1')
+>>> fe.title('The First Episode')
+
        +
        +

        The FeedGenerators method add_entry(...) without argument provides will +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.

        +
        +
        +

        Extensions

        +

        The FeedGenerator supports extension to include additional data into the XML +structure of the feeds. Extensions can be loaded like this:

        +
        >>> fg.load_extension('someext', atom=True, rss=True)
+
        +
        +

        This will try to load the extension “someext” from the file ext/someext.py. +It is required that someext.py contains a class named “SomextExtension” which +is required to have at least the two methods extend_rss(...) and +extend_atom(...). Although not required, it is strongly suggested to use +BaseExtension from ext/base.py as superclass.

        +

        load_extension(‘someext’, ...) will also try to load a class named +“SomextEntryExtension” for every entry of the feed. This class can be located +either in the same file as SomextExtension or in ext/someext_entry.py which +is suggested especially for large extensions.

        +

        The parameters atom and rss 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.

        +

        Example: Produceing a Podcast

        +

        One extension already provided is the podcast extension. A podcast is an RSS +feed with some additional elements for ITunes.

        +

        To produce a podcast simply load the podcast extension:

        +
        >>> from feedgen.feed import FeedGenerator
+>>> fg = FeedGenerator()
+>>> fg.load_extension('podcast')
+...
+>>> fg.podcast.itunes_category('Technology', 'Podcasting')
+...
+>>> fg.rss_str(pretty=True)
+>>> fg.rss_file('podcast.xml')
+
        +
        +

        Of cause the extension has to be loaded for the FeedEntry objects as well but +this is done automatically by the FeedGenerator for every feed entry if the +extension is loaded for the whole feed. You can, however, load an extension for +a specific FeedEntry by calling load_extension(...) on that entry. But this +is a rather uncommon use.

        +

        Of cause you can still produce a normal ATOM or RSS feed, even if you have +loaded some plugins by temporary disabling them during the feed generation. +This can be done by calling the generating method with the keyword argument +extensions set to False.

        +
        +
        +

        Testing the Generator

        +

        You can test the module by simply executing:

        +
        $ pythom -m feedgen
        +
        +

        If you want to have a look at the code for this test to have a working code +example for a whole feed generation process, you can find it in the +__main__.py.

        +
        +
        + + + + +
        +
        + +

        + Contents +   ::   + API Documentation  » +

        + +
        + +
        + © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
        + + \ No newline at end of file diff --git a/py-modindex.html b/py-modindex.html new file mode 100644 index 0000000..78dd400 --- /dev/null +++ b/py-modindex.html @@ -0,0 +1,114 @@ + + + + + + + + + + Python Module Index — pyFeedGen 0.1.s20130505 documentation + + + + + + + + + + + + + + + + +

        + pyFeedGen 0.1.s20130505 documentation

        +

        Python Module Index

        +
        +
        + +

        + Contents +

        + +
        +
        + + + +

        Python Module Index

        + +
        + f +
        + + + + + + + + + + + + + + + + + + + + + + + + + +
         
        + f
        + feedgen +
            + feedgen.entry +
            + feedgen.ext.base +
            + feedgen.ext.podcast +
            + feedgen.ext.podcast_entry +
            + feedgen.feed +
            + feedgen.util +
        + + +
        +
        + +

        + Contents +

        + +
        + +
        + © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
        + + \ No newline at end of file diff --git a/search.html b/search.html new file mode 100644 index 0000000..44d6ef2 --- /dev/null +++ b/search.html @@ -0,0 +1,91 @@ + + + + + + + + + + Search — pyFeedGen 0.1.s20130505 documentation + + + + + + + + + + + + + + + + + +

        + pyFeedGen 0.1.s20130505 documentation

        +

        Search

        +
        +
        + +

        + Contents +

        + +
        +
        + + +

        Search

        +
        + +

        + Please activate JavaScript to enable the search + functionality. +

        +
        +

        + From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +

        +
        + + + +
        + +
        + +
        + +
        +
        + +

        + Contents +

        + +
        + +
        + © Copyright 2013, Lars Kiesow. + Created using Sphinx 1.1.3. +
        + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 0000000..63ea819 --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({objects:{"":{feedgen:[7,0,1,""]},"feedgen.feed":{FeedGenerator:[5,2,1,""]},"feedgen.feed.FeedGenerator":{lastBuildDate:[5,1,1,""],subtitle:[5,1,1,""],item:[5,1,1,""],image:[5,1,1,""],atom_file:[5,1,1,""],ttl:[5,1,1,""],contributor:[5,1,1,""],logo:[5,1,1,""],copyright:[5,1,1,""],id:[5,1,1,""],cloud:[5,1,1,""],category:[5,1,1,""],skipHours:[5,1,1,""],rss_file:[5,1,1,""],pubDate:[5,1,1,""],title:[5,1,1,""],remove_item:[5,1,1,""],textInput:[5,1,1,""],icon:[5,1,1,""],load_extension:[5,1,1,""],updated:[5,1,1,""],description:[5,1,1,""],docs:[5,1,1,""],link:[5,1,1,""],skipDays:[5,1,1,""],remove_entry:[5,1,1,""],atom_str:[5,1,1,""],generator:[5,1,1,""],language:[5,1,1,""],rights:[5,1,1,""],rating:[5,1,1,""],author:[5,1,1,""],managingEditor:[5,1,1,""],add_item:[5,1,1,""],rss_str:[5,1,1,""],add_entry:[5,1,1,""],entry:[5,1,1,""],webMaster:[5,1,1,""]},feedgen:{feed:[5,0,1,""],util:[1,0,1,""],entry:[6,0,1,""]},"feedgen.util":{ensure_format:[1,3,1,""]},"feedgen.ext":{podcast_entry:[3,0,1,""],podcast:[4,0,1,""],base:[2,0,1,""]},"feedgen.ext.podcast_entry":{PodcastEntryExtension:[3,2,1,""]},"feedgen.ext.base.BaseExtension":{extend_atom:[2,1,1,""],extend_rss:[2,1,1,""]},"feedgen.entry.FeedEntry":{category:[6,1,1,""],updated:[6,1,1,""],summary:[6,1,1,""],description:[6,1,1,""],pubdate:[6,1,1,""],rights:[6,1,1,""],ttl:[6,1,1,""],load_extension:[6,1,1,""],title:[6,1,1,""],comments:[6,1,1,""],enclosure:[6,1,1,""],content:[6,1,1,""],link:[6,1,1,""],author:[6,1,1,""],published:[6,1,1,""],contributor:[6,1,1,""],atom_entry:[6,1,1,""],guid:[6,1,1,""],rss_entry:[6,1,1,""],id:[6,1,1,""]},"feedgen.ext.base":{BaseExtension:[2,2,1,""],BaseEntryExtension:[2,2,1,""]},"feedgen.entry":{FeedEntry:[6,2,1,""]},"feedgen.ext.podcast_entry.PodcastEntryExtension":{extend_rss:[3,1,1,""],itunes_block:[3,1,1,""],itunes_summary:[3,1,1,""],itunes_subtitle:[3,1,1,""],itunes_image:[3,1,1,""],itunes_order:[3,1,1,""],itunes_explicit:[3,1,1,""],itunes_is_closed_captioned:[3,1,1,""],itunes_duration:[3,1,1,""],itunes_author:[3,1,1,""]},"feedgen.ext.podcast.PodcastExtension":{itunes_summary:[4,1,1,""],itunes_complete:[4,1,1,""],itunes_block:[4,1,1,""],itunes_new_feed_url:[4,1,1,""],itunes_subtitle:[4,1,1,""],itunes_image:[4,1,1,""],itunes_owner:[4,1,1,""],itunes_explicit:[4,1,1,""],extend_rss:[4,1,1,""],itunes_category:[4,1,1,""],itunes_author:[4,1,1,""]},"feedgen.ext.podcast":{PodcastExtension:[4,2,1,""]}},terms:{represent:[5,6],all:[0,1,2,4,5,7],code:0,skip:5,signific:[5,6],stumbl:5,follow:[0,7,5,6],content:[0,1,2,3,4,5,6,7],lgpl:[0,1,2,3,4,5,6,7],itunes_new_feed_url:4,somextextens:[0,7],base64:6,readabl:[5,6],editori:5,kiesow:[1,2,3,4,5,6,7],cgi:5,spec:4,atomfe:[0,7],sourc:[0,5,6],itunes_block:[3,4],string:[0,7,5,6],fals:[0,7,5,6],internet:5,util:[0,1,7],feedgener:[0,7,2,5,4],artwork:[3,4],cool:[0,7],itunes_categori:[0,7,4],level:[3,4],button:5,load_extens:[0,7,5,6],list:[0,1,7,5,6],"try":[0,7],item:[0,7,3,5,6],rss_str:[0,7,5],small:5,div:[1,2,3,4,5,6],servic:5,prevent:[3,4],second:3,video:[3,5,6],aggreg:5,pass:[5,6],feedread:5,click:[3,4],append:[0,7],even:[0,7],index:[0,5],what:[5,3,4],appear:[3,4],abl:[3,4],baseextens:[0,7,2],version:[5,6],lernfunk:[0,7],"new":[0,7,5,4,6],"public":5,can:[0,3,4,5,6,7],full:[5,6],displai:[5,3,4,6],gener:[0,1,7,5],onli:[0,3,4,5,6,7],modif:[5,6],address:[5,6],path:5,modifi:[5,6],valu:[0,1,3,4,5,6,7],box:5,search:[0,5],pretti:[0,7,5],larger:5,technolog:[0,7],cmyk:[3,4],datetim:[5,6],itunes_explicit:[3,4],typic:[5,6],overrid:3,via:[5,6],modul:[0,1,7],prefer:[5,3,4],filenam:5,href:[0,3,4,5,6,7],subcategori:4,instal:0,cloud:5,from:[0,3,4,5,6,7],describ:[5,6],would:[0,7,3,6],commun:4,univers:[5,6],two:[0,7,3,6],next:[3,4],websit:5,few:[3,4],live:[5,6],call:[0,7,5,6],type:[5,3,4,6],tell:[0,7,5],more:[0,1,2,3,4,5,6,7],ensure_format:1,src:[0,6],conveni:[0,7],relat:[5,6],notic:5,visual:5,accept:5,rssfeed:[0,7],cach:[5,6],must:[3,4,6],itunes_imag:[3,4],none:[5,2,3,4,6],graphic:[3,4],word:[3,4],hour:[5,3,4],work:0,uniqu:[5,6],kwarg:[5,6],lkiesow:[1,2,3,4,5,6],under:0,purpos:[5,6],root:[2,4],control:6,process:[0,5],indic:[5,0,3,4,6],hreflang:[5,6],tag:[5,3,4],tabl:0,want:0,itunes_own:4,phrase:5,occur:[0,7],sundai:5,multipl:[3,5],rather:[0,7],anoth:[5,6],renew:5,write:[0,7,5],how:[5,6],mimetyp:6,instead:5,updat:[5,3,4,6],resourc:[5,6],referenc:[5,6],max:[5,6],after:[0,7,4],someext_entri:[0,7],befor:[5,4,6],mai:[5,3,4,6],end:[3,4],associ:5,lar:[1,2,3,4,5,6,7],enclusur:6,permalink:[5,6],"short":6,explicit:[3,4],element:[0,2,3,4,5,6,7],issu:5,inform:[5,4,6],maintain:4,allow:[5,1,3,4],suggest:[0,7],tall:5,order:[3,4],includ:[0,3,4,5,6,7],elig:[3,4],feedback:5,over:[5,6],jpeg:[5,3,4],held:[5,6],ttl:[5,6],still:[0,7],pointer:5,paramet:[0,1,2,3,4,5,6,7],some:[0,7],group:5,larskiesow:[0,7],window:[3,4],might:[5,6],pixel:[5,3,4],them:[0,7,5],"return":[0,1,2,3,4,5,6,7],feedgen:[0,1,2,3,4,5,6,7],thei:[5,6],handl:[5,6],sentenc:5,pythom:[0,7],remove_entri:5,initi:6,front:[5,6],now:5,term:[0,5,6],name:[0,3,4,5,6,7],refresh:[5,6],mysteri:5,add_item:5,debug:5,found:5,webmast:5,mean:[0,7,3,4],domain:[5,6],replac:[5,6],blank:[5,3,4,6],procedur:5,skipdai:5,year:5,logo:[0,7,5],special:[5,6],shown:[3,4],webservic:5,publish:[5,6],categori:[5,4,6],com:[0,7,5,4,6],rel:[0,7,5,6],reader:5,apititl:[1,2,3,4,5,6],is_closed_capt:3,apitoc:[1,2,3,4,5,6],free:5,standard:[3,4],base:[0,7,2],york:5,dictionari:[0,1,7,5,6],put:[3,4],org:5,"byte":[5,6],basi:5,indent:5,wai:[0,7,5,6],argument:[0,7,5,6],caption:3,length:[5,6],yum:0,perman:[5,6],timezon:[5,6],support:[0,3,4,5,6,7],textinput:5,first:[0,7,3,5,6],feed:[0,1,2,3,4,5,6,7],softwar:5,redhat:0,enterpris:0,feel:5,onc:[0,7,5],number:[3,5,6],date:[5,6],alreadi:[0,7],done:[0,7],testfe:[0,7],wasn:6,owner:4,omittet:5,predefin:[5,6],size:[5,6],differ:[3,4,6],"long":[5,3,4,6],script:5,data:[0,7,5,4,6],licens:[0,1,2,3,4,5,6,7],least:[0,7,3,4],attach:6,circl:[3,4],scheme:[5,6],store:[3,4],listen:5,option:5,relationship:[5,6],especi:[0,7],pubdat:[3,5,6],rssboard:5,specifi:[5,3,4],accompani:[3,4],than:[0,7,3,6],png:[5,3,4],rss:[0,2,3,4,5,6,7],wide:5,kind:[0,7],john:[0,7,5,6],keyword:[0,7,5,6],provid:[0,2,3,5,6,7],remov:[3,5],extend_atom:[0,7,2],tree:4,rate:5,structur:[0,7,2,4,6],charact:[3,4],prebuild:0,cannel:5,minut:[3,5,6],browser:4,anywher:[3,4],packag:0,have:[0,7,5,4,6],"__main__":0,need:[0,7],caus:[0,7],engin:5,squar:[5,3,4],equival:5,self:[0,7,5,6],port:5,note:[0,7],also:[0,3,4,5,6,7],contact:4,take:[1,5],which:[0,2,3,4,5,6,7],noth:[2,6],channel:[5,6],freebsd:[0,1,2,3,4,5,6,7],normal:[0,7,6],object:[0,7,5,6],most:[0,7,5],rsscloud:5,bsd:0,why:6,someext:[0,7],icon:5,url:[5,3,4,6],doc:[2,5],cover:[3,4,6],uri:[5,6],doe:[0,7,2,5,6],ext:[0,7,2,3,4],clean:[3,4],add:[0,7,3,5,6],pars:[5,6],width:5,podcastextens:4,rss_entri:6,advisori:[3,4],feedentri:[0,2,3,5,6,7],find:0,xml:[0,2,3,4,5,6,7],itun:[0,7,3,4],inlin:6,locat:[0,7,4],rss_file:[0,7,5],copyright:[1,2,3,4,5,6,7],categor:[5,6],explain:5,allowed_valu:1,should:[0,3,4,5,6,7],enclosur:[5,6],dict:[5,6],get:[0,3,4,5,6,7],autor:6,itunes_dur:3,requir:[0,1,7,5,6],enabl:5,artist:[3,4],ietf:5,method:[0,7,2,5,6],twice:5,contain:[0,1,2,3,4,5,6,7],where:[5,4],summari:[3,4,6],itunes_summari:[3,4],set:[0,1,2,3,4,5,6,7],art:[3,4],farthest:3,entriess:6,itunes_complet:4,maximum:5,see:[1,2,3,4,5,6,7],mandatori:[5,6],result:5,respons:5,close:3,best:[3,4],wonder:5,parent:[3,4,6],podcast_entri:[0,7,3],someth:5,label:[5,6],written:5,rss_feed:4,"1400x1400":[3,4],"import":[0,7],across:5,attribut:[5,3,4,6],altern:[0,7,5,6],kei:1,extens:[0,2,3,4,5,6,7],entir:4,altert:5,addit:[0,7,3],both:[0,7,5,6],subtitl:[5,0,7,3,4],plugin:[0,7],howev:[0,7,5,6],retir:4,whole:[0,7],load:[0,7,5,6],episod:[0,7,3,4],technic:5,point:[5,4,6],instanti:[0,7],height:5,rpc:5,colon:3,linux:0,respect:[0,7],guid:6,assum:3,three:[3,4],basic:2,popul:[3,4],"abstract":6,baseentryextens:2,imag:[5,3,4],uncommon:[0,7],ani:[5,3,4,6],zero:3,last:[5,6],present:[5,1,3,4,6],"case":[5,6],look:0,itunes_subtitl:[3,4],properti:[5,4],durat:3,defin:4,"while":6,fc17:0,publicli:4,localinstal:0,extend_rss:[0,7,2,3,4],helper:1,itunes_subcategori:4,site:5,jpg:[0,7,3,4],itself:[0,7,5,6],cento:0,identifi:[5,6],synopsi:6,sever:[0,7,6],disabl:[0,7,5],fedora:0,author:[0,3,4,5,6,7],media:[0,7,5,6],belong:[5,6],same:[0,3,4,5,6,7],python:0,html:[5,4,6],split:[5,6],document:[0,7,5,6],conflict:3,complet:[4,6],http:[5,0,7,3,4],issummari:6,effect:4,dai:5,temporari:[0,7],implement:5,entri:[0,7,3,5,6],thu:5,well:[0,7],without:[0,7],person:[5,6],weblog:[5,6],exampl:[0,7,3,5,6],thi:[0,1,3,4,5,6,7],choos:0,audio:[5,6],roughli:5,left:3,comment:6,jdoe:[0,7,5,6],protocol:5,just:[5,6],instanci:[0,7],human:[5,6],simpli:[0,7],languag:[0,3,4,5,6,7],previous:[2,4,6],web:[0,7,5,6],hint:5,identif:5,color:[3,4],rgb:[3,4],input:5,adress:[5,6],build:0,registerprocedur:5,managingeditor:[5,3,4],format:[5,0,7,3,4],insert:[0,7,6],lastbuildd:5,atom_str:[0,7,5],add_entri:[0,7,5],skiphour:5,like:[0,7,3],specif:[0,1,4,5,6,7],integ:[3,5,6],soap:5,api:[0,7],necessari:[2,5,6],singl:[5,6],el6:0,page:[5,0,3,4,6],italian:5,www:[5,4],right:[3,5,6],old:[5,4,6],often:5,convei:[5,6],ontain:6,creation:6,excerpt:6,intern:[0,7],superclass:[0,7],home:[5,6],server:[5,3,4],distribut:0,separ:[3,4],atom_entri:6,rpm:0,per:6,leas:5,larg:[0,7,5,6],either:[0,7,5,6],itunes_ord:3,who:5,run:0,host:[3,4],although:[0,7],post:5,sub:4,about:[5,4,6],column:[3,4],materi:[3,4],manag:5,stand:[5,6],produc:[0,7,3,4],block:[3,4],everi:[0,7,5],mondai:5,itunes_is_closed_capt:3,encod:6,podcastentryextens:3,automat:[0,3,4,5,6,7],somextentryextens:[0,7],contributor:[0,7,5,6],chang:[5,3,4],noarch:0,your:[5,3,4],val:1,area:5,execut:[0,7],submit:5,"class":[0,1,2,3,4,5,6,7],avail:[5,6],gif:5,appl:4,interfac:5,editor:5,"function":[1,5,6],head:[3,4],properli:5,repeatedli:6,tupl:4,link:[0,7,5,6],atom:[0,7,2,5,6],line:5,podcast:[0,7,3,4],"true":[0,7,5,6],extend:[3,4],whether:[3,4],flip:5,record:[5,6],below:3,otherwis:[5,6],embed:3,email:[0,7,5,4,6],featur:[3,4],itunes_author:[3,4],creat:[0,7,2,5,4],request:[5,3,4],dure:[0,7],pic:5,repres:[5,6],strongli:[0,7],exist:6,file:[0,1,3,4,5,7],field:[0,2,3,4,5,6,7],pip:0,download:0,atom_fil:[0,7,5],check:[5,1,3,4],probabl:5,titl:[0,7,5,6],when:[5,3,4,6],detail:[0,1,2,3,4,5,6,7],"default":[0,3,4,5,6,7],other:[5,0,3,4],peopl:5,test:[0,7],ignor:[3,5],you:[0,3,4,5,6,7],lgplv3:0,node:[5,6],cntent:6,time:[3,5,6],consid:[3,4],lang:5,furthermor:6,scientif:0,directori:[3,4],space:[3,4],descript:[5,3,4,6],text:5,potenti:[5,6],remove_item:5,daili:5,adult:[3,4]},objtypes:{"0":"py:module","1":"py:method","2":"py:class","3":"py:function"},titles:["Feedgenerator","feedgen.util","feedgen.ext.base","feedgen.ext.podcast_entry","feedgen.ext.podcast","feedgen.feed","feedgen.entry","API Documentation"],objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"],"3":["py","function","Python function"]},filenames:["index","api.util","ext/api.ext.base","ext/api.ext.podcast_entry","ext/api.ext.podcast","api.feed","api.entry","api"]}) \ No newline at end of file