151 lines
6.9 KiB
HTML
151 lines
6.9 KiB
HTML
<!DOCTYPE html PUBLIC
|
|
"-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN"
|
|
"http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<script type="text/javascript" src="docs.js"></script>
|
|
<link rel="stylesheet" type="text/css" href="docs.css"/>
|
|
<title>Venus Configuration</title>
|
|
</head>
|
|
<body>
|
|
|
|
<h2>Configuration</h2>
|
|
<p>Configuration files are in <a href="http://docs.python.org/lib/module-
|
|
ConfigParser.html">ConfigParser</a> format which basically means the same
|
|
format as INI files, i.e., they consist of a series of
|
|
<code>[sections]</code>, in square brackets, with each section containing a
|
|
list of <code>name:value</code> pairs (or <code>name=value</code> pairs, if
|
|
you prefer).</p>
|
|
<p>You are welcome to place your entire configuration into one file.
|
|
Alternately, you may factor out the templating into a "theme", and
|
|
the list of subscriptions into one or more "reading lists".</p>
|
|
<h3 id="planet"><code>[planet]</code></h3>
|
|
<p>This is the only required section, which is a bit odd as none of the
|
|
parameters listed below are required. Even so, you really do want to
|
|
provide many of these, especially ones that identify your planet and
|
|
either (or both) of <code>template_files</code> and <code>theme</code>.</p>
|
|
<p>Below is a complete list of predefined planet configuration parameters,
|
|
including <del>ones not (yet) implemented by Venus</del> and <ins>ones that
|
|
are either new or implemented differently by Venus</ins>.</p>
|
|
|
|
<blockquote>
|
|
<dl class="compact code">
|
|
<dt>name</dt>
|
|
<dd>Your planet's name</dd>
|
|
<dt>link</dt>
|
|
<dd>Link to the main page</dd>
|
|
<dt>owner_name</dt>
|
|
<dd>Your name</dd>
|
|
<dt>owner_email</dt>
|
|
<dd>Your e-mail address</dd>
|
|
|
|
</dl>
|
|
<dl class="compact code">
|
|
|
|
<dt>cache_directory</dt>
|
|
<dd>Where cached feeds are stored</dd>
|
|
<dt>output_dir</dt>
|
|
<dd>Directory to place output files</dd>
|
|
|
|
</dl>
|
|
<dl class="compact code">
|
|
|
|
<dt><ins>output_theme</ins></dt>
|
|
<dd>Directory containing a <code>config.ini</code> file which is merged
|
|
with this one. This is typically used to specify templating and bill of
|
|
material information.</dd>
|
|
<dt>template_files</dt>
|
|
<dd>Space-separated list of output template files</dd>
|
|
<dt><ins>template_directories</ins></dt>
|
|
<dd>Space-separated list of directories in which <code>template_files</code>
|
|
can be found</dd>
|
|
<dt><ins>bill_of_materials</ins></dt>
|
|
<dd>Space-separated list of files to be copied as is directly from the <code>template_directories</code> to the <code>output_dir</code></dd>
|
|
<dt><ins>filters</ins></dt>
|
|
<dd>Space-separated list of filters to apply to each entry</dd>
|
|
|
|
</dl>
|
|
<dl class="compact code">
|
|
|
|
<dt>items_per_page</dt>
|
|
<dd>How many items to put on each page. <ins>Whereas Planet 2.0 allows this to
|
|
be overridden on a per template basis, Venus currently takes the maximum value
|
|
for this across all templates.</ins></dd>
|
|
<dt><del>days_per_page</del></dt>
|
|
<dd>How many complete days of posts to put on each page This is the absolute, hard limit (over the item limit)</dd>
|
|
<dt>date_format</dt>
|
|
<dd><a href="http://docs.python.org/lib/module-time.html#l2h-2816">strftime</a> format for the default 'date' template variable</dd>
|
|
<dt>new_date_format</dt>
|
|
<dd><a href="http://docs.python.org/lib/module-time.html#l2h-2816">strftime</a> format for the 'new_date' template variable <ins>only applies to htmltmpl templates</ins></dd>
|
|
<dt><del>encoding</del></dt>
|
|
<dd>Output encoding for the file, Python 2.3+ users can use the special "xml" value to output ASCII with XML character references</dd>
|
|
<dt><del>locale</del></dt>
|
|
<dd>Locale to use for (e.g.) strings in dates, default is taken from your system</dd>
|
|
<dt>activity_threshold</dt>
|
|
<dd>If non-zero, all feeds which have not been updated in the indicated
|
|
number of days will be marked as inactive</dd>
|
|
|
|
</dl>
|
|
<dl class="compact code">
|
|
|
|
<dt>log_level</dt>
|
|
<dd>One of <code>DEBUG</code>, <code>INFO</code>, <code>WARNING</code>, <code>ERROR</code> or <code>CRITICAL</code></dd>
|
|
<dt><ins>log_format</ins></dt>
|
|
<dd><a href="http://docs.python.org/lib/node422.html">format string</a> to
|
|
use for logging output. Note: this configuration value is processed
|
|
<a href="http://docs.python.org/lib/ConfigParser-objects.html">raw</a></dd>
|
|
<dt>feed_timeout</dt>
|
|
<dd>Number of seconds to wait for any given feed</dd>
|
|
<dt><del>new_feed_items</del></dt>
|
|
<dd>Number of items to take from new feeds</dd>
|
|
<dt><ins>spider_threads</ins></dt>
|
|
<dd>The number of threads to use when spidering. When set to 0, the default,
|
|
no threads are used and spidering follows the traditional algorithm.</dd>
|
|
<dt><ins>http_cache_directory</ins></dt>
|
|
<dd>If <code>spider_threads</code> is specified, you can also specify a
|
|
directory to be used for an additional HTTP cache to front end the Venus
|
|
cache. If specified as a relative path, it is evaluated relative to the
|
|
<code>cache_directory</code>.</dd>
|
|
</dl>
|
|
<p>Additional options can be found in
|
|
<a href="normalization.html#overrides">normalization level overrides</a>.</p>
|
|
</blockquote>
|
|
|
|
<h3 id="default"><code>[DEFAULT]</code></h3>
|
|
<p>Values placed in this section are used as default values for all sections.
|
|
While it is true that few values make sense in all sections; in most cases
|
|
unused parameters cause few problems.</p>
|
|
|
|
<h3 id="subscription"><code>[</code><em>subscription</em><code>]</code></h3>
|
|
<p>All sections other than <code>planet</code>, <code>DEFAULT</code>, or are
|
|
named in <code>[planet]</code>'s <code>filters</code> or
|
|
<code>templatefiles</code> parameters
|
|
are treated as subscriptions and typically take the form of a
|
|
<acronym title="Uniform Resource Identifier">URI</acronym>.</p>
|
|
<p>Parameters placed in this section are passed to templates. While
|
|
you are free to include as few or as many parameters as you like, most of
|
|
the predefined themes presume that at least <code>name</code> is defined.</p>
|
|
<p>The <code>content_type</code> parameter can be defined to indicate that
|
|
this subscription is a <em>reading list</em>, i.e., is an external list
|
|
of subscriptions. At the moment, two formats of reading lists are supported:
|
|
<code>opml</code> and <code>foaf</code>. In the future, support for formats
|
|
like <code>xoxo</code> could be added.</p>
|
|
<p><a href="normalization.html#overrides">Normalization overrides</a> can
|
|
also be defined here.</p>
|
|
|
|
<h3 id="template"><code>[</code><em>template</em><code>]</code></h3>
|
|
<p>Sections which are listed in <code>[planet] template_files</code> are
|
|
processed as <a href="templates.html">templates</a>. With Planet 2.0,
|
|
it is possible to override parameters like <code>items_per_page</code>
|
|
on a per template basis, but at the current time Planet Venus doesn't
|
|
implement this.</p>
|
|
|
|
<h3 id="filter"><code>[</code><em>filter</em><code>]</code></h3>
|
|
<p>Sections which are listed in <code>[planet] filters</code> are
|
|
processed as <a href="filters.html">filters</a>.</p>
|
|
<p>Parameters which are listed in this section are passed to the filter
|
|
in a language specific manner. Given the way defaults work, filters
|
|
should be prepared to ignore parameters that they didn't expect.</p>
|
|
</body>
|
|
</html>
|