Release 3.0.0beta3

add hogan.js template engine for express@3.0

.gitignore

@@ -1,3 +1,4 @@
+coverage.html
 .DS_Store
 lib-cov
 *.seed
@@ -6,4 +7,12 @@ lib-cov
 *.dat
 *.out
 *.pid
-benchmarks/graphs
+*.swp
+*.swo
+benchmarks/graphs
+testing
+node_modules/
+testing
+.coverage_data
+cover_html
+test.js

.gitmodules

@@ -1,18 +0,0 @@
-[submodule "support/expresso"]
-	path = support/expresso
-	url = git://github.com/visionmedia/expresso.git
-[submodule "support/haml"]
-	path = support/haml
-	url = git://github.com/visionmedia/haml.js.git
-[submodule "support/ejs"]
-	path = support/ejs
-	url = git://github.com/visionmedia/ejs.git
-[submodule "support/connect-form"]
-	path = support/connect-form
-	url = git://github.com/visionmedia/connect-form.git
-[submodule "support/connect"]
-	path = support/connect
-	url = git://github.com/senchalabs/connect.git
-[submodule "support/jade"]
-	path = support/jade
-	url = git://github.com/visionmedia/jade.git

.npmignore

@@ -0,0 +1,9 @@
+.git*
+docs/
+examples/
+support/
+test/
+testing.js
+.DS_Store
+coverage.html
+lib-cov

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - 0.6

History.md

@@ -1,4 +1,531 @@
 
+3.0.0beta3 / 2012-06-15 
+==================
+
+  * Added hogan `--hjs` to express(1) [nullfirm]
+  * Added another example to content-negotiation
+  * Added `fresh` dep
+  * Changed: `res.send()` always checks freshness
+  * Fixed: expose connects mime module. Cloases #1165
+
+3.0.0beta2 / 2012-06-06 
+==================
+
+  * Added `+` support to the router
+  * Added `req.host`
+  * Changed `req.param()` to check route first
+  * Update connect dep
+
+3.0.0beta1 / 2012-06-01 
+==================
+
+  * Added `res.format()` callback to override default 406 behaviour
+  * Fixed `res.redirect()` 406. Closes #1154
+
+3.0.0alpha5 / 2012-05-30 
+==================
+
+  * Added `req.ip`
+  * Added `{ signed: true }` option to `res.cookie()`
+  * Removed `res.signedCookie()`
+  * Changed: dont reverse `req.ips`
+  * Fixed "trust proxy" setting check for `req.ips`
+
+3.0.0alpha4 / 2012-05-09 
+==================
+
+  * Added: allow `[]` in jsonp callback. Closes #1128
+  * Added `PORT` env var support in generated template. Closes #1118 [benatkin]
+  * Updated: connect 2.2.2
+
+3.0.0alpha3 / 2012-05-04 
+==================
+
+  * Added public `app.routes`. Closes #887
+  * Added _view-locals_ example
+  * Added _mvc_ example
+  * Added `res.locals.use()`. Closes #1120
+  * Added conditional-GET support to `res.send()`
+  * Added: coerce `res.set()` values to strings
+  * Changed: moved `static()` in generated apps below router
+  * Changed: `res.send()` only set ETag when not previously set
+  * Changed connect 2.2.1 dep
+  * Changed: `make test` now runs unit / acceptance tests
+  * Fixed req/res proto inheritance
+
+3.0.0alpha2 / 2012-04-26 
+==================
+
+  * Added `make benchmark` back
+  * Added `res.send()` support for `String` objects
+  * Added client-side data exposing example
+  * Added `res.header()` and `req.header()` aliases for BC
+  * Added `express.createServer()` for BC
+  * Perf: memoize parsed urls
+  * Perf: connect 2.2.0 dep
+  * Changed: make `expressInit()` middleware self-aware
+  * Fixed: use app.get() for all core settings
+  * Fixed redis session example
+  * Fixed session example. Closes #1105
+  * Fixed generated express dep. Closes #1078
+
+3.0.0alpha1 / 2012-04-15 
+==================
+
+  * Added `app.locals.use(callback)`
+  * Added `app.locals` object
+  * Added `app.locals(obj)`
+  * Added `res.locals` object
+  * Added `res.locals(obj)`
+  * Added `res.format()` for content-negotiation
+  * Added `app.engine()`
+  * Added `res.cookie()` JSON cookie support
+  * Added "trust proxy" setting
+  * Added `req.subdomains`
+  * Added `req.protocol`
+  * Added `req.secure`
+  * Added `req.path`
+  * Added `req.ips`
+  * Added `req.fresh`
+  * Added `req.stale`
+  * Added comma-delmited / array support for `req.accepts()`
+  * Added debug instrumentation
+  * Added `res.set(obj)`
+  * Added `res.set(field, value)`
+  * Added `res.get(field)`
+  * Added `app.get(setting)`. Closes #842
+  * Added `req.acceptsLanguage()`
+  * Added `req.acceptsCharset()`
+  * Added `req.accepted`
+  * Added `req.acceptedLanguages`
+  * Added `req.acceptedCharsets`
+  * Added "json replacer" setting
+  * Added "json spaces" setting
+  * Added X-Forwarded-Proto support to `res.redirect()`. Closes #92
+  * Added `--less` support to express(1)
+  * Added `express.response` prototype
+  * Added `express.request` prototype
+  * Added `express.application` prototype
+  * Added `app.path()`
+  * Added `app.render()`
+  * Added `res.type()` to replace `res.contentType()`
+  * Changed: `res.redirect()` to add relative support
+  * Changed: enable "jsonp callback" by default
+  * Changed: renamed "case sensitive routes" to "case sensitive routing"
+  * Rewrite of all tests with mocha
+  * Removed "root" setting
+  * Removed `res.redirect('home')` support
+  * Removed `req.notify()`
+  * Removed `app.register()`
+  * Removed `app.redirect()`
+  * Removed `app.is()`
+  * Removed `app.helpers()`
+  * Removed `app.dynamicHelpers()`
+  * Fixed `res.sendfile()` with non-GET. Closes #723
+  * Fixed express(1) public dir for windows. Closes #866
+
+2.5.9/ 2012-04-02 
+==================
+
+  * Added support for PURGE request method [pbuyle]
+  * Fixed `express(1)` generated app `app.address()` before `listening` [mmalecki]
+
+2.5.8 / 2012-02-08 
+==================
+
+  * Update mkdirp dep. Closes #991
+
+2.5.7 / 2012-02-06 
+==================
+
+  * Fixed `app.all` duplicate DELETE requests [mscdex]
+
+2.5.6 / 2012-01-13 
+==================
+
+  * Updated hamljs dev dep. Closes #953
+
+2.5.5 / 2012-01-08 
+==================
+
+  * Fixed: set `filename` on cached templates [matthewleon]
+
+2.5.4 / 2012-01-02 
+==================
+
+  * Fixed `express(1)` eol on 0.4.x. Closes #947
+
+2.5.3 / 2011-12-30 
+==================
+
+  * Fixed `req.is()` when a charset is present
+
+2.5.2 / 2011-12-10 
+==================
+
+  * Fixed: express(1) LF -> CRLF for windows
+
+2.5.1 / 2011-11-17 
+==================
+
+  * Changed: updated connect to 1.8.x
+  * Removed sass.js support from express(1)
+
+2.5.0 / 2011-10-24 
+==================
+
+  * Added ./routes dir for generated app by default
+  * Added npm install reminder to express(1) app gen
+  * Added 0.5.x support
+  * Removed `make test-cov` since it wont work with node 0.5.x
+  * Fixed express(1) public dir for windows. Closes #866
+
+2.4.7 / 2011-10-05 
+==================
+
+  * Added mkdirp to express(1). Closes #795
+  * Added simple _json-config_ example
+  * Added  shorthand for the parsed request's pathname via `req.path`
+  * Changed connect dep to 1.7.x to fix npm issue...
+  * Fixed `res.redirect()` __HEAD__ support. [reported by xerox]
+  * Fixed `req.flash()`, only escape args
+  * Fixed absolute path checking on windows. Closes #829 [reported by andrewpmckenzie]
+
+2.4.6 / 2011-08-22 
+==================
+
+  * Fixed multiple param callback regression. Closes #824 [reported by TroyGoode]
+
+2.4.5 / 2011-08-19 
+==================
+
+  * Added support for routes to handle errors. Closes #809
+  * Added `app.routes.all()`. Closes #803
+  * Added "basepath" setting to work in conjunction with reverse proxies etc.   
+  * Refactored `Route` to use a single array of callbacks
+  * Added support for multiple callbacks for `app.param()`. Closes #801
+Closes #805
+  * Changed: removed .call(self) for route callbacks
+  * Dependency: `qs >= 0.3.1`
+  * Fixed `res.redirect()` on windows due to `join()` usage. Closes #808
+
+2.4.4 / 2011-08-05 
+==================
+
+  * Fixed `res.header()` intention of a set, even when `undefined`
+  * Fixed `*`, value no longer required
+  * Fixed `res.send(204)` support. Closes #771
+
+2.4.3 / 2011-07-14 
+==================
+
+  * Added docs for `status` option special-case. Closes #739
+  * Fixed `options.filename`, exposing the view path to template engines
+
+2.4.2. / 2011-07-06 
+==================
+
+  * Revert "removed jsonp stripping" for XSS
+
+2.4.1 / 2011-07-06 
+==================
+
+  * Added `res.json()` JSONP support. Closes #737
+  * Added _extending-templates_ example. Closes #730
+  * Added "strict routing" setting for trailing slashes
+  * Added support for multiple envs in `app.configure()` calls. Closes #735
+  * Changed: `res.send()` using `res.json()`
+  * Changed: when cookie `path === null` don't default it
+  * Changed; default cookie path to "home" setting. Closes #731
+  * Removed _pids/logs_ creation from express(1)
+
+2.4.0 / 2011-06-28 
+==================
+
+  * Added chainable `res.status(code)`
+  * Added `res.json()`, an explicit version of `res.send(obj)`
+  * Added simple web-service example
+
+2.3.12 / 2011-06-22 
+==================
+
+  * \#express is now on freenode! come join!
+  * Added `req.get(field, param)`
+  * Added links to Japanese documentation, thanks @hideyukisaito!
+  * Added; the `express(1)` generated app outputs the env
+  * Added `content-negotiation` example
+  * Dependency: connect >= 1.5.1 < 2.0.0
+  * Fixed view layout bug. Closes #720
+  * Fixed; ignore body on 304. Closes #701
+
+2.3.11 / 2011-06-04 
+==================
+
+  * Added `npm test`
+  * Removed generation of dummy test file from `express(1)`
+  * Fixed; `express(1)` adds express as a dep
+  * Fixed; prune on `prepublish`
+
+2.3.10 / 2011-05-27 
+==================
+
+  * Added `req.route`, exposing the current route
+  * Added _package.json_ generation support to `express(1)`
+  * Fixed call to `app.param()` function for optional params. Closes #682
+
+2.3.9 / 2011-05-25 
+==================
+
+  * Fixed bug-ish with `../' in `res.partial()` calls
+
+2.3.8 / 2011-05-24
+==================
+
+  * Fixed `app.options()`
+
+2.3.7 / 2011-05-23
+==================
+
+  * Added route `Collection`, ex: `app.get('/user/:id').remove();`
+  * Added support for `app.param(fn)` to define param logic
+  * Removed `app.param()` support for callback with return value
+  * Removed module.parent check from express(1) generated app. Closes #670
+  * Refactored router. Closes #639
+
+2.3.6 / 2011-05-20 
+==================
+
+  * Changed; using devDependencies instead of git submodules
+  * Fixed redis session example
+  * Fixed markdown example
+  * Fixed view caching, should not be enabled in development
+
+2.3.5 / 2011-05-20 
+==================
+
+  * Added export `.view` as alias for `.View`
+
+2.3.4 / 2011-05-08 
+==================
+
+  * Added `./examples/say`
+  * Fixed `res.sendfile()` bug preventing the transfer of files with spaces
+
+2.3.3 / 2011-05-03 
+==================
+
+  * Added "case sensitive routes" option.
+  * Changed; split methods supported per rfc [slaskis]
+  * Fixed route-specific middleware when using the same callback function several times
+
+2.3.2 / 2011-04-27 
+==================
+
+  * Fixed view hints
+
+2.3.1 / 2011-04-26 
+==================
+
+  * Added `app.match()` as `app.match.all()`
+  * Added `app.lookup()` as `app.lookup.all()`
+  * Added `app.remove()` for `app.remove.all()`
+  * Added `app.remove.VERB()`
+  * Fixed template caching collision issue. Closes #644
+  * Moved router over from connect and started refactor
+
+2.3.0 / 2011-04-25 
+==================
+
+  * Added options support to `res.clearCookie()`
+  * Added `res.helpers()` as alias of `res.locals()`
+  * Added; json defaults to UTF-8 with `res.send()`. Closes #632. [Daniel   * Dependency `connect >= 1.4.0`
+  * Changed; auto set Content-Type in res.attachement [Aaron Heckmann]
+  * Renamed "cache views" to "view cache". Closes #628
+  * Fixed caching of views when using several apps. Closes #637
+  * Fixed gotcha invoking `app.param()` callbacks once per route middleware. 
+Closes #638
+  * Fixed partial lookup precedence. Closes #631
+Shaw]
+
+2.2.2 / 2011-04-12 
+==================
+
+  * Added second callback support for `res.download()` connection errors
+  * Fixed `filename` option passing to template engine
+
+2.2.1 / 2011-04-04 
+==================
+
+  * Added `layout(path)` helper to change the layout within a view. Closes #610
+  * Fixed `partial()` collection object support.
+    Previously only anything with `.length` would work.
+    When `.length` is present one must still be aware of holes,
+    however now `{ collection: {foo: 'bar'}}` is valid, exposes
+    `keyInCollection` and `keysInCollection`.
+
+  * Performance improved with better view caching
+  * Removed `request` and `response` locals
+  * Changed; errorHandler page title is now `Express` instead of `Connect`
+
+2.2.0 / 2011-03-30 
+==================
+
+  * Added `app.lookup.VERB()`, ex `app.lookup.put('/user/:id')`. Closes #606
+  * Added `app.match.VERB()`, ex `app.match.put('/user/12')`. Closes #606
+  * Added `app.VERB(path)` as alias of `app.lookup.VERB()`.
+  * Dependency `connect >= 1.2.0`
+
+2.1.1 / 2011-03-29 
+==================
+
+  * Added; expose `err.view` object when failing to locate a view
+  * Fixed `res.partial()` call `next(err)` when no callback is given [reported by aheckmann]
+  * Fixed; `res.send(undefined)` responds with 204 [aheckmann]
+
+2.1.0 / 2011-03-24 
+==================
+
+  * Added `<root>/_?<name>` partial lookup support. Closes #447
+  * Added `request`, `response`, and `app` local variables
+  * Added `settings` local variable, containing the app's settings
+  * Added `req.flash()` exception if `req.session` is not available
+  * Added `res.send(bool)` support (json response)
+  * Fixed stylus example for latest version
+  * Fixed; wrap try/catch around `res.render()`
+
+2.0.0 / 2011-03-17 
+==================
+
+  * Fixed up index view path alternative.
+  * Changed; `res.locals()` without object returns the locals
+
+2.0.0rc3 / 2011-03-17 
+==================
+
+  * Added `res.locals(obj)` to compliment `res.local(key, val)`
+  * Added `res.partial()` callback support
+  * Fixed recursive error reporting issue in `res.render()`
+
+2.0.0rc2 / 2011-03-17 
+==================
+
+  * Changed; `partial()` "locals" are now optional
+  * Fixed `SlowBuffer` support. Closes #584 [reported by tyrda01]
+  * Fixed .filename view engine option [reported by drudge]
+  * Fixed blog example
+  * Fixed `{req,res}.app` reference when mounting [Ben Weaver]
+
+2.0.0rc / 2011-03-14 
+==================
+
+  * Fixed; expose `HTTPSServer` constructor
+  * Fixed express(1) default test charset. Closes #579 [reported by secoif]
+  * Fixed; default charset to utf-8 instead of utf8 for lame IE [reported by NickP]
+
+2.0.0beta3 / 2011-03-09 
+==================
+
+  * Added support for `res.contentType()` literal
+    The original `res.contentType('.json')`,
+    `res.contentType('application/json')`, and `res.contentType('json')`
+    will work now.
+  * Added `res.render()` status option support back
+  * Added charset option for `res.render()`
+  * Added `.charset` support (via connect 1.0.4)
+  * Added view resolution hints when in development and a lookup fails
+  * Added layout lookup support relative to the page view.
+    For example while rendering `./views/user/index.jade` if you create
+    `./views/user/layout.jade` it will be used in favour of the root layout.
+  * Fixed `res.redirect()`. RFC states absolute url [reported by unlink]
+  * Fixed; default `res.send()` string charset to utf8
+  * Removed `Partial` constructor (not currently used)
+
+2.0.0beta2 / 2011-03-07 
+==================
+
+  * Added res.render() `.locals` support back to aid in migration process
+  * Fixed flash example
+
+2.0.0beta / 2011-03-03 
+==================
+
+  * Added HTTPS support
+  * Added `res.cookie()` maxAge support
+  * Added `req.header()` _Referrer_ / _Referer_ special-case, either works
+  * Added mount support for `res.redirect()`, now respects the mount-point
+  * Added `union()` util, taking place of `merge(clone())` combo
+  * Added stylus support to express(1) generated app
+  * Added secret to session middleware used in examples and generated app
+  * Added `res.local(name, val)` for progressive view locals
+  * Added default param support to `req.param(name, default)`
+  * Added `app.disabled()` and `app.enabled()`
+  * Added `app.register()` support for omitting leading ".", either works
+  * Added `res.partial()`, using the same interface as `partial()` within a view. Closes #539
+  * Added `app.param()` to map route params to async/sync logic
+  * Added; aliased `app.helpers()` as `app.locals()`. Closes #481
+  * Added extname with no leading "." support to `res.contentType()`
+  * Added `cache views` setting, defaulting to enabled in "production" env
+  * Added index file partial resolution, eg: partial('user') may try _views/user/index.jade_.
+  * Added `req.accepts()` support for extensions
+  * Changed; `res.download()` and `res.sendfile()` now utilize Connect's
+    static file server `connect.static.send()`.
+  * Changed; replaced `connect.utils.mime()` with npm _mime_ module
+  * Changed; allow `req.query` to be pre-defined (via middleware or other parent
+  * Changed view partial resolution, now relative to parent view
+  * Changed view engine signature. no longer `engine.render(str, options, callback)`, now `engine.compile(str, options) -> Function`, the returned function accepts `fn(locals)`.
+  * Fixed `req.param()` bug returning Array.prototype methods. Closes #552
+  * Fixed; using `Stream#pipe()` instead of `sys.pump()` in `res.sendfile()`
+  * Fixed; using _qs_ module instead of _querystring_
+  * Fixed; strip unsafe chars from jsonp callbacks
+  * Removed "stream threshold" setting
+
+1.0.8 / 2011-03-01 
+==================
+
+  * Allow `req.query` to be pre-defined (via middleware or other parent app)
+  * "connect": ">= 0.5.0 < 1.0.0". Closes #547
+  * Removed the long deprecated __EXPRESS_ENV__ support
+
+1.0.7 / 2011-02-07 
+==================
+
+  * Fixed `render()` setting inheritance.
+    Mounted apps would not inherit "view engine"
+
+1.0.6 / 2011-02-07 
+==================
+
+  * Fixed `view engine` setting bug when period is in dirname
+
+1.0.5 / 2011-02-05 
+==================
+
+  * Added secret to generated app `session()` call
+
+1.0.4 / 2011-02-05 
+==================
+
+  * Added `qs` dependency to _package.json_
+  * Fixed namespaced `require()`s for latest connect support
+
+1.0.3 / 2011-01-13 
+==================
+
+  * Remove unsafe characters from JSONP callback names [Ryan Grove]
+
+1.0.2 / 2011-01-10 
+==================
+
+  * Removed nested require, using `connect.router`
+
+1.0.1 / 2010-12-29 
+==================
+
+  * Fixed for middleware stacked via `createServer()`
+    previously the `foo` middleware passed to `createServer(foo)`
+    would not have access to Express methods such as `res.send()`
+    or props like `req.query` etc.
+
 1.0.0 / 2010-11-16 
 ==================
 

LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2009-2010 TJ Holowaychuk <tj@vision-media.ca>
+Copyright (c) 2009-2011 TJ Holowaychuk <tj@vision-media.ca>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

Makefile

@@ -1,76 +1,36 @@
 
-PREFIX ?= /usr/local
-LIB_PREFIX = ~/.node_libraries
+REPORTER = dot
 
-DOCS = docs/index.md \
-	   docs/executable.md \
-	   docs/contrib.md \
-	   docs/guide.md \
-	   docs/migrate.md \
-	   docs/applications.md
+docs: docs/express.md
 
-MANPAGES =$(DOCS:.md=.1)
-HTMLDOCS =$(DOCS:.md=.html)
+docs/express.md: docs/application.md docs/request.md docs/response.md
+	cat $^ > $@
 
-install: install-docs
-	@mkdir -p $(PREFIX)/bin
-	@mkdir -p $(LIB_PREFIX)
-	cp -f bin/express $(PREFIX)/bin/express
-	cp -fr lib/express $(LIB_PREFIX)/express
+docs/%.md: lib/%.js
+	@mkdir -p docs
+	dox --raw < $< | ./support/docs > $@
 
-uninstall: uninstall-docs
-	rm -f $(PREFIX)/bin/express
-	rm -fr $(LIB_PREFIX)/express
+test: test-unit test-acceptance
 
-install-support:
-	cd support/connect && $(MAKE) install
+test-unit:
+	@NODE_ENV=test ./node_modules/.bin/mocha \
+		--reporter $(REPORTER)
 
