source: trunk/gsdl3/web/sites/localsite/collect/infomine/README@ 6238

Last change on this file since 6238 was 6238, checked in by kjdon, 20 years ago

a description of the cgi scripts and how to use them

  • Property svn:keywords set to Author Date Id Revision
File size: 3.7 KB
Line 
1This collection talks to the iVia installation at INFOMINE, Riverside,
2California. The software should work with any iVia installation.
3
4Cgi scripts are called to do searching of and retrieval from the database.
5All three are fairly generic CGI scripts; iVia's "theming" ability is used to
6 get the data back in the format we want-- there is a gsdl3 theme.
7
8To create a new collection that talks to an iVia database, you need to create
9the two configuration files, collectionConfig.xml, and buildConfig.xml.
10The collectionConfig.xml needs to contain any display information for the
11collection, and any metadata that is available. Also it can contain format
12information for document display or search result lists if the default is
13not useful.
14
15The buildConfig.xml file just needs to specify the InfomineProxy serviceRack
16class.
17
18The following describes the iVia cgi scripts.
19
20For performing a search:
21************************
22
23 http://infomine.ucr.edu/cgi-bin/canned_search
24
25Parameters:
26 Required parameters: theme=gsdl3&query=xxx
27 Useful parameters: no_of_records_per_page=10&start_page_no=1&fields='kw,su'
28 Other parameters: http://infomine.ucr.edu/help/adders/index.php?section=11
29 Example: http://infomine.ucr.edu/cgi-bin/canned_search?query=tree&
30 theme=gsdl3&no_of_records_per_page=10&start_page_no=1
31
32Fields include Title (ti), Subject (su), Keyword (kw), Author (au),
33Description (de) and full text (fu). 'all' will search all fields.
34It's possible to do uch more advanced searches including phrase searching
35and bolean queries.
36
37The canned_search result page will look something like this:
38 Resources: 58
39 Ids: 1015 22128 1730 6020 2981 1014 20147 2097 46569 4360
40
41For getting an HTML representation of a record:
42***********************************************
43
44 http://infomine.ucr.edu/cgi-bin/view_record
45
46Parameters:
47 Required parameters: theme=gsdl3&record_id=x
48 Example: http://infomine.ucr.edu/cgi-bin/view_record?theme=gsdl3&
49 record_id=2097
50
51The result page will be an HTML fragment; specifically, it will be an HTML
52table. Again, the formatting is quite flexible. There's one current
53problem: a lot of the data is displayed as hypertext links to new infomine
54searches; This should be changed eventually.
55
56For now, the Greenstone services process the records, replacing infomine
57links with Greenstone links where possible.
58
59For getting metadata for a set of records:
60******************************************
61
62 http://infomine.ucr.edu/cgi-bin/view_record_set
63
64Parameters:
65 Required parameters: theme=gsdl3&record_id_list=id1,id2,id3
66 Optional parameter: field_list=f1,f2,f3
67 Example: http://infomine.ucr.edu/cgi-bin/view_record_set?theme=gsdl3&
68 record_id_list=1015,2128,1730&field_list=url,title
69
70The result will look like this:
71
72 Record: 1015
73 url: http://www.fruit.affrc.go.jp/index-e.html
74 title: National Institute of Fruit Tree Science (Japan)
75
76 Record: 2128
77 url: http://www.publish.csiro.au/journals/ajb/
78 title: Australian Journal of Botany
79
80 Record: 1730
81 url: http://usda.mannlib.cornell.edu/reports/erssor/specialty/fts-bb/
82 title: Fruit and Tree Nuts : USDA Economics and Statistics System
83
84There are many different metadata fields that can be requested, including
85keywords, subjects, description, access, expert_created, foreign_source,
86foreign_id, and so on.
87
88Note that the metadata always fits on one line (whitespace is explicitly
89normalised to space) to make parsing easier. Generally, the metadata is
90in ISO-8859-15 format (i.e. ISO-8859-1 plus the Euro currency symbol).
91Metadata is usually plain text, though the description field may contain
92HTML entities and limited set of HTML elements (bold tags, italic tags,
93links, and a few others).
94
Note: See TracBrowser for help on using the repository browser.