Versions Compared

Old Version 1

changes.mady.by.user Smita Nair

Saved on

compared with

New Version 2

changes.mady.by.user Smita Nair

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article discusses the recommended way of how URLs must be used in correlation with profiles in the Markdown from a URL macro HTML and XSLT macros. The best practice is to specify both, profile and a relative path, in the macromacros' s configuration. In this way, you can access multiple locations through the same profile, and render Markdown HTML or XML content on your pages.

Description

With the Markdown from a URL macro, you You can connect to an external application or location through a URL and display relevant content on your page. For this purpose, the macro allows macros allow you to use profiles and URLs to specify the complete path to access the required application data.

...

First, it is important to understand how the macro behaves with profiles and URLs. The correlation between URLs and profiles with respect to the macro can be explained as:

Is Profile given?

(Y - Yes, N - No)

Is 

URL to markdown file given

Location given?

(Y - Yes, N - No)

Macro behavior
YNAccesses the URL specified in the profile through the pre-configured information.
NYAccesses the URL specified and renders the
Markdown
HTML or XML content as required.
YYAppends the URL mentioned in the
URL to markdown file parameter to
Location of HTML data or Location of XML data parameter to the URL configured in the profile. Thus, the macro creates
a relative path
an absolute path to the
Markdown
required file. If this path is not valid, a network error message is displayed. To resolve this issue, contact your Confluence administrator for more information.

How

...

Create or edit a page and add the Markdown from a URL macro.

...

Edit the macro and the macro editor appears.

...

it all works

For this example, let’s assume the profile has the following values specified:
Image Modified

Note

Here, the profile is linked to GitLab and the URL shown is the base URL of the application that the macro fills automatically. 

See the Additional links section for more information about GitHub and GitLab profile creation. 


  1. Create or edit a page, add the Markdown from a URL macroHTML macro for this example, and, edit it to open the macro editor.

  2. Enter a relative path (partial URL) to an attachment in URL Location to markdown fileHTML data.

    Note

    As mentioned, the macro appends the relative path in the URL to markdown file Location of HTML data with the base URL given in the profile. If this path is valid, the file(s) are read and the Markdown HTML content is displayed, else, a network error is displayed.


  3. Save the macro and publish the page to see the content.

Info
titlePoints to remember:
  • Profiles are a means to access and retrieve contents from external applications such as GitHub, GitLab, and so on.
  • A profile already contains the base URL and the required credentials to access the relevant application.
  • If you specify a profile in the macro editor, enter a relative path in URL to markdown file to in the Location fields to access the required file(s).
  • You must specify a profile or a URL in the macro editor.
  • If you specify an absolute URL in URL to markdown filethe Location fields, the macro accesses the content in the specified path.
  • Take a look at the existing documentation such as the user guide and the admin administrator guide to know more about the macro itself and its usage.