Mercurial > hg > decoupage

comparison README.txt @ 99:2c7c4fda1a14

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update ReST
author Jeff Hammel <k0scist@gmail.com>
date Tue, 23 Aug 2016 18:11:39 -0700
parents 5330cd62e179
children 70f5be036103
comparison
equal deleted inserted replaced
98:abf23c2e4e82 99:2c7c4fda1a14
53 53
54 Since filenames can't start with a ``/`` (just try it!), the 54 Since filenames can't start with a ``/`` (just try it!), the
55 functionality of decoupage may be extended with ``/`` commands in a 55 functionality of decoupage may be extended with ``/`` commands in a
56 section. This is done by adding a setuptools ``entry_point`` to 56 section. This is done by adding a setuptools ``entry_point`` to
57 ``[decoupage.formatters]``. See the decoupage ``setup.py`` and 57 ``[decoupage.formatters]``. See the decoupage ``setup.py`` and
58 ``decoupage.formatters`` for examples. For instance, 58 ``decoupage.formatters`` for examples. For instance,
59 59
60 Running `decoupage-formatters` from the command line gives the list of 60 Running `decoupage-formatters` from the command line gives the list of
61 formatters that are available (which are pluggable setuptools extension points 61 formatters that are available (which are pluggable setuptools extension points
62 at [decoupage.formatters]). For example: /include = site.html could 62 at [decoupage.formatters]). For example: /include = site.html could
63 include the site.html genshi template at the top of the body. 63 include the site.html genshi template at the top of the body.
64 64
65 Formatters: 65 Formatters:
66 66
67 sort: 67 sort:
68 determines how to sort the files in a directory; 68 determines how to sort the files in a directory;
69 right now only by case-insensitive alphabetically 69 right now only by case-insensitive alphabetically
70 * reverse : reverse the order of the sorting 70 * reverse : reverse the order of the sorting
71 71
72 all: 72 all:
73 only pass files of a certain pattern; 73 only pass files of a certain pattern;
74 the inverse of ignore 74 the inverse of ignore
75 calling all with no arguments means only files with descriptions 75 calling all with no arguments means only files with descriptions
76 are used 76 are used
77 77
78 title: 78 title:
79 splits a description into a title and a description via a 79 splits a description into a title and a description via a
80 separator in 80 separator in
81 the description. The template will now have an additional 81 the description. The template will now have an additional
82 variable, 82 variable,
83 'title', per file 83 'title', per file
84 Arguments: 84 Arguments:
85 * separator: what separator to use (':' by default) 85 * separator: what separator to use (':' by default)
86 86
87 describe: 87 describe:
88 obtain the description from the filename 88 obtain the description from the filename
89 the file extension (if any) will be dropped and 89 the file extension (if any) will be dropped and
90 spaces will be substituted for underscores 90 spaces will be substituted for underscores
91 91
92 ignore: 92 ignore:
93 ignore files of a glob patterns. 93 ignore files of a glob patterns.
94 These files will not be linked to in the template. 94 These files will not be linked to in the template.
95 e.g. /ignore = .* *.pdf # don't list dotfiles and PDFs 95 e.g. ``/ignore = .* *.pdf # don't list dotfiles and PDFs``
96 96
97 include: include a file at the top of the body 97 include: include a file at the top of the body
98
98 css: specify CSS used (whitespace separated list) 99 css: specify CSS used (whitespace separated list)
99 100
100 Decoupage also makes use of other special intrinsic keywords: 101 Decoupage also makes use of other special intrinsic keywords:
101 102
102 formatters: ordered list of formatters to apply 103 formatters: ordered list of formatters to apply