From 6c3701f1fce52904df2318bd73f2cd595c6fee0c Mon Sep 17 00:00:00 2001 From: uriel Date: Wed, 30 Sep 2009 21:44:16 +0000 Subject: [PATCH] Document dir listing optinos and _header.md and _footer.md --- sites/werc.cat-v.org/docs/dir_listings.md | 29 +++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 sites/werc.cat-v.org/docs/dir_listings.md diff --git a/sites/werc.cat-v.org/docs/dir_listings.md b/sites/werc.cat-v.org/docs/dir_listings.md new file mode 100644 index 0000000..9cd642c --- /dev/null +++ b/sites/werc.cat-v.org/docs/dir_listings.md @@ -0,0 +1,29 @@ +Autogenerated Directory Listings +================================ + +If a directory has no `index.md`, `index.html` or `index.txt` and has no other +*main handler* set up by a [werc app](/apps/), the default directory listing +handler is used. + +The default directory handler simply displays the path to the directory, and a +list of links to all files and dirs located at this path. + + +Header and footer +----------------- + +If a `_header.md` or `_footer.md` files are found in the directory, their +contents will be displayed in the corresponding sections before and after +the directory contents. + + +Tuning the item's order +------------------------ + +You can set the `dir_listing_ls_opts` config variable in the dir's corresponding _werc/config to change the way items will be ordered. + +For example to list items in reverse chronological order simply add: + + dir_listing_ls_opts=( -t ) + +The options taken are [the standard Plan 9 ls(1) flags](http://man.cat-v.org/plan_9/1/ls).