Description
This article illustrates how to create a profile in the macros using a URL.
Before you begin:
- Before you enter the URL for a repository, ensure that it is a raw URL.
A raw URL is defined as the part of the URL following the domain information and includes the query string, if present. For example, in the URL string http://www.contoso.com/articles/recent.aspx, the raw URL is /articles/recent.aspx.
Paste the file link into your browser's address bar. If the actual code is displayed in the browser, it is considered to be invalid or in an incorrect format. If the file downloads to your system, the macros can process the file and its contents.
Know what is a complete URL. A typical path for the raw file on GitLab looks like:
/projects/:id/repository/files/:file_path/raw- The host address begins with:
https://gitlab.com/api/v4- The complete URL, in this example, looks like:
https://gitlab.com/api/v4/projects/:id/repository/files/:file_path/raw?ref=master- For illustrative purposes, we have used a public Bitbucket public repository. The process for adding a profile and using it in macros remains the same for other repositories and external sources.
There are three ways to work with URLs where you can use:
- An absolute URL in a profile
- A partial URL in a profile
For this example, let's consider using profiles with the HTML macro.
Using an absolute URL in a profile
You can create a profile by providing the complete URL for the HTML/XML content.
Navigate to CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > HTML > Profiles.
Try this for newer Confluence versions
Select
> Manage apps, either search for HTML for Confluence or scroll to Bob Swift Configuration, and click HTML to view app configuration.Click Add Profile.
- Enter a unique name for the profile in the Profile name text box. For this example, enter BitURL in the text box.
- Select URL from the options in Profile type.
Enter https://bitbucket.org/bob_swift/gint/raw/9c1b737cf0ff28ddf7cbbd199685e533d310ce9f/README.html, for example, in the URL text box.
Click Save profile to create the profile.
To use this profile in a Confluence page:
- Add the HTML macro or edit an existing macro on the page.
- Select BitURL from the Profile list and then, click Save.
Using a partial URL in a profile
You can create a profile by providing a partial URL to access the remote location and entering relative path to the relevant file in the HTML macro.
Navigate to CONFLUENCE ADMINISTRATION > Settings > ATLASSIAN MARKETPLACE > HTML > Profiles.
Try this for newer Confluence versions
Select
> Manage apps, either search for HTML for Confluence or scroll to Bob Swift Configuration, and click HTML to view app configuration.Click Add Profile.
- Enter a unique name for the profile in the Profile name text box. For this example, enter BitURL in the text box.
- Select URL from the options in Profile type.
Enter https://bitbucket.org in the URL text box.
Click Save profile to create the profile.
To use this profile in a Confluence page:
- Add the HTML macro or edit an existing macro on the page.
- Select BitURL from the Profile list in the editor.
- Enter the relative path to the /bob_swift/gint/raw/9c1b737cf0ff28ddf7cbbd199685e533d310ce9f/README.html file, for example, in the Location of HTML data parameter.
- Click Save.
This method allows multiple users to access a profile across pages and instances of the macros.
