From 4a777e1fca47f8ad4418c6643180ebce96026a67 Mon Sep 17 00:00:00 2001 From: Sam Ruby Date: Tue, 17 Oct 2006 11:17:26 -0400 Subject: [PATCH] Documentation nits --- docs/config.html | 8 ++++---- docs/docs.css | 1 + docs/filters.html | 4 ++-- docs/installation.html | 5 +++-- docs/normalization.html | 6 +++--- 5 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/config.html b/docs/config.html index 4b64564..70c6710 100644 --- a/docs/config.html +++ b/docs/config.html @@ -40,7 +40,7 @@ are either new or implemented differently by Venus.

Your e-mail address
-
+
cache_directory
Where cached feeds are stored
@@ -48,7 +48,7 @@ are either new or implemented differently by Venus.

Directory to place output files
-
+
theme
Directory containing a config.ini file which is merged @@ -65,7 +65,7 @@ can be found
Space-separated list of filters to apply to each entry
-
+
items_per_page
How many items to put on each page. Whereas Planet 2.0 allows this to @@ -86,7 +86,7 @@ for this across all templates.
number of days will be marked as inactive
-
+
log_level
One of DEBUG, INFO, WARNING, ERROR or CRITICAL
diff --git a/docs/docs.css b/docs/docs.css index 65b290c..5049baa 100644 --- a/docs/docs.css +++ b/docs/docs.css @@ -78,6 +78,7 @@ dl.compact { dl.code > dt { font-family: monospace; + font-size: large; } dl.compact > dt { diff --git a/docs/filters.html b/docs/filters.html index 9f20686..90cc799 100644 --- a/docs/filters.html +++ b/docs/filters.html @@ -44,7 +44,7 @@ expressions.

  • The file extension of the filter is significant. .py invokes -python. .xslt involkes xslt. .sed and +python. .xslt involkes XSLT. .sed and .tmpl (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.
    • @@ -58,7 +58,7 @@ configuration file (think unix pipes). Planet wide filters are executed before feed specific filters.
  • Templates written using htmltmpl currently only have access to a fixed set -of fields, whereas xslt templates have access to everything.
    • +of fields, whereas XSLT templates have access to everything.
diff --git a/docs/installation.html b/docs/installation.html index 42eff05..8d62ad7 100644 --- a/docs/installation.html +++ b/docs/installation.html @@ -14,8 +14,9 @@

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.

-

Everything Pythonesque Planet need to provide basic operation should be -included in the distribution. Additionally:

+

Everything Pythonesque Planet needs to provide basic operation should be +included in the distribution. Some optional features may require +additional libraries, for example:

  • Usage of XSLT requires either xsltproc diff --git a/docs/normalization.html b/docs/normalization.html index 63455ea..5577899 100644 --- a/docs/normalization.html +++ b/docs/normalization.html @@ -12,11 +12,11 @@

    Venus builds on, and extends, the Universal Feed Parser and BeautifulSoup 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.

    Encoding

    -

    Input data in feeds may be enocded in a variety of formats, most commonly +

    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 character entity @@ -70,7 +70,7 @@ are converted into

If no updated dates are found in an entry, or if the dates found -are in the future, the current time is substitued.

+are in the future, the current time is substituted.

Overrides

All of the above describes what Venus does automatically, either directly or through its dependencies. There are a number of errors which can not