Mercurial > hg > decoupage
changeset 99:2c7c4fda1a14
update ReST
| author | Jeff Hammel <k0scist@gmail.com> |
|---|---|
| date | Tue, 23 Aug 2016 18:11:39 -0700 |
| parents | abf23c2e4e82 |
| children | 82ee67b95a0c |
| files | README.txt setup.py |
| diffstat | 2 files changed, 18 insertions(+), 17 deletions(-) [+] |
line wrap: on
line diff
--- a/README.txt Mon Aug 22 18:19:07 2016 -0700 +++ b/README.txt Tue Aug 23 18:11:39 2016 -0700 @@ -55,7 +55,7 @@ functionality of decoupage may be extended with ``/`` commands in a section. This is done by adding a setuptools ``entry_point`` to ``[decoupage.formatters]``. See the decoupage ``setup.py`` and -``decoupage.formatters`` for examples. For instance, +``decoupage.formatters`` for examples. For instance, Running `decoupage-formatters` from the command line gives the list of formatters that are available (which are pluggable setuptools extension points @@ -64,37 +64,38 @@ Formatters: -sort: - determines how to sort the files in a directory; +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; + +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: + +title: splits a description into a title and a description via a - separator in + separator in the description. The template will now have an additional - variable, + variable, 'title', per file Arguments: * separator: what separator to use (':' by default) -describe: +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. + +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 - + e.g. ``/ignore = .* *.pdf # don't list dotfiles and PDFs`` + include: include a file at the top of the body + css: specify CSS used (whitespace separated list) Decoupage also makes use of other special intrinsic keywords: