Virginia Tech™home

Search component

The search component allows you to create a custom search tool and results page. By default, the search box on any webpage scans all of the pages within the Virginia Tech website. 

The custom search limits to the parameters that you set through the Google Custom Search interface. Those parameters can be limited to the site(s) you manage to give users a better search experience.

Properties window

After placing the component on the page, open its properties by clicking on the configure (wrench) icon. From here, you can adjust the settings of the search component. 

The fields in the properties window include:

Search Page Type: By default, the choice will be Google Search. However, you can select Tag search from the pull-down menu. 

Google Custom Search Engine: When a custom search engine is created, Google will provide an ID number. Place that ID in this field. Leaving it blank will default to the university search. 

Max results per page: Choose the maximum number of results per page. If left blank, the default number will be 10 results. 

Note: When using the Search component for a custom search you must create a search results page with a Search page template. This page should be at the same level in the folders as your home page and will need to be published and linked to from the site level Site Configuration properties (see image below). Site Configuration can be found if you View Properties at the site level, the level you are brought to after login, My Sites. If you cannot edit these properties, you will need to contact someone with Web Admin permissions for your site, in your department.

Search Page Site Configuration Settings
Site Configuration settings for custom search results page

The search component allows you to create a custom search tool and results page. By default, the search box on any webpage scans all of the pages within the Virginia Tech website.

Features

  • Automatic results based on page tags
  • Automatic results based on a Custom Google Search Engine
  • Various list display configuration options for tag results

Dialog Properties

Title and Options

  1. Component Title - Title of Component
  2. CSS Class - CSS class to be applied to the component
  3. Search Page Type
    • Tags - build the search page based on the tags for the current page
    • Google Search - build the search page based on a custom Google search

Tags search

  1. Tag information - display the tags used in the search
    • None
    • Show Title
    • Show Tag and Description
  2. Display Type - displays results in a certain format
    • Column(s)
    • Table
  3. Image Position - the placement of the image (if columns display type is chosen)
    • Top
    • Bottom
    • Left
    • Left (Medium)
    • Left (Large)
    • Right
    • Right (Medium)
    • Right (Large)
    • Hide
  4. Table Type - if table display type is chosen
    • DataTables
    • Regular Table
  5. Image Position - if table display type is chosen
    • First column
    • Last column
    • Hide
  6. Date - various date formatting options
    • Hide
    • 2009-01-15 (ISO-9601)
    • 01/15/2009
    • Jan 15
    • Jan 15, 2009
    • January 2009
    • 01.15.2009
  7. Time - various time formatting options
    • Hide
    • T13:30-05:00 (ISO8601)
    • 1:30 PM
    • 13:30
  8. Title
    • Show
    • Show without link
    • Hide
  9. Description
    • Hide
    • Show
  10. Tag(s)
    • Hide
    • Show
  11. Include hidden pages
  12. Order by - sort the results based on a parameter
    • Filename
    • Title
    • Created Date
    • On Time
  13. Limit - how many results will be in the list
  14. Show Feed Link - renders a link to an RSS feed of the search results
  15. Feed Style
    • Normal
    • Description, Title
  16. Managing Editor - for feeds
  17. Web Master - for feeds
  18. Paginate after - the number of results to display before pagination occurs

Google search

  1. Google Custom Search Engine - the desired CSE ID, will default to Virginia Tech's CSE
  2. Max results per page - default is 10