OPAC: Building an External Voyager Webpage Search Form
[This article was copied from the Voyager Wiki.]
Step One: Opening FORM tag
|
<form method="get" action="http://www.your.edu/vwebv/search"> |
Step Two: Input tag - "Terms to search"
|
<input name="searchArg" class="inputStyle" size="55" type="text"> |
Step Three: Selection tags - "Search Within"
|
<select size="7" name="searchCode"> <!-- # searchCode can be any code in SysAdmin # CMD or BT equals command search # FT equals full text keyword search # + equals Browse # * equals Relevance # ^ equals Automatic AND # | equals Automatic OR # @ equals Headings Keyword (automatically ANDs search terms) # Relevance cannot be used with browse searches # Browse and relevance cannot be used with headings keyword searches --> <option value="GKEY^">Keyword</option> <option value="NKEY^">Name</option> <option value="SKEY^">Subject</option> <option value="TKEY^" selected="selected">Title</option> </select> |
Step Four: Selection tags - "Limit To" (OPTIONAL)
|
<select size="7" name="limitTo"> <!-- # Valid Limit Types: # LANG Language # MEDI Medium (or Format) # PLAC Place # STAT Status # TYPE Item Type # DATE Date # LOCA Location # Limit codes are available in .../vwebv/ui/SKIN/xsl/userTextConfigs/limits.xml # Location Limit Groups are available in SysAdmin --> <option value="LOCA=LOCA_LIMIT_NAME">Limit Name Here</option> <option value="MEDI=LIMIT_CODE_HERE">Limit Name Here</option> <option value="PLAC=LIMIT_CODE_HERE">Limit Name Here</option> <option value="STAT=LIMIT_CODE_HERE">Limit Name Here</option> <option value="TYPE=LIMIT_CODE_HERE">Limit Name Here</option> <option value="DATE=DATE_VALUE_HERE">Limit Name Here</option> <option value="LANG=LIMIT_CODE_HERE">Limit Name Here</option> </select> |
Step Five: Sort By (OPTIONAL)
|
<select size="5" name="sortBy"> <!-- Valid Sort By Options # AUTHOR # TITLE # PUB_DATE # PUB_DATE_DESC # RELEVANCE --> <option value="AUTHOR">Author</option> <option value="TITLE">Title</option> <option value="PUB_DATE">Pub Date Ascending</option> <option value="PUB_DATE_DESC">Pub Date Descending</option> <option value="RELEVANCE">Relevance</option> </select> |
Step Six: Hidden tags
|
<!-- Record Count --> <input value="25" name="recCount" type="hidden">
<!-- Search Types --> <!-- # Unless you are going to include multiple searchArg # commands stick to Quick (0) or Basic (1) searchType --> <input value="1" name="searchType" type="hidden"> |
Step Seven: Submit button
|
<!-- Submit Button --> <input value="Search" type="submit" alt="Get search results" src="/vwebv/ui/SKIN/images/btn_go.gif"> |
Step Eight: Closing FORM tag
|
</form> |
Your completed form code will look like:
|
<form method="get" action="http://www.your.edu/vwebv/search"> <input name="searchArg" class="inputStyle" size="55" type="text"><br /><br /> <select size="7" name="searchCode"> <option value="GKEY^">Keyword</option> <option value="NKEY^">Name</option> <option value="SKEY^">Subject</option> <option value="TKEY^" selected="selected">Title</option> </select><br /><br /> <select size="7" name="limitTo"> <option value="DATE=1999-2013">Published in the last 15 years</option> <option value="DATE=2003-2013">Published in the last 10 years</option> <option value="DATE=2008-2013">Published in the last 5 years</option> <option value="DATE=2013">Published this year (2013)</option> <option value="DATE=2012">Published last year (2012)</option> </select><br /><br /> <select size="5" name="sortBy"> <option value="AUTHOR">Author</option> <option value="TITLE">Title</option> <option value="PUB_DATE">Pub Date Ascending</option> <option value="PUB_DATE_DESC">Pub Date Descending</option> <option value="RELEVANCE">Relevance</option> </select><br /> <input value="25" name="recCount" type="hidden"> <input value="1" name="searchType" type="hidden"> <br /><input value="Search" type="submit" alt="Get search results" src="/vwebv/ui/SKIN/images/btn_go.gif"> </form> |
You may want to add labels to your form:
|
<form method="get" action="http://www.your.edu/vwebv/search"> Search for: <input name="searchArg" class="inputStyle" size="55" type="text"><br /><br /> Search In: <select size="7" name="searchCode"> <option value="GKEY^">Keyword</option> <option value="NKEY^">Name</option> <option value="SKEY^">Subject</option> <option value="TKEY^" selected="selected">Title</option> </select><br /><br /> Limit to: <select size="7" name="limitTo"> <!-- <option selected="selected">Limits</option> --> <option value="DATE=1999-2013">Published in the last 15 years</option> <option value="DATE=2003-2013">Published in the last 10 years</option> <option value="DATE=2008-2013">Published in the last 5 years</option> <option value="DATE=2013">Published this year (2013)</option> <option value="DATE=2012">Published last year (2012)</option> </select><br /><br /> Sort by: <select size="5" name="sortBy"> <option value="AUTHOR">Author</option> <option value="TITLE">Title</option> <option value="PUB_DATE">Pub Date Ascending</option> <option value="PUB_DATE_DESC">Pub Date Descending</option> <option value="RELEVANCE">Relevance</option> </select><br /> <input value="25" name="recCount" type="hidden"> <input value="1" name="searchType" type="hidden"> <br /><input value="Search" type="submit" alt="Get search results" src="/vwebv/ui/SKIN/images/btn_go.gif"> </form> |