/
README
41 lines (36 loc) · 1.63 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
--------------------
What
--------------------
Xearch is a search tool built for use in Axiom CMS websites/applications.
--------------------
License
--------------------
Xearch is released under the GNU Affero General Public License.
/**
* Creates a search tool that can be implemented anywhere from the Axiom CMS
* Copyright (C) 2009 Nicholas Campbell
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
--------------------
Usage
--------------------
To use this tool you should only have to do the following.
- Put the files in the xearch directory under modules.
- Add 'xearch' to your list of modules in your app.properties file for your application.
- Create a Xearch prototype within your application and make sure that 'search_results' is called from within that prototypes main function.
--------------------
Skinning
--------------------
There is not yet a notion of a main wrapper function (tal or JS). Thus, you need to create one. I'll likely have to include one at some point so look for it in the future.