-uninstall-support:
-	cd support/connect && $(MAKE) uninstall
+test-acceptance:
+	@NODE_ENV=test ./node_modules/.bin/mocha \
+		--reporter $(REPORTER) \
+		test/acceptance/*.js
 
-install-docs:
-	@mkdir -p $(PREFIX)/share/man/man1
-	cp -f docs/executable.1 $(PREFIX)/share/man/man1/express.1
+test-cov: lib-cov
+	@EXPRESS_COV=1 $(MAKE) test REPORTER=html-cov > coverage.html
 
-uninstall-docs:
-	rm -f $(PREFIX)/share/man/man1/express.1
-
-test:
-	@NODE_ENV=test ./support/expresso/bin/expresso \
-		-I lib \
-		-I support/connect/lib \
-		-I support/haml/lib \
-		-I support/jade/lib \
-		-I support/ejs/lib \
-		$(TESTFLAGS) \
-		test/*.test.js
-
-test-cov:
-	@TESTFLAGS=--cov $(MAKE) test
-
-docs: docs/api.html $(MANPAGES) $(HTMLDOCS)
-	@ echo "... generating TOC"
-	@./support/toc.js docs/guide.html
-
-docs/api.html: lib/express/*.js
-	dox \
-		--private \
-		--title Express \
-		--desc "High performance web framework for [node](http://nodejs.org)." \
-		$(shell find lib/express/* -type f) > $@
-
-%.1: %.md
-	@echo "... $< -> $@"
-	@ronn -r --pipe $< > $@
-
-%.html: %.md
-	@echo "... $< -> $@"
-	@ronn -5 --pipe --fragment $< \
-	  | cat docs/layout/head.html - docs/layout/foot.html \
-	  | sed 's/NAME/Express/g' \
-	  > $@
+lib-cov:
+	@jscoverage lib lib-cov
 
 docclean:
-	rm -f docs/*.{1,html}
+	rm -fr docs
 
-.PHONY: install uninstall install-docs install-support uninstall-support install-docs uninstall-docs test test-cov docs docclean
+benchmark:
+	@./support/bench
+
+.PHONY: docs docclean test test-unit test-acceptance benchmark

Readme.md

@@ -1,87 +1,167 @@
 
-# Express
-      
-  Insanely fast (and small) server-side JavaScript web development framework
-  built on [node](http://nodejs.org) and [Connect](http://github.com/senchalabs/connect).
-  
-     var app = express.createServer();
-    
-     app.get('/', function(req, res){
-         res.send('Hello World');
-     });
+![express logo](http://f.cl.ly/items/0V2S1n0K1i3y1c122g04/Screen%20Shot%202012-04-11%20at%209.59.42%20AM.png)
 
-	 app.listen(3000);
+  Fast, unopinionated, minimalist web framework for [node](http://nodejs.org). [![Build Status](https://secure.travis-ci.org/visionmedia/express.png)](http://travis-ci.org/visionmedia/express)
+
+```js
+var express = require('express');
+var app = express();
+
+app.get('/', function(req, res){
+  res.send('Hello World');
+});
+
+app.listen(3000);
+```
 
 ## Installation
 
-npm:
+    $ npm install -g express
 
-    $ npm install express
+ To install the 3.0 alpha:
+ 
+    $ npm install -g express@3.0
 
-curl:
+## Quick Start
 
-    $ curl -# http://expressjs.com/install.sh | sh
+ The quickest way to get started with express is to utilize the executable `express(1)` to generate an application as shown below:
+
+ Create the app:
+
+    $ npm install -g express
+    $ express /tmp/foo && cd /tmp/foo
+
+ Install dependencies:
+
+    $ npm install
+
+ Start the server:
+
+    $ node app
 
 ## Features
 
+  * Built on [Connect](http://github.com/senchalabs/connect)
   * Robust routing
-  * Redirection helpers
-  * Dynamic view helpers
+  * HTTP helpers (redirection, caching, etc)
+  * View system supporting 14+ template engines
   * Content negotiation
   * Focus on high performance
-  * View rendering and partials support
   * Environment based configuration
-  * Session based flash notifications
-  * Built on [Connect](http://github.com/senchalabs/connect)
-  * High test coverage
   * Executable for generating applications quickly
-  * Application level view options
+  * High test coverage
 
-Via Connect:
+## Philosophy
 
-  * Session support
-  * Cache API
-  * Mime helpers
-  * ETag support
-  * Persistent flash notifications
-  * Cookie support
-  * JSON-RPC
-  * Logging
-  * and _much_ more!
-
-## Contributors
-
-The following are the major contributors of Express (in no specific order).
-
-  * TJ Holowaychuk ([visionmedia](http://github.com/visionmedia))
-  * Ciaran Jessup ([ciaranj](http://github.com/ciaranj))
-  * Aaron Heckmann ([aheckmann](http://github.com/aheckmann))
-  * Guillermo Rauch ([guille](http://github.com/guille))
+  The Express philosophy is to provide small, robust tooling for HTTP servers. Making
+  it a great solution for single page applications, web sites, hybrids, or public
+  HTTP APIs.
+  
+  Built on Connect you can use _only_ what you need, and nothing more, applications
+  can be as big or as small as you like, even a single file. Express does
+  not force you to use any specific ORM or template engine. With support for over
+  14 template engines via [Consolidate.js](http://github.com/visionmedia/consolidate.js)
+  you can quickly craft your perfect framework.
 
 ## More Information
 
-  * Express [Contrib](http://github.com/visionmedia/express-contrib) repo for additional functionality
-  * Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
+  * Join #express on freenode
   * [Google Group](http://groups.google.com/group/express-js) for discussion
+  * Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
   * Visit the [Wiki](http://github.com/visionmedia/express/wiki)
+  * [日本語ドキュメンテーション](http://hideyukisaito.com/doc/expressjs/) by [hideyukisaito](https://github.com/hideyukisaito)
+  * [Русскоязычная документация](http://express-js.ru/)
 
-## Node Compatibility
-    
-The latest release of Express is compatible with node --version:
+## Viewing Examples
 
-    v0.2.4
+First install the dev dependencies to install all the example / test suite deps:
 
-and connect --version:
+    $ cd express
+    $ npm install
 
-    0.3.0
+then run whichever tests you want:
 
-Express 1.x is maintained in the _1.x_ branch.
+    $ node examples/content-negotiation
+
+## Running Tests
+
+To run the test suite first invoke the following command within the repo, installing the development dependencies:
+
+    $ npm install
+
+then run the tests:
+
+    $ make test
+
+## Contributors
+
+```
+project: express
+commits: 3559
+active : 468 days
+files  : 237
+authors: 
+ 1891	Tj Holowaychuk          53.1%
+ 1285	visionmedia             36.1%
+  182	TJ Holowaychuk          5.1%
+   54	Aaron Heckmann          1.5%
+   34	csausdev                1.0%
+   26	ciaranj                 0.7%
+   21	Robert Sköld          0.6%
+    6	Guillermo Rauch         0.2%
+    3	Dav Glass               0.1%
+    3	Nick Poulden            0.1%
+    2	Randy Merrill           0.1%
+    2	Benny Wong              0.1%
+    2	Hunter Loftis           0.1%
+    2	Jake Gordon             0.1%
+    2	Brian McKinney          0.1%
+    2	Roman Shtylman          0.1%
+    2	Ben Weaver              0.1%
+    2	Dave Hoover             0.1%
+    2	Eivind Fjeldstad        0.1%
+    2	Daniel Shaw             0.1%
+    1	Matt Colyer             0.0%
+    1	Pau Ramon               0.0%
+    1	Pero Pejovic            0.0%
+    1	Peter Rekdal Sunde      0.0%
+    1	Raynos                  0.0%
+    1	Teng Siong Ong          0.0%
+    1	Viktor Kelemen          0.0%
+    1	ctide                   0.0%
+    1	8bitDesigner            0.0%
+    1	isaacs                  0.0%
+    1	mgutz                   0.0%
+    1	pikeas                  0.0%
+    1	shuwatto                0.0%
+    1	tstrimple               0.0%
+    1	ewoudj                  0.0%
+    1	Adam Sanderson          0.0%
+    1	Andrii Kostenko         0.0%
+    1	Andy Hiew               0.0%
+    1	Arpad Borsos            0.0%
+    1	Ashwin Purohit          0.0%
+    1	Benjen                  0.0%
+    1	Darren Torpey           0.0%
+    1	Greg Ritter             0.0%
+    1	Gregory Ritter          0.0%
+    1	James Herdman           0.0%
+    1	Jim Snodgrass           0.0%
+    1	Joe McCann              0.0%
+    1	Jonathan Dumaine        0.0%
+    1	Jonathan Palardy        0.0%
+    1	Jonathan Zacsh          0.0%
+    1	Justin Lilly            0.0%
+    1	Ken Sato                0.0%
+    1	Maciej Małecki         0.0%
+    1	Masahiro Hayashi        0.0%
+```
 
 ## License 
 
 (The MIT License)
 
-Copyright (c) 2009-2010 TJ Holowaychuk <tj@vision-media.ca>
+Copyright (c) 2009-2012 TJ Holowaychuk <tj@vision-media.ca>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

bin/express

@@ -4,82 +4,87 @@
  * Module dependencies.
  */
 
-var fs = require('fs')
-  , sys = require('sys')
-  , exec = require('child_process').exec;
+var exec = require('child_process').exec
+  , program = require('commander')
+  , mkdirp = require('mkdirp')
+  , pkg = require('../package.json')
+  , version = pkg.version
+  , os = require('os')
+  , fs = require('fs');
+
+// CLI
+
+program
+  .version(version)
+  .option('-s, --sessions', 'add session support')
+  .option('-e, --ejs', 'add ejs engine support (defaults to jade)')
+  .option('-J, --jshtml', 'add jshtml engine support (defaults to jade)')
+  .option('-h, --hjs', 'add hogan.js engine support')
+  .option('-c, --css <engine>', 'add stylesheet <engine> support (less|stylus) (defaults to plain css)')
+  .option('-f, --force', 'force on non-empty directory')
+  .parse(process.argv);
+
+// Path
+
+var path = program.args.shift() || '.';
+
+// end-of-line code
+
+var eol = 'win32' == os.platform() ? '\r\n' : '\n'
+
+// Template engine
+
+program.template = 'jade';
+if (program.ejs) program.template = 'ejs';
+if (program.jshtml) program.template = 'jshtml';
+if (program.hjs) program.template = 'hjs';
 
 /**
- * Framework version.
+ * Routes index template.
  */
 
-var version = '1.0.0';
-
-/**
- * stdin stream.
- */
-
-var stdin;
-
-/**
- * Add session support.
- */
-
-var sessions = false;
-
-/**
- * CSS engine to utilize.
- */
-
-var cssEngine;
-
-/**
- * Template engine to utilize.
- */
-
-var templateEngine = 'jade';
-
-/**
- * Usage documentation.
- */
-
-var usage = ''
-  + '\x1b[1mUsage\x1b[0m: express [options] [PATH]\n'
-  + '\n'
-  + '\x1b[1mOptions\x1b[0m:\n'
-  + '  -s, --sessions         Add session support\n'
-  + '  -t, --template ENGINE  Add template ENGINE support (jade|ejs). Defaults to jade\n'
-  + '  -c, --css ENGINE       Add stylesheet ENGINE support (less|sass). Defaults to plain css\n'
-  + '  -v, --version          Output framework version\n'
-  + '  -h, --help             Output help information\n'
-  ;
+var index = [
+    ''
+  , '/*'
+  , ' * GET home page.'
+  , ' */'
+  , ''
+  , 'exports.index = function(req, res){'
+  , '  res.render(\'index\', { title: \'Express\' });'
+  , '};'
+].join(eol);
 
 /**
  * Jade layout template.
  */
 
 var jadeLayout = [
-    '!!!'
+    'doctype 5'
   , 'html'
   , '  head'
   , '    title= title'
   , '    link(rel=\'stylesheet\', href=\'/stylesheets/style.css\')'
-  , '  body!= body'
-].join('\n');
+  , '  body'
+  , '    block content'
+].join(eol);
 
 /**
  * Jade index template.
  */
 
 var jadeIndex = [
-    'h1= title'
-  , 'p Welcome to #{title}'
-].join('\n');
+    'extends layout'
+  , ''
+  , 'block content'
+  , '  h1= title'
+  , '  p Welcome to #{title}'
+].join(eol);
 
 /**
- * EJS layout template.
+ * EJS index template.
  */
 
