Search results

The search results pattern is used to present a list of links typically from a search service. Different types of results may require different content to be featured, so this pattern has a number of options to provide for this.

Rules for search results

  • A list of search results can use any combination of search result layout options.
  • Large lists of search results should be split accross multiple pages.

Options available

Simple result

The simplest implementation must include a heading for each result that links to the corresponding resource. This could be a web page, file or URL.

Example

  1. This is the heading of the web page

  2. This is the name of a document
Code 


    
    
    
  1. 
        
            
    This is the heading of the web page
    
            
            
            
        
        
    
    2. 
    
  2. 
        
            
    This is the name of a document
    
            
            
            
        
        
    
    3.

Standard result

The standard implementation may include an optional path to the result, an optional short descriptive summary and also a heading label for secondary information.

  • The short summary should be no longer than 160 characters.
Example

  1. Heading for the results group

  2. This is the heading of the web page

    Password protected https://www.st-andrews.ac.uk/path/to/page/

    This is a short description for the web page where any matching search term is highlighted.

  3. This is the name of a document

    PDF (525k) https://www.st-andrews.ac.uk/path-to-file/search-term

    This is a short description for the document where any matching search term is highlighted.

Code 


    
    
  1. Heading for the results group
    2. 
    
  2. 
        
            
    This is the heading of the web page
    
            Password protected
            https://www.st-andrews.ac.uk/path/to/page/
            
        
        
    This is a short description for the web page where any matching search term is highlighted.
    
    
    3. 
    
  3. 
        
            
    This is the name of a document
    
            PDF (525k)
            https://www.st-andrews.ac.uk/path-to-file/search-term
            
        
        
    This is a short description for the document where any matching search term is highlighted.
    
    
    4.

Additional result metadata

Results can also include metadata to provide quick key information about a resource. This uses the metadata list pattern.

Example

  1. Heading for the results group

  2. This is the heading of the web page

    Password protected https://www.st-andrews.ac.uk/path/to/page/

    This is a short description for the web page where any matching search term is highlighted.

    File location
    This is a full width metadata field that can be used for prominent or longer values
    Published date
    18 July 2019
    Document type
    Guidance
    Scope (applies to)
    All staff

  3. This is the name of a document

    PDF (525k) https://www.st-andrews.ac.uk/path-to-file/search-term

    This is a short description for the document where any matching search term is highlighted.

    Published date
    21 April 2019
    Document type
    Guidance
    Scope (applies to)
    All staff
    Email
    help@st-andrews.ac.uk
Code 


    
    
  1. Heading for the results group
    2. 
    
  2. 
        
            
    This is the heading of the web page
    
            Password protected
            https://www.st-andrews.ac.uk/path/to/page/
            
        
        
    This is a short description for the web page where any matching search term is highlighted.
    
        
    
            
    File location
    This is a full width metadata field that can be used for prominent or longer values
    
            
    Published date
    18 July 2019
    
            
    Document type
    Guidance
    
            
    Scope (applies to)
    All staff
    
        
    
    
    3. 
    
  3. 
        
            
    This is the name of a document
    
            PDF (525k)
            https://www.st-andrews.ac.uk/path-to-file/search-term
            
        
        
    This is a short description for the document where any matching search term is highlighted.
    
        
    
            
    Published date
    21 April 2019
    
            
    Document type
    Guidance
    
            
    Scope (applies to)
    All staff
    
            
    Email
    help@st-andrews.ac.uk
    
        
    
    
    4.