# HG changeset patch
# User k0s <k0scist@gmail.com>
# Date 1263846822 18000
# Node ID 9e86c5cb111a0eb0a21ffe67c94132bebbec461d
# Parent  f306089d6def5bf9d751f07e74654ec1b22971de
minor documentation updates

diff -r f306089d6def -r 9e86c5cb111a README.txt
--- a/README.txt	Sun Jan 17 19:49:04 2010 -0500
+++ b/README.txt	Mon Jan 18 15:33:42 2010 -0500
@@ -63,6 +63,8 @@
 at [decoupage.formatters]).  For example: /include = site.html could
 include the site.html genshi template at the top of the body.
 
+Formatters:
+
 all: 
     only pass files of a certain pattern; 
     the inverse of ignore
@@ -76,3 +78,7 @@
 include: include a file at the top of the body
 css: specify CSS
 
+Decoupage also makes use of other special intrinsic keywords:
+
+inherit:
+transform: 
diff -r f306089d6def -r 9e86c5cb111a decoupage/formatters.py
--- a/decoupage/formatters.py	Sun Jan 17 19:49:04 2010 -0500
+++ b/decoupage/formatters.py	Mon Jan 18 15:33:42 2010 -0500
@@ -36,7 +36,10 @@
 ### formatters
 
 class Ignore(object):
-    """ignore files of a certain pattern"""
+    """
+    ignore files of a glob patterns.  These files will not be used in the index template.
+    e.g. /ignore = .* *.pdf  # don't list dotfiles and PDFs
+    """
     
 
     def __init__(self, ignore):
@@ -79,7 +82,11 @@
         data['files'] = _files
         
 class Sort(object):
-    """ determines how to sort the files in a directory """
+    """
+    determines how to sort the files in a directory; 
+    right now only by case-insensitive alphabetically
+    * reverse : reverse the 
+    """
     def __init__(self, pattern):
         self.args = [i.strip() for i in pattern.split(',')]