-var ejsLayout = [
+var ejsIndex = [
     '<!DOCTYPE html>'
   , '<html>'
   , '  <head>'
@@ -87,19 +92,54 @@ var ejsLayout = [
   , '    <link rel=\'stylesheet\' href=\'/stylesheets/style.css\' />'
   , '  </head>'
   , '  <body>'
-  , '    <%- body %>'
+  , '    <h1><%= title %></h1>'
+  , '    <p>Welcome to <%= title %></p>'
   , '  </body>'
   , '</html>'
-].join('\n');
+].join(eol);
 
 /**
- * EJS index template.
+ * JSHTML layout template.
  */
 
-var ejsIndex = [
-    '<h1><%= title %></h1>'
-  , '<p>Welcome to <%= title %></p>'
-  ].join('\n');
+var jshtmlLayout = [
+    '<!DOCTYPE html>'
+  , '<html>'
+  , '  <head>'
+  , '    <title> @write(title) </title>'
+  , '    <link rel=\'stylesheet\' href=\'/stylesheets/style.css\' />'
+  , '  </head>'
+  , '  <body>'
+  , '    @write(body)'
+  , '  </body>'
+  , '</html>'
+].join(eol);
+
+/**
+ * JSHTML index template.
+ */
+
+var jshtmlIndex = [
+    '<h1>@write(title)</h1>'
+  , '<p>Welcome to @write(title)</p>'
+].join(eol);
+
+/**
+ * Hogan.js index template.
+ */
+var hjsIndex = [
+    '<!DOCTYPE html>'
+  , '<html>'
+  , '  <head>'
+  , '    <title>{{ title }}</title>'
+  , '    <link rel=\'stylesheet\' href=\'/stylesheets/style.css\' />'
+  , '  </head>'
+  , '  <body>'
+  , '    <h1>{{ title }}</h1>'
+  , '    <p>Welcome to {{ title }}</p>'
+  , '  </body>'
+  , '</html>'
+].join(eol);
 
 /**
  * Default css template.
@@ -110,7 +150,11 @@ var css = [
   , '  padding: 50px;'
   , '  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;'
   , '}'
-].join('\n');
+  , ''
+  , 'a {'
+  , '  color: #00B7FF;'
+  , '}'
+].join(eol);
 
 /**
  * Default less template.
@@ -121,43 +165,23 @@ var less = [
   , '  padding: 50px;'
   , '  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;'
   , '}'
-].join('\n');
+  , ''
+  , 'a {'
+  , '  color: #00B7FF;'
+  , '}'
+].join(eol);
 
 /**
- * Default sass template.
+ * Default stylus template.
  */
 
-var sass = [
+var stylus = [
     'body'
-  , '  :padding 50px'
-  , '  :font 14px "Lucida Grande", Helvetica, Arial, sans-serif'
-].join('\n');
-
-/**
- * App test template.
- */
-
-var appTest = [
-    ""
-  , "// Run $ expresso"
-  , ""
-  , "/**"
-  , " * Module dependencies."
-  , " */"
-  , ""
-  , "var app = require('../app');"
-  , "",
-  , "module.exports = {"
-  , "  'GET /': function(assert){"
-  , "    assert.response(app,"
-  , "      { url: '/' },"
-  , "      { status: 200, headers: { 'Content-Type': 'text/html; charset=utf-8' }},"
-  , "      function(res){"
-  , "        assert.includes(res.body, '<title>Express</title>');"
-  , "      });"
-  , "  }"
-  , "};"
-].join('\n');
+  , '  padding: 50px'
+  , '  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif'
+  , 'a'
+  , '  color: #00B7FF'
+].join(eol);
 
 /**
  * App template.
@@ -169,96 +193,46 @@ var app = [
   , ' * Module dependencies.'
   , ' */'
   , ''
-  , 'var express = require(\'express\');'
+  , 'var express = require(\'express\')'
+  , '  , routes = require(\'./routes\')'
+  , '  , http = require(\'http\');'
   , ''
-  , 'var app = module.exports = express.createServer();'
-  , ''
-  , '// Configuration'
+  , 'var app = express();'
   , ''
   , 'app.configure(function(){'
+  , '  app.set(\'port\', process.env.PORT || 3000);'
   , '  app.set(\'views\', __dirname + \'/views\');'
   , '  app.set(\'view engine\', \':TEMPLATE\');'
-  , '  app.use(express.bodyDecoder());'
-  , '  app.use(express.methodOverride());:SESS:CSS'
-  , '  app.use(app.router);'
-  , '  app.use(express.staticProvider(__dirname + \'/public\'));'
+  , '  app.use(express.favicon());'
+  , '  app.use(express.logger(\'dev\'));'
+  , '  app.use(express.bodyParser());'
+  , '  app.use(express.methodOverride());{sess}'
+  , '  app.use(app.router);{css}'
+  , '  app.use(express.static(__dirname + \'/public\'));'
   , '});'
   , ''
   , 'app.configure(\'development\', function(){'
-  , '  app.use(express.errorHandler({ dumpExceptions: true, showStack: true })); '
+  , '  app.use(express.errorHandler());'
   , '});'
   , ''
-  , 'app.configure(\'production\', function(){'
-  , '  app.use(express.errorHandler()); '
+  , 'app.get(\'/\', routes.index);'
+  , ''
+  , 'http.createServer(app).listen(app.get(\'port\'), function(){'
+  , '  console.log("Express server listening on port " + app.get(\'port\'));'
   , '});'
   , ''
-  , '// Routes'
-  , ''
-  , 'app.get(\'/\', function(req, res){'
-  , '  res.render(\'index\', {'
-  , '    locals: {'
-  , '      title: \'Express\''
-  , '    }'
-  , '  });'
-  , '});'
-  , ''
-  , '// Only listen on $ node app.js'
-  , ''
-  , 'if (!module.parent) {'
-  , '  app.listen(3000);'
-  , '  console.log("Express server listening on port %d", app.address().port)'
-  , '}'
-  , ''
-].join('\n');
-
-// Parse arguments
-
-var args = process.argv.slice(2)
-  , path = '.';
-
-while (args.length) {
-  var arg = args.shift();
-  switch (arg) {
-    case '-h':
-    case '--help':
-      abort(usage);
-      break;
-    case '-v':
-    case '--version':
-      abort(version);
-      break;
-    case '-s':
-    case '--session':
-    case '--sessions':
-      sessions = true;
-      break;
-    case '-c':
-    case '--css':
-      args.length
-        ? (cssEngine = args.shift())
-        : abort('--css requires an argument');
-      break;
-    case '-t':
-    case '--template':
-      args.length
-        ? (templateEngine = args.shift())
-        : abort('--template requires an argument');
-      break;
-    default:
-        path = arg;
-  }
-}
+].join(eol);
 
 // Generate application
 
 (function createApplication(path) {
   emptyDirectory(path, function(empty){
-    if (empty) {
+    if (empty || program.force) {
       createApplicationAt(path);
     } else {
-      confirm('destination is not empty, continue? ', function(ok){
+      program.confirm('destination is not empty, continue? ', function(ok){
         if (ok) {
-          stdin.destroy();
+          process.stdin.destroy();
           createApplicationAt(path);
         } else {
           abort('aborting');
@@ -275,70 +249,104 @@ while (args.length) {
  */
 
 function createApplicationAt(path) {
+  console.log();
+  process.on('exit', function(){
+    console.log();
+    console.log('   install dependencies:');
+    console.log('     $ cd %s && npm install', path);
+    console.log();
+    console.log('   run the app:');
+    console.log('     $ node app');
+    console.log();
+  });
+
   mkdir(path, function(){
-    mkdir(path + '/pids');
-    mkdir(path + '/logs');
+    mkdir(path + '/public');
     mkdir(path + '/public/javascripts');
     mkdir(path + '/public/images');
     mkdir(path + '/public/stylesheets', function(){
-      switch (cssEngine) {
+      switch (program.css) {
         case 'less':
           write(path + '/public/stylesheets/style.less', less);
           break;
-        case 'sass':
-          write(path + '/public/stylesheets/style.sass', sass);
+        case 'stylus':
+          write(path + '/public/stylesheets/style.styl', stylus);
           break;
         default:
           write(path + '/public/stylesheets/style.css', css);
       }
     });
-    mkdir(path + '/views/partials', function(){
-      switch (templateEngine) {
+
+    mkdir(path + '/routes', function(){
+      write(path + '/routes/index.js', index);
+    });
+
+    mkdir(path + '/views', function(){
+      switch (program.template) {
         case 'ejs':
-          write(path + '/views/layout.ejs', ejsLayout);
           write(path + '/views/index.ejs', ejsIndex);
           break;
         case 'jade':
           write(path + '/views/layout.jade', jadeLayout);
           write(path + '/views/index.jade', jadeIndex);
           break;
+        case 'jshtml':
+          write(path + '/views/layout.jshtml', jshtmlLayout);
+          write(path + '/views/index.jshtml', jshtmlIndex);
+          break;
+        case 'hjs':
+          write(path + '/views/index.hjs', hjsIndex);
+          break;
+
       }
     });
-    mkdir(path + '/test', function(){
-      write(path + '/test/app.test.js', appTest);
-    });
 
     // CSS Engine support
-    switch (cssEngine) {
-      case 'sass':
+    switch (program.css) {
       case 'less':
-        app = app.replace(':CSS', '\n  app.use(express.compiler({ src: __dirname + \'/public\', enable: [\'' + cssEngine + '\'] }));');
+        app = app.replace('{css}', eol + '  app.use(require(\'less-middleware\')({ src: __dirname + \'/public\' }));');
+        break;
+      case 'stylus':
+        app = app.replace('{css}', eol + '  app.use(require(\'stylus\').middleware(__dirname + \'/public\'));');
         break;
       default:
-        app = app.replace(':CSS', '');
+        app = app.replace('{css}', '');
     }
 
     // Session support
-    app = app.replace(':SESS', sessions
-      ? '\n  app.use(express.cookieDecoder());\n  app.use(express.session());'
+    app = app.replace('{sess}', program.sessions
+      ? eol + '  app.use(express.cookieParser(\'your secret here\'));' + eol + '  app.use(express.session());'
       : '');
 
     // Template support
-    app = app.replace(':TEMPLATE', templateEngine);
+    app = app.replace(':TEMPLATE', program.template);
 
-    write(path + '/app.js', app);
-
-    // Suggestions
-    process.on('exit', function(){
-      if (cssEngine) {
-        console.log('   - make sure you have installed %s: \x1b[33m$ npm install %s\x1b[0m'
-          , cssEngine
-          , cssEngine);
+    // package.json
+    var pkg = {
+        name: 'application-name'
+      , version: '0.0.1'
+      , private: true
+      , scripts: { start: 'node app' }
+      , dependencies: {
+        express: version
       }
-      console.log('   - make sure you have installed %s: \x1b[33m$ npm install %s\x1b[0m'
-        , templateEngine
-        , templateEngine);
-    });
+    }
+
+    if (program.template) pkg.dependencies[program.template] = '*';
+
+    // CSS Engine support
+    switch (program.css) {
+      case 'less':
+        pkg.dependencies['less-middleware'] = '*';
+        break;
+      default:
+        if (program.css) {
+          pkg.dependencies[program.css] = '*';
+        }
+    }
+
+    write(path + '/package.json', JSON.stringify(pkg, null, 2));
+    write(path + '/app.js', app);
   });
 }
 
@@ -351,7 +359,7 @@ function createApplicationAt(path) {
 
 function emptyDirectory(path, fn) {
   fs.readdir(path, function(err, files){
-    if (err && err.errno !== process.ENOENT) throw err;
+    if (err && 'ENOENT' != err.code) throw err;
     fn(!files || !files.length);
   });
 }
@@ -365,37 +373,7 @@ function emptyDirectory(path, fn) {
 
 function write(path, str) {
   fs.writeFile(path, str);
-  console.log('   \x1b[33mcreate\x1b[0m : ' + path);
-}
-
-/**
- * Prompt confirmation with the given `msg`.
- *
- * @param {String} msg
- * @param {Function} fn
- */
-
-function confirm(msg, fn) {
-  prompt(msg, function(val){
-    fn(/^ *y(es)?/i.test(val));
-  });
-}
-
-/**
- * Prompt input with the given `msg` and callback `fn`.
- *
- * @param {String} msg
- * @param {Function} fn
- */
-
-function prompt(msg, fn) {
-  stdin = stdin || process.openStdin();
-  sys[msg[msg.length - 1] == ' ' ? 'print' : 'puts'](msg);
-  stdin.setEncoding('ascii');
-  stdin.addListener('data', function(data){
-    fn(data);
-    stdin.removeListener('data', arguments.callee);
-  });
+  console.log('   \x1b[36mcreate\x1b[0m : ' + path);
 }
 
 /**
@@ -406,9 +384,9 @@ function prompt(msg, fn) {
  */
 
 function mkdir(path, fn) {
-  exec('mkdir -p ' + path, function(err){
+  mkdirp(path, 0755, function(err){
     if (err) throw err;
-    console.log('   \x1b[33mcreate\x1b[0m : ' + path);
+    console.log('   \033[36mcreate\033[0m : ' + path);
     fn && fn();
   });
 }

client.js

@@ -0,0 +1,25 @@
+
+var http = require('http');
+
+var times = 50;
+
+while (times--) {
+  var req = http.request({
+      port: 3000
+    , method: 'POST'
+    , headers: { 'Content-Type': 'application/x-www-form-urlencoded' }
+  });
+
+  req.on('response', function(res){
+    console.log(res.statusCode);
+  });
+
+  var n = 500000;
+  while (n--) {
+    req.write('foo=bar&bar=baz&');
+  }
+
+  req.write('foo=bar&bar=baz');
+
+  req.end();
+}

docs/application.md

@@ -0,0 +1,181 @@
+
+# app
+
+  Application prototype.
+
+# app.use()
+
+  Proxy `connect#use()` to apply settings to
+  mounted applications.
+
+# app.engine()
+
+  Register the given template engine callback `fn`
+  as `ext`.
+  
+  By default will `require()` the engine based on the
+  file extension. For example if you try to render
+  a "foo.jade" file Express will invoke the following internally:
+  
+      app.engine('jade', require('jade').__express);
+  
+  For engines that do not provide `.__express` out of the box,
+  or if you wish to "map" a different extension to the template engine
+  you may use this method. For example mapping the EJS template engine to
+  ".html" files
+  
+      app.engine('html', require('ejs').renderFile);
+  
+  In this case EJS provides a `.renderFile()` method with
+  the same signature that Express expects: `(path, options, callback)`,
+  though note that it aliases this method as `ejs.__express` internally
+  so if you're using ".ejs" extensions you dont need to do anything.
+  
+  Some template engines do not follow this convention, the
+  [Consolidate.js](https://github.com/visionmedia/consolidate.js)
+  library was created to map all of node's popular template
+  engines to follow this convention, thus allowing them to
+  work seemlessly within Express.
+
+# app.param()
+
+  Map the given param placeholder `name`(s) to the given callback(s).
+  
+  Parameter mapping is used to provide pre-conditions to routes
+  which use normalized placeholders. For example a _:user_id_ parameter
+  could automatically load a user's information from the database without
+  any additional code,
+  
+  The callback uses the samesignature as middleware, the only differencing
+  being that the value of the placeholder is passed, in this case the _id_
+  of the user. Once the `next()` function is invoked, just like middleware
+  it will continue on to execute the route, or subsequent parameter functions.
+  
+       app.param('user_id', function(req, res, next, id){
+         User.find(id, function(err, user){
+           if (err) {
+             next(err);
+           } else if (user) {
+             req.user = user;
+             next();
+           } else {
+             next(new Error('failed to load user'));
+           }
+         });
+       });
+
+# app.set()
+
+  Assign `setting` to `val`, or return `setting`'s value.
+  
+     app.set('foo', 'bar');
+     app.get('foo');
+     // => "bar"
+  
+  Mounted servers inherit their parent server's settings.
+
+# app.enabled()
+
+  Check if `setting` is enabled (truthy).
+  
+     app.enabled('foo')
+     // => false
+  
+     app.enable('foo')
+     app.enabled('foo')
+     // => true
+
+# app.disabled()
+
+  Check if `setting` is disabled.
+  
+     app.disabled('foo')
+     // => true
+  
+     app.enable('foo')
+     app.disabled('foo')
+     // => false
+
+# app.enable()
+
+  Enable `setting`.
+
+# app.disable()
+
+  Disable `setting`.
+
+# app.configure()
+
+  Configure callback for zero or more envs,
+  when no `env` is specified that callback will
+  be invoked for all environments. Any combination
+  can be used multiple times, in any order desired.
+  
+  ## Examples
+  
+     app.configure(function(){
+       // executed for all envs
+     });
+  
+     app.configure('stage', function(){
+       // executed staging env
+     });
+  
+     app.configure('stage', 'production', function(){
+       // executed for stage and production
+     });
+  
+  ## Note
+  
+   These callbacks are invoked immediately, and
+   are effectively sugar for the following.
+  
+      var env = process.env.NODE_ENV || 'development';
+  
+       switch (env) {
+         case 'development':
+           ...
+           break;
+         case 'stage':
+           ...
+           break;
+         case 'production':
+           ...
+           break;
+       }
+
+# app.all()
+
+  Special-cased "all" method, applying the given route `path`,
+  middleware, and callback to _every_ HTTP method.
+
+# app.render()
+
+  Render the given view `name` name with `options`
+  and a callback accepting an error and the
+  rendered template string.
+  
+  ## Example
+  
+     app.render('email', { name: 'Tobi' }, function(err, html){
+       // ...
+     })
+
+# app.listen()
+
+  Listen for connections.
+  
+  A node `http.Server` is returned, with this
+  application (which is a `Function`) as its
+  callback. If you wish to create both an HTTP
+  and HTTPS server you may do so with the "http"
+  and "https" modules as shown here.
+  
+     var http = require('http')
+       , https = require('https')
+       , express = require('express')
+       , app = express();
+  
+     http.createServer(app).listen(80);
+     http.createServer({ ... }, app).listen(443);
+

docs/applications.1

@@ -1,70 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "APPLICATIONS" "" "October 2010" "" ""
-.
-.SH "NAME"
-\fBapplications\fR
-.
-.P
-Learnboost \fIhttp://learnboost\.com\fR is a free online gradebook application, aimed to crush the competition with innovative, realtime, enjoyable features\.
-.
-.P
- \fIhttp://learnboost\.com\fR
-.
-.P
-Storify \fIhttp://storify\.com\fR lets you turn what people post on social media websites into compelling stories\.
-.
-.P
- \fIhttp://storify\.com\fR
-.
-.P
-Pakistan Survey \fIhttp://pakistansurvey\.org/\fR by Development Seed \fIhttp://developmentseed\.org\fR, provides in\-depth agency\-specific analysis from regional experts with data from 1,000 interviews across 120 villages in all seven tribal agencies and mapping of 142 reported drone strikes in FATA through July 2010\.
-.
-.P
- \fIhttp://pakistansurvey\.org\fR
-.
-.P
-Markup\.IO \fIhttp://markup\.io\fR allows you to draw directly on \fIany\fR website, then share with others to share your thoughts\.
-.
-.P
- \fIhttp://markup\.io\fR
-.
-.P
-Scrabb\.ly \fIhttp://scrabb\.ly\fR is a massively multiplayer scrabble game initially created for the Node Knockout \fIhttp://nodeknockout\.com/\fR competition\.
-.
-.P
- \fIhttp://scrabb\.ly\fR
-.
-.P
-ClickDummy \fIhttp://clickdummy\.net/\fR is a rapid mockup prototyping application for designers and dummies\.
-.
-.P
- \fIhttp://clickdummy\.net\fR
-.
-.P
-Node Knockout \fIhttp://nodeknockout\.com\fR organized the first ever node\-specific competition with hundreds of contestants\.
-.
-.P
- \fIhttp://nodeknockout\.com\fR
-.
-.P
-Widescript \fIhttp://widescript\.com\fR is an innovative app that helps you focus and interact with your texts \- on your desktop, your couch or on the go\.
-.
-.P
- \fIhttp://widescript\.com\fR
-.
-.P
-e\-resistable \fIhttp://www\.e\-resistible\.co\.uk/\fR is an online order takeaway system providing an intuitive way to fill your belly from your computer!
-.
-.P
- \fIhttp://www\.e\-resistible\.co\.uk\fR
-.
-.P
-Top Twitter Trends \fIhttp://toptwittertrends\.com\fR utilizes MongoDB, Socket\.IO, jQuery and many other exciting libraries to bring you trending tweets in realtime\.
-.
-.P
- \fIhttp://toptwittertrends\.com\fR
-.
-.P
-The applications shown above are not listed in any specific order\. To have an application added or removed please contact TJ Holowaychuk \fIhttp://github\.com/visionmedia\fR\.

docs/applications.html

@@ -1,252 +0,0 @@
-<html>
-	<head>
-		<title>Express - node web framework</title>
-		<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
-		<style>
-			#tagline {
-			  margin-left: 75px;
-			  margin-bottom: 30px;
-			  color: rgba(255,255,255,0.7); }
-			html {
-			  background: #1c1c1c url(images/bg.tile.jpg); }
-
-			body {
-			  margin: 0;
-			  padding-bottom: 30px;
-			  font: 14px/1.4 "Helvetica Neue", "Lucida Grande", "Arial";
-			  font-size: 14px;
-			  line-height: 1.5;
-			  -webkit-font-smoothing: antialiased;
-			  background: url(images/bg.jpg) 50% 0 no-repeat;
-			  color: #8b8b8b; }
-
-			* {
-			  outline: none; }
-
-			em {
-			  color: white; }
-
-			a img {
-			  border: none !important; }
-
-			a {
-			  font-weight: bold;
-			  text-decoration: none;
-			  color: white;
-			  -webkit-transition-property: opacity, -webkit-transform, color, background-color, padding, -webkit-box-shadow;
-			  -webkit-transition-duration: 0.15s;
-			  -webkit-transition-timing-function: ease-out; }
-			  a:hover {
-			    opacity: 0.8; }
-
-			h1, h2, h3, h4 {
-			  margin: 45px 0 0 0;
-			  color: white;
-			  text-shadow: 1px 2px 2px rgba(0,0,0,0.6); }
-
-			h3 {
-			  font-size: 18px; }
-			h4 {
-			  margin-left: 10px;
-			  font-size: 14px;
-			}
-
-			pre {
-			  margin: 20px 10px;
-			  padding: 25px 20px;
-			  background: rgba(0,0,0,0.5);
-			  border: 1px solid #323232;
-			  -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -webkit-border-radius: 5px;
-			  -moz-border-radius: 5px; }
-
-			code {
-			  font-family: "Helvetica Neue", "Lucida Grande", "Arial"; }
-
-			ul {
-			  margin: 15px 0;
-			  padding: 0 0 0 35px; }
-			  ul li {
-			    margin: 0;
-			    padding: 2px 0;
-			    list-style: square; }
-          ul li ul {
-            margin: 0;
-            padding-left: 12px;
-          }
-
-      .man-name, #Express { display:none; }
-
-			.sect {
-			  margin-left: 40px; }
-			img {
-			  margin-left: 20px;
-			  margin-bottom: 15px;
-			}
-
-			#logo {
-			  display: block;
-			  margin-left: 30%;
-			  margin-bottom: 30px;
-			  width: 194px;
-			  height: 51px;
-			  background: url(images/logo.png) 0 0 no-repeat;
-			  text-indent: -99999px; }
-			  #logo:hover {
-			    opacity: 0.7; }
-			  #logo:active {
-			    opacity: 0.3; }
-
-			#ribbon {
-			  position: fixed;
-			  top: 0;
-			  right: 0;
-			  z-index: 2; }
-
-			#wrapper {
-			  width: 100%;
-			  min-height: 800px;
-			  background: url(images/top.png) 0 0 repeat-x; }
-
-			#container {
-			  margin: 0 auto;
-			  padding-top: 80px;
-			  width: 550px; }
-
-			#toc {
-				position: fixed;
-				top: 0;
-				left: 0;
-				margin: 0 0 0 15px;
-				padding: 15px;
-				height: 100%;
-				background: rgba(0,0,0,0.2);
-				overflow: auto;
-				border-right: 1px solid rgba(255,255,255,0.05);
-			}
-			#toc li {
-				padding: 0;
-				list-style: none;
-			}
-			#toc li a {
-				font-size: 11px;
-			}
-			#menu {
-			  margin-left: 65px;
-			  padding: 0;
-			  padding-bottom: 30px; }
-			  #menu li {
-			    display: inline;
-			    list-style: none; }
-			    #menu li a {
-			      display: block;
-			      float: left;
-			      margin: 0 2px;
-			      padding: 3px 15px;
-			      background: rgba(0,0,0,0.2);
-			      -webkit-border-radius: 8px;
-			      -moz-border-radius: 8px;
-			      -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -webkit-transition-property: opacity, -webkit-transform, color, background-color, -webkit-box-shadow;
-			      -webkit-transition-duration: 0.15s;
-			      -webkit-transition-timing-function: ease-out; }
-			      #menu li a:hover,
-			      #menu li a.active {
-			        background: rgba(0,0,0,0.5); }
-			      #menu li a:active {
-			        background: rgba(0,0,0,0.1);
-			        -webkit-box-shadow: 1px 1px 1px rgba(0,0,0,0.4);
-			        -moz-box-shadow: 1px 1px 1px rgba(0,0,0,0.4); }
-		</style>
-		<script>
-		  $(function(){
-		    $('.section').hide();
-		    $('.toggle, a.section-title').toggle(function(){
-		      $(this).siblings('ul').fadeIn(300);
-		      return false;
-		    }, function(){
-		      $(this).siblings('ul').fadeOut(300);
-		      return false;
-		    });
-		  });
-		</script>
-	</head>
-	<body>
-		<a href='http://github.com/visionmedia/express'> 
-		  <img alt='Fork me on GitHub' id='ribbon' src='http://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png' /> 
-		</a>
-		<div id="wrapper">
-			<div id="container">
-				<a href='http://github.com/visionmedia/express' id='logo'>Express</a> 
-				<p id="tagline">
-				   High performance, high class web development for
-				  <a href="http://nodejs.org">Node.js</a>
-				</p>
-				<ul id="menu">
-					<li><a href="index.html">Home</a></li>
-					<li><a href="guide.html">Guide</a></li>
-					<li><a href="contrib.html">Contributing</a></li>
-					<li><a href="applications.html">Applications</a></li>
-				</ul>
-<div class='mp'>
-<h2 id="Express">Express</h2>
-<p class="man-name">
-  <code>applications</code>
-</p>
-
-
-<br />
-
-
-<p><a href="http://learnboost.com">Learnboost</a> is a free online gradebook application, aimed to crush the competition with innovative, realtime, enjoyable features.</p>
-
-<p><a href="http://learnboost.com"><img src="images/apps/learnboost.png" alt="LearnBoost" /></a></p>
-
-<p><a href="http://storify.com">Storify</a> lets you turn what people post on social media websites into compelling stories.</p>
-
-<p><a href="http://storify.com"><img src="images/apps/storify.png" alt="Storify" /></a></p>
-
-<p><a href="http://pakistansurvey.org/">Pakistan Survey</a> by <a href="http://developmentseed.org">Development Seed</a>, provides in-depth agency-specific analysis from regional experts with data from 1,000 interviews across 120 villages in all seven tribal agencies and mapping of 142 reported drone strikes in FATA through July 2010.</p>
-
-<p><a href="http://pakistansurvey.org"><img src="images/apps/developmentseed.png" alt="Pakistan Survey" /></a></p>
-
-<p><a href="http://markup.io">Markup.IO</a> allows you to draw directly on <em>any</em> website, then share with others to share your thoughts.</p>
-
-<p><a href="http://markup.io"><img src="images/apps/markupio.png" alt="Markup.IO" /></a></p>
-
-<p><a href="http://scrabb.ly">Scrabb.ly</a> is a massively multiplayer scrabble game initially created for the <a href="http://nodeknockout.com/">Node Knockout</a> competition.</p>
-
-<p><a href="http://scrabb.ly"><img src="images/apps/scrabbly.png" alt="Online Realtime Scrabble" /></a></p>
-
-<p><a href="http://clickdummy.net/">ClickDummy</a> is a rapid mockup prototyping application for designers and dummies.</p>
-
-<p><a href="http://clickdummy.net"><img src="images/apps/clickdummy.png" alt="Mockup Prototying" /></a></p>
-
-<p><a href="http://nodeknockout.com">Node Knockout</a> organized the first ever node-specific competition with hundreds of contestants.</p>
-
-<p><a href="http://nodeknockout.com"><img src="images/apps/nodeko.png" alt="Node Knockout Competition Express" /></a></p>
-
-<p><a href="http://widescript.com">Widescript</a> is an innovative app that helps you focus and interact with your texts - on your desktop, your couch or on the go.</p>
-
-<p><a href="http://widescript.com"><img src="images/apps/widescript.png" alt="Widescript" /></a></p>
-
-<p><a href="http://www.e-resistible.co.uk/">e-resistable</a> is an online order takeaway system providing an intuitive way to fill your belly from your computer!</p>
-
-<p><a href="http://www.e-resistible.co.uk"><img src="images/apps/e-resistable.png" alt="Online Takeaway" /></a></p>
-
-<p><a href="http://toptwittertrends.com">Top Twitter Trends</a> utilizes MongoDB, Socket.IO, jQuery and many other exciting libraries to bring you trending tweets in realtime.</p>
-
-<p><a href="http://toptwittertrends.com"><img src="images/apps/toptwittertrends.png" alt="Twitter Trends" /></a></p>
-
-<br />
-
-
-<p>The applications shown above are not listed in any specific order. To have an application added or removed please contact <a href="http://github.com/visionmedia">TJ Holowaychuk</a>.</p>
-
-</div>
-			</div>
-		</div>
-	</body>
-</html>

docs/applications.md

@@ -1,47 +0,0 @@
-
-<br />
-
-[Learnboost](http://learnboost.com) is a free online gradebook application, aimed to crush the competition with innovative, realtime, enjoyable features.
-
-[![LearnBoost](images/apps/learnboost.png)](http://learnboost.com)
-
-[Storify](http://storify.com) lets you turn what people post on social media websites into compelling stories.
-
-[![Storify](images/apps/storify.png)](http://storify.com)
-
-
-[Pakistan Survey](http://pakistansurvey.org/) by [Development Seed](http://developmentseed.org), provides in-depth agency-specific analysis from regional experts with data from 1,000 interviews across 120 villages in all seven tribal agencies and mapping of 142 reported drone strikes in FATA through July 2010.
-
-[![Pakistan Survey](images/apps/developmentseed.png)](http://pakistansurvey.org)
-
-[Markup.IO](http://markup.io) allows you to draw directly on _any_ website, then share with others to share your thoughts.
-
-[![Markup.IO](images/apps/markupio.png)](http://markup.io)
-
-[Scrabb.ly](http://scrabb.ly) is a massively multiplayer scrabble game initially created for the [Node Knockout](http://nodeknockout.com/) competition.
-
-[![Online Realtime Scrabble](images/apps/scrabbly.png)](http://scrabb.ly)
-
-[ClickDummy](http://clickdummy.net/) is a rapid mockup prototyping application for designers and dummies.
-
-[![Mockup Prototying](images/apps/clickdummy.png)](http://clickdummy.net)
-
-[Node Knockout](http://nodeknockout.com) organized the first ever node-specific competition with hundreds of contestants.
-
-[![Node Knockout Competition Express](images/apps/nodeko.png)](http://nodeknockout.com)
-
-[Widescript](http://widescript.com) is an innovative app that helps you focus and interact with your texts - on your desktop, your couch or on the go.
-
-[![Widescript](images/apps/widescript.png)](http://widescript.com)
-
-[e-resistable](http://www.e-resistible.co.uk/) is an online order takeaway system providing an intuitive way to fill your belly from your computer!
-
-[![Online Takeaway](images/apps/e-resistable.png)](http://www.e-resistible.co.uk)
-
-[Top Twitter Trends](http://toptwittertrends.com) utilizes MongoDB, Socket.IO, jQuery and many other exciting libraries to bring you trending tweets in realtime.
-
-[![Twitter Trends](images/apps/toptwittertrends.png)](http://toptwittertrends.com)
-
-<br />
-
-The applications shown above are not listed in any specific order. To have an application added or removed please contact [TJ Holowaychuk](http://github.com/visionmedia).

docs/contrib.1

@@ -1,82 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "CONTRIB" "" "October 2010" "" ""
-.
-.SH "NAME"
-\fBcontrib\fR
-.
-.SS "Development Dependencies"
-Express development dependencies are stored within the \fI\./support\fR directory\. To update them execute:
-.
-.IP "" 4
-.
-.nf
-
-$ git submodule update \-\-init
-.
-.fi
-.
-.IP "" 0
-.
-.SS "Running Tests"
-Express uses the Expresso \fIhttp://github\.com/visionmedia/expresso\fR TDD framework to write and run elegant test suites extremely fast\. To run all test suites simply execute:
-.
-.IP "" 4
-.
-.nf
-
-$ make test
-.
-.fi
-.
-.IP "" 0
-.
-.P
-To target specific suites we may specify the files via:
-.
-.IP "" 4
-.
-.nf
-
-$ make test TESTS=test/view\.test\.js
-.
-.fi
-.
-.IP "" 0
-.
-.P
-To check test coverage run:
-.
-.IP "" 4
-.
-.nf
-
-$ make test\-cov
-.
-.fi
-.
-.IP "" 0
-.
-.SS "Contributions"
-To accept a contribution, you should follow these guidelines:
-.
-.IP "\(bu" 4
-All tests \fImust\fR pass
-.
-.IP "\(bu" 4
-Your alterations or additions \fImust\fR include tests
-.
-.IP "\(bu" 4
-Your commit(s) should be \fIfocused\fR, do not commit once for several changes
-.
-.IP "\(bu" 4
-Do \fInot\fR alter release information such as the \fIversion\fR, or \fIHistory\.md\fR
-.
-.IP "\(bu" 4
-Indents are \fI2\fR spaces\.
-.
-.IP "" 0
-.
-.SS "Documentation"
-To contribute documentation edit the markdown files in \fI\./docs\fR, however do \fInot\fR run \fImake docs\fR, as they will be re\-built and published with each release\.

docs/contrib.html

@@ -1,247 +0,0 @@
-<html>
-	<head>
-		<title>Express - node web framework</title>
-		<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
-		<style>
-			#tagline {
-			  margin-left: 75px;
-			  margin-bottom: 30px;
-			  color: rgba(255,255,255,0.7); }
-			html {
-			  background: #1c1c1c url(images/bg.tile.jpg); }
-
-			body {
-			  margin: 0;
-			  padding-bottom: 30px;
-			  font: 14px/1.4 "Helvetica Neue", "Lucida Grande", "Arial";
-			  font-size: 14px;
-			  line-height: 1.5;
-			  -webkit-font-smoothing: antialiased;
-			  background: url(images/bg.jpg) 50% 0 no-repeat;
-			  color: #8b8b8b; }
-
-			* {
-			  outline: none; }
-
-			em {
-			  color: white; }
-
-			a img {
-			  border: none !important; }
-
-			a {
-			  font-weight: bold;
-			  text-decoration: none;
-			  color: white;
-			  -webkit-transition-property: opacity, -webkit-transform, color, background-color, padding, -webkit-box-shadow;
-			  -webkit-transition-duration: 0.15s;
-			  -webkit-transition-timing-function: ease-out; }
-			  a:hover {
-			    opacity: 0.8; }
-
-			h1, h2, h3, h4 {
-			  margin: 45px 0 0 0;
-			  color: white;
-			  text-shadow: 1px 2px 2px rgba(0,0,0,0.6); }
-
-			h3 {
-			  font-size: 18px; }
-			h4 {
-			  margin-left: 10px;
-			  font-size: 14px;
-			}
-
-			pre {
-			  margin: 20px 10px;
-			  padding: 25px 20px;
-			  background: rgba(0,0,0,0.5);
-			  border: 1px solid #323232;
-			  -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -webkit-border-radius: 5px;
-			  -moz-border-radius: 5px; }
-
-			code {
-			  font-family: "Helvetica Neue", "Lucida Grande", "Arial"; }
-
-			ul {
-			  margin: 15px 0;
-			  padding: 0 0 0 35px; }
-			  ul li {
-			    margin: 0;
-			    padding: 2px 0;
-			    list-style: square; }
-          ul li ul {
-            margin: 0;
-            padding-left: 12px;
-          }
-
-      .man-name, #Express { display:none; }
-
-			.sect {
-			  margin-left: 40px; }
-			img {
-			  margin-left: 20px;
-			  margin-bottom: 15px;
-			}
-
-			#logo {
-			  display: block;
-			  margin-left: 30%;
-			  margin-bottom: 30px;
-			  width: 194px;
-			  height: 51px;
-			  background: url(images/logo.png) 0 0 no-repeat;
-			  text-indent: -99999px; }
-			  #logo:hover {
-			    opacity: 0.7; }
-			  #logo:active {
-			    opacity: 0.3; }
-
-			#ribbon {
-			  position: fixed;
-			  top: 0;
-			  right: 0;
-			  z-index: 2; }
-
-			#wrapper {
-			  width: 100%;
-			  min-height: 800px;
-			  background: url(images/top.png) 0 0 repeat-x; }
-
-			#container {
-			  margin: 0 auto;
-			  padding-top: 80px;
-			  width: 550px; }
-
-			#toc {
-				position: fixed;
-				top: 0;
-				left: 0;
-				margin: 0 0 0 15px;
-				padding: 15px;
-				height: 100%;
-				background: rgba(0,0,0,0.2);
-				overflow: auto;
-				border-right: 1px solid rgba(255,255,255,0.05);
-			}
-			#toc li {
-				padding: 0;
-				list-style: none;
-			}
-			#toc li a {
-				font-size: 11px;
-			}
-			#menu {
-			  margin-left: 65px;
-			  padding: 0;
-			  padding-bottom: 30px; }
-			  #menu li {
-			    display: inline;
-			    list-style: none; }
-			    #menu li a {
-			      display: block;
-			      float: left;
-			      margin: 0 2px;
-			      padding: 3px 15px;
-			      background: rgba(0,0,0,0.2);
-			      -webkit-border-radius: 8px;
-			      -moz-border-radius: 8px;
-			      -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -webkit-transition-property: opacity, -webkit-transform, color, background-color, -webkit-box-shadow;
-			      -webkit-transition-duration: 0.15s;
-			      -webkit-transition-timing-function: ease-out; }
-			      #menu li a:hover,
-			      #menu li a.active {
-			        background: rgba(0,0,0,0.5); }
-			      #menu li a:active {
-			        background: rgba(0,0,0,0.1);
-			        -webkit-box-shadow: 1px 1px 1px rgba(0,0,0,0.4);
-			        -moz-box-shadow: 1px 1px 1px rgba(0,0,0,0.4); }
-		</style>
-		<script>
-		  $(function(){
-		    $('.section').hide();
-		    $('.toggle, a.section-title').toggle(function(){
-		      $(this).siblings('ul').fadeIn(300);
-		      return false;
-		    }, function(){
-		      $(this).siblings('ul').fadeOut(300);
-		      return false;
-		    });
-		  });
-		</script>
-	</head>
-	<body>
-		<a href='http://github.com/visionmedia/express'> 
-		  <img alt='Fork me on GitHub' id='ribbon' src='http://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png' /> 
-		</a>
-		<div id="wrapper">
-			<div id="container">
-				<a href='http://github.com/visionmedia/express' id='logo'>Express</a> 
-				<p id="tagline">
-				   High performance, high class web development for
-				  <a href="http://nodejs.org">Node.js</a>
-				</p>
-				<ul id="menu">
-					<li><a href="index.html">Home</a></li>
-					<li><a href="guide.html">Guide</a></li>
-					<li><a href="contrib.html">Contributing</a></li>
-					<li><a href="applications.html">Applications</a></li>
-				</ul>
-<div class='mp'>
-<h2 id="Express">Express</h2>
-<p class="man-name">
-  <code>contrib</code>
-</p>
-<h3 id="Development-Dependencies">Development Dependencies</h3>
-
-<p>Express development dependencies are stored within the <em>./support</em> directory. To
-update them execute:</p>
-
-<pre><code>$ git submodule update --init
-</code></pre>
-
-<h3 id="Running-Tests">Running Tests</h3>
-
-<p>Express uses the <a href="http://github.com/visionmedia/expresso">Expresso</a> TDD
-framework to write and run elegant test suites extremely fast. To run all test suites
-simply execute:</p>
-
-<pre><code>$ make test
-</code></pre>
-
-<p>To target specific suites we may specify the files via:</p>
-
-<pre><code>$ make test TESTS=test/view.test.js
-</code></pre>
-
-<p>To check test coverage run:</p>
-
-<pre><code>$ make test-cov
-</code></pre>
-
-<h3 id="Contributions">Contributions</h3>
-
-<p>To accept a contribution, you should follow these guidelines:</p>
-
-<ul>
-<li>All tests <em>must</em> pass</li>
-<li>Your alterations or additions <em>must</em> include tests</li>
-<li>Your commit(s) should be <em>focused</em>, do not commit once for several changes</li>
-<li>Do <em>not</em> alter release information such as the <em>version</em>, or <em>History.md</em></li>
-<li>Indents are <em>2</em> spaces.</li>
-</ul>
-
-
-<h3 id="Documentation">Documentation</h3>
-
-<p>To contribute documentation edit the markdown files in <em>./docs</em>, however
-do <em>not</em> run <em>make docs</em>, as they will be re-built and published with each release.</p>
-
-</div>
-			</div>
-		</div>
-	</body>
-</html>

docs/contrib.md

@@ -1,38 +0,0 @@
-
-### Development Dependencies
-
-Express development dependencies are stored within the _./support_ directory. To
-update them execute:
-
-    $ git submodule update --init
-
-### Running Tests
-
-Express uses the [Expresso](http://github.com/visionmedia/expresso) TDD
-framework to write and run elegant test suites extremely fast. To run all test suites
-simply execute:
-
-    $ make test
-
-To target specific suites we may specify the files via:
-
-    $ make test TESTS=test/view.test.js
-
-To check test coverage run:
-
-    $ make test-cov
-
-### Contributions
-
-To accept a contribution, you should follow these guidelines:
-
-  * All tests _must_ pass
-  * Your alterations or additions _must_ include tests
-  * Your commit(s) should be _focused_, do not commit once for several changes
-  * Do _not_ alter release information such as the _version_, or _History.md_
-  * Indents are _2_ spaces.
-
-### Documentation
-
-To contribute documentation edit the markdown files in _./docs_, however
-do _not_ run _make docs_, as they will be re-built and published with each release.

docs/executable.1

@@ -1,30 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "EXECUTABLE" "" "October 2010" "" ""
-.
-.SH "NAME"
-\fBexecutable\fR
-.
-.SH "Synopsis"
-.
-.nf
-
-express [\-h|\-\-help] [\-v|\-\-version] [\-c|\-css ENGINE] [PATH]
-.
-.fi
-.
-.SH "Description"
-The \fBexpress\fR executable generates apps at the given \fBPATH\fR or the current working directory\. Although Express is not bound to a specific application structure, this executable creates a maintainable base app\.
-.
-.SH "Options"
-.
-.nf
-
-\-s, \-\-sessions        Add session support
-\-c, \-\-css ENGINE      Add css ENGINE support (less|sass)\. Defaults to plain css
-\-v, \-\-version         Output framework version
-\-h, \-\-help            Display help information
-.
-.fi
-

docs/executable.html

@@ -1,221 +0,0 @@
-<html>
-	<head>
-		<title>Express - node web framework</title>
-		<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
-		<style>
-			#tagline {
-			  margin-left: 75px;
-			  margin-bottom: 30px;
-			  color: rgba(255,255,255,0.7); }
-			html {
-			  background: #1c1c1c url(images/bg.tile.jpg); }
-
-			body {
-			  margin: 0;
-			  padding-bottom: 30px;
-			  font: 14px/1.4 "Helvetica Neue", "Lucida Grande", "Arial";
-			  font-size: 14px;
-			  line-height: 1.5;
-			  -webkit-font-smoothing: antialiased;
-			  background: url(images/bg.jpg) 50% 0 no-repeat;
-			  color: #8b8b8b; }
-
-			* {
-			  outline: none; }
-
-			em {
-			  color: white; }
-
-			a img {
-			  border: none !important; }
-
-			a {
-			  font-weight: bold;
-			  text-decoration: none;
-			  color: white;
-			  -webkit-transition-property: opacity, -webkit-transform, color, background-color, padding, -webkit-box-shadow;
-			  -webkit-transition-duration: 0.15s;
-			  -webkit-transition-timing-function: ease-out; }
-			  a:hover {
-			    opacity: 0.8; }
-
-			h1, h2, h3, h4 {
-			  margin: 45px 0 0 0;
-			  color: white;
-			  text-shadow: 1px 2px 2px rgba(0,0,0,0.6); }
-
-			h3 {
-			  font-size: 18px; }
-			h4 {
-			  margin-left: 10px;
-			  font-size: 14px;
-			}
-
-			pre {
-			  margin: 20px 10px;
-			  padding: 25px 20px;
-			  background: rgba(0,0,0,0.5);
-			  border: 1px solid #323232;
-			  -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -webkit-border-radius: 5px;
-			  -moz-border-radius: 5px; }
-
-			code {
-			  font-family: "Helvetica Neue", "Lucida Grande", "Arial"; }
-
-			ul {
-			  margin: 15px 0;
-			  padding: 0 0 0 35px; }
-			  ul li {
-			    margin: 0;
-			    padding: 2px 0;
-			    list-style: square; }
-          ul li ul {
-            margin: 0;
-            padding-left: 12px;
-          }
-
-      .man-name, #Express { display:none; }
-
-			.sect {
-			  margin-left: 40px; }
-			img {
-			  margin-left: 20px;
-			  margin-bottom: 15px;
-			}
-
-			#logo {
-			  display: block;
-			  margin-left: 30%;
-			  margin-bottom: 30px;
-			  width: 194px;
-			  height: 51px;
-			  background: url(images/logo.png) 0 0 no-repeat;
-			  text-indent: -99999px; }
-			  #logo:hover {
-			    opacity: 0.7; }
-			  #logo:active {
-			    opacity: 0.3; }
-
-			#ribbon {
-			  position: fixed;
-			  top: 0;
-			  right: 0;
-			  z-index: 2; }
-
-			#wrapper {
-			  width: 100%;
-			  min-height: 800px;
-			  background: url(images/top.png) 0 0 repeat-x; }
-
-			#container {
-			  margin: 0 auto;
-			  padding-top: 80px;
-			  width: 550px; }
-
-			#toc {
-				position: fixed;
-				top: 0;
-				left: 0;
-				margin: 0 0 0 15px;
-				padding: 15px;
-				height: 100%;
-				background: rgba(0,0,0,0.2);
-				overflow: auto;
-				border-right: 1px solid rgba(255,255,255,0.05);
-			}
-			#toc li {
-				padding: 0;
-				list-style: none;
-			}
-			#toc li a {
-				font-size: 11px;
-			}
-			#menu {
-			  margin-left: 65px;
-			  padding: 0;
-			  padding-bottom: 30px; }
-			  #menu li {
-			    display: inline;
-			    list-style: none; }
-			    #menu li a {
-			      display: block;
-			      float: left;
-			      margin: 0 2px;
-			      padding: 3px 15px;
-			      background: rgba(0,0,0,0.2);
-			      -webkit-border-radius: 8px;
-			      -moz-border-radius: 8px;
-			      -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -webkit-transition-property: opacity, -webkit-transform, color, background-color, -webkit-box-shadow;
-			      -webkit-transition-duration: 0.15s;
-			      -webkit-transition-timing-function: ease-out; }
-			      #menu li a:hover,
-			      #menu li a.active {
-			        background: rgba(0,0,0,0.5); }
-			      #menu li a:active {
-			        background: rgba(0,0,0,0.1);
-			        -webkit-box-shadow: 1px 1px 1px rgba(0,0,0,0.4);
-			        -moz-box-shadow: 1px 1px 1px rgba(0,0,0,0.4); }
-		</style>
-		<script>
-		  $(function(){
-		    $('.section').hide();
-		    $('.toggle, a.section-title').toggle(function(){
-		      $(this).siblings('ul').fadeIn(300);
-		      return false;
-		    }, function(){
-		      $(this).siblings('ul').fadeOut(300);
-		      return false;
-		    });
-		  });
-		</script>
-	</head>
-	<body>
-		<a href='http://github.com/visionmedia/express'> 
-		  <img alt='Fork me on GitHub' id='ribbon' src='http://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png' /> 
-		</a>
-		<div id="wrapper">
-			<div id="container">
-				<a href='http://github.com/visionmedia/express' id='logo'>Express</a> 
-				<p id="tagline">
-				   High performance, high class web development for
-				  <a href="http://nodejs.org">Node.js</a>
-				</p>
-				<ul id="menu">
-					<li><a href="index.html">Home</a></li>
-					<li><a href="guide.html">Guide</a></li>
-					<li><a href="contrib.html">Contributing</a></li>
-					<li><a href="applications.html">Applications</a></li>
-				</ul>
-<div class='mp'>
-<h2 id="Express">Express</h2>
-<p class="man-name">
-  <code>executable</code>
-</p>
-<h2 id="Synopsis">Synopsis</h2>
-
-<pre><code>express [-h|--help] [-v|--version] [-c|-css ENGINE] [PATH]
-</code></pre>
-
-<h2 id="Description">Description</h2>
-
-<p>The <code>express</code> executable generates apps at the given <strong>PATH</strong> or the
-current working directory. Although Express is not bound to a specific
-application structure, this executable creates a maintainable base app.</p>
-
-<h2 id="Options">Options</h2>
-
-<pre><code>-s, --sessions        Add session support
--c, --css ENGINE      Add css ENGINE support (less|sass). Defaults to plain css
--v, --version         Output framework version
--h, --help            Display help information
-</code></pre>
-
-</div>
-			</div>
-		</div>
-	</body>
-</html>

docs/executable.md

@@ -1,18 +0,0 @@
-
-## Synopsis
-
-    express [-h|--help] [-v|--version] [-c|-css ENGINE] [PATH]
-
-## Description
-
-The `express` executable generates apps at the given **PATH** or the 
-current working directory. Although Express is not bound to a specific
-application structure, this executable creates a maintainable base app.
-
-## Options
-
-    -s, --sessions        Add session support
-    -c, --css ENGINE      Add css ENGINE support (less|sass). Defaults to plain css
-    -v, --version         Output framework version
-    -h, --help            Display help information
-

docs/express.md

@@ -0,0 +1,506 @@
+
+# app
+
+  Application prototype.
+
+# app.use()
+
+  Proxy `connect#use()` to apply settings to
+  mounted applications.
+
+# app.engine()
+
+  Register the given template engine callback `fn`
+  as `ext`.
+  
+  By default will `require()` the engine based on the
+  file extension. For example if you try to render
+  a "foo.jade" file Express will invoke the following internally:
+  
+      app.engine('jade', require('jade').__express);
+  
+  For engines that do not provide `.__express` out of the box,
+  or if you wish to "map" a different extension to the template engine
+  you may use this method. For example mapping the EJS template engine to
+  ".html" files
+  
+      app.engine('html', require('ejs').renderFile);
+  
+  In this case EJS provides a `.renderFile()` method with
+  the same signature that Express expects: `(path, options, callback)`,
+  though note that it aliases this method as `ejs.__express` internally
+  so if you're using ".ejs" extensions you dont need to do anything.
+  
+  Some template engines do not follow this convention, the
+  [Consolidate.js](https://github.com/visionmedia/consolidate.js)
+  library was created to map all of node's popular template
+  engines to follow this convention, thus allowing them to
+  work seemlessly within Express.
+
+# app.param()
+
+  Map the given param placeholder `name`(s) to the given callback(s).
+  
+  Parameter mapping is used to provide pre-conditions to routes
+  which use normalized placeholders. For example a _:user_id_ parameter
+  could automatically load a user's information from the database without
+  any additional code,
+  
+  The callback uses the samesignature as middleware, the only differencing
+  being that the value of the placeholder is passed, in this case the _id_
+  of the user. Once the `next()` function is invoked, just like middleware
+  it will continue on to execute the route, or subsequent parameter functions.
+  
+       app.param('user_id', function(req, res, next, id){
+         User.find(id, function(err, user){
+           if (err) {
+             next(err);
+           } else if (user) {
+             req.user = user;
+             next();
+           } else {
+             next(new Error('failed to load user'));
+           }
+         });
+       });
+
+# app.set()
+
+  Assign `setting` to `val`, or return `setting`'s value.
+  
+     app.set('foo', 'bar');
+     app.get('foo');
+     // => "bar"
+  
+  Mounted servers inherit their parent server's settings.
+
+# app.enabled()
+
+  Check if `setting` is enabled (truthy).
+  
+     app.enabled('foo')
+     // => false
+  
+     app.enable('foo')
+     app.enabled('foo')
+     // => true
+
+# app.disabled()
+
+  Check if `setting` is disabled.
+  
+     app.disabled('foo')
+     // => true
+  
+     app.enable('foo')
+     app.disabled('foo')
+     // => false
+
+# app.enable()
+
+  Enable `setting`.
+
+# app.disable()
+
+  Disable `setting`.
+
+# app.configure()
+
+  Configure callback for zero or more envs,
+  when no `env` is specified that callback will
+  be invoked for all environments. Any combination
+  can be used multiple times, in any order desired.
+  
+  ## Examples
+  
+     app.configure(function(){
+       // executed for all envs
+     });
+  
+     app.configure('stage', function(){
+       // executed staging env
+     });
+  
+     app.configure('stage', 'production', function(){
+       // executed for stage and production
+     });
+  
+  ## Note
+  
+   These callbacks are invoked immediately, and
+   are effectively sugar for the following.
+  
+      var env = process.env.NODE_ENV || 'development';
+  
+       switch (env) {
+         case 'development':
+           ...
+           break;
+         case 'stage':
+           ...
+           break;
+         case 'production':
+           ...
+           break;
+       }
+
+# app.all()
+
+  Special-cased "all" method, applying the given route `path`,
+  middleware, and callback to _every_ HTTP method.
+
+# app.render()
+
+  Render the given view `name` name with `options`
+  and a callback accepting an error and the
+  rendered template string.
+  
+  ## Example
+  
+     app.render('email', { name: 'Tobi' }, function(err, html){
+       // ...
+     })
+
+# app.listen()
+
+  Listen for connections.
+  
+  A node `http.Server` is returned, with this
+  application (which is a `Function`) as its
+  callback. If you wish to create both an HTTP
+  and HTTPS server you may do so with the "http"
+  and "https" modules as shown here.
+  
+     var http = require('http')
+       , https = require('https')
+       , express = require('express')
+       , app = express();
+  
+     http.createServer(app).listen(80);
+     http.createServer({ ... }, app).listen(443);
+
+
+# req
+
+  Request prototype.
+
+# req.get
+
+  Return request header.
+  
+  The `Referrer` header field is special-cased,
+  both `Referrer` and `Referer` are interchangeable.
+  
+  ## Examples
+  
+      req.get('Content-Type');
+      // => "text/plain"
+      
+      req.get('content-type');
+      // => "text/plain"
+      
+      req.get('Something');
+      // => undefined
+  
+  Aliased as `req.header()`.
+
+# req.accepts()
+
+  Check if the given `type(s)` is acceptable, returning
+  the best match when true, otherwise `undefined`, in which
+  case you should respond with 406 "Not Acceptable".
+  
+  The `type` value may be a single mime type string
+  such as "application/json", the extension name
+  such as "json", a comma-delimted list such as "json, html, text/plain",
+  or an array `["json", "html", "text/plain"]`. When a list
+  or array is given the _best_ match, if any is returned.
+  
+  ## Examples
+  
+      // Accept: text/html
+      req.accepts('html');
+      // => "html"
+  
+      // Accept: text/*, application/json
+      req.accepts('html');
+      // => "html"
+      req.accepts('text/html');
+      // => "text/html"
+      req.accepts('json, text');
+      // => "json"
+      req.accepts('application/json');
+      // => "application/json"
+  
+      // Accept: text/*, application/json
+      req.accepts('image/png');
+      req.accepts('png');
+      // => undefined
+  
+      // Accept: text/*;q=.5, application/json
+      req.accepts(['html', 'json']);
+      req.accepts('html, json');
+      // => "json"
+
+# req.acceptsCharset()
+
+  Check if the given `charset` is acceptable,
+  otherwise you should respond with 406 "Not Acceptable".
+
+# req.acceptsLanguage()
+
+  Check if the given `lang` is acceptable,
+  otherwise you should respond with 406 "Not Acceptable".
+
+# req.param()
+
+  Return the value of param `name` when present or `defaultValue`.
+  
+   - Checks route placeholders, ex: _/user/:id_
+   - Checks body params, ex: id=12, {"id":12}
+   - Checks query string params, ex: ?id=12
+  
+  To utilize request bodies, `req.body`
+  should be an object. This can be done by using
+  the `connect.bodyParser()` middleware.
+
+# req.is()
+
+  Check if the incoming request contains the "Content-Type" 
+  header field, and it contains the give mime `type`.
+  
+  ## Examples
+  
+       // With Content-Type: text/html; charset=utf-8
+       req.is('html');
+       req.is('text/html');
+       req.is('text/*');
+       // => true
+      
+       // When Content-Type is application/json
+       req.is('json');
+       req.is('application/json');
+       req.is('application/*');
+       // => true
+      
+       req.is('html');
+       // => false
+
+
+# res
+
+  Response prototype.
+
+# res.status()
+
+  Set status `code`.
+
+# res.send()
+
+  Send a response.
+  
+  ## Examples
+  
+      res.send(new Buffer('wahoo'));
+      res.send({ some: 'json' });
+      res.send('<p>some html</p>');
+      res.send(404, 'Sorry, cant find that');
+      res.send(404);
+
+# res.json()
+
+  Send JSON response.
+  
+  ## Examples
+  
+      res.json(null);
+      res.json({ user: 'tj' });
+      res.json(500, 'oh noes!');
+      res.json(404, 'I dont have that');
+
+# res.sendfile()
+
+  Transfer the file at the given `path`.
+  
+  Automatically sets the _Content-Type_ response header field.
+  The callback `fn(err)` is invoked when the transfer is complete
+  or when an error occurs. Be sure to check `res.sentHeader`
+  if you wish to attempt responding, as the header and some data
+  may have already been transferred.
+  
+  ## Options
+  
+    - `maxAge` defaulting to 0
+    - `root`   root directory for relative filenames
+  
+  ## Examples
+  
+   The following example illustrates how `res.sendfile()` may
+   be used as an alternative for the `static()` middleware for
+   dynamic situations. The code backing `res.sendfile()` is actually
+   the same code, so HTTP cache support etc is identical.
+  
+      app.get('/user/:uid/photos/:file', function(req, res){
+        var uid = req.params.uid
+          , file = req.params.file;
+      
+        req.user.mayViewFilesFrom(uid, function(yes){
+          if (yes) {
+            res.sendfile('/uploads/' + uid + '/' + file);
+          } else {
+            res.send(403, 'Sorry! you cant see that.');
+          }
+        });
+      });
+
+# res.download()
+
+  Transfer the file at the given `path` as an attachment.
+  
+  Optionally providing an alternate attachment `filename`,
+  and optional callback `fn(err)`. The callback is invoked
+  when the data transfer is complete, or when an error has
+  ocurred. Be sure to check `res.headerSent` if you plan to respond.
+  
+  This method uses `res.sendfile()`.
+
+# res.format()
+
+  Respond to the Acceptable formats using an `obj`
+  of mime-type callbacks.
+  
+  This method uses `req.accepted`, an array of
+  acceptable types ordered by their quality values.
+  When "Accept" is not present the _first_ callback
+  is invoked, otherwise the first match is used. When
+  no match is performed the server responds with
+  406 "Not Acceptable".
+  
+  Content-Type is set for you, however if you choose
+  you may alter this within the callback using `res.type()`
+  or `res.set('Content-Type', ...)`.
+  
+     res.format({
+       'text/plain': function(){
+         res.send('hey');
+       },
+     
+       'text/html': function(){
+         res.send('<p>hey</p>');
+       },
+     
+       'appliation/json': function(){
+         res.send({ message: 'hey' });
+       }
+     });
+  
+  In addition to canonicalized MIME types you may
+  also use extnames mapped to these types:
+  
+     res.format({
+       text: function(){
+         res.send('hey');
+       },
+     
+       html: function(){
+         res.send('<p>hey</p>');
+       },
+     
+       json: function(){
+         res.send({ message: 'hey' });
+       }
+     });
+  
+  By default Express passes an `Error`
+  with a `.status` of 406 to `next(err)`
+  if a match is not made, however you may
+  provide an optional callback `fn` to
+  be invoked instead.
+
+# res.attachment()
+
+  Set _Content-Disposition_ header to _attachment_ with optional `filename`.
+
+# res.set
+
+  Set header `field` to `val`, or pass
+  an object of header fields.
+  
+  ## Examples
+  
+     res.set('Accept', 'application/json');
+     res.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
+  
+  Aliased as `res.header()`.
+
+# res.get()
+
+  Get value for header `field`.
+
+# res.clearCookie()
+
+  Clear cookie `name`.
+
+# res.cookie()
+
+  Set cookie `name` to `val`, with the given `options`.
+  
+  ## Options
+  
+     - `maxAge`   max-age in milliseconds, converted to `expires`
+     - `signed`   sign the cookie
+     - `path`     defaults to "/"
+  
+  ## Examples
+  
+     // "Remember Me" for 15 minutes
+     res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true });
+  
+     // save as above
+     res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true })
+
+# res.redirect()
+
+  Redirect to the given `url` with optional response `status`
+  defaulting to 302.
+  
+  The given `url` can also be the name of a mapped url, for
+  example by default express supports "back" which redirects
+  to the _Referrer_ or _Referer_ headers or "/".
+  
+  ## Examples
+  
+     res.redirect('/foo/bar');
+     res.redirect('http://example.com');
+     res.redirect(301, 'http://example.com');
+     res.redirect('../login'); // /blog/post/1 -> /blog/login
+  
+  ## Mounting
+  
+    When an application is mounted, and `res.redirect()`
+    is given a path that does _not_ lead with "/". For 
+    example suppose a "blog" app is mounted at "/blog",
+    the following redirect would result in "/blog/login":
+  
+       res.redirect('login');
+  
+    While the leading slash would result in a redirect to "/login":
+  
+       res.redirect('/login');
+
+# res.render()
+
+  Render `view` with the given `options` and optional callback `fn`.
+  When a callback function is given a response will _not_ be made
+  automatically, otherwise a response of _200_ and _text/html_ is given.
+  
+  ## Options
+   
+   - `status`    Response status code (`res.statusCode`)
+   - `charset`   Set the charset (`res.charset`)
+  
+  ## Reserved locals
+  
+   - `cache`     boolean hinting to the engine it should cache
+   - `filename`  filename of the view being rendered
+

docs/index.1

@@ -1,106 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "INDEX" "" "October 2010" "" ""
-.
-.SH "NAME"
-\fBindex\fR
-.
-.IP "" 4
-.
-.nf
-
-var app = express\.createServer();
-
-app\.get(\'/\', function(req, res){
-    res\.send(\'Hello World\');
-});
-
-app\.listen(3000);
-.
-.fi
-.
-.IP "" 0
-.
-.SH "Features"
-.
-.IP "\(bu" 4
-Robust routing
-.
-.IP "\(bu" 4
-Redirection helpers
-.
-.IP "\(bu" 4
-Dynamic view helpers
-.
-.IP "\(bu" 4
-Application level view options
-.
-.IP "\(bu" 4
-Content negotiation
-.
-.IP "\(bu" 4
-Focus on high performance
-.
-.IP "\(bu" 4
-View rendering and partials support
-.
-.IP "\(bu" 4
-Environment based configuration
-.
-.IP "\(bu" 4
-Session based flash notifications
-.
-.IP "\(bu" 4
-Built on Connect \fIhttp://github\.com/senchalabs/connect\fR
-.
-.IP "\(bu" 4
-Executable \fIexecutable\.html\fR for generating applications quickly
-.
-.IP "\(bu" 4
-High test coverage
-.
-.IP "" 0
-.
-.SH "Contributors"
-The following are the major contributors of Express (in no specific order)\.
-.
-.IP "\(bu" 4
-TJ Holowaychuk (visionmedia \fIhttp://github\.com/visionmedia\fR)
-.
-.IP "\(bu" 4
-Ciaran Jessup (ciaranj \fIhttp://github\.com/ciaranj\fR)
-.
-.IP "\(bu" 4
-Aaron Heckmann (aheckmann \fIhttp://github\.com/aheckmann\fR)
-.
-.IP "\(bu" 4
-Guillermo Rauch (guille \fIhttp://github\.com/guille\fR)
-.
-.IP "" 0
-.
-.SH "More Information"
-.
-.IP "\(bu" 4
-Google Group \fIhttp://groups\.google\.com/group/express\-js\fR for discussion
-.
-.IP "\(bu" 4
-Follow tjholowaychuk \fIhttp://twitter\.com/tjholowaychuk\fR on twitter for updates
-.
-.IP "\(bu" 4
-Annotated source documentation \fIapi\.html\fR
-.
-.IP "\(bu" 4
-View the Connect \fIhttp://github\.com/senchalabs/connect\fR repo for middleware usage
-.
-.IP "\(bu" 4
-View the Connect Wiki \fIhttp://wiki\.github\.com/senchalabs/connect/\fR for contrib middleware
-.
-.IP "\(bu" 4
-View the examples \fIhttp://github\.com/visionmedia/express/tree/master/examples/\fR
-.
-.IP "\(bu" 4
-View the source \fIhttp://github\.com/visionmedia/express\fR
-.
-.IP "" 0
-

docs/index.html

@@ -1,254 +0,0 @@
-<html>
-	<head>
-		<title>Express - node web framework</title>
-		<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
-		<style>
-			#tagline {
-			  margin-left: 75px;
-			  margin-bottom: 30px;
-			  color: rgba(255,255,255,0.7); }
-			html {
-			  background: #1c1c1c url(images/bg.tile.jpg); }
-
-			body {
-			  margin: 0;
-			  padding-bottom: 30px;
-			  font: 14px/1.4 "Helvetica Neue", "Lucida Grande", "Arial";
-			  font-size: 14px;
-			  line-height: 1.5;
-			  -webkit-font-smoothing: antialiased;
-			  background: url(images/bg.jpg) 50% 0 no-repeat;
-			  color: #8b8b8b; }
-
-			* {
-			  outline: none; }
-
-			em {
-			  color: white; }
-
-			a img {
-			  border: none !important; }
-
-			a {
-			  font-weight: bold;
-			  text-decoration: none;
-			  color: white;
-			  -webkit-transition-property: opacity, -webkit-transform, color, background-color, padding, -webkit-box-shadow;
-			  -webkit-transition-duration: 0.15s;
-			  -webkit-transition-timing-function: ease-out; }
-			  a:hover {
-			    opacity: 0.8; }
-
-			h1, h2, h3, h4 {
-			  margin: 45px 0 0 0;
-			  color: white;
-			  text-shadow: 1px 2px 2px rgba(0,0,0,0.6); }
-
-			h3 {
-			  font-size: 18px; }
-			h4 {
-			  margin-left: 10px;
-			  font-size: 14px;
-			}
-
-			pre {
-			  margin: 20px 10px;
-			  padding: 25px 20px;
-			  background: rgba(0,0,0,0.5);
-			  border: 1px solid #323232;
-			  -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -webkit-border-radius: 5px;
-			  -moz-border-radius: 5px; }
-
-			code {
-			  font-family: "Helvetica Neue", "Lucida Grande", "Arial"; }
-
-			ul {
-			  margin: 15px 0;
-			  padding: 0 0 0 35px; }
-			  ul li {
-			    margin: 0;
-			    padding: 2px 0;
-			    list-style: square; }
-          ul li ul {
-            margin: 0;
-            padding-left: 12px;
-          }
-
-      .man-name, #Express { display:none; }
-
-			.sect {
-			  margin-left: 40px; }
-			img {
-			  margin-left: 20px;
-			  margin-bottom: 15px;
-			}
-
-			#logo {
-			  display: block;
-			  margin-left: 30%;
-			  margin-bottom: 30px;
-			  width: 194px;
-			  height: 51px;
-			  background: url(images/logo.png) 0 0 no-repeat;
-			  text-indent: -99999px; }
-			  #logo:hover {
-			    opacity: 0.7; }
-			  #logo:active {
-			    opacity: 0.3; }
-
-			#ribbon {
-			  position: fixed;
-			  top: 0;
-			  right: 0;
-			  z-index: 2; }
-
-			#wrapper {
-			  width: 100%;
-			  min-height: 800px;
-			  background: url(images/top.png) 0 0 repeat-x; }
-
-			#container {
-			  margin: 0 auto;
-			  padding-top: 80px;
-			  width: 550px; }
-
-			#toc {
-				position: fixed;
-				top: 0;
-				left: 0;
-				margin: 0 0 0 15px;
-				padding: 15px;
-				height: 100%;
-				background: rgba(0,0,0,0.2);
-				overflow: auto;
-				border-right: 1px solid rgba(255,255,255,0.05);
-			}
-			#toc li {
-				padding: 0;
-				list-style: none;
-			}
-			#toc li a {
-				font-size: 11px;
-			}
-			#menu {
-			  margin-left: 65px;
-			  padding: 0;
-			  padding-bottom: 30px; }
-			  #menu li {
-			    display: inline;
-			    list-style: none; }
-			    #menu li a {
-			      display: block;
-			      float: left;
-			      margin: 0 2px;
-			      padding: 3px 15px;
-			      background: rgba(0,0,0,0.2);
-			      -webkit-border-radius: 8px;
-			      -moz-border-radius: 8px;
-			      -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -webkit-transition-property: opacity, -webkit-transform, color, background-color, -webkit-box-shadow;
-			      -webkit-transition-duration: 0.15s;
-			      -webkit-transition-timing-function: ease-out; }
-			      #menu li a:hover,
-			      #menu li a.active {
-			        background: rgba(0,0,0,0.5); }
-			      #menu li a:active {
-			        background: rgba(0,0,0,0.1);
-			        -webkit-box-shadow: 1px 1px 1px rgba(0,0,0,0.4);
-			        -moz-box-shadow: 1px 1px 1px rgba(0,0,0,0.4); }
-		</style>
-		<script>
-		  $(function(){
-		    $('.section').hide();
-		    $('.toggle, a.section-title').toggle(function(){
-		      $(this).siblings('ul').fadeIn(300);
-		      return false;
-		    }, function(){
-		      $(this).siblings('ul').fadeOut(300);
-		      return false;
-		    });
-		  });
-		</script>
-	</head>
-	<body>
-		<a href='http://github.com/visionmedia/express'> 
-		  <img alt='Fork me on GitHub' id='ribbon' src='http://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png' /> 
-		</a>
-		<div id="wrapper">
-			<div id="container">
-				<a href='http://github.com/visionmedia/express' id='logo'>Express</a> 
-				<p id="tagline">
-				   High performance, high class web development for
-				  <a href="http://nodejs.org">Node.js</a>
-				</p>
-				<ul id="menu">
-					<li><a href="index.html">Home</a></li>
-					<li><a href="guide.html">Guide</a></li>
-					<li><a href="contrib.html">Contributing</a></li>
-					<li><a href="applications.html">Applications</a></li>
-				</ul>
-<div class='mp'>
-<h2 id="Express">Express</h2>
-<p class="man-name">
-  <code>index</code>
-</p>
-<pre><code>var app = express.createServer();
-
-app.get('/', function(req, res){
-    res.send('Hello World');
-});
-
-app.listen(3000);
-</code></pre>
-
-<h2 id="Features">Features</h2>
-
-<ul>
-<li>Robust routing</li>
-<li>Redirection helpers</li>
-<li>Dynamic view helpers</li>
-<li>Application level view options</li>
-<li>Content negotiation</li>
-<li>Focus on high performance</li>
-<li>View rendering and partials support</li>
-<li>Environment based configuration</li>
-<li>Session based flash notifications</li>
-<li>Built on <a href="http://github.com/senchalabs/connect">Connect</a></li>
-<li><a href="executable.html">Executable</a> for generating applications quickly</li>
-<li>High test coverage</li>
-</ul>
-
-
-<h2 id="Contributors">Contributors</h2>
-
-<p>The following are the major contributors of Express (in no specific order).</p>
-
-<ul>
-<li>TJ Holowaychuk (<a href="http://github.com/visionmedia">visionmedia</a>)</li>
-<li>Ciaran Jessup (<a href="http://github.com/ciaranj">ciaranj</a>)</li>
-<li>Aaron Heckmann (<a href="http://github.com/aheckmann">aheckmann</a>)</li>
-<li>Guillermo Rauch (<a href="http://github.com/guille">guille</a>)</li>
-</ul>
-
-
-<h2 id="More-Information">More Information</h2>
-
-<ul>
-<li><a href="http://groups.google.com/group/express-js">Google Group</a> for discussion</li>
-<li>Follow <a href="http://twitter.com/tjholowaychuk">tjholowaychuk</a> on twitter for updates</li>
-<li>Annotated source <a href="api.html">documentation</a></li>
-<li>View the <a href="http://github.com/senchalabs/connect">Connect</a> repo for middleware usage</li>
-<li>View the <a href="http://wiki.github.com/senchalabs/connect/">Connect Wiki</a> for contrib middleware</li>
-<li>View the <a href="http://github.com/visionmedia/express/tree/master/examples/">examples</a></li>
-<li>View the <a href="http://github.com/visionmedia/express">source</a></li>
-</ul>
-
-
-</div>
-			</div>
-		</div>
-	</body>
-</html>

