Handbuch:Erweiterung/IssueTrackerLinks: Unterschied zwischen den Versionen

Version vom 11. November 2025, 12:34 Uhr

Die Erweiterung IssueTrackerLink sorgt für die einfache Verlinkung zu externen Issue-Tracking-Anwendungen wie GitHub, GitLab, Jira oder EasyRedmine. Administratoren können definieren, welche Anwendungen als Issue-Tracker-Links verfügbar sind.

Funktionsweise[Bearbeiten | Quelltext bearbeiten]

Beispiel: Ein Administrator hat den Issue-Tracker für GitHub konfiguriert:

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

Kopieren und Einfügen[Bearbeiten | Quelltext bearbeiten]

Mit der oben aufgeführten Konfiguration können Sie nun den folgenden Link in eine Wiki-Seite einfügen:

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

Die URL-Bezeichnung wird visuell als Problemverfolgungs-URL mit dem Textstring des Parameters "display-mask" formatiert, der für GitHub definiert ist.

GitHub Issue-Tracker

Kurzbefehl-Sequenz[Bearbeiten | Quelltext bearbeiten]

Es ist Administratoren möglich, einen Kurzbefehl ("sequence") zu definieren.

Standardmäßig ist für GitHub Issue-Links keine Kurzbefehl-Sequenz definiert, da es nicht wirklich zeitsparend ist, die erforderlichen Werte für die drei Variablen owner, repo und id manuell zu verknüpfen. Ein Administrator könnte eine Tastenkombination wie folgt definieren:

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

Der obige Link kann dann manuell erstellt werden, indem die folgende Zeichenkette gefolgt von einem Leerzeichen eingegeben wird:

GH-wikimedia-edxplatform-553

Es ist empfohlen, Kurzbefehle nur anzubieten, wenn ein Issue-Tracker nur eine Variable benötigt.

Content-Droplet[Bearbeiten | Quelltext bearbeiten]

Einige Issue-Links können wie folgt eingegeben werden: Content-Droplet:

GitHub-Issue-Link
GitLab-Issue-Link
Jira

Hinweis:

Content-Droplets akzeptieren nur den vollständigen URL-Pfad des Issue-Tracker-Links.

Technische Referenz: IssueTrackerLinks

@@ Zeile 24: / Zeile 24: @@
 Es ist  Administratoren möglich, einen Kurzbefehl ("[[Reference:IssueTrackerLinks|sequence]]") zu definieren.
-Standardmäßig ist für GitHub Issue-Links keine Kurzbefehl-Sequenz definiert, da es nicht wirklich zeitsparend ist, die erforderlichen Werte für die drei Variablen <code>owner</code>, <code>repo</code> und <code>id</code> manuell zu verknüpfen. Ein Administrator könnte eine Tastenkombination wie folgt definieren: <syntaxhighlight lang="json">
+Standardmäßig ist für GitHub Issue-Links keine Kurzbefehl-Sequenz definiert, da es nicht wirklich zeitsparend ist, die erforderlichen Werte für die drei Variablen <code>owner</code>, <code>repo</code> und <code>id</code> manuell zu verknüpfen. Ein Administrator könnte eine Tastenkombination wie folgt definieren: <syntaxhighlight lang="text">GH-{owner}-{repo}-{id}</syntaxhighlight> Der obige Link kann dann manuell erstellt werden, indem die folgende Zeichenkette gefolgt von einem Leerzeichen eingegeben wird: <syntaxhighlight lang="text">
-GH-{owner}-{repo}-{id}
-</syntaxhighlight> Der obige Link kann dann manuell erstellt werden, indem die folgende Zeichenkette gefolgt von einem Leerzeichen eingegeben wird: <syntaxhighlight lang="text">
 GH-wikimedia-edxplatform-553
 </syntaxhighlight>Es ist empfohlen,  Kurzbefehle nur anzubieten, wenn ein Issue-Tracker nur eine Variable benötigt.