modules/googleajaxsearch/README.txt

Description
-----------

The main googleajaxsearch module allows you to add inline searches over a number
of Google services (Web Search, Local Search, Video Search, Blog Search, News Search,
Book Search, Image Search and Patent Search).

Installation
------------

1) copy the googleajaxsearch directory into the modules directory

2) Get a Google Ajax Search API Key at http://code.google.com/apis/ajaxsearch/signup.html

3) enable the 'googleajaxsearch' module in drupal

4) edit admin/settings/googleajaxsearch to include the key you received from google and
   change any other default setting.

5) configure an 'input format' so that the gmap filter is activated.  If
   this will be on a 'html filtered' format, ensure that the weighting is
   such that the HTML filter comes before the gmap filter.


Instructions
------------

Macro
-----

A googleajaxsearch macro can be created on the googleajaxsearch/macro page and the text can then be
copied and pasted into any node where the gmap filter is enabled.

Default settings will be the initial settings and will be used for any
parameter not inserted into the macro.

Current macro flags
-------------------
target={self,blank,parent,top}
state={open,closed,partial}
mode={linear,tabbed}
searcher={web,video,news,blog,local}
initialsearch={some initial search string}
resultid={block element id name where the results should be placed}
place={initial local search place ex. "New York,NY"}

Macro Example
-------------
[googleajaxsearch|target=blank|state=closed|mode=linear|searcher=web|searcher=blog|searcher=video|searcher=local|initialsearch=NYC|resultid=somedivid|place=New York,NY]

Module functionality
--------------------

- googleajaxsearch block in the block section
- block title enable/disable
- custom block title
- available google inline searchers: 
	*	web search
	*	blog search
	*	news search
	* 	video search
	*	local search
- initial search phrase
- initial place for local search
- google control modes: 
	*	tabbed
	*	linear
- google searchers default state
	*	open
	*	closed
	*	partial
- link target:
	* 	blank
	*	self
	*	top
	*	parent
- enable search from root [search form in a different place than result]


User
----

Any user that has permission for "view googleajaxsearch" will then be able to see
a inline searcher and user google inline search.

Demo
----
For a few pages that show some of the items mentioned above see:
http://www.6na9.info/googleajaxsearch/macro
http://www.6na9.info/gasdemo

ugs & quirks
-------------

- when using googleajax search in sidebar video links and blogs links are too long which causes sidebar width change 

To do
-----

- create php functions to parse array and macro directly in theme file
- copy functionality has to be implemented so users can copy search results into the nodes directly
- search result nodes [different node type for storing users search results]
- macro creator improvments
- Create an API that will allow the use of the macro creation tool in any
  module.

Credit
------

Written by:
Meant4.pl development team:
Maciej Perlinski, Adam Ludwinski, Krzysztof Golinski
http://www.meant4.pl

Sugestions&Questions 
--------------------


History
-------

2006-10-26 - Initial release
1	Description
2	-----------
3
4	The main googleajaxsearch module allows you to add inline searches over a number
5	of Google services (Web Search, Local Search, Video Search, Blog Search, News Search,
6	Book Search, Image Search and Patent Search).
7
8	Installation
9	------------
10
11	1) copy the googleajaxsearch directory into the modules directory
12
13	2) Get a Google Ajax Search API Key at http://code.google.com/apis/ajaxsearch/signup.html
14
15	3) enable the 'googleajaxsearch' module in drupal
16
17	4) edit admin/settings/googleajaxsearch to include the key you received from google and
18	change any other default setting.
19
20	5) configure an 'input format' so that the gmap filter is activated. If
21	this will be on a 'html filtered' format, ensure that the weighting is
22	such that the HTML filter comes before the gmap filter.
23
24
25	Instructions
26	------------
27
28	Macro
29	-----
30
31	A googleajaxsearch macro can be created on the googleajaxsearch/macro page and the text can then be
32	copied and pasted into any node where the gmap filter is enabled.
33
34	Default settings will be the initial settings and will be used for any
35	parameter not inserted into the macro.
36
37	Current macro flags
38	-------------------
39	target={self,blank,parent,top}
40	state={open,closed,partial}
41	mode={linear,tabbed}
42	searcher={web,video,news,blog,local}
43	initialsearch={some initial search string}
44	resultid={block element id name where the results should be placed}
45	place={initial local search place ex. "New York,NY"}
46
47	Macro Example
48	-------------
49	[googleajaxsearch\|target=blank\|state=closed\|mode=linear\|searcher=web\|searcher=blog\|searcher=video\|searcher=local\|initialsearch=NYC\|resultid=somedivid\|place=New York,NY]
50
51	Module functionality
52	--------------------
53
54	- googleajaxsearch block in the block section
55	- block title enable/disable
56	- custom block title
57	- available google inline searchers:
58	* web search
59	* blog search
60	* news search
61	* video search
62	* local search
63	- initial search phrase
64	- initial place for local search
65	- google control modes:
66	* tabbed
67	* linear
68	- google searchers default state
69	* open
70	* closed
71	* partial
72	- link target:
73	* blank
74	* self
75	* top
76	* parent
77	- enable search from root [search form in a different place than result]
78
79
80	User
81	----
82
83	Any user that has permission for "view googleajaxsearch" will then be able to see
84	a inline searcher and user google inline search.
85
86	Demo
87	----
88	For a few pages that show some of the items mentioned above see:
89	http://www.6na9.info/googleajaxsearch/macro
90	http://www.6na9.info/gasdemo
91
92	ugs & quirks
93	-------------
94
95	- when using googleajax search in sidebar video links and blogs links are too long which causes sidebar width change
96
97	To do
98	-----
99
100	- create php functions to parse array and macro directly in theme file
101	- copy functionality has to be implemented so users can copy search results into the nodes directly
102	- search result nodes [different node type for storing users search results]
103	- macro creator improvments
104	- Create an API that will allow the use of the macro creation tool in any
105	module.
106
107	Credit
108	------
109
110	Written by:
111	Meant4.pl development team:
112	Maciej Perlinski, Adam Ludwinski, Krzysztof Golinski
113	http://www.meant4.pl
114
115	Sugestions&Questions
116	--------------------
117
118
119	History
120	-------
121
122	2006-10-26 - Initial release