docs/index.md

@@ -1,42 +0,0 @@
-
-    var app = express.createServer();
-    
-    app.get('/', function(req, res){
-        res.send('Hello World');
-    });
-
-    app.listen(3000);
-
-## Features
-
-  * Robust routing
-  * Redirection helpers
-  * Dynamic view helpers
-  * Application level view options
-  * Content negotiation
-  * Focus on high performance
-  * View rendering and partials support
-  * Environment based configuration
-  * Session based flash notifications
-  * Built on [Connect](http://github.com/senchalabs/connect)
-  * [Executable](executable.html) for generating applications quickly
-  * High test coverage
-
-## Contributors
-
-The following are the major contributors of Express (in no specific order).
-
-  * TJ Holowaychuk ([visionmedia](http://github.com/visionmedia))
-  * Ciaran Jessup ([ciaranj](http://github.com/ciaranj))
-  * Aaron Heckmann ([aheckmann](http://github.com/aheckmann))
-  * Guillermo Rauch ([guille](http://github.com/guille))
-
-## More Information
-
-  * [Google Group](http://groups.google.com/group/express-js) for discussion
-  * Follow [tjholowaychuk](http://twitter.com/tjholowaychuk) on twitter for updates
-  * Annotated source [documentation](api.html)
-  * View the [Connect](http://github.com/senchalabs/connect) repo for middleware usage
-  * View the [Connect Wiki](http://wiki.github.com/senchalabs/connect/) for contrib middleware
-  * View the [examples](http://github.com/visionmedia/express/tree/master/examples/)
-  * View the [source](http://github.com/visionmedia/express)

docs/layout/foot.html

@@ -1,4 +0,0 @@
-			</div>
-		</div>
-	</body>
-</html>

docs/layout/head.html

@@ -1,192 +0,0 @@
-<html>
-	<head>
-		<title>Express - node web framework</title>
-		<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
-		<style>
-			#tagline {
-			  margin-left: 75px;
-			  margin-bottom: 30px;
-			  color: rgba(255,255,255,0.7); }
-			html {
-			  background: #1c1c1c url(images/bg.tile.jpg); }
-
-			body {
-			  margin: 0;
-			  padding-bottom: 30px;
-			  font: 14px/1.4 "Helvetica Neue", "Lucida Grande", "Arial";
-			  font-size: 14px;
-			  line-height: 1.5;
-			  -webkit-font-smoothing: antialiased;
-			  background: url(images/bg.jpg) 50% 0 no-repeat;
-			  color: #8b8b8b; }
-
-			* {
-			  outline: none; }
-
-			em {
-			  color: white; }
-
-			a img {
-			  border: none !important; }
-
-			a {
-			  font-weight: bold;
-			  text-decoration: none;
-			  color: white;
-			  -webkit-transition-property: opacity, -webkit-transform, color, background-color, padding, -webkit-box-shadow;
-			  -webkit-transition-duration: 0.15s;
-			  -webkit-transition-timing-function: ease-out; }
-			  a:hover {
-			    opacity: 0.8; }
-
-			h1, h2, h3, h4 {
-			  margin: 45px 0 0 0;
-			  color: white;
-			  text-shadow: 1px 2px 2px rgba(0,0,0,0.6); }
-
-			h3 {
-			  font-size: 18px; }
-			h4 {
-			  margin-left: 10px;
-			  font-size: 14px;
-			}
-
-			pre {
-			  margin: 20px 10px;
-			  padding: 25px 20px;
-			  background: rgba(0,0,0,0.5);
-			  border: 1px solid #323232;
-			  -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -webkit-border-radius: 5px;
-			  -moz-border-radius: 5px; }
-
-			code {
-			  font-family: "Helvetica Neue", "Lucida Grande", "Arial"; }
-
-			ul {
-			  margin: 15px 0;
-			  padding: 0 0 0 35px; }
-			  ul li {
-			    margin: 0;
-			    padding: 2px 0;
-			    list-style: square; }
-          ul li ul {
-            margin: 0;
-            padding-left: 12px;
-          }
-
-      .man-name, #Express { display:none; }
-
-			.sect {
-			  margin-left: 40px; }
-			img {
-			  margin-left: 20px;
-			  margin-bottom: 15px;
-			}
-
-			#logo {
-			  display: block;
-			  margin-left: 30%;
-			  margin-bottom: 30px;
-			  width: 194px;
-			  height: 51px;
-			  background: url(images/logo.png) 0 0 no-repeat;
-			  text-indent: -99999px; }
-			  #logo:hover {
-			    opacity: 0.7; }
-			  #logo:active {
-			    opacity: 0.3; }
-
-			#ribbon {
-			  position: fixed;
-			  top: 0;
-			  right: 0;
-			  z-index: 2; }
-
-			#wrapper {
-			  width: 100%;
-			  min-height: 800px;
-			  background: url(images/top.png) 0 0 repeat-x; }
-
-			#container {
-			  margin: 0 auto;
-			  padding-top: 80px;
-			  width: 550px; }
-
-			#toc {
-				position: fixed;
-				top: 0;
-				left: 0;
-				margin: 0 0 0 15px;
-				padding: 15px;
-				height: 100%;
-				background: rgba(0,0,0,0.2);
-				overflow: auto;
-				border-right: 1px solid rgba(255,255,255,0.05);
-			}
-			#toc li {
-				padding: 0;
-				list-style: none;
-			}
-			#toc li a {
-				font-size: 11px;
-			}
-			#menu {
-			  margin-left: 65px;
-			  padding: 0;
-			  padding-bottom: 30px; }
-			  #menu li {
-			    display: inline;
-			    list-style: none; }
-			    #menu li a {
-			      display: block;
-			      float: left;
-			      margin: 0 2px;
-			      padding: 3px 15px;
-			      background: rgba(0,0,0,0.2);
-			      -webkit-border-radius: 8px;
-			      -moz-border-radius: 8px;
-			      -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -webkit-transition-property: opacity, -webkit-transform, color, background-color, -webkit-box-shadow;
-			      -webkit-transition-duration: 0.15s;
-			      -webkit-transition-timing-function: ease-out; }
-			      #menu li a:hover,
-			      #menu li a.active {
-			        background: rgba(0,0,0,0.5); }
-			      #menu li a:active {
-			        background: rgba(0,0,0,0.1);
-			        -webkit-box-shadow: 1px 1px 1px rgba(0,0,0,0.4);
-			        -moz-box-shadow: 1px 1px 1px rgba(0,0,0,0.4); }
-		</style>
-		<script>
-		  $(function(){
-		    $('.section').hide();
-		    $('.toggle, a.section-title').toggle(function(){
-		      $(this).siblings('ul').fadeIn(300);
-		      return false;
-		    }, function(){
-		      $(this).siblings('ul').fadeOut(300);
-		      return false;
-		    });
-		  });
-		</script>
-	</head>
-	<body>
-		<a href='http://github.com/visionmedia/express'> 
-		  <img alt='Fork me on GitHub' id='ribbon' src='http://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png' /> 
-		</a>
-		<div id="wrapper">
-			<div id="container">
-				<a href='http://github.com/visionmedia/express' id='logo'>Express</a> 
-				<p id="tagline">
-				   High performance, high class web development for
-				  <a href="http://nodejs.org">Node.js</a>
-				</p>
-				<ul id="menu">
-					<li><a href="index.html">Home</a></li>
-					<li><a href="guide.html">Guide</a></li>
-					<li><a href="contrib.html">Contributing</a></li>
-					<li><a href="applications.html">Applications</a></li>
-				</ul>

docs/migrate.1

@@ -1,347 +0,0 @@
-.\" generated with Ronn/v0.7.3
-.\" http://github.com/rtomayko/ronn/tree/0.7.3
-.
-.TH "MIGRATE" "" "October 2010" "" ""
-.
-.SH "NAME"
-\fBmigrate\fR
-.
-.SS "Built On Connect"
-Express 1\.x is written to run on\-top of the Connect \fIhttp://extjs\.github\.com/Connect\fR middlware framework, thus the \fIPlugin\fR has been replaced by Connect\'s middleware\. By abstracting our middleware to Connect we allow additional community frameworks to develop robust, high\-level frameworks using the same technologies as Express\.
-.
-.SS "Creating Applications"
-Previously due to legacy code implemented in the early days of node, Express unfortunately had some globals\. The DSL would previously be accessed as shown below:
-.
-.IP "" 4
-.
-.nf
-
-require(\'express\');
-
-configure(function(){
-    // app configuration
-});
-
-get(\'/\', function(){
-    return \'hello world\';
-});
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Now we utilize the CommonJS module system appropriately, and introduce \fIexpress\.createServer()\fR which accepts the same arguments as \fIhttp\.createServer()\fR:
-.
-.IP "" 4
-.
-.nf
-
-var express = require(\'express\'),
-    app = express\.createServer();
-
-app\.configure(function(){
-    // app configuration
-});
-
-app\.get(\'/\', function(req, res){
-    res\.send(\'hello world\');
-});
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Express 1\.x does \fInot\fR currently allow returning of a string\.
-.
-.SS "Plugins vs Middleware"
-Previously Express was bundled with plugins, which were essentially what are now Connect middleware\. Previously plugins would be utilized in a manor similar to below:
-.
-.IP "" 4
-.
-.nf
-
-use(Logger);
-use(MethodOverride);
-use(Cookie);
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Which we can now \fIuse()\fR within our app, or pass to the \fIexpress\.createServer()\fR method:
-.
-.IP "" 4
-.
-.nf
-
-var app = express\.createServer(
-    express\.logger(),
-    express\.methodOverride(),
-    express\.cookieDecoder()
-);
-.
-.fi
-.
-.IP "" 0
-.
-.P
-or:
-.
-.IP "" 4
-.
-.nf
-
-var app = express\.createServer();
-
-app\.use(express\.logger());
-app\.use(express\.methodOverride());
-app\.use(express\.cookieDecoder());
-.
-.fi
-.
-.IP "" 0
-.
-.P
-For documentation on creating Connect middleware visit Middleware Authoring \fIhttp://extjs\.github\.com/Connect/#Middleware\-Authoring\fR\.
-.
-.SS "Running Applications"
-Previously a global function \fIrun()\fR, was available:
-.
-.IP "" 4
-.
-.nf
-
-run();
-.
-.fi
-.
-.IP "" 0
-.
-.P
-The new \fIexpress\.Server\fR has the same API as \fIhttp\.Server\fR, so we can do things like:
-.
-.IP "" 4
-.
-.nf
-
-app\.listen();
-app\.listen(3000);
-.
-.fi
-.
-.IP "" 0
-.
-.SS "Route Parameters"
-Previously we could use \fIthis\.param()\fR to attempt fetching a route, query string, or request body parameter:
-.
-.IP "" 4
-.
-.nf
-
-get(\'/user/:id\', function(){
-    this\.param(\'id\');
-});
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Polymorphic parameter access can be done using \fBreq\.param()\fR:
-.
-.IP "" 4
-.
-.nf
-
-app\.get(\'/user/:id\', function(req, res){
-    req\.param(\'id\');
-});
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Route parameters are available via \fBreq\.params\fR:
-.
-.IP "" 4
-.
-.nf
-
-app\.get(\'/user/:id\', function(req, res){
-    req\.params\.id;
-});
-.
-.fi
-.
-.IP "" 0
-.
-.SS "Passing Route Control"
-Old express had a weak notion of route passing, which did not support async, and was never properly implemented for practical use:
-.
-.IP "" 4
-.
-.nf
-
-get(\'/\', function(){
-    this\.pass(\'/foobar\');
-});
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Now Express has access to Connect\'s \fInext()\fR function, which is passed as the third and final argument\. Calling \fInext()\fR will pass control to the next \fImatching route\fR, or continue down the stack of Connect middleware\.
-.
-.IP "" 4
-.
-.nf
-
-app\.get(\'/user/:id?\', function(req, res, next){
-    next();
-});
-
-app\.get(\'/user\', function(){
-    // \.\.\. respond
-});
-.
-.fi
-.
-.IP "" 0
-.
-.SS "View Rendering"
-View filenames no longer take the form \fINAME\fR\.\fITYPE\fR\.\fIENGINE\fR, the \fIContent\-Type\fR can be set via \fIres\.contentType()\fR or \fIres\.header()\fR\. For example what was previously \fIlayout\.html\.haml\fR, should now be \fIlayout\.haml\fR\.
-.
-.P
-Previously a view render looked something like this:
-.
-.IP "" 4
-.
-.nf
-
-get(\'/\', function(){
-    this\.render(\'index\.html\.haml\', {
-        locals: { title: \'My Site\' }
-    });
-});
-.
-.fi
-.
-.IP "" 0
-.
-.P
-We now have \fIres\.render()\fR, however the options passed to haml \fIhttp://github\.com/visionmedia/haml\.js\fR, jade \fIhttp://github\.com/visionmedia/jade\fR, and others remain the same\.
-.
-.IP "" 4
-.
-.nf
-
-app\.get(\'/\', function(req, res){
-    res\.render(\'index\.haml\', {
-        locals: { title: \'My Site\' }
-    });
-});
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Previously rendering of a collection via \fIpartial()\fR would look something like this:
-.
-.IP "" 4
-.
-.nf
-
-this\.partial(\'comment\.html\.haml\', { collection: comments });
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Although this worked just fine, it was generally to verbose, the similar but new API looks like this, as \fIpartial()\fR is \fIalways\fR passed as a local variable:
-.
-.IP "" 4
-.
-.nf
-
-partial(\'comment\.haml\', { collection: comments });
-.
-.fi
-.
-.IP "" 0
-.
-.P
-To make things even less verbose we can assume the extension when omitted:
-.
-.IP "" 4
-.
-.nf
-
-partial(\'comment\', { collection: comments });
-.
-.fi
-.
-.IP "" 0
-.
-.P
-And once again even further, when rendering a collection we can simply pass an array, if no other options are desired:
-.
-.IP "" 4
-.
-.nf
-
-partial(\'comments\', comments);
-.
-.fi
-.
-.IP "" 0
-.
-.SS "Redirecting"
-Previously you would
-.
-.IP "" 4
-.
-.nf
-
-this\.redirect(\'/somewhere\');
-.
-.fi
-.
-.IP "" 0
-.
-.P
-However you would now:
-.
-.IP "" 4
-.
-.nf
-
-res\.redirect(\'/somewhere\');
-res\.redirect(\'/somewhere\', 301);
-.
-.fi
-.
-.IP "" 0
-.
-.SS "HTTP Client"
-Previously Express provided a high level http client, this library is no more as it does not belong in Express, however it may be resurrected as a separate module\.
-.
-.SS "Core Extensions"
-Express is no longer dependent on the JavaScript Extensions \fIhttp://github\.com/visionmedia/ext\.js\fR library, so those of you using the methods provided by it such as \fBObject\.merge(a, b)\fR will need to roll your own, or install the module via:
-.
-.IP "" 4
-.
-.nf
-
-$ npm install ext
-.
-.fi
-.
-.IP "" 0
-

docs/migrate.html

@@ -1,412 +0,0 @@
-<html>
-	<head>
-		<title>Express - node web framework</title>
-		<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
-		<style>
-			#tagline {
-			  margin-left: 75px;
-			  margin-bottom: 30px;
-			  color: rgba(255,255,255,0.7); }
-			html {
-			  background: #1c1c1c url(images/bg.tile.jpg); }
-
-			body {
-			  margin: 0;
-			  padding-bottom: 30px;
-			  font: 14px/1.4 "Helvetica Neue", "Lucida Grande", "Arial";
-			  font-size: 14px;
-			  line-height: 1.5;
-			  -webkit-font-smoothing: antialiased;
-			  background: url(images/bg.jpg) 50% 0 no-repeat;
-			  color: #8b8b8b; }
-
-			* {
-			  outline: none; }
-
-			em {
-			  color: white; }
-
-			a img {
-			  border: none !important; }
-
-			a {
-			  font-weight: bold;
-			  text-decoration: none;
-			  color: white;
-			  -webkit-transition-property: opacity, -webkit-transform, color, background-color, padding, -webkit-box-shadow;
-			  -webkit-transition-duration: 0.15s;
-			  -webkit-transition-timing-function: ease-out; }
-			  a:hover {
-			    opacity: 0.8; }
-
-			h1, h2, h3, h4 {
-			  margin: 45px 0 0 0;
-			  color: white;
-			  text-shadow: 1px 2px 2px rgba(0,0,0,0.6); }
-
-			h3 {
-			  font-size: 18px; }
-			h4 {
-			  margin-left: 10px;
-			  font-size: 14px;
-			}
-
-			pre {
-			  margin: 20px 10px;
-			  padding: 25px 20px;
-			  background: rgba(0,0,0,0.5);
-			  border: 1px solid #323232;
-			  -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			  -webkit-border-radius: 5px;
-			  -moz-border-radius: 5px; }
-
-			code {
-			  font-family: "Helvetica Neue", "Lucida Grande", "Arial"; }
-
-			ul {
-			  margin: 15px 0;
-			  padding: 0 0 0 35px; }
-			  ul li {
-			    margin: 0;
-			    padding: 2px 0;
-			    list-style: square; }
-          ul li ul {
-            margin: 0;
-            padding-left: 12px;
-          }
-
-      .man-name, #Express { display:none; }
-
-			.sect {
-			  margin-left: 40px; }
-			img {
-			  margin-left: 20px;
-			  margin-bottom: 15px;
-			}
-
-			#logo {
-			  display: block;
-			  margin-left: 30%;
-			  margin-bottom: 30px;
-			  width: 194px;
-			  height: 51px;
-			  background: url(images/logo.png) 0 0 no-repeat;
-			  text-indent: -99999px; }
-			  #logo:hover {
-			    opacity: 0.7; }
-			  #logo:active {
-			    opacity: 0.3; }
-
-			#ribbon {
-			  position: fixed;
-			  top: 0;
-			  right: 0;
-			  z-index: 2; }
-
-			#wrapper {
-			  width: 100%;
-			  min-height: 800px;
-			  background: url(images/top.png) 0 0 repeat-x; }
-
-			#container {
-			  margin: 0 auto;
-			  padding-top: 80px;
-			  width: 550px; }
-
-			#toc {
-				position: fixed;
-				top: 0;
-				left: 0;
-				margin: 0 0 0 15px;
-				padding: 15px;
-				height: 100%;
-				background: rgba(0,0,0,0.2);
-				overflow: auto;
-				border-right: 1px solid rgba(255,255,255,0.05);
-			}
-			#toc li {
-				padding: 0;
-				list-style: none;
-			}
-			#toc li a {
-				font-size: 11px;
-			}
-			#menu {
-			  margin-left: 65px;
-			  padding: 0;
-			  padding-bottom: 30px; }
-			  #menu li {
-			    display: inline;
-			    list-style: none; }
-			    #menu li a {
-			      display: block;
-			      float: left;
-			      margin: 0 2px;
-			      padding: 3px 15px;
-			      background: rgba(0,0,0,0.2);
-			      -webkit-border-radius: 8px;
-			      -moz-border-radius: 8px;
-			      -webkit-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -moz-box-shadow: 1px 2px 2px rgba(0,0,0,0.6);
-			      -webkit-transition-property: opacity, -webkit-transform, color, background-color, -webkit-box-shadow;
-			      -webkit-transition-duration: 0.15s;
-			      -webkit-transition-timing-function: ease-out; }
-			      #menu li a:hover,
-			      #menu li a.active {
-			        background: rgba(0,0,0,0.5); }
-			      #menu li a:active {
-			        background: rgba(0,0,0,0.1);
-			        -webkit-box-shadow: 1px 1px 1px rgba(0,0,0,0.4);
-			        -moz-box-shadow: 1px 1px 1px rgba(0,0,0,0.4); }
-		</style>
-		<script>
-		  $(function(){
-		    $('.section').hide();
-		    $('.toggle, a.section-title').toggle(function(){
-		      $(this).siblings('ul').fadeIn(300);
-		      return false;
-		    }, function(){
-		      $(this).siblings('ul').fadeOut(300);
-		      return false;
-		    });
-		  });
-		</script>
-	</head>
-	<body>
-		<a href='http://github.com/visionmedia/express'> 
-		  <img alt='Fork me on GitHub' id='ribbon' src='http://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png' /> 
-		</a>
-		<div id="wrapper">
-			<div id="container">
-				<a href='http://github.com/visionmedia/express' id='logo'>Express</a> 
-				<p id="tagline">
-				   High performance, high class web development for
-				  <a href="http://nodejs.org">Node.js</a>
-				</p>
-				<ul id="menu">
-					<li><a href="index.html">Home</a></li>
-					<li><a href="guide.html">Guide</a></li>
-					<li><a href="contrib.html">Contributing</a></li>
-					<li><a href="applications.html">Applications</a></li>
-				</ul>
-<div class='mp'>
-<h2 id="Express">Express</h2>
-<p class="man-name">
-  <code>migrate</code>
-</p>
-<h3 id="Built-On-Connect">Built On Connect</h3>
-
-<p>Express 1.x is written to run on-top of the <a href="http://extjs.github.com/Connect">Connect</a> middlware
-framework, thus the <em>Plugin</em> has been replaced by Connect's middleware. By abstracting our middleware
-to Connect we allow additional community frameworks to develop robust, high-level frameworks using
-the same technologies as Express.</p>
-
-<h3 id="Creating-Applications">Creating Applications</h3>
-
-<p>Previously due to legacy code implemented in the early days of node,
-Express unfortunately had some globals. The DSL would previously be
-accessed as shown below:</p>
-
-<pre><code>require('express');
-
-configure(function(){
-    // app configuration
-});
-
-get('/', function(){
-    return 'hello world';
-});
-</code></pre>
-
-<p>Now we utilize the CommonJS module system appropriately, and
-introduce <em>express.createServer()</em> which accepts the same arguments
-as <em>http.createServer()</em>:</p>
-
-<pre><code>var express = require('express'),
-    app = express.createServer();
-
-app.configure(function(){
-    // app configuration
-});
-
-app.get('/', function(req, res){
-    res.send('hello world');
-});
-</code></pre>
-
-<p>Express 1.x does <em>not</em> currently allow returning of a string.</p>
-
-<h3 id="Plugins-vs-Middleware">Plugins vs Middleware</h3>
-
-<p>Previously Express was bundled with plugins, which were essentially what
-are now Connect middleware. Previously plugins would be utilized in a manor
-similar to below:</p>
-
-<pre><code>use(Logger);
-use(MethodOverride);
-use(Cookie);
-</code></pre>
-
-<p>Which we can now <em>use()</em> within our app, or pass to the <em>express.createServer()</em> method:</p>
-
-<pre><code>var app = express.createServer(
-    express.logger(),
-    express.methodOverride(),
-    express.cookieDecoder()
-);
-</code></pre>
-
-<p>or:</p>
-
-<pre><code>var app = express.createServer();
-
-app.use(express.logger());
-app.use(express.methodOverride());
-app.use(express.cookieDecoder());
-</code></pre>
-
-<p>For documentation on creating Connect middleware visit <a href="http://extjs.github.com/Connect/#Middleware-Authoring">Middleware Authoring</a>.</p>
-
-<h3 id="Running-Applications">Running Applications</h3>
-
-<p>Previously a global function <em>run()</em>, was available:</p>
-
-<pre><code>run();
-</code></pre>
-
-<p>The new <em>express.Server</em> has the same API as <em>http.Server</em>,
-so we can do things like:</p>
-
-<pre><code>app.listen();
-app.listen(3000);
-</code></pre>
-
-<h3 id="Route-Parameters">Route Parameters</h3>
-
-<p>Previously we could use <em>this.param()</em> to attempt
-fetching a route, query string, or request body parameter:</p>
-
-<pre><code>get('/user/:id', function(){
-    this.param('id');
-});
-</code></pre>
-
-<p>Polymorphic parameter access can be done using <code>req.param()</code>:</p>
-
-<pre><code>app.get('/user/:id', function(req, res){
-    req.param('id');
-});
-</code></pre>
-
-<p>Route parameters are available via <code>req.params</code>:</p>
-
-<pre><code>app.get('/user/:id', function(req, res){
-    req.params.id;
-});
-</code></pre>
-
-<h3 id="Passing-Route-Control">Passing Route Control</h3>
-
-<p>Old express had a weak notion of route passing,
-which did not support async, and was never properly
-implemented for practical use:</p>
-
-<pre><code>get('/', function(){
-    this.pass('/foobar');
-});
-</code></pre>
-
-<p>Now Express has access to Connect's <em>next()</em> function,
-which is passed as the third and final argument. Calling <em>next()</em> will
-pass control to the next <em>matching route</em>, or continue down the stack
-of Connect middleware.</p>
-
-<pre><code>app.get('/user/:id?', function(req, res, next){
-    next();
-});
-
-app.get('/user', function(){
-    // ... respond
-});
-</code></pre>
-
-<h3 id="View-Rendering">View Rendering</h3>
-
-<p>View filenames no longer take the form <em>Express</em>.<em>TYPE</em>.<em>ENGINE</em>,
-the <em>Content-Type</em> can be set via <em>res.contentType()</em> or
-<em>res.header()</em>. For example what was previously <em>layout.html.haml</em>,
-should now be <em>layout.haml</em>.</p>
-
-<p>Previously a view render looked something like this:</p>
-
-<pre><code>get('/', function(){
-    this.render('index.html.haml', {
-        locals: { title: 'My Site' }
-    });
-});
-</code></pre>
-
-<p>We now have <em>res.render()</em>, however the options passed to <a href="http://github.com/visionmedia/haml.js">haml</a>, <a href="http://github.com/visionmedia/jade">jade</a>, and others
-remain the same.</p>
-
-<pre><code>app.get('/', function(req, res){
-    res.render('index.haml', {
-        locals: { title: 'My Site' }
-    });
-});
-</code></pre>
-
-<p>Previously rendering of a collection via <em>partial()</em> would look something like this:</p>
-
-<pre><code>this.partial('comment.html.haml', { collection: comments });
-</code></pre>
-
-<p>Although this worked just fine, it was generally to verbose, the similar but new API
-looks like this, as <em>partial()</em> is <em>always</em> passed as a local variable:</p>
-
-<pre><code>partial('comment.haml', { collection: comments });
-</code></pre>
-
-<p>To make things even less verbose we can assume the extension when omitted:</p>
-
-<pre><code>partial('comment', { collection: comments });
-</code></pre>
-
-<p>And once again even further, when rendering a collection we can simply pass
-an array, if no other options are desired:</p>
-
-<pre><code>partial('comments', comments);
-</code></pre>
-
-<h3 id="Redirecting">Redirecting</h3>
-
-<p>Previously you would</p>
-
-<pre><code>this.redirect('/somewhere');
-</code></pre>
-
-<p>However you would now:</p>
-
-<pre><code>res.redirect('/somewhere');
-res.redirect('/somewhere', 301);
-</code></pre>
-
-<h3 id="HTTP-Client">HTTP Client</h3>
-
-<p>Previously Express provided a high level http client, this library is no more
-as it does not belong in Express, however it may be resurrected as a separate module.</p>
-
-<h3 id="Core-Extensions">Core Extensions</h3>
-
-<p>Express is no longer dependent on the <a href="http://github.com/visionmedia/ext.js">JavaScript Extensions</a> library, so those of you using the methods provided by it such as <code>Object.merge(a, b)</code> will need to
-roll your own, or install the module via:</p>
-
-<pre><code>$ npm install ext
-</code></pre>
-
-</div>
-			</div>
-		</div>
-	</body>
-</html>

