diff --git a/README b/README index a1fb9e9..3014d89 100644 --- a/README +++ b/README @@ -9,11 +9,11 @@ also actively being maintained. It uses Mark Pilgrim's Universal Feed Parser to read from CDF, RDF, RSS and Atom feeds; Leonard Richardson's Beautiful Soup to correct markup issues; -and Tomas Styblo's templating engine to output static files in any -format you can dream up. +and either Tomas Styblo's templating engine Daniel Viellard's implementation +of XSLT to output static files in any format you can dream up. -To get started, check out the INSTALL file in this directory. If you have any -questions or comments, please don't hesitate to use the planet mailing list: +To get started, check out the documentation in the docs directory. If you have +any questions or comments, please don't hesitate to use the planet mailing list: http://lists.planetplanet.org/mailman/listinfo/devel diff --git a/TODO b/TODO index 62c6c1a..0350a25 100644 --- a/TODO +++ b/TODO @@ -1,11 +1,6 @@ TODO ==== - * Enable per-feed adjustments - - The goal is to better cope with feeds that don't have dates or ids or - consitently encode or escape things incorrectly. - * Expire feed history The feed cache doesn't currently expire old entries, so could get diff --git a/docs/config.html b/docs/config.html index 503f350..4b64564 100644 --- a/docs/config.html +++ b/docs/config.html @@ -27,6 +27,7 @@ either (or both) of template_files and theme.

Below is a complete list of predefined planet configuration parameters, including ones not (yet) implemented by Venus and ones that are either new or implemented differently by Venus.

+
name
@@ -37,16 +38,35 @@ are either new or implemented differently by Venus.

Your name
owner_email
Your e-mail address
+ +
+
+
cache_directory
Where cached feeds are stored
-
log_level
-
One of DEBUG, INFO, WARNING, ERROR or CRITICAL
-
output_theme
+
output_dir
+
Directory to place output files
+ +
+
+ +
theme
Directory containing a config.ini file which is merged with this one. This is typically used to specify templating and bill of material information.
-
output_dir
-
Directory to place output files
+
template_files
+
Space-separated list of output template files
+
template_directories
+
Space-separated list of directories in which template_files +can be found
+
bill_of_materials
+
Space-separated list of files to be copied as is directly from the template_directories to the output_dir
+
filters
+
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 be overridden on a per template basis, Venus currently takes the maximum value @@ -61,22 +81,19 @@ for this across all templates.
Output encoding for the file, Python 2.3+ users can use the special "xml" value to output ASCII with XML character references
locale
Locale to use for (e.g.) strings in dates, default is taken from your system
+
activity_threshold
+
If non-zero, all feeds which have not been updated in the indicated +number of days will be marked as inactive
+ +
+
+ +
log_level
+
One of DEBUG, INFO, WARNING, ERROR or CRITICAL
feed_timeout
Number of seconds to wait for any given feed
new_feed_items
Number of items to take from new feeds
-
activity_threshold
-
If non-zero, all feeds which have not been updated in the indicated -number of days will be marked as inactive
-
template_files
-
Space-separated list of output template files
-
template_directories
-
Space-separated list of directories in which template_files -can be found
-
bill_of_materials
-
Space-separated list of files to be copied as is directly from the template_directories to the output_dir
-
filters
-
Space-separated list of filters to apply to each entry
diff --git a/docs/docs.css b/docs/docs.css index c5a1baf..65b290c 100644 --- a/docs/docs.css +++ b/docs/docs.css @@ -12,21 +12,18 @@ a:link, a:visited { color: #333; text-decoration: none !important; border-bottom: 1px dotted #333 !important; - text-decoration: underline; - border-bottom: 0; } a:hover { background-color: transparent; - color: #993344; + color: #934; text-decoration: none !important; - text-decoration: underline; border-bottom: 1px dotted #993344 !important; - border-bottom: 0; } code { - color: green; + background-color: #FFF; + color: #00F; font-size: large } @@ -42,14 +39,13 @@ h2 { clear: both; } -ul.outer > li { +ul, ul.outer > li { margin: 14px 0 10px 0; } .z { float:left; background: url(img/shadowAlpha.png) no-repeat bottom right !important; - background: url(img/shadow.gif) no-repeat bottom right; margin: -15px 0 20px -15px !important; } @@ -60,21 +56,18 @@ ul.outer > li { .z .sectionInner { width: 730px; background: none !important; - background: url(img/shadow2.gif) no-repeat left top; padding: 0 !important; - padding: 0 6px 6px 10; } .z .sectionInner .sectionInner2 { - background-color: #fff; border: 1px solid #a9a9a9; padding: 4px; margin: -6px 6px 6px -6px !important; - margin: 0; } ins { - color: magenta; + background-color: #FFF; + color: #F0F; text-decoration: none; } @@ -84,7 +77,7 @@ dl.compact { } dl.code > dt { - font-family: mono; + font-family: monospace; } dl.compact > dt { diff --git a/docs/docs.js b/docs/docs.js index 0b2a925..229b13c 100644 --- a/docs/docs.js +++ b/docs/docs.js @@ -1,6 +1,8 @@ window.onload=function() { var vindex = document.URL.lastIndexOf('venus/'); + if (vindex<0) vindex = document.URL.lastIndexOf('planet/'); var base = document.URL.substring(0,vindex+6); + if (vindex<0) vindex = '..'; var body = document.getElementsByTagName('body')[0]; var div = document.createElement('div'); diff --git a/docs/img/shadow.gif b/docs/img/shadow.gif deleted file mode 100644 index f1e6cb5..0000000 Binary files a/docs/img/shadow.gif and /dev/null differ diff --git a/docs/img/shadow2.gif b/docs/img/shadow2.gif deleted file mode 100644 index a0b9ed4..0000000 Binary files a/docs/img/shadow2.gif and /dev/null differ diff --git a/docs/index.html b/docs/index.html index 7889335..b19d0c8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10,6 +10,7 @@

Table of Contents