modules/exhibit/README.txt

// $Id$

Exhibit for Drupal
==================
This is an-alpha version of the Exhibit module currently being developed
for Drupal 6.x under the auspices of the project at:

  <http://drupal.org/project/exhibit>

For more information about Exhibit, see the project's home page at SIMILE:

  <http://simile.mit.edu/exhibit/>


BUG REPORTS
-----------
Post bug reports and feature requests to the issue tracking system at:

  <http://drupal.org/node/add/project_issue/exhibit>


USAGE
-----
See INSTALL.txt for installation and basic configuration of the Exhibit
module.  Once you have the module installed and configured and some feeds
to work with, you can create an Exhibit node at node/add/exhibit.

The Exhibit node contains two different definition fields, one for the main
body of the Exhibit, and the other for the Exhibit facet.  The main facet
definition is where you will include the various views, and lenses for your
Exhibit.  If you don't know what these are, see Exhibit links above.

The facet definition allows you to separate your facets from the main body of
your Exhibit.  These facets get rendered in a block that you can configure at
admin/build/block.  Make sure that if you are going to be putting your facets
inside the facet definition, that the Exhibit facets block is enabled for your
Exhibit path.

Beneath the facet definition is a simple facet generator.  The facet generator
looks at the feeds that you have selected and allows you to create facets based
on the fields within those feeds.  The facet generator will limit the various
facet types that are available based on type of field you have selected.  The
types are defined in the "properties" section of the Exhibit feed.  Once you
have selected a facet type, various options for that facet will be available
for you.  These options are automatically set to their default state.  Once
you are satisfied with the facet options, click the "Generate Facet HTML"
button and facet HTML will be generated and appended to the Facet definition
field.

Once your Exhibit definitions are complete, save the node, and you should have
a fully functioning Exhibit rendered on the front end.


CREDITS
-------
Developed and maintained by Arto Bendiken <http://bendiken.net/>
Co-maintained by Josh Huckabee <http://joshhuckabee.com/>
Co-maintained by Djun Kim <http://www.puregin.org/>
Sponsored by MakaluMedia Group <http://www.makalumedia.com/>
Sponsored by M.C. Dean, Inc. <http://www.mcdean.com/>
Sponsored by SPAWAR <http://www.spawar.navy.mil/>
1	// $Id$
2
3	Exhibit for Drupal
4	==================
5	This is an-alpha version of the Exhibit module currently being developed
6	for Drupal 6.x under the auspices of the project at:
7
8	<http://drupal.org/project/exhibit>
9
10	For more information about Exhibit, see the project's home page at SIMILE:
11
12	<http://simile.mit.edu/exhibit/>
13
14
15	BUG REPORTS
16	-----------
17	Post bug reports and feature requests to the issue tracking system at:
18
19	<http://drupal.org/node/add/project_issue/exhibit>
20
21
22	USAGE
23	-----
24	See INSTALL.txt for installation and basic configuration of the Exhibit
25	module. Once you have the module installed and configured and some feeds
26	to work with, you can create an Exhibit node at node/add/exhibit.
27
28	The Exhibit node contains two different definition fields, one for the main
29	body of the Exhibit, and the other for the Exhibit facet. The main facet
30	definition is where you will include the various views, and lenses for your
31	Exhibit. If you don't know what these are, see Exhibit links above.
32
33	The facet definition allows you to separate your facets from the main body of
34	your Exhibit. These facets get rendered in a block that you can configure at
35	admin/build/block. Make sure that if you are going to be putting your facets
36	inside the facet definition, that the Exhibit facets block is enabled for your
37	Exhibit path.
38
39	Beneath the facet definition is a simple facet generator. The facet generator
40	looks at the feeds that you have selected and allows you to create facets based
41	on the fields within those feeds. The facet generator will limit the various
42	facet types that are available based on type of field you have selected. The
43	types are defined in the "properties" section of the Exhibit feed. Once you
44	have selected a facet type, various options for that facet will be available
45	for you. These options are automatically set to their default state. Once
46	you are satisfied with the facet options, click the "Generate Facet HTML"
47	button and facet HTML will be generated and appended to the Facet definition
48	field.
49
50	Once your Exhibit definitions are complete, save the node, and you should have
51	a fully functioning Exhibit rendered on the front end.
52
53
54	CREDITS
55	-------
56	Developed and maintained by Arto Bendiken <http://bendiken.net/>
57	Co-maintained by Josh Huckabee <http://joshhuckabee.com/>
58	Co-maintained by Djun Kim <http://www.puregin.org/>
59	Sponsored by MakaluMedia Group <http://www.makalumedia.com/>
60	Sponsored by M.C. Dean, Inc. <http://www.mcdean.com/>
61	Sponsored by SPAWAR <http://www.spawar.navy.mil/>