docs/migrate.md

@@ -1,189 +0,0 @@
-
-### Built On Connect
-
-Express 1.x is written to run on-top of the [Connect](http://extjs.github.com/Connect) middlware
-framework, thus the _Plugin_ has been replaced by Connect's middleware. By abstracting our middleware
-to Connect we allow additional community frameworks to develop robust, high-level frameworks using
-the same technologies as Express.
-
-### Creating Applications
-
-Previously due to legacy code implemented in the early days of node,
-Express unfortunately had some globals. The DSL would previously be
-accessed as shown below:
-
-    require('express');
-
-    configure(function(){
-	    // app configuration
-    });
-
-    get('/', function(){
-	    return 'hello world';
-    });
-
-Now we utilize the CommonJS module system appropriately, and
-introduce _express.createServer()_ which accepts the same arguments
-as _http.createServer()_:
-
-    var express = require('express'),
-		app = express.createServer();
-	
-	app.configure(function(){
-		// app configuration
-	});
-	
-	app.get('/', function(req, res){
-		res.send('hello world');
-	});
-
-Express 1.x does _not_ currently allow returning of a string.
-
-### Plugins vs Middleware
-
-Previously Express was bundled with plugins, which were essentially what
-are now Connect middleware. Previously plugins would be utilized in a manor
-similar to below:
-
-    use(Logger);
-    use(MethodOverride);
-    use(Cookie);
-
-Which we can now _use()_ within our app, or pass to the _express.createServer()_ method:
-
-    var app = express.createServer(
-		express.logger(),
-		express.methodOverride(),
-		express.cookieDecoder()
-	);
-
-or:
-
-	var app = express.createServer();
-
-	app.use(express.logger());
-	app.use(express.methodOverride());
-	app.use(express.cookieDecoder());
-
-For documentation on creating Connect middleware visit [Middleware Authoring](http://extjs.github.com/Connect/#Middleware-Authoring).
-
-### Running Applications
-
-Previously a global function _run()_, was available:
-
-    run();
-
-The new _express.Server_ has the same API as _http.Server_,
-so we can do things like:
-
-	app.listen();
-	app.listen(3000);
-
-### Route Parameters
-
-Previously we could use _this.param()_ to attempt
-fetching a route, query string, or request body parameter:
-
-    get('/user/:id', function(){
-		this.param('id');
-    });
-
-Polymorphic parameter access can be done using `req.param()`:
-
-    app.get('/user/:id', function(req, res){
-		req.param('id');
-	});
-
-Route parameters are available via `req.params`:
-
-    app.get('/user/:id', function(req, res){
-		req.params.id;
-    });
-
-### Passing Route Control
-
-Old express had a weak notion of route passing,
-which did not support async, and was never properly 
-implemented for practical use:
-
-    get('/', function(){
-	    this.pass('/foobar');
-    });
-
-Now Express has access to Connect's _next()_ function,
-which is passed as the third and final argument. Calling _next()_ will
-pass control to the next _matching route_, or continue down the stack
-of Connect middleware.
-
-    app.get('/user/:id?', function(req, res, next){
-	    next();
-    });
-
-	app.get('/user', function(){
-		// ... respond
-	});
-
-### View Rendering
-
-View filenames no longer take the form _NAME_._TYPE_._ENGINE_,
-the _Content-Type_ can be set via _res.contentType()_ or
-_res.header()_. For example what was previously _layout.html.haml_,
-should now be _layout.haml_.
-
-Previously a view render looked something like this:
-
-    get('/', function(){
-		this.render('index.html.haml', {
-			locals: { title: 'My Site' }
-		});
-	});
-
-We now have _res.render()_, however the options passed to [haml](http://github.com/visionmedia/haml.js), [jade](http://github.com/visionmedia/jade), and others
-remain the same.
-
-	app.get('/', function(req, res){
-		res.render('index.haml', {
-			locals: { title: 'My Site' }
-		});
-	});
-
-Previously rendering of a collection via _partial()_ would look something like this:
-
-	this.partial('comment.html.haml', { collection: comments });
-
-Although this worked just fine, it was generally to verbose, the similar but new API
-looks like this, as _partial()_ is _always_ passed as a local variable:
-
-    partial('comment.haml', { collection: comments });
-
-To make things even less verbose we can assume the extension when omitted:
-
-    partial('comment', { collection: comments });
-
-And once again even further, when rendering a collection we can simply pass
-an array, if no other options are desired:
-
-    partial('comments', comments);
-
-### Redirecting
-
-Previously you would
-
-    this.redirect('/somewhere');
-
-However you would now:
-
-    res.redirect('/somewhere');
-    res.redirect('/somewhere', 301);
-
-### HTTP Client
-
-Previously Express provided a high level http client, this library is no more
-as it does not belong in Express, however it may be resurrected as a separate module.
-
-### Core Extensions
-
-Express is no longer dependent on the [JavaScript Extensions](http://github.com/visionmedia/ext.js) library, so those of you using the methods provided by it such as `Object.merge(a, b)` will need to
-roll your own, or install the module via:
-
-    $ npm install ext

docs/request.md

@@ -0,0 +1,107 @@
+
+# req
+
+  Request prototype.
+
+# req.get
+
+  Return request header.
+  
+  The `Referrer` header field is special-cased,
+  both `Referrer` and `Referer` are interchangeable.
+  
+  ## Examples
+  
+      req.get('Content-Type');
+      // => "text/plain"
+      
+      req.get('content-type');
+      // => "text/plain"
+      
+      req.get('Something');
+      // => undefined
+  
+  Aliased as `req.header()`.
+
+# req.accepts()
+
+  Check if the given `type(s)` is acceptable, returning
+  the best match when true, otherwise `undefined`, in which
+  case you should respond with 406 "Not Acceptable".
+  
+  The `type` value may be a single mime type string
+  such as "application/json", the extension name
+  such as "json", a comma-delimted list such as "json, html, text/plain",
+  or an array `["json", "html", "text/plain"]`. When a list
+  or array is given the _best_ match, if any is returned.
+  
+  ## Examples
+  
+      // Accept: text/html
+      req.accepts('html');
+      // => "html"
+  
+      // Accept: text/*, application/json
+      req.accepts('html');
+      // => "html"
+      req.accepts('text/html');
+      // => "text/html"
+      req.accepts('json, text');
+      // => "json"
+      req.accepts('application/json');
+      // => "application/json"
+  
+      // Accept: text/*, application/json
+      req.accepts('image/png');
+      req.accepts('png');
+      // => undefined
+  
+      // Accept: text/*;q=.5, application/json
+      req.accepts(['html', 'json']);
+      req.accepts('html, json');
+      // => "json"
+
+# req.acceptsCharset()
+
+  Check if the given `charset` is acceptable,
+  otherwise you should respond with 406 "Not Acceptable".
+
+# req.acceptsLanguage()
+
+  Check if the given `lang` is acceptable,
+  otherwise you should respond with 406 "Not Acceptable".
+
+# req.param()
+
+  Return the value of param `name` when present or `defaultValue`.
+  
+   - Checks route placeholders, ex: _/user/:id_
+   - Checks body params, ex: id=12, {"id":12}
+   - Checks query string params, ex: ?id=12
+  
+  To utilize request bodies, `req.body`
+  should be an object. This can be done by using
+  the `connect.bodyParser()` middleware.
+
+# req.is()
+
+  Check if the incoming request contains the "Content-Type" 
+  header field, and it contains the give mime `type`.
+  
+  ## Examples
+  
+       // With Content-Type: text/html; charset=utf-8
+       req.is('html');
+       req.is('text/html');
+       req.is('text/*');
+       // => true
+      
+       // When Content-Type is application/json
+       req.is('json');
+       req.is('application/json');
+       req.is('application/*');
+       // => true
+      
+       req.is('html');
+       // => false
+

docs/response.md

@@ -0,0 +1,218 @@
+
+# res
+
+  Response prototype.
+
+# res.status()
+
+  Set status `code`.
+
+# res.send()
+
+  Send a response.
+  
+  ## Examples
+  
+      res.send(new Buffer('wahoo'));
+      res.send({ some: 'json' });
+      res.send('<p>some html</p>');
+      res.send(404, 'Sorry, cant find that');
+      res.send(404);
+
+# res.json()
+
+  Send JSON response.
+  
+  ## Examples
+  
+      res.json(null);
+      res.json({ user: 'tj' });
+      res.json(500, 'oh noes!');
+      res.json(404, 'I dont have that');
+
+# res.sendfile()
+
+  Transfer the file at the given `path`.
+  
+  Automatically sets the _Content-Type_ response header field.
+  The callback `fn(err)` is invoked when the transfer is complete
+  or when an error occurs. Be sure to check `res.sentHeader`
+  if you wish to attempt responding, as the header and some data
+  may have already been transferred.
+  
+  ## Options
+  
+    - `maxAge` defaulting to 0
+    - `root`   root directory for relative filenames
+  
+  ## Examples
+  
+   The following example illustrates how `res.sendfile()` may
+   be used as an alternative for the `static()` middleware for
+   dynamic situations. The code backing `res.sendfile()` is actually
+   the same code, so HTTP cache support etc is identical.
+  
+      app.get('/user/:uid/photos/:file', function(req, res){
+        var uid = req.params.uid
+          , file = req.params.file;
+      
+        req.user.mayViewFilesFrom(uid, function(yes){
+          if (yes) {
+            res.sendfile('/uploads/' + uid + '/' + file);
+          } else {
+            res.send(403, 'Sorry! you cant see that.');
+          }
+        });
+      });
+
+# res.download()
+
+  Transfer the file at the given `path` as an attachment.
+  
+  Optionally providing an alternate attachment `filename`,
+  and optional callback `fn(err)`. The callback is invoked
+  when the data transfer is complete, or when an error has
+  ocurred. Be sure to check `res.headerSent` if you plan to respond.
+  
+  This method uses `res.sendfile()`.
+
+# res.format()
+
+  Respond to the Acceptable formats using an `obj`
+  of mime-type callbacks.
+  
+  This method uses `req.accepted`, an array of
+  acceptable types ordered by their quality values.
+  When "Accept" is not present the _first_ callback
+  is invoked, otherwise the first match is used. When
+  no match is performed the server responds with
+  406 "Not Acceptable".
+  
+  Content-Type is set for you, however if you choose
+  you may alter this within the callback using `res.type()`
+  or `res.set('Content-Type', ...)`.
+  
+     res.format({
+       'text/plain': function(){
+         res.send('hey');
+       },
+     
+       'text/html': function(){
+         res.send('<p>hey</p>');
+       },
+     
+       'appliation/json': function(){
+         res.send({ message: 'hey' });
+       }
+     });
+  
+  In addition to canonicalized MIME types you may
+  also use extnames mapped to these types:
+  
+     res.format({
+       text: function(){
+         res.send('hey');
+       },
+     
+       html: function(){
+         res.send('<p>hey</p>');
+       },
+     
+       json: function(){
+         res.send({ message: 'hey' });
+       }
+     });
+  
+  By default Express passes an `Error`
+  with a `.status` of 406 to `next(err)`
+  if a match is not made, however you may
+  provide an optional callback `fn` to
+  be invoked instead.
+
+# res.attachment()
+
+  Set _Content-Disposition_ header to _attachment_ with optional `filename`.
+
+# res.set
+
+  Set header `field` to `val`, or pass
+  an object of header fields.
+  
+  ## Examples
+  
+     res.set('Accept', 'application/json');
+     res.set({ Accept: 'text/plain', 'X-API-Key': 'tobi' });
+  
+  Aliased as `res.header()`.
+
+# res.get()
+
+  Get value for header `field`.
+
+# res.clearCookie()
+
+  Clear cookie `name`.
+
+# res.cookie()
+
+  Set cookie `name` to `val`, with the given `options`.
+  
+  ## Options
+  
+     - `maxAge`   max-age in milliseconds, converted to `expires`
+     - `signed`   sign the cookie
+     - `path`     defaults to "/"
+  
+  ## Examples
+  
+     // "Remember Me" for 15 minutes
+     res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true });
+  
+     // save as above
+     res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true })
+
+# res.redirect()
+
+  Redirect to the given `url` with optional response `status`
+  defaulting to 302.
+  
+  The given `url` can also be the name of a mapped url, for
+  example by default express supports "back" which redirects
+  to the _Referrer_ or _Referer_ headers or "/".
+  
+  ## Examples
+  
+     res.redirect('/foo/bar');
+     res.redirect('http://example.com');
+     res.redirect(301, 'http://example.com');
+     res.redirect('../login'); // /blog/post/1 -> /blog/login
+  
+  ## Mounting
+  
+    When an application is mounted, and `res.redirect()`
+    is given a path that does _not_ lead with "/". For 
+    example suppose a "blog" app is mounted at "/blog",
+    the following redirect would result in "/blog/login":
+  
+       res.redirect('login');
+  
+    While the leading slash would result in a redirect to "/login":
+  
+       res.redirect('/login');
+
+# res.render()
+
+  Render `view` with the given `options` and optional callback `fn`.
+  When a callback function is given a response will _not_ be made
+  automatically, otherwise a response of _200_ and _text/html_ is given.
+  
+  ## Options
+   
+   - `status`    Response status code (`res.statusCode`)
+   - `charset`   Set the charset (`res.charset`)
+  
+  ## Reserved locals
+  
+   - `cache`     boolean hinting to the engine it should cache
+   - `filename`  filename of the view being rendered
+

