Virginia Tech®home

Search component

The Search component is used to embed a separate search field or custom search field into any page. By default, the search box within the basic user interface of the site's design template on any page scans all of the pages within all of Virginia Tech's web properties and redirects the user to search.vt.edu for results. 

Ensemble users can submit a Service Now ticket to request a Google Custom Search Engine and ID for any site or subsite (path within a site).

NOTE: This component is for embedding a search field separate from the basic user interface search within the site's design template. For a custom Search landing page within your site, you will need to create a Search page e.g., /search, enter the Google Custom Search ID in the embedded search component in the Search page template, and publish that page. You will also need to set the Site Configuration field for the search landing page to the one you just created and published.

The Title and Options configuration dialog contains the following options:

  • Component Title - text input field that does not display for this component but useful for giving the component a title for keeping track of what it is used for on the page
  • CSS Class - text input field for custom CSS and/or utility classes
  • Search Page Type - select pulldown used to choose Google Search or Tags as the result type
  • Google Custom Search Engine - text input field for Google Custom Search Engine ID supplied by Ensemble support personnel via Service Now
  • Max results per page - number field to limit the number of displayed search result items
Search Component Title and Options configuration dialog
Search Component Title and Options configuration dialog

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

CSS Classes

  • fa
  • fa-search
  • gcse-searchresults-only
  • list
  • parbase
  • search
  • section
  • vt-gcse-script
  • vt-go-button
  • vt-go-button-text
  • vt-list
  • vt-search-block
  • vt-search-form
  • vt-search-googlesearch
  • vt-search-tagsearch