Understanding Link Types in Energy.gov

Learn the many different ways to link to content on and off the site. This article will teach you how and where and why.

CMS Support

June 17, 2021
minute read time

There are many places and methods to link to pages, content, and media within and outside of the site. This guide should help you understand which to use when, and the best practices.

CMS Support

Autocomplete Link Text fields

These autocomplete fields will let you search for published node content in the site, or you can manually enter the URL

How to Use Autocomplete Text Fields

  • Autocomplete: Search by Title, and select content from the drop down
  • Add directly by using the "slash-node-slash-node ID" link format 
    • /node/3029979
    • Be sure to include the preceding "/", or the link won't work
  • Add by RELATIVE link
    • /test-group/articles/zen-article-one-everything
    • Be sure to include the preceding "/", or the link won't work
    • Do not include the full URL for content inside the CMS
  • Add external link
    • https://www.google.com
    • Be sure to include the preceding "https://", or the link won't work

Note: Selected Autocompleted content may display differently, depending on the field

  • Image
  • Image

Entity Reference Fields

These fields need to specifically reference something in the CMS- usually so it can display things like Title, Summary, and Thumbnail image from the referenced node or media. If you want one of these fields to link to page outside the site (e.g. a page from https://whitehouse.gov) you will first need to create an External Resource media item to link to it.

How to use Entity Reference Fields

  • Entity Type: Switch between Content nodes and External Resource Media
  • Autocomplete: Search by Title, and select content from the drop down
  • Autocomplete: Search by node id and select content from the drop down

Where to find Entity Reference Fields

Article:

  • Contributor (Person node only)

Paragraph Blocks

  • Contributor: Person (Person node only)
  • Featured Item (Content & External Resource Media)
  • Listing: (Listing Type: Dynamic Listing Node): Listing (Listing nodes only)
  • Listing: (Listing Type: A Static list): Items (Content & External Resource Media)
  • Photo Gallery (Photo Gallery nodes only)
  • Podcast Item (Podcast nodes only)
Tags:
  • Cybersecurity
  • Energy Efficiency
  • Federal Facility Optimization and Management
  • Grid Modernization Initiative
  • Electric Grids

Any Questions, Comments, or Requests?

Contact us at [email protected]