Google Search Appliance

Office of Information Technology

Designing the Appearance of Your Front End

Your front end design determines how your Web visitors see their search results. You must design your front end to look different from a general University Web search and relevant to your organization; otherwise, people may think they are searching over the entire University when they are actually searching only within your collection.

You have two ways to edit the appearance of your front end. You may use the Page Layout Helper to control basic features, or you may fine-tune all features manually using the XSLT Stylesheet Editor. The Page Layout Helper is the default design mode on a new front end.

These design modes are mutually exclusive; you must use one or the other but not both. If you try the XSLT Stylesheet Editor and later decide to revert to the Page Layout Helper, you must also revert to the default stylesheet, so remember to export a backup of your current configuration first.

The front end is served from the Search Appliance, not from your Web site. Remember to provide full URLs for images, CSS files, and other files that browsers will load when they visit your front end.

Using the Page Layout Helper

This tool is mostly self-explanatory. Many of the options, when changed, provide a live preview of the search results page. You must submit the changes before they will actually take effect.

When you insert HTML code into the header and footer fields, remember that these pieces will appear inside the rendered document's BODY element. You should not supply your own HTML, HEAD, or BODY tags. If you are integrating the front end into the look and feel of an existing Web site, you probably want to copy the header HTML code from the source code of a page on the site: copy the code between the opening BODY tag and the beginning of the page's unique content. For the footer, copy between the end of the content and the closing BODY tag. You may want to reference your site's style sheet (CSS) file from the header to maintain consistency between the front end and pages on your site.

Using the XSLT Stylesheet Editor

You can edit the underlying XSLT stylesheet directly to gain access to options not provided through the Page Layout Helper. For example, you can add extra input controls to the search form. You should have a basic understanding of XML syntax before editing the XSLT code. A small typing error, such as omitting an angle bracket, will prevent you applying your upated stylesheet until you fix the error. Embedded HTML code for the header and footer must have its angle brackets <> escaped as &lt; and &gt;, respectively, or else it will invalidate the XML syntax of the stylesheet.

Many of the common customizable options are documented in the built-in Help pages of the Search Appliance. For more detailed explanations of the XSLT stylesheet and search form parameters, please consult the Google Search Protocol Reference.

Delayed changes in appearance

Occasionally there is a short delay until the changes appear in your live front end search results. If you want to see the changes immediately, perform one search with the &proxyreload=1 parameter added to your URL query string.

Contact U of M Privacy
© Regents of the University of Minnesota. All rights reserved.
The University of Minnesota is an equal opportunity educator and employer.

Last modified 2008-05-26 22:20:32 CDT · Retrieved 2009-11-25 02:06:38 CST · URL http://www.umn.edu/google/managers/format.html