comparison README.txt @ 28:fc1c479296c3

more docmentation updates
author k0s <k0scist@gmail.com>
date Tue, 19 Jan 2010 09:15:35 -0500
parents 9e86c5cb111a
children ffd661a0f169
comparison
equal deleted inserted replaced
27:9e86c5cb111a 28:fc1c479296c3
63 at [decoupage.formatters]). For example: /include = site.html could 63 at [decoupage.formatters]). For example: /include = site.html could
64 include the site.html genshi template at the top of the body. 64 include the site.html genshi template at the top of the body.
65 65
66 Formatters: 66 Formatters:
67 67
68 sort:
69 determines how to sort the files in a directory;
70 right now only by case-insensitive alphabetically
71 * reverse : reverse the order of the sorting
72
68 all: 73 all:
69 only pass files of a certain pattern; 74 only pass files of a certain pattern;
70 the inverse of ignore 75 the inverse of ignore
71 calling all with no arguments means only files with descriptions 76 calling all with no arguments means only files with descriptions
72 are used 77 are used
73 78
74 title: splits a description into a title and a description with a 79 title:
75 separator 80 splits a description into a title and a description via a
76 describe: substitute the description for the filename 81 separator in
77 ignore: ignore files of a certain pattern 82 the description. The template will now have an additional
83 variable,
84 'title', per file
85 Arguments:
86 * separator: what separator to use (':' by default)
87
88 describe:
89 obtain the description from the filename
90 the file extension (if any) will be dropped and
91 spaces will be substituted for underscores
92
93 ignore:
94 ignore files of a glob patterns.
95 These files will not be linked to in the template.
96 e.g. /ignore = .* *.pdf # don't list dotfiles and PDFs
97
98 images: display images with thumbnails
78 include: include a file at the top of the body 99 include: include a file at the top of the body
79 css: specify CSS 100 css: specify CSS used (whitespace separated list)
80 101
81 Decoupage also makes use of other special intrinsic keywords: 102 Decoupage also makes use of other special intrinsic keywords:
82 103
83 inherit: 104 formatters: ordered list of formatters to apply
84 transform: 105
106 inherit: inherit configuration from a certain directory (instead of
107 the parent
108
109 transform: a list of transformers for contenttransformer