Add development to 2.0 from 1.6
[working/Evergreen.git] / 2.0 / development / customize_opac.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <chapter xml:id="Customizing_OPAC" xmlns="" version="5.0" xml:lang="EN"\r
3     xmlns:xi="" xmlns:xlink="">\r
4         <info>\r
5                 <title>Customizing the OPAC</title>\r
6         </info>\r
7         <para>While Evergreen is ready to go out of the box, libraries will want to customize Evergreen with their own color scheme, logos and layout. This chapter will explain how to \r
8         customize Evergreen to meet the needs of your users. For these task some knowledge of <systemitem>html</systemitem> and <systemitem>css</systemitem> is required. Many of these \r
9         instructions assume an installation of Evergreen using the default file locations.</para>\r
10         <note>\r
11                 <para>Be sure to save a backup copy of all files you edit in a location other than <filename class="directory">/openils/var/web/opac/</filename> as files here could be \r
12                 overwritten when you upgrade your copy of Evergreen.</para>\r
13         </note> \r
14         <section xml:id="ColorScheme">\r
15                 <title>Change the Color Scheme</title>\r
16                 <indexterm><primary>OPAC</primary><secondary>customizing</secondary><tertiary>changing the color scheme</tertiary></indexterm>\r
17                 <para>To change the color scheme of the default Evergreen skin, edit <filename>/openils/var/web/opac/theme/default/css/colors.css</filename>. From this one file you can \r
18                 change the 4 base color scheme as well as colors of specific elements.     \r
19                 </para>                                                  \r
20                 <para>You can also create alternate themes for your users.</para>     \r
21                 <procedure>\r
22                         <step>\r
23                                 <para>Copy the css folder and its contents from the example alternate theme <filename>/openils/var/web/opac/theme/reddish/</filename> \r
24                                 to a new folder <filename>/openils/var/web/opac/theme/<emphasis>[your new theme]</emphasis>/</filename>.</para>\r
25                         </step> \r
26                         <step>\r
27                                 <para>Edit <filename>/openils/var/web/opac/theme/<emphasis role="bold">[your new theme]</emphasis>/css/colors.css</filename> to use the colors you want.</para>\r
28                         </step>\r
29                         <step>\r
30                                 <para>Link to your new style sheet by adding the following to <filename>/openils/var/web/opac/skin/default/xml/common/css_common.xml</filename>.</para>\r
31 <programlisting language="xml">\r
32 &lt;link type='text/css'\r
33 rel="alternate stylesheet"  \r
34 title='&amp;;'  \r
35 href="&lt;!--#echo var='OILS_THEME_BASE'--&gt;/yourtheme/css/colors.css" \r
36 name='Default' csstype='color'/&gt;\r
37 </programlisting> \r
38                         </step> \r
39                         <step>\r
40                                 <para> Give your new theme a name users can select by adding the following to <filename>/openils/var/web/opac/locale/<emphasis role="bold">\r
41                                 [your locale]</emphasis>/opac.dtd</filename>.</para>\r
42                                 <screen>&lt;!ENTITY "YourTheme"&gt;</screen>       \r
43                         </step> \r
44                 </procedure>    \r
45         </section>\r
46         <section xml:id="customizing_opac_text">\r
47                 <title>customizing Opac Text and Labels</title>\r
48                 <indexterm><primary>OPAC</primary><secondary>customizing</secondary><tertiary>text and labels</tertiary></indexterm>\r
49                 <para>To change text and links used throughout the OPAC, edit the following files:</para>\r
50                 <itemizedlist>\r
51                         <listitem><filename>/openils/var/web/opac/locale/<emphasis role="bold">[your locale]</emphasis>/lang.dtd</filename></listitem>\r
52                         <listitem><filename>/openils/var/web/opac/locale/<emphasis role="bold">[your locale]</emphasis>/opac.dtd</filename></listitem>\r
53                 </itemizedlist>\r
54                 <tip>\r
55                         <para>A better way to customize OPAC text is to create custom dtd files for your lang and opac customizations and then add a include \r
56                         statement above the default dtd files.</para>\r
57                 <programlisting>\r
58                 &lt;!DOCTYPE html PUBLIC \r
59                 "-//W3C//DTD XHTML 1.0 Transitional//EN"\r
60                 "" [\r
61                 &lt;!--#include virtual="/opac/locale/${locale}/custom_opac.dtd"--&gt;\r
62                 &lt;!--#include virtual="/opac/locale/${locale}/opac.dtd"--&gt;\r
63                 ]&gt;\r
64                 </programlisting>\r
65                         <para>position is important here. The first/top included dtd files will take precedence over the subsequent dtd includes.</para> \r
66                 </tip>\r
67                 <para>While it is possible to add text to the xml files itself, it is a good practice to use the DTD file to control the text and refer to the DTD elements in the xml/html code.</para>   \r
68                 <para>For example, the <filename>footer.xml</filename> file has this code to generate a copyright statement:</para>\r
69 <programlisting>\r
70 &lt;div id='copyright_text'&gt;\r
71 &lt;span&gt;&amp;footer.copyright;&lt;/span&gt;\r
72 </programlisting>\r
73                 <para>The included <filename>opac.dtd</filename> file in the en-US locale directory has this setting for &amp;footer.copyright text:</para>  \r
74                 <programlisting>&lt;!ENTITY footer.copyright "Copyright &#xA9; 2006-2010 Georgia Public Library Service, and others"&gt;</programlisting>\r
75         </section>\r
76         <section xml:id="Logo_Images">\r
77                 <title>Logo Images</title>\r
78                 <para>To change the logos used by default to your own logos, replace the following files with images of your own, appropriately sized. </para>\r
79                 <itemizedlist>\r
80                         <listitem>Large main logo:<filename>/openils/var/web/opac/images/main_logo.jpg</filename></listitem>\r
81                         <listitem>Small logo:<filename>/openils/var/web/opac/images/small_logo.jpg</filename></listitem>\r
82                 </itemizedlist>                          \r
83         </section>\r
84         <section xml:id="AddedContent">\r
85                 <title>Added Content</title>\r
86                 <indexterm><primary>OPAC</primary><secondary>added content</secondary></indexterm>\r
87                 <para>By default Evergreen includes customizable <quote>Added Content</quote> features to enhance the OPAC experience for your user. These features include Amazon book covers \r
88                 and Google books searching. These features can be turned off or customized.</para>\r
89                 <simplesect xml:id="bookcovers">\r
90                         <title>Book Covers</title>\r
91                         <para>The default install of Evergreen includes Amazon book covers. The settings for this are controlled by the &lt;added_content&gt; section of \r
92                         <filename>/openils/conf/opensrf.xml</filename>. Here are the key elements of this configuration:</para> \r
93                         <programlisting>&lt;module&gt;OpenILS::WWW::AddedContent::Amazon&lt;/module&gt;</programlisting>\r
94                         <para>This calls the Amazon perl module. If you wish to link to a different book cover service other than Amazon, you must create a new perl module and refer to it here. \r
95                         You will also need to change other settings accordingly. There are some available book cover perl modules available in  \r
96                         <ulink url="">trunk</ulink></para>\r
97                         <programlisting>&lt;base_url&gt;;/base_url&gt;</programlisting>\r
98                         <para>Base URL for Amazon added content fetching.  This URL may need to be shortened when new (read: non-image) content fetching \r
99                         capabilities are added.</para>   \r
100                         <programlisting>&lt;timeout&gt;1&lt;/timeout&gt;</programlisting>\r
101                         <para>Max number of seconds to wait for an added content request to return data.  Data not returned within the timeout is considered a failure.</para>   \r
102                         <programlisting>&lt;retry_timeout&gt;600&lt;/retry_timeout&gt;</programlisting>\r
103                         <para>After added content lookups have been disabled due to too many lookup failures, this is the amount of time to wait before we try again.</para>\r
104                         <programlisting>&lt;max_errors&gt;15&lt;/max_errors&gt;</programlisting>\r
105                         <para>Maximum number of consecutive lookup errors a given process can live before added content lookups are disabled for everyone.</para>       \r
106                         <programlisting>&lt;userid&gt;MY_USER_ID&lt;/userid&gt;</programlisting>\r
107                         <para>If a userid is required to access the added content.</para>\r
108                 </simplesect>\r
109                 <simplesect xml:id="googlebookslink">\r
110                         <title>Google Books Link</title>\r
111                         <indexterm><primary>OPAC</primary><secondary>added content</secondary><tertiary>Google Books</tertiary></indexterm>\r
112                         <para>The results page will display a <emphasis role="bold">Browse in Google Books Search</emphasis> link for items in the results page which have corresponding entries\r
113                          in <systemitem class="resource">Google Books</systemitem>. \r
114                         This will link to Google Books content including table of contents and complete versions of the work if it exists in Google Books. Items not in Google Books will not \r
115                         display a link. This feature can be turned off by changing the googleBooksLink variable setting to <emphasis>false</emphasis> in the file \r
116                         <filename>/openils/var/web/opac/skin/default/js/result_common.js</filename>. By default, this feature is activated. </para> \r
117                 </simplesect>     \r
118         </section>\r
119         <section xml:id="resultspage">\r
120                 <title>Customizing the Results Page</title>\r
121                 <para>The results page is extremely customizable and allows some built in features to be activated with some simple edits or more advanced customizations can be done by more \r
122                 experienced web developers.</para>\r
123                 <para>There are several critical files to edit if you wish to  customize the results page:</para>\r
124                 <itemizedlist>\r
125                         <listitem><filename>/openils/var/web/opac/skin/default/js/result_common.js</filename> - This file controls the JavaScript for the top level elements on the results \r
126                         page and should only be edited by experienced web developers except for the <link linkend='googlebookslink'>Google books link setting</link> mentioned previously.</listitem>\r
127                         <listitem><filename>/openils/var/web/opac/skin/default/js/rresult.js</filename> - Has some good controls of results page settings at the top of this file but \r
128                         requires web development skills for editing this file.</listitem>\r
129                         <listitem><filename>/openils/var/web/opac/skin/default/xml/result/rresult_table.xml</filename> - This controls the layout of the items table on results page.</listitem>\r
130                 </itemizedlist>          \r
131         </section>\r
132         <section xml:id="deatailspage">\r
133                 <title>Customizing the Details Page</title>\r
134                 <indexterm><primary>OPAC</primary><secondary>customizing</secondary><tertiary>details page</tertiary></indexterm>\r
135                 <para>There are many options when customizing the details page in Evergreen. The default settings are effective for most libraries, but it is important to understand the full potential \r
136                 of Evergreen when displaying the details of items.</para>               \r
137                 <para>Some quick features can be turned on and off by changing variable values in the file <filename>/openils/var/web/opac/skin/default/js/rdedail.js</filename>. \r
138                 You will notice the section at the top of this file called <quote>Per-skin configuration settings</quote>. Changing setting in this section can control several features including \r
139                 limiting results to local only or showing copy location or displaying serial holdings. Form this section you can also enable refworks and set the Refworks host URL.</para>\r
140                 <para>Some copy level details settings can be turned on and off from <filename>/openils/var/web/opac/skin/default/js/copy_details.js</filename> including displaying certain fields \r
141                 such as due date in the OPAC.</para>\r
142                 <para>An important file is the <filename>/openils/var/web/opac/skin/default/xml/rdetail/rdetail_summary.xml</filename> file. This file allows you to control which field to display in \r
143                 the details summary of the record. The new <link linkend='BibTemplate'>BibTemplate</link> feature makes this file even more powerful by allowing you to display any marc fields \r
144                 with a variety of formatting options.</para>\r
145                 <para>The <filename>/openils/var/web/opac/skin/default/xml/rdetail/rdetail_copyinfo.xml</filename> file allows you to format the display of the copy information.</para>   \r
146         </section>              \r
147         <section xml:id="BibTemplate">\r
148                 <title>BibTemplate</title><indexterm><primary>BibTemplate</primary></indexterm>\r
149                 <para>BibTemplate is an Evergreen-custom Dojo module which can be used to retrieve and format XML  data served by the Evergreen <systemitem class="protocol">unAPI</systemitem> service.                        <systemitem class="protocol">unAPI</systemitem> is a protocol for requesting known objects in specific formats, and Evergreen uses this to supply data – bibliographic records, \r
150                 metarecords, monograph holdings information, Located URIs, and more to come – in many different formats from MARCXML to MODS to custom XML applications.</para>\r
151                 <indexterm><primary>unAPI</primary></indexterm> <indexterm><primary>MARCXML</primary></indexterm><indexterm><primary>MODS</primary></indexterm>\r
152                 <para>Managing the display of information from raw XML can be difficult, and the purpose of BibTemplate  is to make this simpler, as well as move the display closer to the \r
153                 client and away from the source data. This is good from a separation-of-responsibilities perspective, and also makes it easier to contain and control local customization.</para>\r
154                 <para>BibTemplate supports the following Evergreen meta data formats:</para>\r
155                 <itemizedlist>\r
156                         <listitem>MARCXML - datatype='marcxml-full' (default)</listitem>                                        \r
157                         <listitem>MODS 3.3: datatype='mods33'</listitem>\r
158                         <listitem>Dublin Core: datatype='rdf_dc'</listitem><indexterm><primary>Dublin Core</primary></indexterm>\r
159                         <listitem>FGDC: datatype='fgdc'</listitem><indexterm><primary>FGDC</primary></indexterm>\r
160                 </itemizedlist>                 \r
161                 <simplesect>\r
162                         <title>HTML API</title>\r
163                         <para>BibTemplate follows the Dojo convention of adding attributes to existing (X)HTML in order to progressively change its behavior. The 1.6.0 HTML API consists of a \r
164                         set of attributes that are added to existing OPAC markup, and fall into two classes:</para><indexterm><primary>Dojo toolkit</primary></indexterm>\r
165                         <itemizedlist>\r
166                                 <listitem> The slot marker – Elements that denote the location of bibliographic data to insert.</listitem>\r
167                                 <listitem>The slot formatter – Elements that specify how the named data should be formatted for display.</listitem>\r
168                         </itemizedlist>          \r
169                 </simplesect>\r
170                 <simplesect>\r
171                         <title>Slot Marker</title><indexterm><primary>slot marker</primary></indexterm>\r
172                         <para>A slot marker is any displayable HTML element that has a type attribute with a value starting with opac/slot-data. This element will become the container \r
173                         for the formatted data. A slot marker is required in order to retrieve, format and display data using BibTemplate. A slot marker must also have an \r
174                         attribute called query containing a CSS3 selector. This selector is applied to the XML returned by the unAPI service in order to gather the specific XML \r
175                         Nodes that should be considered for formatting.</para><indexterm><primary>CSS3</primary></indexterm>\r
176                         <para>The slot marker can also specify the format of the data to be returned from the unAPI service. This can be specified by adding +{format} to the type \r
177                         attribute, as in opac/slot-data+mods33-full. The default data format is marcxml-uri, which is an augmented MARCXML record containing Located URI information \r
178                         and unAPI links.</para>\r
179                         <para>Example of a slot marker:</para>\r
180                         <screen>&lt;p type='opac/slot-data' query='datafield[tag=245]'&gt;&lt;/p&gt;</screen>\r
181                         <para>Most useful attribute match operators include:</para>\r
182                         <itemizedlist>\r
183                                 <listitem> datafield[tag=245] - exact match</listitem>\r
184                                 <listitem>datafield[tag^=65] - match start of value</listitem>\r
185                         </itemizedlist> \r
186                         <tip><para>Selectors always narrow, so select broadly and iterate through the NodeList</para></tip>\r
187                 </simplesect>\r
188                 <simplesect>\r
189                         <title>Slot Formatter</title><indexterm><primary>slot formatter</primary></indexterm>\r
190                         <para>A slot formatter is any invisible HTML element which has a type attribute with the value of opac/slot-format. (NOTE: before, only &lt;script&gt; \r
191                         elements were supported, though this restriction is now removed to support Internet Explorer.) Only one slot formatter element is allowed in each slot. The text contents \r
192                         of this element are wrapped in a JavaScript<indexterm><primary>JavaScript</primary></indexterm> function and run for each node returned by the query CSS3 selector \r
193                         specified on the slot marker. This function is passed \r
194                         one argument, called item, which an XML Node captured by the selector. This function should return HTML text. The output for all runs of the slot formatter is \r
195                         concatenated into a single string and used to replace the contents of the slot marker.</para>\r
196                         <para>The slot formatter is optional, and if not supplied BibTemplate will create a simple function which extracts and returns the text content of the XML Nodes \r
197                         specified in the CSS3 selector.</para>\r
198                         <para>Example of a slot formatter:</para>\r
199 <programlisting>\r
200         &lt;td class='rdetail_item' id='rdetail_online' type='opac/slot-data' \r
201         query='volumes volume uris uri' join=", "&gt;\r
202                 &lt;script type='opac/slot-format'&gt;&lt;![CDATA[\r
203                         var link = '&lt;a href="' + item.getAttribute('href') + '"&gt;' + item.getAttribute('label') + '&lt;/a&gt;';\r
204                         if (item.getAttribute('use_restriction'))\r
205                                 link += ' (Use restriction: ' + item.getAttribute('use_restriction') + ')';\r
206                                 return link;\r
207                 ]]&gt;&lt;/script&gt;\r
208         &lt;/td&gt;\r
209 </programlisting>\r
210                 </simplesect>\r
211                 <simplesect>\r
212                         <title>JavaScript API</title><indexterm><primary>JavaScript</primary></indexterm>\r
213                         <para>In order for BibTemplate to find the slot markers and invoke the slot formatters JavaScript renderer must be instantiated and called. This must be done \r
214                         for each record that is to contribute to a pages display. The API for this is simple and straight-forward:</para>\r
215                         <para>The slot formatter is optional, and if not supplied BibTemplate will create a simple function which extracts and returns the text content of the XML Nodes \r
216                         specified in the CSS3 selector.</para><indexterm><primary>CSS3</primary></indexterm>\r
217                         <para>Example of a slot formatter:</para>\r
218 <programlisting>\r
219         dojo.require('openils.BibTemplate'); // Tell Dojo to load BibTemplate, if it is not already loaded\r
220         \r
221         // Create a renderer supplying the record id and the short name of the org unit, if known, \r
222         // and call the render() method                                         \r
223         new openils.BibTemplate({ record : new CGI().param('r'), org_unit : here.shortname() }).render(); \r
224 </programlisting>\r
225                         <para>The argument hash supplied to the new <systemitem>openils.BibTemplate()</systemitem> constructor can have the following properties:</para>\r
226                         <itemizedlist>\r
227                                 <listitem>record – The bibliographic record ID.</listitem>\r
228                                 <listitem>org_unit – The relevant Organizational Unit, used to restrict holdings scope as on a search result or record detail page.</listitem>\r
229                                 <listitem>root – The root element within the web page that BibTemplate should search for slot markers</listitem>\r
230                         </itemizedlist>          \r
231                 </simplesect>\r
232                 <simplesect>\r
233                         <title>BibTemplate Examples</title>\r
234                         <para>This is all that we had to add to display the contents of an arbitrary MARC field:</para>\r
235 <programlisting>\r
236 &lt;tr&gt;\r
237         &lt;td&gt;Bibliography note&lt;/td&gt;\r
238         &lt;td type='opac/slot-data' query='datafield[tag=504]'&gt;&lt;/td&gt;\r
239 &lt;/tr&gt;\r
240 </programlisting>\r
241                         <note><para>If multiple fields match, they are displayed on consecutive lines within the same left-hand cell.</para></note>\r
242                         <para>To display a specific MARC subfield, add that subfield to the query attribute.</para><indexterm><primary>MARC</primary></indexterm>\r
243                         <para>For example, subfield $a is the only user-oriented subfield in field 586 (Awards Note)</para>\r
244 <programlisting>\r
245 &lt;tr&gt;\r
246         &lt;td&gt;Awards note&lt;/td&gt;\r
247         &lt;td type='opac/slot-data' query='datafield[tag=586] subfield[code=a]'&gt;&lt;/td&gt;\r
248 &lt;/tr&gt;\r
249 </programlisting>\r
250                         <para>Hide empty rows by default, and display them only if they have content:</para>\r
251 <programlisting>\r
252         &lt;tr class='hide_me' id='tag504'&gt;\r
253                 &lt;td&gt;Bibliographic note&lt;/td&gt;\r
254                 &lt;td type='opac/slot-data' query='datafield[tag=504]'&gt;\r
255                         &lt;script type='opac/slot-format'&gt;&lt;![CDATA[\r
256                                 dojo.query('#tag504').removeClass('hide_me');\r
257                                 return '&lt;span&gt;' + +\r
258                                 '&lt;/span&gt;&lt;br/&gt;';\r
259                         ]]&gt;&lt;/script&gt;\r
260                 &lt;/td&gt;&lt;/tr&gt;\r
261 </programlisting>\r
262                         <itemizedlist>\r
263                                 <listitem>&lt;![CDATA[ ... ]]&gt; tells Evergreen Web server to treat the contents as literal <quote>character data</quote> - \r
264                                 avoids hilarity of entity substitution</listitem>\r
265                                 <listitem>&lt;script type='opac/slot-format'&gt;...&lt;/script&gt;, contained within an <quote>opac/slot-data</quote> element, receives a variable named item \r
266                                 containing the results of the query (a NodeList)</listitem>     \r
267                         </itemizedlist> \r
268                         <para>Suppressing a subfield:</para>\r
269 <programlisting>\r
270 &lt;tr class='hide_me' id='tag700'&gt;\r
271         &lt;td>Additional authors&lt;/td&gt;\r
272         &lt;td type='opac/slot-data' query='datafield[tag=700]'&gt;\r
273                 &lt;script type='opac/slot-format'&gt;&lt;![CDATA[\r
274                         dojo.query('#tag700').removeClass('hide_me');\r
275                         var text = '';\r
276                         var list = dojo.query('subfield:not([code=4])', item);\r
277                         for (var i =0; i &lt; list.length; i++) {\r
278                                 text +=[i]) + ' ';\r
279                         }\r
280                         return '&lt;span&gt;' + text + '&lt;/span&gt;&lt;br/&gt;';\r
281                 ]]&gt;&lt;/script>\r
282         &lt;/td&gt;&lt;/tr&gt;\r
283 </programlisting>\r
284                 </simplesect>\r
285         </section>\r
286         <section xml:id="customizingslimpac">\r
287                 <title>Customizing the Slimpac</title>\r
288                 <para>The Slimpac is the an alternative OPAC display for browsers or devices without JavaScript or which may have screen size limitations. There is both a simple and advanced search \r
289                 option for the Slimpac.</para> \r
290                 <para>The html files for customizing the Slimpac search display are located in the folder <filename class="directory">/openils/var/web/opac/extras/slimpac</filename>.</para>\r
291                 <para><filename>start.html</filename> is the basic search display and <filename>advanced.html</filename> is the display for the advanced search option.</para>  \r
292                 <para>By default, the Slimpac files include the same locale dtd as the regular OPAC (<filename>opac.dtd</filename>). However, the slimpac files do not use the same CSS files as the \r
293                 regular OPAC which means that if you change the OPAC color scheme, you must also edit the Slimpac files.</para>\r
294                 <simplesect>\r
295                         <title>Customizing the Slimpac Results Display</title>\r
296                         <para>Two files control the display results for the slimpac. Edit the XSL stylesheet (<filename>/openils/var/xsl/ATOM2XHTML.xsl</filename>) to edit the elements of the \r
297                         record as pulled from the XML output. \r
298                         You may also change the style of the page by editing the CSS stylesheet for the results display (<filename>/openils/var/web/opac/extras/os.css</filename>).</para> \r
299                 </simplesect>\r
300                 <simplesect>\r
301                         <title>Customizing the Slimpac Details/Holdings Display</title> \r
302                         <para>It is also possible to customize the details page when viewing specific items from the results list. To edit the holdings display which contains the details of the specific \r
303                         record linked from the results display, edit the CSS stylesheet for the holdings/details page \r
304                         (<filename>/openils/var/web/opac/extras/htmlcard.css</filename>). You may also control the content of the record by editing <filename>MARC21slim2HTMLCard.xsl</filename>. \r
305                         Holdings data may also be controlled by editing <filename>MARC21slim2HTMLCard-holdings.xsl</filename>.</para>     \r
306                 </simplesect>\r
307         </section>\r
308         <section xml:id="integratingsearchforms">\r
309                 <title>Integrating a Evergreen Search Form on a Web Page</title>\r
310                 <para>It is possible to embed a simple search form into an html page which will allow users to search for materials in your Evergreen catalog. Here is code which can be embedded \r
311                 anywhere in the body of your web page:</para> \r
312 <programlisting language="html"><![CDATA[\r
313 <form action="http://[domain name]/opac/[locale]/skin/default/xml/rresult.xml" method="get">\r
314 <div>\r
315         Quick Catalog Search:<br />\r
316         <input type="text" alt="Input Box for Catalog Search" maxlength="250" \r
317         size="20" id="t" name="t" value=""  />\r
318         <input type="hidden" id="rt" name="rt" value="keyword" />\r
319         <input type="hidden" id="tp" name="tp" value="keyword" />\r
320         <input type="hidden" id="l" name="l" value="2" />\r
321         <input type="hidden" id="d" name="d" value="" />\r
322         <input type="hidden" id="f" name="f" value="" />\r
323         <input type="submit" value="Search" class="form-submit"  />\r
324     </div>\r
325 </form>\r
326 ]]>\r
327 </programlisting>\r
328                 <para> Replace <emphasis>[domain name]</emphasis> with the domain name of your Evergreen server and replace <emphasis>[locale]</emphasis> with the desired locale of \r
329                 your Evergreen instance (e.g. en-US). This does a basic keyword search. Different types of searches and more advanced search forms can be developed. For further information on the url parameters used by Evergreen, see <xref linkend="search_url" /> for more details.</para> \r
330         </section>\r
331 </chapter>\r
332 \r