modules/actionapps/README.txt

// $Id:$

Readme
------
aaview displays ActionApps View output inside Drupal through a simple configuration frontend
aaitem displays ActionApps Items inside Drupal 

** The complete documentation can be found on http://actionkit.gn.apc.org **

Install
-------
aaview and aaitem depends on a local ActionApps installation and the ActiveForms Drupal module.
* ActionApps (tested with version 2.81): 
  - Installation Guide: http://www.actionapps.org/en/Installation_Guide
  - Download: http://sourceforge.net/projects/apc-aa/
* ActiveForms Drupal module
  - Download (not official drupal module): http://groups.drupal.org/node/317

Usage:
------
After enabling the aaview, aaitem and the activeforms modules, the ActionApps installation path needs to be set. Go to 

Administer | aaview | AA View Settings

Enter where you installed ActionApps (e.g. /var/www/htdocs/www.mysite.com/apc-aa)

Then go to Administer | blocks and configure the ActionApps View. First select the Slice, then the list of Views will update. Optionally, you can add view parameters to this (see http://www.actionapps.org/en/Url_Parameters#View_parameters)

Todos
-----
* Add support for slice based views (Index, Fulltext, Design)
* Find some method of (automatic) URL conversion
* Allow for more than one aaview block per site
* Add node type aaview

Hints for ActionApps Installation
---------------------------------
Many sites use a shared ActionApps installation. The configuration for these usually is to run the ActionApps installation folders as PHP Safe_Mode off. In a scenario like this it's necessary to run a Drupal that wants to use aaview also with Safe_Mode off.
For a more secure setup Drupal and ActionApps can be set up with the same user. In this case Safe_Mode only needs to be turned off for ActionApps (and even this might change with one of the next releases of ActionApps).


Details
-------
For the technically interested: aaview and aaitem use an ActionApps interface class (see actionapps.inc). The idea is to handle any calls to AA inside this class rather than putting them straight into the module. 


Author
------
(C)2006 Michael Moritz <mimo/at/gn.apc.org>
1	// $Id:$
2
3	Readme
4	------
5	aaview displays ActionApps View output inside Drupal through a simple configuration frontend
6	aaitem displays ActionApps Items inside Drupal
7
8	The complete documentation can be found on http://actionkit.gn.apc.org
9
10	Install
11	-------
12	aaview and aaitem depends on a local ActionApps installation and the ActiveForms Drupal module.
13	* ActionApps (tested with version 2.81):
14	- Installation Guide: http://www.actionapps.org/en/Installation_Guide
15	- Download: http://sourceforge.net/projects/apc-aa/
16	* ActiveForms Drupal module
17	- Download (not official drupal module): http://groups.drupal.org/node/317
18
19	Usage:
20	------
21	After enabling the aaview, aaitem and the activeforms modules, the ActionApps installation path needs to be set. Go to
22
23	Administer \| aaview \| AA View Settings
24
25	Enter where you installed ActionApps (e.g. /var/www/htdocs/www.mysite.com/apc-aa)
26
27	Then go to Administer \| blocks and configure the ActionApps View. First select the Slice, then the list of Views will update. Optionally, you can add view parameters to this (see http://www.actionapps.org/en/Url_Parameters#View_parameters)
28
29	Todos
30	-----
31	* Add support for slice based views (Index, Fulltext, Design)
32	* Find some method of (automatic) URL conversion
33	* Allow for more than one aaview block per site
34	* Add node type aaview
35
36	Hints for ActionApps Installation
37	---------------------------------
38	Many sites use a shared ActionApps installation. The configuration for these usually is to run the ActionApps installation folders as PHP Safe_Mode off. In a scenario like this it's necessary to run a Drupal that wants to use aaview also with Safe_Mode off.
39	For a more secure setup Drupal and ActionApps can be set up with the same user. In this case Safe_Mode only needs to be turned off for ActionApps (and even this might change with one of the next releases of ActionApps).
40
41
42	Details
43	-------
44	For the technically interested: aaview and aaitem use an ActionApps interface class (see actionapps.inc). The idea is to handle any calls to AA inside this class rather than putting them straight into the module.
45
46
47	Author
48	------
49	(C)2006 Michael Moritz <mimo/at/gn.apc.org>