tibe.io

URL Parameter Macro - Documentation

Introduction

This plugin is designed to be used in Atlassian Confluence pages to insert content directly from URL. This is intended to be used in e.g. personalized manuals or onboarding processes. Here's how you can use it in your own Confluence content.

Installation

You can install this plugin right from the Atlassian Marketplace. If you do not have an internet connection with your Confluence install, you can go to the marketplace, download the latest version of the plugin and upload it to your local installation of Confluence. You can refer to this Atlassian Knowledge Base entry to get more details about installing plugins in Confluence: https://confluence.atlassian.com/upm/installing-add-ons-273875715.html

Usage in your content

You can insert the macro like you use any other macro on your content page. From any content editor, open your macro browser and search for "URL Parameter":

Adjust the neccessary settings:

Parameter Name: This is the name of the URL parameter you want to use in your content, e.g. "name"

Default Value: This value will be shown if the parameter in the URL is not present (e.g. the page is opened from search or direct link without parameters)

After that, apply the macro to your content.

 

You can now use the macro in different ways:

Calling the content page without parameter set in the URL

If you call your content without the parameter set in the URL, your page will be displayed and at the location of this macro you'll find the default value you have specified before. 

Sample URL: https://confluence.example.com/display/space/page

 

Calling the content page with parameter set in the URL

If you call your content with the parameter set in the URL, your page will be displayed with the content of the parameter you've specified.

Sample URL: https://confluence.example.com/display/space/page?name=My%20Name