examples/README
Copyright (C) 2003 Merjis Ltd. (http://www.merjis.com/)
$Id: README,v 1.5 2004/02/13 13:43:54 rwmj Exp $

This directory contains both simple and more complicated worked
examples of mod_caml handlers, CGI scripts and DBI programs.

BEGINNERS should start out by looking at:

	simple-scripts/hello.ml
		"Hello, world!" example script. Start here.

	simple-scripts/params.ml
		Parameter parsing, tables in templates.

	simple-scripts/conditions.ml
		::if(...):: conditions in templates.

	simple-scripts/cookies.ml
		Sending and displaying cookies.

	simple-handlers/print_trans.ml
		A translate handler which just prints out URIs.

	simple-handlers/auth_simple.ml
		Example of doing authentication with a fixed table of users.

ADVANCED USERS should look at:

	comments/
		A system for attaching comments to web pages. This
		demonstrates: using cookies for session state, database
		API, database handle caching.

	useful-scripts/crumbs.ml
		This script can be included in SSI pages to generate
		"breadcrumb trails" (see http://www.useit.com/). To find
		out how to use it, look at the top of the file.

	useful-scripts/maillist.ml
	useful-scripts/maillist.sql
		Allow users to add themselves to a mailing list, so they
		receive email when a section of the site is updated (not
		automatically).
