|
How area search works
A search box that searches your program or region´s content
is a standard element of content pages on both public access and
the intranet. On public access, this search box is included in the
agency template.
While we often refer to your area´s content as a collection,
there is, in fact, only one physical collection for public access, and
one for intranet. Search is restricted to that part of the collection
that belongs to you by "filtering". Filtering works by
matching one or more piece of text to codes in the collection that are
unique to your area. A filtered search is referred to as an "area
search".
Coding your search form
Search is implemented in content pages using an HTML form. The
same rules apply for forms in static and dynamic content.
- All parameter names must be coded in lower case.
- Parameter values may not contain < > & or \ .
- Use commas to separate multiple terms in the value.
Required fields for area search
The fields below are required both for intranet and public
access search forms.
| Name | Values | Comments |
|---|
| typeofsearch | area | epa |
Use area to search only your area,
epa to search entire agency (1.) |
| areaname | The plain English name of your
area as it should appear in the search results. |
Keep it short! No ampersands (&). |
| filter | Samplefilt.hts |
sample2filt.hts |
sample3filt.hts |
See Choosing a Filter section. |
| fld | tssms or URL string | Separate
multiple values with commas. See Choosing a Filter
section |
| result_template | epafiles_default.xsl (public
access) | agcyintr_default.xsl (intranet) | custom
| Extensible style language stylesheet to render
results. |
| querytext | |
Textbox for entering search terms |
1. You can allow the user to toggle between area and epa search
Sample 1. – Search tssms "region13" on public
access.
<form method="get"
action=" http://nlquery.epa.gov/epasearch/epasearch">
<input type="hidden" name="typeofsearch"
value="area">
<input type="hidden" name="areaname"
value="Region 13">
<input type="hidden" name="filter"
value="samplefilt.hts">
<input type="hidden" name="fld"
value="region13">
<input type="hidden" name="result_template"
value="epafiles_default.xsl">
<input type="text" name="querytext">
</form>
|
Sample 2. – Search tssms "region13" on intranet.
<form method="get" action=
" http://nlintrasearch.epa.gov/epasearch/epasearch "
>
<input type="hidden" name="typeofsearch"
value="area">
<input type="hidden" name="areaname"
value="Region 13">
<input type="hidden" name="filter"
value="samplefilt.hts">
<input type="hidden" name="fld"
value="region13">
<input type="hidden" name="result_template"
value="agcyintr_default.xsl">
<input type="text" name="querytext">
</form>
|
Top of page
Choosing a filter
There are two fields available for filtering, TSSMS and URL.
You can filter on one, the other or both.
For content on the primary Unix servers www.epa.gov and
intranet.epa.gov, you are assigned one or more TSSMS. Pages on
servers other than these are still assigned a TSSMS in the collection,
for the purpose of filtering. This will be the same TSSMS as you use
on the Unix servers unless you request otherwise. Filtering by TSSMS
alone is the most common type of filtering. To search all of one or
more TSSMS, use samplefilt.hts . samplefilt uses the
fld parameter to specify TSSMS.
The URL encoded in the search collection is your preferred alias.
If you have only one alias, it is considered your preferred alias.
If you have multiple aliases, you must designate which is preferred
by (how do we do this these days?). You would filter on a partial
URL in addition to TSSMS if you wanted to search only certain
directories of your TSSMS. If you want to search one or more
directories of one or more TSSMS, use sample3filt.hts .
sample3filt uses the fld parameter to specify TSSMS, and the
url_directory parameter to specify partial URL.
The least common technique is to filter exclusively on URL. The
disadvantage of filtering on URL is that you may have to change your
search form each time you add or change an alias. The only possible
reasons for filtering are URL exclusively are 1. you want to search
all of one TSSMS, but only part of another or 2. there is a directory
in one TSSMS you want to search, and a directory of the same name in
another TSSMS you do not want to search. If either of these is true,
use sample2filt.hts . sample2filt uses the fld
parameter to specify partial URL.
Summary of filtering options
| filter | fld | url_directory |
|---|
| samplefilt.hts | tssms | N/A |
| sample2filt.hts | url | N/A |
| sample3filt.hts | tssms | url |
Optional parameters
The fields below are required both for intranet and public
access search forms.
| Name | Value | Comments |
|---|
| areacontacts | url |
If present, this will be the link for "Contact
us" in search results. If not present,
"Contact us" will link to the Agency
contact page. |
| areasearchurl | url | If present, this
will be the link for "Advanced Search" in search
results. If not present, "Advanced Search" will link
to Agency advanced search. |
| search_crumbs | yes | no | Controls
searching and displaying topical "Browse pages".
Default is no for area search, yes for epa search. |
| search_pdf | yes | no | Controls whether
PDF documents are include in the search. Default is
yes. |
| weighted_search | yes | no | Controls
whether ranking boost is applied to documents in Web Inventory
(WEB, iWEBI). Default is yes. |
| weight_string | See note | Used to apply
custom weighting for ranking. Please consult search webmasters
before using this parameter. |
| sort | term_relevancy | date | Controls
ordering of search results. Default is term_relevancy
(sic). |
| tmf | yes | no | Controls whether results
are for visual presentation. Default is "yes".
"no" is typically used only when requesting results
in machine-readable format, e.g. XML. |
Top of page
|