Mercurial > hg > decoupage

comparison README.txt @ 34:527ccb76d043

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
merged some stuff
author k0s <k0scist@gmail.com>
date Mon, 08 Feb 2010 11:44:20 -0500
parents ffd661a0f169
children 9ba237db4cde
comparison
equal deleted inserted replaced
33:e384d4569ac3 34:527ccb76d043
61 Running `decoupage-formatters` from the command line gives the list of 61 Running `decoupage-formatters` from the command line gives the list of
62 formatters that are available (which are pluggable setuptools extension points 62 formatters that are available (which are pluggable setuptools extension points
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:
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
66 all: 73 all:
67 only pass files of a certain pattern; 74 only pass files of a certain pattern;
68 the inverse of ignore 75 the inverse of ignore
69 calling all with no arguments means only files with descriptions 76 calling all with no arguments means only files with descriptions
70 are used 77 are used
71 78
72 title: splits a description into a title and a description with a 79 title:
73 separator 80 splits a description into a title and a description via a
74 describe: substitute the description for the filename 81 separator in
75 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
76 include: include a file at the top of the body 98 include: include a file at the top of the body
77 css: specify CSS 99 css: specify CSS used (whitespace separated list)
78 100
101 Decoupage also makes use of other special intrinsic keywords:
102
103 formatters: ordered list of formatters to apply
104
105 inherit: inherit configuration from a certain directory (instead of
106 the parent
107
108 transform: a list of transformers for contenttransformer