Skip to main content

Report Token: {Link_Section}

This guide explains how to use the Link_Section token in reports to create internal hyperlinks to report sections.


Basic Structure

The token uses URL-style parameters separated by & characters. For example:

{Link_Section?name=Executive Summary&text=Go to Executive Summary}

Configuration Sections

1. Required Parameters

name=[section_name]

  • The name of the section to link to
  • Must match the exact section name as defined in the report template
  • Case-sensitive matching for the anchor ID generation
  • Example: name=Executive Summary

2. Optional Parameters

text=[custom_text]

  • Custom text to display for the link
  • If not specified, defaults to the section name
  • Example: text=Click here to view the summary

display=[inline|block]

  • Controls how the link is rendered
  • Available values: inline (default), block
  • inline: Renders as a span element, suitable for use within paragraphs
  • block: Renders as a div element, suitable for standalone links
  • Example: display=block

How It Works

The Link_Section token creates clickable hyperlinks that navigate to the corresponding section within the same PDF document.

  • When the report is generated, the token creates a link using the section name

For this to work properly:

  • The section must exist in the report template
  • The section name must match exactly

Error Handling

The token displays error messages in the following cases:

Missing name parameter:

[Invalid Link: No section name specified]

HTML Structure and CSS Classes

The Link_Section token generates hyperlinks that navigate to section divs within the document.

<span class="internal-link-text">Link Text</span>

CSS Classes:

  • internal-link-text: Base styling for the link text in preview
<div class="internal-link-text">Link Text</div>

CSS Classes:

  • internal-link-text: Base styling for the link text in preview
<a href="#executive-summary" class="internal-link internal-link-section">Link Text</a>

CSS Classes:

  • internal-link: Base class for all internal links
  • internal-link-section: Specific class for section links

Block Display Wrapper (in PDF)

<div class="internal-link-block">
    <a href="#executive-summary" class="internal-link internal-link-section">Link Text</a>
</div>

CSS Classes:

  • internal-link-block: Wrapper for block-level links

Error Display

<span class="link-error">[Error message]</span>

CSS Classes:

  • link-error: Styling for error messages

Examples

Basic link with default text

{Link_Section?name=Executive Summary}

Creates a link displaying "Executive Summary" that navigates to that section.

Link with custom text

{Link_Section?name=Executive Summary&text=Jump to Summary}

Creates a link with custom display text while still navigating to the Executive Summary section.

{Link_Section?name=Findings&text=View All Findings&display=block}

Creates a standalone block-level link, useful for prominent navigation elements.

Inline link within text

For a high-level overview, please refer to the {Link_Section?name=Executive Summary&text=executive summary} at the beginning of this report.

Creates an inline link that flows naturally within a paragraph.

Table of contents style navigation

This report contains the following sections:
- {Link_Section?name=Executive Summary}
- {Link_Section?name=Methodology}
- {Link_Section?name=Findings}
- {Link_Section?name=Recommendations}
- {Link_Section?name=Appendix}

Creates a navigational list linking to all major sections.

Was this article helpful?