root/trunk/extensions/search/README

Revision 577, 1.4 kB (checked in by seancribbs, 10 months ago)

Added installation instructions and example code to the README file in search extension. Closes #565. [Richard Hurt]

Line 
1 = Search
2
3    Ported by: Sean Cribbs
4      Version: 0.1
5  Description: A port of Oliver Baltzer's search behavior, with removal of the
6               live-preview options.
7
8 Requirements:
9   None
10
11 Installation:
12   This extension works by creating a new page type called "Search".  After you
13 install it and re-start your web server, you should have a new type of page
14 available.
15
16  1) Download and install just like any other extension.
17  2) Create a new page called "Search" (or whatever you want)
18  3) Set the Page Type to "Search" and the Status to "Published"
19  4) Take the sample code below and paste it into the body of the new page.
20  5) Visit http://localhost:3000/search and enter a search term.
21  6) Bask in the glow of a job well done.  :)
22
23 Example:
24   Place everything between the SNIPs in the body of the "Search" page.  This
25 will provide a very basic Search page, but it should show you everything you
26 need to know to make your own page better.
27
28 ==================================== SNIP ====================================
29 <r:search:form label="Search for:"/>
30
31 <r:search:empty>
32   <strong>I couldn't find anything named "<r:search:query/>".</strong>
33 </r:search:empty>
34
35 <r:search:results>
36   Found the following pages that contain "<r:search:query/>".
37
38   <ul>
39   <r:search:results:each>
40     <li><r:link/> - <r:author/> - <r:date/></li>
41   </r:search:results:each>
42   </ul>
43 </r:search:results>
44 ==================================== SNIP ====================================
Note: See TracBrowser for help on using the browser.