Documentation nits
This commit is contained in:
parent
48a4b89840
commit
4a777e1fca
@ -40,7 +40,7 @@ are either new or implemented differently by Venus</ins>.</p>
|
||||
<dd>Your e-mail address</dd>
|
||||
|
||||
</dl>
|
||||
<dl class="compact">
|
||||
<dl class="compact code">
|
||||
|
||||
<dt>cache_directory</dt>
|
||||
<dd>Where cached feeds are stored</dd>
|
||||
@ -48,7 +48,7 @@ are either new or implemented differently by Venus</ins>.</p>
|
||||
<dd>Directory to place output files</dd>
|
||||
|
||||
</dl>
|
||||
<dl class="compact">
|
||||
<dl class="compact code">
|
||||
|
||||
<dt><ins>theme</ins></dt>
|
||||
<dd>Directory containing a <code>config.ini</code> file which is merged
|
||||
@ -65,7 +65,7 @@ can be found</dd>
|
||||
<dd>Space-separated list of filters to apply to each entry</dd>
|
||||
|
||||
</dl>
|
||||
<dl class="compact">
|
||||
<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
|
||||
@ -86,7 +86,7 @@ for this across all templates.</ins></dd>
|
||||
number of days will be marked as inactive</dd>
|
||||
|
||||
</dl>
|
||||
<dl class="compact">
|
||||
<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>
|
||||
|
@ -78,6 +78,7 @@ dl.compact {
|
||||
|
||||
dl.code > dt {
|
||||
font-family: monospace;
|
||||
font-size: large;
|
||||
}
|
||||
|
||||
dl.compact > dt {
|
||||
|
@ -44,7 +44,7 @@ expressions.</p>
|
||||
<ul>
|
||||
|
||||
<li>The file extension of the filter is significant. <code>.py</code> invokes
|
||||
python. <code>.xslt</code> involkes xslt. <code>.sed</code> and
|
||||
python. <code>.xslt</code> involkes XSLT. <code>.sed</code> and
|
||||
<code>.tmpl</code> (a.k.a. htmltmp) are also options. Other languages, like
|
||||
perl or ruby or class/jar (java), aren't supported at the moment, but these
|
||||
would be easy to add.</li>
|
||||
@ -58,7 +58,7 @@ configuration file (think unix pipes). Planet wide filters are executed before
|
||||
feed specific filters.</li>
|
||||
|
||||
<li>Templates written using htmltmpl currently only have access to a fixed set
|
||||
of fields, whereas xslt templates have access to everything.</li>
|
||||
of fields, whereas XSLT templates have access to everything.</li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
|
@ -14,8 +14,9 @@
|
||||
<p>You'll need at least Python 2.2 installed on your system, we recommend
|
||||
Python 2.4 though as there may be bugs with the earlier libraries.</p>
|
||||
|
||||
<p>Everything Pythonesque Planet need to provide basic operation should be
|
||||
included in the distribution. Additionally:</p>
|
||||
<p>Everything Pythonesque Planet needs to provide basic operation should be
|
||||
included in the distribution. Some optional features may require
|
||||
additional libraries, for example:</p>
|
||||
<ul>
|
||||
<li>Usage of XSLT requires either
|
||||
<a href="http://xmlsoft.org/XSLT/xsltproc2.html">xsltproc</a>
|
||||
|
@ -12,11 +12,11 @@
|
||||
<p>Venus builds on, and extends, the <a
|
||||
href="http://www.feedparser.org/">Universal Feed Parser</a> and <a
|
||||
href="http://www.crummy.com/software/BeautifulSoup/">BeautifulSoup</a> to
|
||||
convert all feeds into Atom 1.0, with well formed XHTML, and encoded as utf-8,
|
||||
convert all feeds into Atom 1.0, with well formed XHTML, and encoded as UTF-8,
|
||||
meaning that you don't have to worry about funky feeds, tag soup, or character
|
||||
encoding.</p>
|
||||
<h3>Encoding</h3>
|
||||
<p>Input data in feeds may be enocded in a variety of formats, most commonly
|
||||
<p>Input data in feeds may be encoded in a variety of formats, most commonly
|
||||
ASCII, ISO-8859-1, WIN-1252, AND UTF-8. Additionally, many feeds make use of
|
||||
the wide range of
|
||||
<a href="http://www.w3.org/TR/html401/sgml/entities.html">character entity
|
||||
@ -70,7 +70,7 @@ are converted into
|
||||
</ul>
|
||||
<p>If no <a href="http://www.feedparser.org/docs/reference-feed-
|
||||
updated.html">updated</a> dates are found in an entry, or if the dates found
|
||||
are in the future, the current time is substitued.</p>
|
||||
are in the future, the current time is substituted.</p>
|
||||
<h3 id="overrides">Overrides</h3>
|
||||
<p>All of the above describes what Venus does automatically, either directly
|
||||
or through its dependencies. There are a number of errors which can not
|
||||
|
Loading…
x
Reference in New Issue
Block a user