Referenz:IssueTrackerLinks: Unterschied zwischen den Versionen

Margit Link-Rodrigue (Diskussion | Beiträge)
Keine Bearbeitungszusammenfassung
Markierung: Quelltext-Bearbeitung 2017
Margit Link-Rodrigue (Diskussion | Beiträge)
Keine Bearbeitungszusammenfassung
Zeile 29: Zeile 29:
<code>Github: {id}</code> würde als <code>Github: 6</code> dargestellt.
<code>Github: {id}</code> würde als <code>Github: 6</code> dargestellt.
|-
|-
| style="width:120px;" |<code>Sequenz</code>
| style="width:120px;" |<code>sequence</code>
|Optional -<br /> Wenn Sie bestimmte Sequenzen im VisualEditor automatisch in Tracker-Links konvertieren möchten, geben Sie hier die Maske an. Wenn die Maske beispielsweise als <code>GH{id}</code> definiert ist, wird jede <code>GH123</code>-Sequenz in einen Link zum Tracker mit <code>id=123</code> konvertiert, oder <code>GH:{repo},{id}</code> für <code>GH:example-repo,123</code>, wobei <code>repo=example-repo</code> und <code>id=123</code>. <br />Enthält die URL-Maske mehr Variablen als in der Sequenz vorhanden sind, führt dies zu fehlerhaften Links. Es wird empfohlen, Sequenzen nur für URLs mit einer Variable zu verwenden, z. B. für Vorgangs-IDs. {{Textbox|boxtype=important|header=Important!|text=Sequenzmaske darf keine Kommas zur Trennung der Variablen enthalten.|icon=yes}}
|Optional -<br /> Wenn Sie bestimmte Sequenzen im VisualEditor automatisch in Tracker-Links konvertieren möchten, geben Sie hier die Maske an. Wenn die Maske beispielsweise als <code>GH{id}</code> definiert ist, wird jede <code>GH123</code>-Sequenz in einen Link zum Tracker mit <code>id=123</code> konvertiert, oder <code>GH:{repo},{id}</code> für <code>GH:example-repo,123</code>, wobei <code>repo=example-repo</code> und <code>id=123</code>. <br />Enthält die URL-Maske mehr Variablen als in der Sequenz vorhanden sind, führt dies zu fehlerhaften Links. Es wird empfohlen, Sequenzen nur für URLs mit einer Variable zu verwenden, z. B. für Vorgangs-IDs. {{Textbox|boxtype=important|header=Important!|text=Die sequence-Maske darf keine Kommas zur Trennung der Variablen enthalten.|icon=yes}}
|}
|}
=== Beispiel für eine JSON-Konfiguration ===
=== Beispiel für eine JSON-Konfiguration ===
Standardmäßig sind GitHub-, GitLab- und Jira-Vorgänge vorkonfiguriert und können bei Bedarf angepasst werden. Weitere Ticketsysteme können hinzugefügt werden, z. B. Links zu EasyRedmine (ERM). Bitte beachten Sie, dass der Label-Parameter für die vorkonfigurierten Ticketsysteme zur Unterstützung der Benutzersprache als [[mediawikiwiki:Help:System_message#Message_sources|Systemnachrichten]] definiert ist. Systemnachrichten werden nur in mehrsprachigen Wiki-Instanzen benötigt:
Standardmäßig sind GitHub-, GitLab- und Jira-Vorgänge vorkonfiguriert und können bei Bedarf angepasst werden. Weitere Ticketsysteme können hinzugefügt werden, z. B. Links zu EasyRedmine (ERM). Bitte beachten Sie, dass der Label-Parameter für die vorkonfigurierten Ticketsysteme zur Unterstützung der Benutzersprache als [[mediawikiwiki:Help:System_message#Message_sources|Systemnachrichten]] definiert ist. Systemnachrichten werden nur in mehrsprachigen Wiki-Instanzen benötigt:

Version vom 20. Oktober 2025, 14:49 Uhr

alle Erweiterungen

Übersicht
Beschreibung:

Links for issue trackers

Status: stable Lizenz: GPL-3.0-only
Entwickler: Hallo Welt! Distribution: BlueSpice
Kategorie: Rich Articles Edition: BlueSpice pro, BlueSpice farm, BlueSpice cloud 5.2+

Technische Information[Bearbeiten | Quelltext bearbeiten]

Voraussetzungen[Bearbeiten | Quelltext bearbeiten]

  • MediaWiki: 1.43.0
  • VisualEditorPlus: *

Integriert in[Bearbeiten | Quelltext bearbeiten]

  • BlueSpiceSMWConnector
  • ContentDroplets
  • VisualEditor

Hooks[Bearbeiten | Quelltext bearbeiten]



Konfiguration[Bearbeiten | Quelltext bearbeiten]

Ein Wiki-Administrator muss festlegen, welche Issue-Links im Wiki verfolgt werden. Dies geschieht auf der Seite MediaWiki:IssueTrackerLinksConfig.json. Diese Seite ist bereits mit gängigen Issue-Trackern vorbelegt.

Die Konfiguration ist ein JSON-Objekt, wobei key eine eindeutige ID für den Tracker und value ein Objekt mit den folgenden Eigenschaften ist:

Eigenschaft Beschreibung
url obligatorisch - URL-Muster für die Tracker-Links. Alle variablen Teile können durch eine Variable ersetzt werden (z. B. {repo}, {id},...) "https://github.com/{owner}/{repo}/issues/{id}"
label optional -
Nachrichtenschlüssel oder String-Nachricht, die als Bezeichnung für diesen Tracker-Typ verwendet werden soll.
display-mask optional -
Wie dieser Tracker-Link auf der Seite dargestellt werden soll. Beispiel:

Github: {id} würde als Github: 6 dargestellt.

sequence Optional -
Wenn Sie bestimmte Sequenzen im VisualEditor automatisch in Tracker-Links konvertieren möchten, geben Sie hier die Maske an. Wenn die Maske beispielsweise als GH{id} definiert ist, wird jede GH123-Sequenz in einen Link zum Tracker mit id=123 konvertiert, oder GH:{repo},{id} für GH:example-repo,123, wobei repo=example-repo und id=123.
Enthält die URL-Maske mehr Variablen als in der Sequenz vorhanden sind, führt dies zu fehlerhaften Links. Es wird empfohlen, Sequenzen nur für URLs mit einer Variable zu verwenden, z. B. für Vorgangs-IDs.
Important!

Die sequence-Maske darf keine Kommas zur Trennung der Variablen enthalten.

Beispiel für eine JSON-Konfiguration[Bearbeiten | Quelltext bearbeiten]

Standardmäßig sind GitHub-, GitLab- und Jira-Vorgänge vorkonfiguriert und können bei Bedarf angepasst werden. Weitere Ticketsysteme können hinzugefügt werden, z. B. Links zu EasyRedmine (ERM). Bitte beachten Sie, dass der Label-Parameter für die vorkonfigurierten Ticketsysteme zur Unterstützung der Benutzersprache als Systemnachrichten definiert ist. Systemnachrichten werden nur in mehrsprachigen Wiki-Instanzen benötigt:


PDF-Ausschluss - Start

Feedback zur Dokumentation ist im Community-Forum möglich.

PDF-Ausschluss - Ende