Mercurial > hg > decoupage

comparison README.txt @ 18:ebc1a802f9b8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update documentation
author k0s <k0scist@gmail.com>
date Tue, 29 Dec 2009 21:49:01 -0500
parents fa2005f769eb
children 9e86c5cb111a
comparison
equal deleted inserted replaced
17:eab191e0b9b3 18:ebc1a802f9b8
5 ----------- 5 -----------
6 6
7 decoupage is a static file server that allows for index pages 7 decoupage is a static file server that allows for index pages
8 configurable with genshi templates and .ini files. I mainly wrote it 8 configurable with genshi templates and .ini files. I mainly wrote it
9 because i was tired of using apache for serving my website and 9 because i was tired of using apache for serving my website and
10 generating index.html files by hand. 10 generating index.html files by hand. Decoupage provides views into
11 the filesystem.
12
11 13
12 14
13 how do i use it? 15 how do i use it?
14 ---------------- 16 ----------------
15 17
52 54
53 Since filenames can't start with a ``/`` (just try it!), the 55 Since filenames can't start with a ``/`` (just try it!), the
54 functionality of decoupage may be extended with ``/`` commands in a 56 functionality of decoupage may be extended with ``/`` commands in a
55 section. This is done by adding a setuptools ``entry_point`` to 57 section. This is done by adding a setuptools ``entry_point`` to
56 ``[decoupage.formatters]``. See the decoupage ``setup.py`` and 58 ``[decoupage.formatters]``. See the decoupage ``setup.py`` and
57 ``decoupage.formatters`` for examples. 59 ``decoupage.formatters`` for examples. For instance,
60
61 Running `decoupage-formatters` from the command line gives the list of
62 formatters that are available (which are pluggable setuptools extension points
63 at [decoupage.formatters]). For example: /include = site.html could
64 include the site.html genshi template at the top of the body.
65
66 all:
67 only pass files of a certain pattern;
68 the inverse of ignore
69 calling all with no arguments means only files with descriptions
70 are used
71
72 title: splits a description into a title and a description with a
73 separator
74 describe: substitute the description for the filename
75 ignore: ignore files of a certain pattern
76 include: include a file at the top of the body
77 css: specify CSS
78