add index terms to OPAC chapters.
[working/Evergreen.git] / 1.6 / opac / search_URL.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="search_url" xmlns="" version="5.0" xml:lang="EN"\r
3     xmlns:xi="" xmlns:xlink="">\r
4         <info>\r
5                 <title>Search URL</title>\r
6         </info>\r
7         <para>When performing a search or clicking on the details links, Evergreen constructs a GET request url with the parameters of the search. The url for searches and details in Evergreen are persistent links in that they can be saved, shared and used later.</para>\r
8         <para>Here is a basic search URL structure:</para>\r
9                 <screen><emphasis>[hostname]</emphasis>/opac/<emphasis>[locale]</emphasis>/skin/default/xml/rresult.xml?<emphasis role='bold'>rt</emphasis>=keyword&amp;<emphasis role='bold'>tp</emphasis>=keyword&amp;<emphasis role='bold'>t</emphasis>=<emphasis>[search term]</emphasis>&amp;<emphasis role='bold'>l</emphasis>=<emphasis>[location id]</emphasis>&amp;<emphasis role='bold'>d</emphasis>=0</screen>       \r
10         <simplesect>\r
11                 <title><emphasis>l</emphasis> Parameter</title><indexterm><primary>searching parameters</primary><secondary>location</secondary></indexterm>\r
12                 <para>This is the id of the search location. It is an integer and maches the id of the location the user selected in the location drop down menu.</para>\r
13         <para>This is accompanied by a <emphasis>d</emphasis> parameter which indicated the depth of the location selected. For example, <emphasis>0</emphasis> would be the highest level and <emphasis>1</emphasis> would represent the next depth level.</para>\r
14         </simplesect>\r
15         <simplesect>\r
16                 <title><emphasis>rt</emphasis> Parameter</title><indexterm><primary>searching parameters</primary><secondary>request types</secondary></indexterm>\r
17                 <para>The <emphasis>rt</emphasis> parameter in the URL represents the search type values and represent one of the following search or request types:</para>\r
18                 <itemizedlist>\r
19                         <listitem>keyword</listitem>\r
20                         <listitem>title</listitem>\r
21                         <listitem>author</listitem>\r
22                         <listitem>subject</listitem>\r
23                         <listitem>series</listitem>\r
24                 </itemizedlist>\r
25                 <para>These match the options in the search type drop-down box.</para>\r
26         </simplesect>\r
27         <simplesect>\r
28                 <title>Sorting</title><indexterm><primary>searching parameters</primary><secondary>sorting criteria</secondary></indexterm>\r
29                 <para>The <emphasis>s</emphasis> parameter sorts the results on one of these criteria.</para>\r
30                 <itemizedlist>\r
31                         <listitem>pubdate (publication date) - chronological order</listitem>\r
32                         <listitem>title - Alphabetical order</listitem>\r
33                         <listitem>author - Alphabetical order on family name first</listitem>\r
34                 </itemizedlist>\r
35                 <para>The <emphasis>sd</emphasis> indicates the direction to sort</para>\r
36                 <itemizedlist>\r
37                         <listitem>asc - ascending</listitem>\r
38                         <listitem>desc - descending</listitem>\r
39                 </itemizedlist>\r
40                 <para>In the absence of <emphasis>s</emphasis> or <emphasis>sd</emphasis> parameter, the search results default to sorting by relevance.</para>\r
41         </simplesect>\r
42         <simplesect>\r
43                 <title>Advanced search (multiple fields)</title>\r
44                 <para>Uses rt=multi; then prepend search field to the search terms (delimited by a colon) in the t parameter:</para>\r
45                 <screen>;t=keyword%3Afools title%3Arush&amp;av=&amp;rt=multi</screen>\r
46                 <para>ISBN and ISSN search include the following in the URL:</para>\r
47                 <screen>...rt=isbn&amp;adv=...</screen>\r
48                 <screen>...rt=issn&amp;adv=...</screen>\r
49                 <para>Call number search will include:</para>\r
50                 <screen>...cnbrowse.xml?cn=pr5655...</screen>   \r
51         </simplesect>\r
52 </chapter>\r
53 \r
54   \r