Handbuch:Erweiterung/IssueTrackerLinks: Unterschied zwischen den Versionen

KKeine Bearbeitungszusammenfassung
Margit Link-Rodrigue (Diskussion | Beiträge)
Keine Bearbeitungszusammenfassung
Markierung: Quelltext-Bearbeitung 2017
 
(4 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
{{BSVersion|bsvFrom=5.2|bsvFeature=IssueTrackerLinks|info=}}
Die Erweiterung ''IssueTrackerLink'' sorgt für die einfache Verlinkung zu externen Issue-Tracking-Anwendungen wie GitHub, GitLab, Jira oder EasyRedmine. Administratoren können [[Referenz:IssueTrackerLinks|definieren, welche Anwendungen als Issue-Tracker-Links verfügbar sind]].
Die Erweiterung ''IssueTrackerLink'' sorgt für die einfache Verlinkung zu externen Issue-Tracking-Anwendungen wie GitHub, GitLab, Jira oder EasyRedmine. Administratoren können [[Referenz:IssueTrackerLinks|definieren, welche Anwendungen als Issue-Tracker-Links verfügbar sind]].




== Funktionsweise ==
== Funktionsweise ==
Beispiel: Ein Administrator hat den [[Reference:IssueTrackerLinks|Issue-Tracker für GitHub]] konfiguriert: <syntaxhighlight lang="json">
Beispiel: Ein Administrator hat den [[Referenz:IssueTrackerLinks|Issue-Tracker für GitHub]] konfiguriert: <syntaxhighlight lang="json">
{
{
     "github": {
     "github": {
Zeile 22: Zeile 23:
=== Kurzbefehl-Sequenz ===
=== Kurzbefehl-Sequenz ===


Es ist  Administratoren möglich, einen Kurzbefehl ("[[Reference:IssueTrackerLinks|sequence]]") zu definieren.  
Es ist  Administratoren möglich, einen Kurzbefehl ("[[Referenz: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="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">
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">
Zeile 29: Zeile 30:


== Content-Droplet ==
== Content-Droplet ==
Einige Issue-Links können wie folgt eingegeben werden: [[Manual:Extension/ContentDroplets|Content-Droplet]]:
Einige Issue-Links können wie folgt eingegeben werden: [[Handbuch:Erweiterung/ContentDroplets|Content-Droplet]]:


* GitHub-Issue-Link
* GitHub-Issue-Link
Zeile 35: Zeile 36:
* Jira
* Jira
{{Textbox|boxtype=note|header=Hinweis:|text=Content-Droplets akzeptieren nur den vollständigen URL-Pfad des Issue-Tracker-Links.|icon=yes}}
{{Textbox|boxtype=note|header=Hinweis:|text=Content-Droplets akzeptieren nur den vollständigen URL-Pfad des Issue-Tracker-Links.|icon=yes}}
[[Category:Content]]

Aktuelle Version vom 21. November 2025, 12:35 Uhr

IssueTrackerLinks ist ab BlueSpice 5.2 enthalten.

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.

Formatierte Kurzlink-Bezeichnung für ein GitHub-Issue
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.