examples/auth/app.js

@@ -1,65 +1,63 @@
 
-// Expose modules in ./support for demo purposes
-require.paths.unshift(__dirname + '/../../support');
-
 /**
  * Module dependencies.
  */
 
-var express = require('../../lib/express'),
-    crypto = require('crypto');
+var express = require('../../lib/express')
+  , crypto = require('crypto');
 
-var app = express.createServer();
+var app = module.exports = express();
 
-app.set('views', __dirname + '/views');
-app.set('view engine', 'ejs');
-
-app.use(express.bodyDecoder());
-app.use(express.cookieDecoder());
+app.use(express.bodyParser());
+app.use(express.cookieParser('shhhh, very secret'));
 app.use(express.session());
 
-// Message helper, ideally we would use req.flash()
-// however this is more light-weight for an example
+app.set('view engine', 'ejs');
+app.set('views', __dirname + '/views');
 
-app.dynamicHelpers({
-    message: function(req){
-        var err = req.session.error,
-            msg = req.session.success;
-        delete req.session.error;
-        delete req.session.success;
-        if (err) return '<p class="msg error">' + err + '</p>';
-        if (msg) return '<p class="msg success">' + msg + '</p>';
-    }
-});
+// Session-persisted message middleware
+
+app.locals.use(function(req,res){
+  var err = req.session.error
+    , msg = req.session.success;
+  delete req.session.error;
+  delete req.session.success;
+  res.locals.message = '';
+  if (err) res.locals.message = '<p class="msg error">' + err + '</p>';
+  if (msg) res.locals.message = '<p class="msg success">' + msg + '</p>';
+})
 
 // Generate a salt for the user to prevent rainbow table attacks
