documentation related to search, needs further review
[software/sisu] / data / doc / sisu / markup-samples / manual / en / sisu_search_intro.ssi
1 % SiSU insert 2.0
2
3 @title: SiSU
4 :subtitle: Search
5
6 @creator:
7 :author: Amissah, Ralph
8
9 @date:
10 :published: 2007-09-16
11 :created: 2002-08-28
12 :issued: 2002-08-28
13 :available: 2002-08-28
14 :modified: 2011-02-07
15
16 @rights:
17 :copyright: Copyright (C) Ralph Amissah 2007
18 :license: GPL 3 (part of SiSU documentation)
19
20 :A~? @title @creator
21
22 :B~? SiSU Search
23
24 1~search_intro SiSU Search - Introduction
25 ={ SiSU search }
26
27 Because the document structure of sites created is clearly defined, and the text object citation system is available hypothetically at least, for all forms of output, it is possible to search the sql database, and either read results from that database, or map the results to the html or other output, which has richer text markup.
28
29 SiSU can populate a relational sql type database with documents at an object level, including objects numbers that are shared across different output types. Making a document corpus searchable with that degree of granularity. Basically, your match criteria is met by these documents and at these locations within each document, which can be viewed within the database directly or in various output formats.
30
31 SiSU can populate an sql database (sqlite3 or postgresql) with documents made up of their objects. It also can generate a cgi search form that can be used to query the database.
32
33 In order to use the built in search functionality you would take the following steps.
34
35 _* use sisu to populate an sql database with with a sisu markup content
36
37 _1* sqlite3 should work out of the box
38
39 _1* postgresql may require some initial database configuration
40
41 _* provide a way to query the database, which sisu can assist with by
42
43 _1* generating a sample ruby cgi search form, required (sisu configuration recommended)
44
45 _1* adding a query field for this search form to be added to all html files (sisu configuration required)