diff README.txt @ 34:527ccb76d043

merged some stuff
author k0s <k0scist@gmail.com>
date Mon, 08 Feb 2010 11:44:20 -0500
parents ffd661a0f169
children 9ba237db4cde
line wrap: on
line diff
--- a/README.txt	Mon Feb 08 11:40:57 2010 -0500
+++ b/README.txt	Mon Feb 08 11:44:20 2010 -0500
@@ -63,16 +63,46 @@
 at [decoupage.formatters]).  For example: /include = site.html could
 include the site.html genshi template at the top of the body.
 
+Formatters:
+
+sort: 
+    determines how to sort the files in a directory; 
+    right now only by case-insensitive alphabetically
+    * reverse : reverse the order of the sorting
+    
 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
+title: 
+    splits a description into a title and a description via a
+    separator in 
+    the description.  The template will now have an additional
+    variable, 
+    'title', per file
+    Arguments:
+    * separator: what separator to use (':' by default)
+    
+describe: 
+    obtain the description from the filename
+    the file extension (if any) will be dropped and
+    spaces will be substituted for underscores
+    
+ignore: 
+    ignore files of a glob patterns.  
+    These files will not be linked to in the template.
+    e.g. /ignore = .* *.pdf  # don't list dotfiles and PDFs
+    
 include: include a file at the top of the body
-css: specify CSS
+css: specify CSS used (whitespace separated list)
+
+Decoupage also makes use of other special intrinsic keywords:
 
+formatters: ordered list of formatters to apply
+
+inherit: inherit configuration from a certain directory (instead of
+the parent
+
+transform: a list of transformers for contenttransformer