Document detail

Document detail page types provide summary information about a document or related group of documents. These pages help users better understand the relevancy and context of documents before deciding whether or not to download or engage further.

Each document detail page template has three basic content areas:

docdetail_top_example.png

Use case

When to use

  • When the primary goal of the page is to encourage users to download a resource or understand the context around a document.
  • When creating a filterable list of items, document detail pages house the items within the filterable list.

When other options are better

  • When providing the full text of an article or detailed content, but not specifically focused on a document for download, use the more general Learn page template.
Page components included

Within each area of the template, various components may be selected to best fit the content of the specific page being created.

Area 1

Item introduction

Area 2

Full width text

Table

Expandable

Area 3

Metadata / Related posts / Related links

Contact information

Email sign up

Behavior

Below the 901 px breakpoint, the sidebar stacks below the main content area.

Breakpoints 901+

docdetail_behavior_desktop.png

Breakpoints 900 and less

docdetail_behavior_mobile.png

Post preview

When document detail pages are accessed via entries within a filterable list, information about each page is displayed on filterable list pages via the post preview component.

Post preview within a filterable list at breakpoints 601+

post_preview_desktop_1.png

Breakpoints 600 and less

post_preview_mobile_1.png

Content guidelines

Document detail page

  • Page content should provide context for the document housed on the page and should help users get a sense of what will be in the document before the download it; what answers it provides, what they will learn, etc.
  • Multiple documents should only be grouped on a single page when they are different versions of a single document, or provide context for one another.

Post preview

  • Function of the post preview is to provide context to the user to help them decide if the document has the information they need as they browse through a list.
  • May use up to two category labels, but strongly recommended to assign one category label per page.
  • Post preview title will be linked, so no need to provide “Click here to read more” direct call to action, or link to the doc detail page within the preview description text.
  • Post preview description text should be limited to 2-3 sentences; 50 words. Language should provide a “nudge” to action.

Style

Document detail page

Area 1: Item introduction

  • Using the item introduction is required.

Area 2: Main content

  • At least one component is required here.

Area 3: Sidebar

  • Strongly recommend using the metadata sidebar component in order to display basic information about the document(s) housed on this page.
  • When the metadata sidebar is used, it must appear at the top of the sidebar area.

Post preview

Possible metadata inputs shown

post preview inputs
  1. Category label - minicon, H4 (2 max)

  2. Date - H5 Grey #75797C (required)

  3. Image (thumbnail) - 30px padding

  4. Event date icon - Unique option for events, dynamic icon with 15px padding

  5. Post title - H3 (required)

  6. Sub-heading - H6

  7. Description - Avenir paragraph (required)

  8. Author label - Avenir paragraph

  9. Secondary link - Standard hyperlink

  10. Topics tags - H6 Grey #75797C, 80% gold #FAAF4C dotted underline and round bullet