Skip to content

Commit

Permalink
Fix name of config files in snaplet tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
mightybyte committed Aug 11, 2012
1 parent b0059ba commit 77883ea
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions snaplets/heist/templates/docs/tutorials/snaplets-tutorial.lhs
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ into the directory of any project that uses it. Here's an example of what a
snaplet filesystem layout might look like: snaplet filesystem layout might look like:


foosnaplet/ foosnaplet/
|-- *snaplet.cfg* |-- *devel.cfg*
|-- db.cfg |-- db.cfg
|-- public/ |-- public/
|-- stylesheets/ |-- stylesheets/
Expand All @@ -296,13 +296,13 @@ snaplet filesystem layout might look like:
|-- subsnaplet2/ |-- subsnaplet2/


Only the starred items are actually enforced by current code, but we want to Only the starred items are actually enforced by current code, but we want to
establish the others as a convention. The file snaplet.cfg is automatically establish the others as a convention. The file devel.cfg is automatically
read by the snaplet infrastructure. It is available to you via the read by the snaplet infrastructure. It is available to you via the
`getSnapletUserConfig` function. Config files use the format defined by Bryan `getSnapletUserConfig` function. Config files use the format defined by Bryan
O'Sullivan's excellent [configurator O'Sullivan's excellent [configurator
package](http://hackage.haskell.org/package/configurator). In this example, package](http://hackage.haskell.org/package/configurator). In this example,
the user has chosen to put db config items in a separate file and use the user has chosen to put db config items in a separate file and use
configurator's import functionality to include it in snaplet.cfg. If configurator's import functionality to include it in devel.cfg. If
foosnaplet uses `nestSnaplet` or `embedSnaplet` to include any other snaplets, foosnaplet uses `nestSnaplet` or `embedSnaplet` to include any other snaplets,
then filesystem data defined by those snaplets will be included in then filesystem data defined by those snaplets will be included in
subdirectories under the `snaplets/` directory. subdirectories under the `snaplets/` directory.
Expand Down Expand Up @@ -346,7 +346,7 @@ make everything work, you have to tell Cabal about your data files by
including a section like the following in snaplet-killerapp.cabal: including a section like the following in snaplet-killerapp.cabal:
data-files: data-files:
resources/snaplet.cfg, resources/devel.cfg,
resources/public/stylesheets/style.css, resources/public/stylesheets/style.css,
resources/snaplets/heist/templates/page.tpl resources/snaplets/heist/templates/page.tpl
Expand Down

0 comments on commit 77883ea

Please sign in to comment.