Virginia Tech™home

List component

The list component can compile and display content from a variety of sources. Whether it's tags, pages within a folder, or a customized set of items, this component can be used to feature content in a manner for indexing or displaying in a list style. It can also produce an XML file for syndication. 

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 component. 

List component

Properties for the list component are divided among three tabs: List Properties, Display Options, Feed Options

List Properties

Component Title: Give the component a title if you plan to use it as a reference.

CSS Class:  

Build list using: There are several ways to build a list. Options include:

  • Child pages: These are pages within a folder. Use the browse icon to find the path. 
  • Descedant pages: All of the pages within a particluar folder. Use the browse icon to find the path. 
  • Fixed list: A set list of items that can pull from a variety of different pages within the system. Click the "add field" button to expand the list.
  • Search: Set a certain path and create a list by selecting a particular term. 
  • Search list:
  • Advanced search
  • Tags: Build a list using tags

Display as: You can control the display of the list items by:

  • Title (from the Basic page properties)
  • Title with description (from the Basic page properties)
  • Title with description and image (the image from the Image component embedded in the Article page template)
  • Title with image

NOTE: Lists will only display the embedded image from an Article page. It does not work with any other type of page template.

Date format: The date format is available if you wish to feature the publish date with the list item. Options include:

  • None
  • YYYY-MM-DD
  • MM/DD/YYYY
  • Month (abbreviated) Day
  • Month (abbreviated) Day, Year
  • Month Year
  • MM.DD.YYYY

Time format: You can also choose a time format for list items. These styles include:

  • None
  • ISO 8601 standard (explanation)
  • HH:MM AM/PM
  • 24-hour time

Order by: Choose the order of the list by title, creation, last modification, or template.

Limit: Limit the amount of items in the list. 

Enable Feed: Check this box if you want to produce an XML feed of this list. 

Paginate after: To prevent an incredibly long page, choose the number of items to appear in a list before a new page is created. 


The list component can compile and display content from a variety of sources. Whether it's tags, pages within a folder, or a customized set of items, this component can be used to feature content in a manner for indexing or displaying in a list style. It can also produce an XML file for syndication.

Features

  • Various list source options
  • Various list display configuration options
  • Inclusion of RSS feed link
  • Pagination controls
  • Sorting and limiting

Dialog Properties

List Properties

  1. Component Title - Title of Component
  2. CSS Class - CSS class to be applied to the component
  3. Build list using - the source of the list
    • Child pages
    • Descendant pages
    • Fixed list
    • Search
    • Search list
    • Advanced Search
    • Tags
  4. Options for Child Pages - depending on the Build list using selection, this menu contains different options
    • Child pages
      • Children of
    • Descendant pages
      • Descendants of
    • Search
      • Search query
      • Search in
      • Search List
        • Search in
        • Search depth
          • Child page only
          • All pages (recursive)
        • Page type
          • Articles
          • Bios
          • Buildings
          • Events
          • General
          • Locations
          • Redirect
          • Resources
          • Videos
      • Additional Filter by Tags
        • Match
          • any tag
          • all tags
        • Tags
    • Advanced Search
      • Options for Querybuilder Querybuilder predicate notation
    • Tags
      • Options for tags
        • Parent page
        • Tags
        • Match
          • any tag
          • all tags
    1. Order by - sort the results based on a parameter
      • Filename
      • Title
      • Created Date
      • On Time
    2. Sort order
      • ascending
      • descending
    3. Limit - how many results will be in the list
    4. Include hidden pages
    5. Offset - the list result to start rendering from
    6. Paginate after - the number of results to display before pagination occurs

Display Options

  1. Display Type - displays results in a certain format
    • Column(s)
    • Table
  2. Number of Columns
    • 1
    • 2
    • 3
    • 4
    • 6
  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

Feed Options

  1. Show Feed Link - renders a link to an RSS feed of the search results
  2. Feed Style
    • Normal
    • Description, Title
  3. Managing Editor - for feeds
  4. Web Master - for feeds
  5. Paginate after - the number of results to display before pagination occurs

Video

Loading player for /content/dam/ensemble_cms_vt_edu/videos/list.mp4...

See a video demonstration of this component. Click the arrows to the right of the player bar to expand the window.