Manual:Extension/IssueTrackerLinks: Difference between revisions

Latest revision as of 10:34, 18 November 2025

The IssueTrackerLinks extension handles the rendering of links to external issue tracker applications, such as GitHub, GitLab, Jira, or EasyRedmine. Administrators can define which applications are available as issue tracker links.

How it works

For example, an administrator has configured issue tracking for GitHub:

{
	"github": {
		"url": "https://github.com/{owner}/{repo}/issues/{id}",
		"label": "issuetrackerlinks-type-label-github",
		"icon": "github",
		"display-mask": "{owner}/{repo}#{id}"
	}
}

Copy and paste

With the above configuration, you can now paste the following link in a wiki page:

https://github.com/wikimedia/edx-platform/issues/553

The URL label will be visually formatted as an issue tracker url with the text string of the display-mask parameter that is defined for GitHub in your wiki.

GitHub issue tracker link

Shortcut sequence

It is possible that Administrators define a shortcut ("sequence"). By default, GitHub issue links do not have a shortcut sequence defined, because it is not really time-saving to manually string the necessary values for the three variables owner, repo, and id together. But an administrator could define a shortcut sequence like:

GH-{owner}-{repo}-{id}

Then, the above link could be created by manually entering the following string, followed by a space:

GH-wikimedia-edxplatform-553

Keyboard shortcuts are mainly useful if an issue tracker requires only one variable.

Content droplet

Some issue links can be entered as Content droplet:

GitHub issue link
GitLab issue link
Jira

Note: Content droplets only accept the full URL path of the issue tracker link.

Technical Reference: IssueTrackerLinks

PDF exclude - start

To submit feedback about this documentation, visit our community forum.

PDF exclude - end

@@ Line 1: / Line 1: @@
-The '''External Content''' extension allows for embedding external content, such as markdown files, in your wiki pages. The standard configuration allows embedding links from GitHub and Bitbucket.
+The '''IssueTrackerLinks''' extension handles the rendering of links to external issue tracker applications, such as GitHub, GitLab, Jira, or EasyRedmine. Administrators can [[Reference:IssueTrackerLinks|define which applications are available]] as issue tracker links.
+== How it works ==
-== Embedding external content ==
+For example, an administrator has [[Reference:IssueTrackerLinks|configured issue tracking for GitHub]]:<syntaxhighlight lang="json">
+{
+	"github": {
+		"url": "https://github.com/{owner}/{repo}/issues/{id}",
+		"label": "issuetrackerlinks-type-label-github",
+		"icon": "github",
+		"display-mask": "{owner}/{repo}#{id}"
+	}
+}
+</syntaxhighlight>
 === Copy and paste ===
-In visual editing mode, you can simply copy the url to your clipboard and paste it into the wiki page in visual editing mode. The visual editor will automatically convert the url to an embedded view of the actual external content.
+With the above configuration, you can now paste the following link in a wiki page: <syntaxhighlight lang="text">https://github.com/wikimedia/edx-platform/issues/553</syntaxhighlight>The URL label will be visually formatted as an issue tracker url with the text string of the display-mask parameter that is defined for GitHub in your wiki.
-[[File:external template copy and paste.png|alt=Open menu for adding link parameters|center|thumb|650x650px|Pasting a github url directly into the visual editor.]]
+[[File:IssueTrackerLinks github display.png|alt=Formatted shortened link label for a GitHub issue|center|thumb|GitHub issue tracker  link]]
-If you want to post a link to the external page instead, you need to paste the url into the "Insert link" menu.  After adding the link you can add a label, since external links that are created with the "insert link" menu do not automatically show the full url or a link label.
+=== Shortcut sequence ===
-[[File:external content github link.png|alt="Insert link" menu with link to github content|center|thumb|750x750px|Link to github content]]
+It is possible that Administrators define a shortcut ("[[Reference:IssueTrackerLinks|sequence]]"). By default, GitHub issue links do not have a shortcut sequence defined, because it is not really time-saving to manually string the necessary values for the three variables  <code>owner</code>, <code>repo</code>, and <code>id</code> together. But an administrator could define a shortcut sequence like:<syntaxhighlight lang="text">
+GH-{owner}-{repo}-{id}
+</syntaxhighlight>Then, the above link could be created by manually entering the following string, followed by a space:<syntaxhighlight lang="text">
+GH-wikimedia-edxplatform-553
+</syntaxhighlight>Keyboard shortcuts are mainly useful if an issue tracker requires only one variable.
 == Content droplet ==
-To embed a GitHub or Bitbucket link, you can also select the related Content droplet:
+Some issue links can be entered as [[Manual:Extension/ContentDroplets|Content droplet]]:
-* External content (for GitHub)
+* GitHub issue link
-* Bitbucket file
+* GitLab issue link
+* Jira
+{{Textbox|boxtype=note|header=Note:|text=Content droplets only accept the full URL path of the issue tracker link.|icon=yes}}
 [[Category:Content]]