-
+// for better security take a look at the bcrypt c++ addon:
+// https://github.com/ncb000gt/node.bcrypt.js
 var users = {
-    tj: {
-        name: 'tj',
-        salt: 'randomly-generated-salt',
-        pass: md5('foobar' + 'randomly-generated-salt')
-    }
+  tj: {
+      name: 'tj'
+    , salt: 'randomly-generated-salt'
+    , pass: hash('foobar', 'randomly-generated-salt')
+  }
 };
 
 // Used to generate a hash of the plain-text password + salt
-
-function md5(str) {
-    return crypto.createHash('md5').update(str).digest('hex');
+function hash(msg, key) {
+  return crypto
+    .createHmac('sha256', key)
+    .update(msg)
+    .digest('hex');
 }
 
 // Authenticate using our plain-object database of doom!
-
 function authenticate(name, pass, fn) {
-    var user = users[name];
-    // query the db for the given username
-    if (!user) return fn(new Error('cannot find user'));
-    // apply the same algorithm to the POSTed password, applying
-    // the md5 against the pass / salt, if there is a match we
-    // found the user
-    if (user.pass == md5(pass + user.salt)) return fn(null, user);
-    // Otherwise password is invalid
-    fn(new Error('invalid password'));
+  if (!module.parent) console.log('authenticating %s:%s', name, pass);
+  var user = users[name];
+  // query the db for the given username
+  if (!user) return fn(new Error('cannot find user'));
+  // apply the same algorithm to the POSTed password, applying
+  // the hash against the pass / salt, if there is a match we
+  // found the user
+  if (user.pass == hash(pass, user.salt)) return fn(null, user);
+  // Otherwise password is invalid
+  fn(new Error('invalid password'));
 }
 
 function restrict(req, res, next) {
@@ -71,56 +69,53 @@ function restrict(req, res, next) {
   }
 }
 
-function accessLogger(req, res, next) {
-    console.log('/restricted accessed by %s', req.session.user.name);
-    next();
-}
-
 app.get('/', function(req, res){
-    res.redirect('/login');
+  res.redirect('login');
 });
 
-app.get('/restricted', restrict, accessLogger, function(req, res){
-    res.send('Wahoo! restricted area');
+app.get('/restricted', restrict, function(req, res){
+  res.send('Wahoo! restricted area');
 });
 
 app.get('/logout', function(req, res){
-    // destroy the user's session to log them out
-    // will be re-created next request
-    req.session.destroy(function(){
-        res.redirect('home');
-    });
+  // destroy the user's session to log them out
+  // will be re-created next request
+  req.session.destroy(function(){
+    res.redirect('/');
+  });
 });
 
 app.get('/login', function(req, res){
-    if (req.session.user) {
-        req.session.success = 'Authenticated as ' + req.session.user.name
-            + ' click to <a href="/logout">logout</a>. '
-            + ' You may now access <a href="/restricted">/restricted</a>.';
-    }
-    res.render('login');
+  if (req.session.user) {
+    req.session.success = 'Authenticated as ' + req.session.user.name
+      + ' click to <a href="/logout">logout</a>. '
+      + ' You may now access <a href="/restricted">/restricted</a>.';
+  }
+  res.render('login');
 });
 
 app.post('/login', function(req, res){
-    authenticate(req.body.username, req.body.password, function(err, user){
-        if (user) {
-            // Regenerate session when signing in
-            // to prevent fixation 
-            req.session.regenerate(function(){
-                // Store the user's primary key 
-                // in the session store to be retrieved,
-                // or in this case the entire user object
-                req.session.user = user;
-                res.redirect('back');
-            });
-        } else {
-            req.session.error = 'Authentication failed, please check your '
-                + ' username and password.'
-                + ' (use "tj" and "foobar")';
-            res.redirect('back');
-        }
-    });
+  authenticate(req.body.username, req.body.password, function(err, user){
+    if (user) {
+      // Regenerate session when signing in
+      // to prevent fixation 
+      req.session.regenerate(function(){
+        // Store the user's primary key 
+        // in the session store to be retrieved,
+        // or in this case the entire user object
+        req.session.user = user;
+        res.redirect('back');
+      });
+    } else {
+      req.session.error = 'Authentication failed, please check your '
+        + ' username and password.'
+        + ' (use "tj" and "foobar")';
+      res.redirect('login');
+    }
+  });
 });
 
-app.listen(3000);
-console.log('Express started on port 3000');
+if (!module.parent) {
+  app.listen(3000);
+  console.log('Express started on port 3000');
+}

examples/auth/views/login.ejs

@@ -1,6 +1,6 @@
 <h1>Login</h1>
 <%- message %>
-Try accessing <a href="/restricted">/restricted</a>.
+Try accessing <a href="/restricted">/restricted</a>, then authenticate with "tj" and "foobar".
 <form method="post" action="/login">
   <p>
     <label>Username:</label>

examples/big-view/index.js

@@ -0,0 +1,24 @@
+
+var express = require('../..')
+  , app = express();
+
+app.set('views', __dirname);
+app.set('view engine', 'jade');
+
+var pets = [];
+
+var n = 1000;
+while (n--) {
+  pets.push({ name: 'Tobi', age: 2, species: 'ferret' });
+  pets.push({ name: 'Loki', age: 1, species: 'ferret' });
+  pets.push({ name: 'Jane', age: 6, species: 'ferret' });
+}
+
+app.use(express.logger('dev'));
+
+app.get('/', function(req, res){
+  res.render('pets', { pets: pets });
+});
+
+app.listen(3000);
+console.log('Express listening on port 3000');

examples/big-view/pets.jade

@@ -0,0 +1,12 @@
+style
+  body {
+    padding: 50px;
+    font: 16px "Helvetica Neue", Helvetica;
+  }
+
+table
+  for pet in pets
+    tr
+      td= pet.name
+      td= pet.age
+      td= pet.species

examples/blog/app.js

@@ -1,25 +0,0 @@
-
-// Expose modules in ./support for demo purposes
-require.paths.unshift(__dirname + '/../../support');
-
-/**
- * Module dependencies.
- */
-
-var express = require('./../../lib/express');
-
-// Our app IS the exports, this prevents require('./app').app,
-// instead it is require('./app');
-var app = module.exports = express.createServer();
-
-// Illustrates that an app can be broken into
-// several files, but yet extend the same app
-require('./main');
-require('./contact');
-
-// Illustrates that one app (Server instance) can
-// be "mounted" to another at the given route.
-app.use('/blog', require('./blog'));
-
-app.listen(3000);
-console.log('Express started on port 3000');

examples/blog/blog/index.js

@@ -1,45 +0,0 @@
-
-/**
- * Module dependencies.
- */
-
-var express = require('./../../../lib/express'),
-    fs = require('fs');
-
-// Export our app as the module
-var app = module.exports = express.createServer();
-
-// Set views directory
-app.set('views', __dirname + '/views');
-
-// Load our posts
-var posts = JSON.parse(fs.readFileSync(__dirname + '/posts.json', 'utf8'));
-
-// Set our default view engine to "ejs"
-app.set('view engine', 'ejs');
-
-app.dynamicHelpers({
-    basepath: function(){
-        // "this" is the app, we can
-        // dynamically provide the "home"
-        // setting to all views
-        return this.set('home');
-    }
-});
-
-app.get('/', function(req, res){
-    res.render('index', {
-        locals: {
-            posts: posts
-        }
-    });
-});
-
-app.get('/post/:id', function(req, res){
-    var id = req.params.id;
-    res.render('post', {
-        locals: {
-            post: posts[id]
-        }
-    });
-});

examples/blog/blog/posts.json

@@ -1,4 +0,0 @@
-[
- { "id": 0, "title": "Post one", "body": "Just some lame post" },
- { "id": 1, "title": "Post two", "body": "Just another lame post" }
-]

examples/blog/blog/views/index.ejs

@@ -1,2 +0,0 @@
-<h2>Posts</h2>
-<%- partial('post', { collection: posts, as: global }) %>

examples/blog/blog/views/layout.ejs

@@ -1,9 +0,0 @@
-<html>
-    <head>
-        <title>Blog Example</title>
-    </head>
-    <body>
-        <h1>Best Blog Ever</h1>
-        <%- body %>
-    </body>
-</html>

examples/blog/blog/views/partials/post.ejs

@@ -1,2 +0,0 @@
-<h3><a href="<%= basepath %>/post/<%= id %>"><%= title %></a></h3>
-<p><%= body %></p>

examples/blog/blog/views/post.ejs

@@ -1 +0,0 @@
-<%- partial('post', { object: post, as: global }) %>

examples/blog/contact.js

@@ -1,9 +0,0 @@
-
-// in ./app.js we did "module.exports", allowing
-// us to grab the app from the parent module (the one 
-// which required it)
-var app = module.parent.exports;
-
-app.get('/contact', function(req, res){
-    res.send('<p>Wahoo contact page</p>');
-});

examples/blog/main.js

@@ -1,10 +0,0 @@
-
-// in ./app.js we did "module.exports", allowing
-// us to grab the app from the parent module (the one 
-// which required it)
-var app = module.parent.exports;
-
-app.get('/', function(req, res){
-    res.send('<p>Visit <a href="/blog">/blog</a>'
-        + ' or <a href="/contact">/contact</a></p>');
-});

examples/content-negotiation/db.js

@@ -0,0 +1,8 @@
+
+var users = [];
+
+users.push({ name: 'Tobi' });
+users.push({ name: 'Loki' });
+users.push({ name: 'Jane' });
+
+module.exports = users;

examples/content-negotiation/index.js

@@ -0,0 +1,41 @@
+
+var express = require('../../')
+  , app = module.exports = express()
+  , users = require('./db');
+
+app.get('/', function(req, res){
+  res.format({
+    html: function(){
+      res.send('<ul>' + users.map(function(user){
+        return '<li>' + user.name + '</li>';
+      }).join('') + '</ul>');
+    },
+
+    text: function(){
+      res.send(users.map(function(user){
+        return ' - ' + user.name + '\n';
+      }).join(''));
+    },
+
+    json: function(){
+      res.json(users);
+    }
+  })
+});
+
+// or you could write a tiny middleware like
+// this to abstract make things a bit more declarative:
+
+function format(mod) {
+  var obj = require(mod);
+  return function(req, res){
+    res.format(obj);
+  }
+}
+
+app.get('/users', format('./users'));
+
+if (!module.parent) {
+  app.listen(3000);
+  console.log('listening on port 3000');
+}

examples/content-negotiation/users.js

@@ -0,0 +1,18 @@
+
+var users = require('./db');
+
+exports.html = function(req, res){
+  res.send('<ul>' + users.map(function(user){
+    return '<li>' + user.name + '</li>';
+  }).join('') + '</ul>');
+};
+
+exports.text = function(req, res){
+  res.send(users.map(function(user){
+    return ' - ' + user.name + '\n';
+  }).join(''));
+};
+
+exports.json = function(req, res){
+  res.json(users);
+};

examples/cookie-sessions/index.js

@@ -0,0 +1,32 @@
+
+/**
+ * Module dependencies.
+ */
+
+var express = require('../../');
+
+var app = module.exports = express();
+
+// ignore GET /favicon.ico
+app.use(express.favicon());
+
+// pass a secret to cookieParser() for signed cookies
+app.use(express.cookieParser('manny is cool'));
+
+// add req.session cookie support
+app.use(express.cookieSession());
+
+// do something with the session
+app.use(count);
+
+// custom middleware
+function count(req, res) {
+  req.session.count = req.session.count || 0;
+  var n = req.session.count++;
+  res.send('viewed ' + n + ' times\n');
+}
+
+if (!module.parent) {
+  app.listen(3000);
+  console.log('Express server listening on port 3000');
+}

examples/cookies/app.js

@@ -3,44 +3,52 @@
  * Module dependencies.
  */
 
-var express = require('./../../lib/express');
+var express = require('../../')
+  , app = module.exports = express();
 
-var app = express.createServer(
-    // Place default Connect favicon above logger so it is not in
-    // the logging output
-    express.favicon(),
 
-    // Custom logger format
-    express.logger({ format: '\x1b[1m:method\x1b[0m \x1b[33m:url\x1b[0m :response-time' }),
+// add favicon() before logger() so
+// GET /favicon.ico requests are not
+// logged, because this middleware
+// reponds to /favicon.ico and does not
+// call next()
+app.use(express.favicon());
 
-    // Provides req.cookies
-    express.cookieDecoder(),
+// custom log format
+if ('test' != process.env.NODE_ENV)
+  app.use(express.logger(':method :url'));
 
-    // Parses x-www-form-urlencoded request bodies (and json)
-    express.bodyDecoder()
-);
+// parses request cookies, populating
+// req.cookies and req.signedCookies
+// when the secret is passed, used 
+// for signing the cookies.
+app.use(express.cookieParser('my secret here'));
+
+// parses json, x-www-form-urlencoded, and multipart/form-data
+app.use(express.bodyParser());
 
 app.get('/', function(req, res){
-    if (req.cookies.remember) {
-        res.send('Remembered :). Click to <a href="/forget">forget</a>!.');
-    } else {
-        res.send('<form method="post"><p>Check to <label>'
-            + '<input type="checkbox" name="remember"/> remember me</label> '
-            + '<input type="submit" value="Submit"/>.</p></form>');
-    }
+  if (req.cookies.remember) {
+    res.send('Remembered :). Click to <a href="/forget">forget</a>!.');
+  } else {
+    res.send('<form method="post"><p>Check to <label>'
+      + '<input type="checkbox" name="remember"/> remember me</label> '
+      + '<input type="submit" value="Submit"/>.</p></form>');
+  }
 });
 
 app.get('/forget', function(req, res){
-    res.clearCookie('remember');
-    res.redirect('back');
+  res.clearCookie('remember');
+  res.redirect('back');
 });
 
 app.post('/', function(req, res){
-    if (req.body.remember) {
-        res.cookie('remember', '1', { path: '/', expires: new Date(Date.now() + 900000), httpOnly: true });
-    }
-    res.redirect('back');
+  var minute = 60000;
+  if (req.body.remember) res.cookie('remember', 1, { maxAge: minute });
+  res.redirect('back');
 });
 
-app.listen(3000);
-console.log('Express started on port 3000');
+if (!module.parent){
+  app.listen(3000);
+  console.log('Express started on port 3000');
+}

examples/downloads/app.js

@@ -3,30 +3,42 @@
  * Module dependencies.
  */
 
-var express = require('./../../lib/express');
-
-var app = express.createServer();
+var express = require('../../')
+  , app = module.exports = express();
 
 app.get('/', function(req, res){
-    res.send('<ul>'
-        + '<li>Download <a href="/files/amazing.txt">amazing.txt</a>.</li>'
-        + '<li>Download <a href="/files/missing.txt">missing.txt</a>.</li>'
-        + '</ul>');
+  res.send('<ul>'
+    + '<li>Download <a href="/files/amazing.txt">amazing.txt</a>.</li>'
+    + '<li>Download <a href="/files/missing.txt">missing.txt</a>.</li>'
+    + '</ul>');
 });
 
-app.get('/files/*', function(req, res){
-    var file = req.params[0];
-    res.download(__dirname + '/files/' + file);
+// /files/* is accessed via req.params[0]
+// but here we name it :file
+app.get('/files/:file(*)', function(req, res, next){
+  var file = req.params.file
+    , path = __dirname + '/files/' + file;
+
+  res.download(path);
 });
 
-app.error(function(err, req, res, next){
-    if (process.ENOENT == err.errno) {
-        res.send('Cant find that file, sorry!');
-    } else {
-        // Not a 404
-        next(err);
-    }
+// error handling middleware. Because it's
+// below our routes, you will be able to
+// "intercept" errors, otherwise Connect
+// will respond with 500 "Internal Server Error".
+app.use(function(err, req, res, next){
+  // special-case 404s,
+  // remember you could
+  // render a 404 template here
+  if (404 == err.status) {
+    res.statusCode = 404;
+    res.send('Cant find that file, sorry!');
+  } else {
+    next(err);
+  }
 });
 
-app.listen(3000);
-console.log('Express started on port 3000');
+if (!module.parent) {
+  app.listen(3000);
+  console.log('Express started on port 3000');
+}

examples/downloads/files/amazing.txt

@@ -1 +1 @@
-wow supes cool are you glad you downloaded this?
+what an amazing download

examples/ejs/app.js

@@ -1,32 +0,0 @@
-
-// Expose modules in ./support for demo purposes
-require.paths.unshift(__dirname + '/../../support');
-
-/**
- * Module dependencies.
- */
-
-var express = require('./../../lib/express');
-
-var app = express.createServer();
-
-// Optional since express defaults to CWD/views
-
-app.set('views', __dirname + '/views');
-
-// Dummy users
-var users = [
-    { name: 'tj', email: 'tj@sencha.com' },
-    { name: 'ciaran', email: 'ciaranj@gmail.com' },
-    { name: 'aaron', email: 'aaron.heckmann+github@gmail.com' }
-];
-
-app.get('/', function(req, res){
-    res.render('users.ejs', {
-        locals: {
-            users: users
-        }
-    });
-});
-
-app.listen(3000);

examples/ejs/index.js

@@ -0,0 +1,46 @@
+
+/**
+ * Module dependencies.
+ */
+
+var express = require('../../');
+
+var app = module.exports = express();
+
+// Register ejs as .html. If we did
+// not call this, we would need to
+// name our views foo.ejs instead
+// of foo.html. The __express method
+// is simply a function that engines
+// use to hook into the Express view
+// system by default, so if we want
+// to change "foo.ejs" to "foo.html"
+// we simply pass _any_ function, in this
+// case `ejs.__express`.
+
+app.engine('.html', require('ejs').__express);
+
+// Optional since express defaults to CWD/views
+
+app.set('views', __dirname + '/views');
+
+// Without this you would need to
+// supply the extension to res.render()
+// ex: res.render('users.html').
+app.set('view engine', 'html');
+
+// Dummy users
+var users = [
+    { name: 'tobi', email: 'tobi@learnboost.com' }
+  , { name: 'loki', email: 'loki@learnboost.com' }
+  , { name: 'jane', email: 'jane@learnboost.com' }
+];
+
+app.get('/', function(req, res){
+  res.render('users', { users: users });
+});
+
+if (!module.parent) {
+  app.listen(3000);
+  console.log('Express app started on port 3000');
+}

examples/ejs/views/layout.ejs

@@ -1,6 +0,0 @@
-<html>
-    <body>
-        <h1>Users</h1>
-        <%- body %>
-    </body>
-</html>

examples/ejs/views/partials/user.ejs

@@ -1 +0,0 @@
-<li><%= user.name %> &lt;<%= user.email %>&gt;</li>

examples/ejs/views/users.ejs

@@ -1,3 +0,0 @@
-<ul id="users">
-    <%- partial('user', users) %>
-</ul>

examples/ejs/views/users.html

@@ -0,0 +1,6 @@
+<h1>Users</h1>
+<ul id="users">
+  <% users.forEach(function(user){ %>
+    <li><%= user.name %> <%= user.email %></li>
+  <% }) %>
+</ul>

examples/error-pages/app.js

@@ -1,103 +0,0 @@
-
-// Expose modules in ./support for demo purposes
-require.paths.unshift(__dirname + '/../../support');
-
-/**
- * Module dependencies.
- */
-
-var express = require('./../../lib/express');
-
-var app = express.createServer(),
-    sys = require('sys');
-
-// Serve default connect favicon
-app.use(express.favicon());
-
-// Logger is placed below favicon, so favicon.ico
-// requests will not be logged
-app.use(express.logger({ format: '":method :url" :status' }));
-
-// "app.router" positions our routes 
-// specifically above the middleware
-// assigned below
-
-app.use(app.router);
-
-// When no more middleware require execution, aka
-// our router is finished and did not respond, we
-// can assume that it is "not found". Instead of
-// letting Connect deal with this, we define our
-// custom middleware here to simply pass a NotFound
-// exception
-
-app.use(function(req, res, next){
-    next(new NotFound(req.url));
-});
-
-app.set('views', __dirname + '/views');
-
-// Provide our app with the notion of NotFound exceptions
-
-function NotFound(path){
-    this.name = 'NotFound';
-    if (path) {
-        Error.call(this, 'Cannot find ' + path);
-        this.path = path;
-    } else {
-        Error.call(this, 'Not Found');
-    }
-    Error.captureStackTrace(this, arguments.callee);
-}
-
-sys.inherits(NotFound, Error);
-
-// We can call app.error() several times as shown below.
-// Here we check for an instanceof NotFound and show the
-// 404 page, or we pass on to the next error handler.
-
-// These handlers could potentially be defined within
-// configure() blocks to provide introspection when
-// in the development environment.
-
-app.error(function(err, req, res, next){
-    if (err instanceof NotFound) {
-        res.render('404.jade', {
-            status: 404,
-            locals: {
-                error: err
-            }
-        });
-    } else {
-        next(err);
-    }
-});
-
-// Here we assume all errors as 500 for the simplicity of
-// this demo, however you can choose whatever you like
-
-app.error(function(err, req, res){
-    res.render('500.jade', {
-        status: 500,
-        locals: {
-            error: err
-        } 
-    });
-});
-
-// Routes
-
-app.get('/', function(req, res){
-    res.render('index.jade');
-});
-
-app.get('/404', function(req, res){
-    throw new NotFound;
-});
-
-app.get('/500', function(req, res, next){
-    next(new Error('keyboard cat!'));
-});
-
-app.listen(3000);
-console.log('Express app started on port 3000');

examples/error-pages/index.js

@@ -0,0 +1,95 @@
+
+/**
+ * Module dependencies.
+ */
+
+var express = require('../../')
+  , app = module.exports = express()
+  , silent = 'test' == process.env.NODE_ENV;
+
+app.set('views', __dirname + '/views');
+app.set('view engine', 'jade');
+
+app.use(express.favicon());
+
+silent || app.use(express.logger('dev'));
+
+// "app.router" positions our routes 
+// above the middleware defined below,
+// this means that Express will attempt
+// to match & call routes _before_ continuing
+// on, at which point we assume it's a 404 because
+// no route has handled the request.
+
+app.use(app.router);
+
+// Since this is the last non-error-handling
+// middleware use()d, we assume 404, as nothing else
+// responded.
+
+// $ curl http://localhost:3000/notfound
+// $ curl http://localhost:3000/notfound -H "Accept: application/json"
+// $ curl http://localhost:3000/notfound -H "Accept: text/plain"
+
+app.use(function(req, res, next){
+  // respond with html page
+  if (req.accepts('html')) {
+    res.status(404);
+    res.render('404', { url: req.url });
+    return;
+  }
+
+  // respond with json
+  if (req.accepts('json')) {
+    res.send({ error: 'Not found' });
+    return;
+  }
+
+  // default to plain-text. send()
+  res.type('txt').send('Not found');
+});
+
+// error-handling middleware, take the same form
+// as regular middleware, however they require an
+// arity of 4, aka the signature (err, req, res, next).
+// when connect has an error, it will invoke ONLY error-handling
+// middleware.
+
+// If we were to next() here any remaining non-error-handling
+// middleware would then be executed, or if we next(err) to
+// continue passing the error, only error-handling middleware
+// would remain being executed, however here
+// we simply respond with an error page.
+
+app.use(function(err, req, res, next){
+  // we may use properties of the error object
+  // here and next(err) appropriately, or if
+  // we possibly recovered from the error, simply next().
+  res.status(err.status || 500);
+  res.render('500', { error: err });
+});
+
+// Routes
+
+app.get('/', function(req, res){
+  res.render('index.jade');
+});
+
+app.get('/404', function(req, res, next){
+  next();
+});
+
+app.get('/403', function(req, res, next){
+  var err = new Error('not allowed!');
+  err.status = 403;
+  next(err);
+});
+
+app.get('/500', function(req, res, next){
+  next(new Error('keyboard cat!'));
+});
+
+if (!module.parent) {
+  app.listen(3000);
+  silent || console.log('Express started on port 3000');
+}

examples/error-pages/views/404.jade

@@ -1,4 +1,5 @@
-- if (error.path)
-  h2 Cannot find #{error.path}
-- else
-  h2 Page Not Found
+
+extends error
+
+block content
+  h2 Cannot find #{url}

examples/error-pages/views/500.jade

@@ -1,2 +1,10 @@
-h1 Error: #{error.message}
-pre= error.stack
+
+// note that we extend a different
+// layout with jade for 4xx & 5xx
+// responses
+
+extends error
+
+block content
+  h1 Error: #{error.message}
+  pre= error.stack

examples/error-pages/views/error.jade

@@ -0,0 +1,6 @@
+html
+  head 
+    title Error
+  body
+    h1 An error occurred!
+    block content

examples/error-pages/views/index.jade

@@ -1,8 +1,15 @@
-h2 Pages Example
-ul
-  li 
-    | visit 
-    a(href="/500") 500
-  li
-    | visit
-    a(href="/404") 404
+
+extends layout
+
+block content
+  h2 Pages Example
+  ul
+    li 
+      | visit 
+      a(href="/500") 500
+    li
+      | visit
+      a(href="/404") 404
+    li
+      | visit
+      a(href='/403') 403

examples/error-pages/views/layout.jade

@@ -3,4 +3,4 @@ html
     title Custom Pages Example
   body
     h1 My Site
-    != body
+    block content

examples/error/app.js

@@ -1,25 +0,0 @@
-
-/**
- * Module dependencies.
- */
-
-var express = require('./../../lib/express');
-
-var app = express.createServer();
-
-app.get('/', function(req, res){
-    // Caught and passed down to the errorHandler middleware
-    throw new Error('something broke!');
-});
-
-app.get('/next', function(req, res, next){
-    // We can also pass exceptions to next()
-    next(new Error('oh no!'))
-});
-
-// The errorHandler middleware in this case will dump exceptions to stderr
-// as well as show the stack trace in responses, currently handles text/plain,
-// text/html, and application/json responses to aid in development
-app.use('/', express.errorHandler({ dumpExceptions: true, showStack: true }));
-
-app.listen(3000);

examples/error/index.js

@@ -0,0 +1,48 @@
+
+/**
+ * Module dependencies.
+ */
+
+var express = require('../../')
+  , app = module.exports = express()
+  , test = app.get('env') == 'test';
+
+if (!test) app.use(express.logger('dev'));
+app.use(app.router);
+
+// the error handler is strategically
+// placed *below* the app.router; if it
+// were above it would not receive errors
+// from app.get() etc 
+app.use(error);
+
+// error handling middleware have an arity of 4
+// instead of the typical (req, res, next),
+// otherwise they behave exactly like regular
+// middleware, you may have several of them,
+// in different orders etc.
+
+function error(err, req, res, next) {
+  // log it
+  if (!test) console.error(err.stack);
+
+  // respond with 500 "Internal Server Error".
+  res.send(500);
+}
+
+app.get('/', function(req, res){
+  // Caught and passed down to the errorHandler middleware
+  throw new Error('something broke!');
+});
+
+app.get('/next', function(req, res, next){
+  // We can also pass exceptions to next()
+  process.nextTick(function(){
+    next(new Error('oh no!'));
+  });
+});
+
+if (!module.parent) {
+  app.listen(3000);
+  console.log('Express started on port 3000');
+}

examples/expose-data-to-client/index.js

@@ -0,0 +1,68 @@
+
+var express = require('../..')
+  , app = express();
+
+app.set('view engine', 'jade');
+app.set('views', __dirname + '/views');
+
+function User(name) {
+  this.private = 'heyyyy';
+  this.secret = 'something';
+  this.name = name;
+  this.id = 123;
+}
+
+// You'll probably want to do
+// something like this so you
+// dont expose "secret" data.
+
+User.prototype.toJSON = function(){
+  return {
+    id: this.id,
+    name: this.name
+  }
+};
+
+app.use(express.logger('dev'));
+
+// earlier on expose an object
+// that we can tack properties on.
+// all res.locals props are exposed
+// to the templates, so "expose" will
+// be present.
+
+app.use(function(req, res, next){
+  res.locals.expose = {};
+  // you could alias this as req or res.expose
+  // to make it shorter and less annoying
+  next();
+});
+
+// pretend we loaded a user
+
+app.use(function(req, res, next){
+  req.user = new User('Tobi');
+  next();
+});
+
+// if you wanted to _always_ expose
+// the user you might do something like this:
+/*
+app.locals.use(function(req, res){
+  if (req.user) res.locals.expose.user = req.user;
+})
+*/
+
+app.get('/', function(req, res){
+  res.redirect('/user');
+});
+
+app.get('/user', function(req, res){
+  // we only want to expose the user
+  // to the client for this route:
+  res.locals.expose.user = req.user;
+  res.render('page');
+});
+
+app.listen(3000);
+console.log('app listening on port 3000');

examples/expose-data-to-client/views/page.jade

@@ -0,0 +1,14 @@
+html
+  head
+    title Express
+    script
+      // call this whatever you like,
+      // or dump them into individual
+      // props like "var user ="
+      var data = !{JSON.stringify(expose)}
+  body
+    h1 Expose client data
+    p The following was exposed to the client:
+    pre
+      script
+        document.write(JSON.stringify(data, null, 2))

examples/flash/app.js

@@ -1,78 +0,0 @@
-
-// Expose modules in ./support for demo purposes
-require.paths.unshift(__dirname + '/../../support');
-
-/**
- * Module dependencies.
- */
-
-var express = require('../../lib/express');
-
-// App with session support
-
-var app = express.createServer(
-    express.cookieDecoder(),
-    express.session()
-);
-
-// View settings
-
-app.set('views', __dirname + '/views');
-app.set('view engine', 'ejs');
-
-// Dynamic helpers are functions which are executed
-// on each view render, unless dynamicHelpers is false.
-
-// So for example we do not need to call messages() in our
-// template, "messages" will be populated with the return
-// value of this function.
-
-app.dynamicHelpers({
-    messages: function(req, res){
-        // In the case of flash messages
-        // we return a function, allowing
-        // flash messages to only be flushed
-        // when called, otherwise every request
-        // will flush flash messages regardless.
-        return function(){
-            // Grab the flash messages
-            var messages = req.flash();
-            // We will render the "messages.ejs" partial
-            return res.partial('messages', {
-                // Our target object is our messages
-                object: messages,
-                // We want it to be named "types" in the partial
-                // since they are keyed like this:
-                // { info: ['foo'], error: ['bar']}
-                as: 'types',
-                // Pass a local named "hasMessages" so we can easily
-                // check if we have any messages at all
-                locals: { hasMessages: Object.keys(messages).length },
-                // We dont want dynamicHelpers in this partial, as
-                // it would cause infinite recursion
-                dynamicHelpers: false
-            });
-        }
-    }
-});
-
-app.dynamicHelpers({
-    // Another dynamic helper example. Since dynamic
-    // helpers resolve at view rendering time, we can
-    // "inject" the "page" local variable per request
-    // providing us with the request url.
-    page: function(req, res){
-        return req.url;
-    } 
-});
-
-app.get('/', function(req, res){
-    // Not very realistic notifications but illustrates usage
-    req.flash('info', 'email queued');
-    req.flash('info', 'email sent');
-    req.flash('error', 'delivery failed');
-    res.render('index');
-});
-
-app.listen(3000);
-console.log('Express app started on port 3000');

examples/flash/views/index.ejs

@@ -1,3 +0,0 @@
-<h1>Flash Message Example</h1>
-<p>on page <%- page %></p>
-<%- messages() %>

examples/flash/views/layout.ejs

@@ -1,5 +0,0 @@
-<html>
-    <body>
-        <%- body %>
-    </body>
-</html>

examples/flash/views/partials/messages.ejs

@@ -1,12 +0,0 @@
-<% if (hasMessages) { %>
-    <div id="messages">
-        <% for (var type in types) { %>
-            <h2><%= type %> messages</h2>
-            <ul id="<%= type %>">
-                <% types[type].forEach(function(msg){ %>
-                    <li><%= msg %></li>
-                <% }) %>
-            </ul>
-        <% } %>
-    </div>
-<% } %>

examples/form/app.js

@@ -1,79 +0,0 @@
-
-/**
- * Module dependencies.
- */
-
-var express = require('./../../lib/express'),
-    sys = require('sys');
-
-var app = express.createServer();
-
-// Here we use the bodyDecoder middleware
-// to parse urlencoded request bodies
-// which populates req.body
-app.use(express.bodyDecoder());
-    
-// The methodOverride middleware allows us
-// to set a hidden input of _method to an arbitrary
-// HTTP method to support app.put(), app.del() etc
-app.use(express.methodOverride());
-
-// Required by session
-app.use(express.cookieDecoder());
-
-// Required by req.flash() for persistent
-// notifications
-app.use(express.session());
-
-app.get('/', function(req, res){
-    // get ?name=foo
-    var name = req.param('name') || '';
-    
-    // Switch the button label based if we have a name
-    var label = name ? 'Update' : 'Save';
-
-    // Buffer all flash messages.
-    // Typically this would all be done in a template
-    // however for illustration purposes we iterate
-    // here.
-    
-    // The messages in req.flash() persist until called,
-    // at which time they are flushed from the session
-    var msgs = '<ul>',
-        flash = req.flash();
-    Object.keys(flash).forEach(function(type){
-        flash[type].forEach(function(msg){
-            msgs += '<li class="' + type + '">' + msg + '</li>';
-        });
-    });
-    msgs += '</ul>';
-
-    // If we have a name, we are updating,
-    // so add the hidden _method input
-    res.send(msgs
-        + '<form method="post">'
-        + (name ? '<input type="hidden" value="put" name="_method" />' : '')
-        + 'Name: <input type="text" name="name" value="' + name + '" />'
-        + '<input type="submit" value="' + label + '" />'
-        + '</form>');
-});
-
-app.post('/', function(req, res){
-    if (req.body.name) {
-        // Typically here we would create a resource
-        req.flash('info', 'Saved ' + req.body.name);
-        res.redirect('/?name=' + req.body.name);
-    } else {
-        req.flash('error', 'Error: name required');
-        res.redirect('/');
-    }
-});
-
-app.put('/', function(req, res){
-    // Typically here we would update a resource
-    req.flash('info', 'Updated ' + req.body.name);
-    res.redirect('/?name=' + req.body.name);
-});
-
-app.listen(3000);
-console.log('Express app started on port 3000');

examples/format/app.js

@@ -1,63 +0,0 @@
-
-/**
- * Module dependencies.
- */
-
-var express = require('../../lib/express');
-
-var app = express.createServer();
-
-// Fake items
-
-var items = [
-    { name: 'foo' },
-    { name: 'bar' },
-    { name: 'baz' }
-];
-
-// Routes
-
-app.get('/', function(req, res, next){
-    res.send('Visit /item/2');
-});
-
-app.get('/item/:id.:format?', function(req, res, next){
-    var id = req.params.id,
-        format = req.params.format,
-        item = items[id];
-    // Ensure item exists
-    if (item) {
-        // Serve the format
-        switch (format) {
-            case 'json':
-                // Detects json
-                res.send(item);
-                break;
-            case 'xml':
-                // Set contentType as xml then sends
-                // the string
-                var xml = ''
-                    + '<items>'
-                    + '<item>' + item.name + '</item>'
-                    + '</items>';
-                res.contentType('.xml');
-                res.send(xml);
-                break;
-            case 'html':
-            default:
-                // By default send some hmtl
-                res.send('<h1>' + item.name + '</h1>');
-        }
-    } else {
-        // We could simply pass route control and potentially 404
-        // by calling next(), or pass an exception like below.
-        next(new Error('Item ' + id + ' does not exist'));
-    }
-});
-
-// Middleware
-
-app.use(express.errorHandler({ showStack: true }));
-
-app.listen(3000);
-console.log('Express app started on port 3000');

examples/github/app.js

@@ -1,119 +0,0 @@
-
-// Expose modules in ./support for demo purposes
-require.paths.unshift(__dirname + '/../../support');
-
-/**
- * Module dependencies.
- */
-
-var express = require('./../../lib/express'),
-    http = require('http');
-
-var app = express.createServer();
-
-// Expose our views
-
-app.set('views', __dirname + '/views');
-
-/**
- * Request github json api `path`.
- *
- * @param {String} path
- * @param {Function} fn
- * @api public
- */
-
-function request(path, fn){
-    var client = http.createClient(80, 'github.com'),
-        req = client.request('GET', '/api/v2/json' + path, { Host: 'github.com' });
-    req.addListener('response', function(res){
-        res.body = '';
-        res.addListener('data', function(chunk){ res.body += chunk; });
-        res.addListener('end', function(){
-            try {
-                fn(null, JSON.parse(res.body));
-            } catch (err) {
-                fn(err);
-            }
-        });
-    });
-    req.end();
-}
-
-/**
- * Sort repositories by watchers desc.
- *
- * @param {Array} repos
- * @api public
- */
-
-function sort(repos){
-    return repos.sort(function(a, b){
-        if (a.watchers == b.watchers) return 0;
-        if (a.watchers > b.watchers) return -1;
-        if (a.watchers < b.watchers) return 1;
-    });
-}
-
-/**
- * Tally up total watchers.
- *
- * @param {Array} repos
- * @return {Number}
- * @api public
- */
-
-function totalWatchers(repos) {
-    return repos.reduce(function(sum, repo){
-        return sum + repo.watchers;
-    }, 0);
-}
-
-/**
- * Default to my user name :)
- */
-
-app.get('/', function(req, res){
-    res.redirect('/repos/visionmedia');
-});
-
-/**
- * Display repos.
- */
-
-app.get('/repos/*', function(req, res, next){
-    var names = req.params[0].split('/'),
-        users = [];
-    (function fetchData(name){
-        // We have a user name
-        if (name) {
-            console.log('... fetching \x1b[33m%s\x1b[0m', name);
-            request('/repos/show/' + name, function(err, user){
-                if (err) {
-                    next(err)
-                } else {
-                    user.totalWatchers = totalWatchers(user.repositories);
-                    user.repos = sort(user.repositories);
-                    user.name = name;
-                    users.push(user);
-                    fetchData(names.shift());
-                }
-            });
-        // No more users
-        } else {
-            console.log('... done');
-            res.render('index.jade', {
-                locals: {
-                    users: users
-                }
-            });
-        }
-    })(names.shift());
-});
-
-// Serve statics from ./public
-app.use(express.staticProvider(__dirname + '/public'));
-
-// Listen on port 3000
-app.listen(3000);
-console.log('Express app started on port 3000');

examples/github/public/style.css

@@ -1,19 +0,0 @@
-body {
-    padding: 30px 50px;
-    font: 12px/1.4 "Helvetica Neue", Arial, sans-serif;
-}
-a {
-    color: #00AAFF;
-    text-decoration: none;
-}
-a:hover {
-    text-decoration: underline;
-}
-.user {
-  margin: 0 10px;
-  float: left;
-  width: 25%;
-}
-table td:nth-child(2) {
-  padding: 0 5px;
-}

examples/github/views/index.jade

@@ -1,8 +0,0 @@
-- each user in users
-  .user
-    h2= user.name
-    p.summary
-      | <a href="http://github.com/#{user.name}">#{user.name}</a> has
-      | <strong>#{user.repos.length}</strong> repositories 
-      | with a total of <strong>#{user.totalWatchers}</strong> watchers.
-    table#repos!= partial('repo', user.repos)

examples/github/views/layout.jade

@@ -1,7 +0,0 @@
-!!!
-html
-  head
-    title Github Example
-    link(rel="stylesheet", href="/style.css")
-  body
-    #container!= body

examples/github/views/partials/repo.jade

@@ -1,5 +0,0 @@
-tr.repo
-  td.name
-    a(href: repo.homepage || repo.url)= repo.name
-  td.watchers
-    = repo.watchers

examples/hello-world/index.js

@@ -0,0 +1,11 @@
+
+var express = require('../../');
+
+var app = express();
+
+app.get('/', function(req, res){
+  res.send('Hello World');
+});
+
+app.listen(3000);
+console.log('Express started on port 3000');

examples/helloworld/app.js

@@ -1,14 +0,0 @@
-
-/**
- * Module dependencies.
- */
-
-var express = require('./../../lib/express');
-
-var app = express.createServer();
-
-app.get('/', function(req, res){
-    res.send('Hello World');
-});
-
-app.listen(3000);