Warning |
---|
title | Removal notice (applicable for Markdown from a URL macro): |
---|
|
Please note that the URL user and URL user password parameters were removed in 3.8.2 (see Deprecation notice: URL user and URL user password parameters). We recommend using profiles to access external data. |
The Markdown from a URL macro renders Markdown content from URLs or from profiles. Profiles are a means of retrieving data from other external sources such as other applications or even databases.
Note |
---|
Markdown content containing links or images referring to a public location can be accessed and then rendered. Currently, any links or images that refer to a private repository, or a location that must be logged in to, cannot be accessed and thus, rendered. Due to the architecture of Confluence cloud, the cloud app macros cannot access any of the private repositories maintained on Enterprise servers. Pages that refer to such repositories or locations after migration will show errors as the content cannot be accessed.
|
Info |
---|
|
- Only raw URLs must be given in either, the URL field in profiles or the URL to markdown file field, in the macros. 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.
- It is recommended to specify absolute URLs to access files from public locations and to use profiles to access files from private sources. For example, a raw URL that can access a Markdown file in a public Bitbucket repository is valid. But to render a Markdown file located in a private repository, we recommend using a profile.
- Profiles are a means to access and retrieve contents from external applications such as Bitbucket, GitLab or GitHub. A profile already contains the base URL and the required credentials (user credentials or an access token) to access the relevant application.
- This method allows multiple users to access a profile across pages and instances of the macro.
|
Parameters
Macro editor label | Parameter | Default | Macro Browser LabelDescriptionDescription |
---|
Profile | profile | Profile |
| Default parameters provided by the Administrator. Specify a profile to be used with the macro. Administrators set up profiles to connect to other applications such as GitHub or GitLab. Profiles contain a basic set of parameters used to access a remote location such as the type of URL, user credentials, and so on. Some profiles may be restricted. Since 2.0. | url Note |
---|
- Contact your administrator to know more about the profiles used in your instance.
- If a profile is specified, it is recommended to provide the relative path to the location of the Markdown file to be rendered.
|
|
URL to Markdown file | Refers to the URL of the markdown file. | url |
| Enter the relative path to the Markdown file to be displayed. If a valid path is entered here, the macro accesses the given location and processes the Markdown content accordingly.
A profile comprises a base URL and other credentials that are required to access a specific application. These details point to the actual location where the required Markdown file is available. The contents are then accessed and displayed through the macro. Info |
---|
markdown - Markdown files available on apps linked to Confluence, entering the username and password parameters may not be necessary.
accessing the app - rendering the file in the Markdown macro for the first time,
log in - you are asked to authorize the
linked app and click allow when prompted- app via Click to authorize link. For subsequent requests, the app
will work - works seamlessly.
- File permissions
will apply - are applied based on the user profiles and respective levels of access in the linked
App To know more about linking apps with confluence Confluence, refer to Application Linklinks. Since 3.4 |
| userThe - given here with the URL specified in the profile configuration, and accesses the location to render the required Markdown file.
- Lastly, if application link or profile is not specified, the given URL is processed as-is and the required Markdown file is rendered.
|
|
URL user | user |
| Enter the user name for the given URL to access that requires basic authentication. | password | URL password | User password for URL access that requires basic authentication. | timeout | URL connection timeout | Used to increase the wait time for URL access on slow connections. |
encoding | UTF-8 | File encoding | Encoding for an external file if different from the system default handling. |
the required Markdown file.
|
URL password | password |
| Enter the user password for the given URL to access the required Markdown file.
|
URL connection timeout | timeout |
| Enter time in milliseconds such that URL connections does not disconnect before getting data. Use this to increase the access time needed for slow connections. Note that if a zero is given the connection may wait infinitely. |
File encoding | encoding | UTF-8 | Specify the encoding for an external file, if different from default system handling. |
Show URL | showURL | Off | Enable this option to display the absolute path of the Markdown file. The URL given in the URL to markdown file parameter is appended to the URL given in the specified profile to form the absolute path of the required Markdown file. |
Note |
---|
It is mandatory to specify either a profile or a URL for this macro. |
Info |
---|
title | How profiles and URLs are processed in the macro |
---|
|
Depending on the values provided for the Profile and URL to Markdown file parameters, the following process applies: Is Profile given? (Y - Yes, N - No) | Is URL to markdown file given? (Y - Yes, N - No) | Macro behavior |
---|
Y | N | Accesses the URL specified in the profile through the pre-configured information. | N | Y | Accesses the URL specified and renders the Markdown content as required. | Y | Y | Appends the URL mentioned in the URL to Markdown file parameter to the URL configured in the profile. Thus, the macro creates an absolute path to the Markdown file. If this path is not valid, a network error message is displayed. Contact your Confluence administrator to know how you can resolve the issue. |
|
Common parameters
Include Page |
---|
| Common parameters |
---|
| Common parameters |
---|
|
Basic
...
use
This macro can be deployed using one of the following methods:
Selected from the Macro Browsermacro browser | Markdown from a URL |
---|
Markup Shortcutshortcut | {markdown-url} |
---|
Screenshot
...