Mercurial > hg > decoupage

changeset 18:ebc1a802f9b8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update documentation
author k0s <k0scist@gmail.com>
date Tue, 29 Dec 2009 21:49:01 -0500
parents eab191e0b9b3
children d2e519a2f13c
files README.txt setup.py
diffstat 2 files changed, 25 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Sat Dec 26 14:43:00 2009 -0500
+++ b/README.txt	Tue Dec 29 21:49:01 2009 -0500
@@ -7,7 +7,9 @@
 decoupage is a static file server that allows for index pages
 configurable with genshi templates and .ini files.  I mainly wrote it
 because i was tired of using apache for serving my website and
-generating index.html files by hand.
+generating index.html files by hand.  Decoupage provides views into
+the filesystem.
+
 
 
 how do i use it?
@@ -54,4 +56,23 @@
 functionality of decoupage may be extended with ``/`` commands in a
 section.  This is done by adding a setuptools ``entry_point`` to
 ``[decoupage.formatters]``.  See the decoupage ``setup.py`` and
-``decoupage.formatters`` for examples.
+``decoupage.formatters`` for examples.  For instance, 
+
+Running `decoupage-formatters` from the command line gives the list of
+formatters that are available (which are pluggable setuptools extension points
+at [decoupage.formatters]).  For example: /include = site.html could
+include the site.html genshi template at the top of the body.
+
+all: 
+    only pass files of a certain pattern; 
+    the inverse of ignore
+    calling all with no arguments means only files with descriptions
+    are used
+    
+title: splits a description into a title and a description with a
+separator
+describe: substitute the description for the filename
+ignore: ignore files of a certain pattern
+include: include a file at the top of the body
+css: specify CSS
+
--- a/setup.py	Sat Dec 26 14:43:00 2009 -0500
+++ b/setup.py	Tue Dec 29 21:49:01 2009 -0500
@@ -6,11 +6,11 @@
 except IOError:
     description = ''
 
-version = '0.4.1'
+version = '0.4.2'
 
 setup(name='decoupage',
       version=version,
-      description="Decoupage is the art of decorating an object by gluing colored paper cutouts onto it in combination with special paint effects ...",
+      description="Decoupage is the art of decorating an object by gluing colored paper cutouts onto it in combination with special paint effects ... The software decoupage lets you stitch together index pages from filesystem content",
       long_description=description,
       classifiers=[], # Get strings from http://www.python.org/pypi?%3Aaction=list_classifiers
       author='Jeff Hammel',