Vorlage:Phab

[Werkzeuge][Bearbeiten]

Dokumentation

TemplateData

Abstrahierte Verlinkung mit Quellcodes, Bug-Tickets und anderem im jeweiligen Software-Verwaltungssystem von MediaWiki; zurzeit Phabricator.

⧼templatedata-doc-params⧽

⧼templatedata-doc-param-name⧽		⧼templatedata-doc-param-desc⧽	⧼templatedata-doc-param-type⧽	⧼templatedata-doc-param-status⧽
Anchor	Anchor	Fragmentnummer des Aufgaben-Kommentars (nur Ziffern)	⧼templatedata-doc-param-type-number⧽	⧼templatedata-doc-param-status-optional⧽
Bugzilla	Bugzilla	Bugzilla-Nummer, ggf. mit Fragmentnummer des Kommentars	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Zuweisung	Engage	Team, Projekt, Board	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Mediendatei	File	File-Nummer (mit oder ohne 'F') – nicht 'file='	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Mockup	Mock	Mock-Nummer (mit oder ohne 'M')	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Linktitel Aufgabe	Show	Abweichender Linktitel für Aufgabenmanageent	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Aufgabe (Bug)	Task	Task-Nummer (mit oder ohne 'T'), ggf. mit Nummer des Kommentars	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Benutzer	User	Benutzername	⧼templatedata-doc-param-type-wiki-user-name⧽	⧼templatedata-doc-param-status-optional⧽
branch	branch	Versionsbezeichnung, etwa: 'REL1_20'	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
callsigns	callsigns	Liste der Phabricator-Shortcuts generieren (1=ausführlich)	⧼templatedata-doc-param-type-boolean⧽	⧼templatedata-doc-param-status-optional⧽
commit	commit	Übersicht über einen Beitrag anzeigen (40 Zeichen Hexcode [low])	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
commitdiff	commitdiff	Versionsunterschied zu einem Beitrag anzeigen (40 Zeichen Hexcode [low])	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
diff	diff	Unterschied zur aktuellen Version (HEAD) anzeigen; Angabe der Bezugsversion wie bei branch=	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Pfad Verzeichnis	dir	Pfad zu einem Verzeichnis	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Pfad Quellcode	file	Pfad zu einem einzelnen Quellcode – nicht 'File='	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
history	history	Versionsgeschichte zu Datei, Verzeichnis, Projekt ('1' angeben)	⧼templatedata-doc-param-type-boolean⧽	⧼templatedata-doc-param-status-optional⧽
Zeilennummer	line	Zeilennummer im Quellcode (nur Ziffern)	⧼templatedata-doc-param-type-number⧽	⧼templatedata-doc-param-status-optional⧽
Pfad	plain	Pfad zu einem einzelnen Text; meist ASCII-Notes wie README	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
project	project	Einzel-Quellcode-Projekt (repository); Vorgabe: mediawiki/core	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Linktitel Quellcode	title	Abweichender Linktitel für Quellcodes	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽

Format: inline

<templatedata>{"format":"inline","description":"Abstrahierte Verlinkung mit Quellcodes, Bug-Tickets und anderem im jeweiligen Software-Verwaltungssystem von MediaWiki; zurzeit Phabricator.","paramOrder":["Anchor","Bugzilla","Engage","File","Mock","Show","Task","User","branch","callsigns","commit","commitdiff","diff","dir","file","history","line","plain","project","title"],

"params":{ "Anchor":{"type":"number","description":"Fragmentnummer des Aufgaben-Kommentars (nur Ziffern)","required":false},

"Bugzilla":{"type":"line","description":"Bugzilla-Nummer, ggf. mit Fragmentnummer des Kommentars","required":false},

"Engage":{"description":"Team, Projekt, Board","type":"line","required":false,"label":"Zuweisung"},

"File":{"description":"File-Nummer (mit oder ohne 'F') – nicht 'file='","type":"line","required":false,"label":"Mediendatei"},

"Mock":{"description":"Mock-Nummer (mit oder ohne 'M')","type":"line","required":false,"label":"Mockup"},

"Show":{"description":"Abweichender Linktitel für Aufgabenmanageent","type":"line","required":false,"label":"Linktitel Aufgabe"},

"Task":{"description":"Task-Nummer (mit oder ohne 'T'), ggf. mit Nummer des Kommentars","type":"line","required":false,"label":"Aufgabe (Bug)"},

"User":{"description":"Benutzername","type":"wiki-user-name","required":false,"label":"Benutzer"},

"branch":{"type":"line","description":"Versionsbezeichnung, etwa: 'REL1_20'","required":false},

"callsigns":{"type":"boolean","description":"Liste der Phabricator-Shortcuts generieren (1=ausführlich)","required":false},

"commit":{"type":"line","description":"Übersicht über einen Beitrag anzeigen (40 Zeichen Hexcode [low])","required":false},

"commitdiff":{"type":"line","description":"Versionsunterschied zu einem Beitrag anzeigen (40 Zeichen Hexcode [low])","required":false},

"diff":{"type":"line","description":"Unterschied zur aktuellen Version (HEAD) anzeigen; Angabe der Bezugsversion wie bei branch=","required":false},

"dir":{"description":"Pfad zu einem Verzeichnis","type":"line","required":false,"label":"Pfad Verzeichnis"},

"file":{"description":"Pfad zu einem einzelnen Quellcode – nicht 'File='","type":"line","required":false,"label":"Pfad Quellcode"},

"history":{"type":"boolean","description":"Versionsgeschichte zu Datei, Verzeichnis, Projekt ('1' angeben)","required":false},

"line":{"description":"Zeilennummer im Quellcode (nur Ziffern)","type":"number","required":false,"label":"Zeilennummer"},

"plain":{"description":"Pfad zu einem einzelnen Text; meist ASCII-Notes wie README","type":"line","required":false,"label":"Pfad"},

"project":{"type":"line","description":"Einzel-Quellcode-Projekt (repository); Vorgabe: mediawiki/core","required":false},

"title":{"description":"Abweichender Linktitel für Quellcodes","type":"line","required":false,"label":"Linktitel Quellcode"} }

}</templatedata>

Hintergrund

In gewisser Regelmäßigkeit ändert sich bei MediaWiki die Systematik für Verwaltungsangelegenheiten nebst der Verlinkungen. Diese Vorlage wirkt dem entgegen und soll möglichst systemunabhängig agieren, indem das Ziel abstrakt vorgegeben und unter den wechselnden Rahmenbedingungen die jeweilige Verlinkung gebildet wird.

Bei den Bug-Tickets wurde im November 2014 von Bugzilla zu Maniphest@Phabricator migriert.

Für die Quellcodes ist dies zurzeit noch GIT mit mw:Gerrit; ein Wechsel wie 2012 von SVN nach Gerrit und Anfang Juni 2013 nach GIT soll möglichst ohne Veränderung der Parameter erfolgen.

Die Pseudo-Interwikis git: und gerrit: vertragen sich nicht mit Sonderzeichen in den Parametern.

Eine verwandte Vorlage ist {{Tracked}}.

Kopiervorlage

<syntaxhighlight lang="wikitext" copy> </syntaxhighlight>

Parameterstruktur

Alle Parameter sind optional. Management- und Quellcode-Parameter können nicht gemischt werden.

Management (auch Bugs)

Zuletzt Bugzilla. Aktuell Phabricator: „Maniphest“

• Von Bugzilla, File, Mock, Task darf nur eins angegeben sein.

Anchor

Fragmentnummer des Aufgaben-Kommentars (nur Ziffern)

Wie auch immer ermittelt: phab:T1177 phab:T76459

Bugzilla

Bugzilla-Nummer, ggf. mit Fragmentnummer des Kommentars

• Bugzilla=123456
• Bugzilla=123456 #3
• Bugzilla=123456#c3

Engage

Zuweisung, Verknüpfung, Taggen …

… an oder mit: Team, Projekt, Board

File

Nummer einer Mediendatei (mit oder ohne 'F')

Nicht mit file= verwechseln.

Mock

Mock-Nummer (mit oder ohne 'M')

Show

Abweichender Linktitel für Aufgabenmanageent

Task

Task-Nummer (mit oder ohne 'T'), ggf. mit Nummer des Kommentars

User

Benutzername

Countdown

reserviert

Differential

reserviert

Gerrit

reserviert

Join

reserviert

Paste

reserviert

Review

reserviert

Quellcodes und Commits

Quellcodes: SVN, danach GIT. Inzwischen Phabricator: „Diffusion“
Commits: Zuletzt noch Gerrit. Zukünftig Phabricator: „Differential“

• Von branch, commit, commitdiff darf nur eins angegeben sein.
• Von commit, commitdiff, dir, file, plain darf nur eins angegeben sein.

branch

Versionsbezeichnung, etwa: REL1_20

Vorgabe: HEAD (laufende Entwicklung)

Andere Möglichkeiten wären 40 Zeichen Hexcode (low), etwa: c0825f3f13ff3656e5d589e270a42a6f7844c32d

Gerrit bis 6. Juni 2013: hb= (hash base); auch noch bei blobdiff@GIT

callsigns

Liste der Phabricator-Shortcuts generieren

1 – ausführlich

commit

Übersicht über einen Beitrag anzeigen

Parameterwert: Versionsbezeichnung; 40 Zeichen Hexcode (low)

Bei project=SVN auch die bis zu 6 Ziffern lange Gerrit-SVN-Nummer.

commitdiff

Nur Versionsunterschied zu einem Beitrag anzeigen

Parameterwert: Versionsbezeichnung; 40 Zeichen Hexcode (low)

Phabricator: Wirkungsgleich mit commit=, weil dies auch alle Unterschiede enthält

diff

Unterschied zur aktuellen Version (HEAD) anzeigen

Angabe der Bezugsversion wie bei branch=

Nur bei file= sinnvoll und zulässig.

dir

Pfad zu einem Verzeichnis.

Darf nicht zusammen mit file angegeben werden.

Vorgabe: file oder sonst das gesamte Projekt.

Gerrit bis 6. Juni 2013: a=tree

file

Pfad zu einem einzelnen Quellcode.

Darf nicht zusammen mit dir angegeben werden.

Nicht mit File= verwechseln.

Gerrit bis 6. Juni 2013: a=blob

history

Versionsgeschichte zu Datei, Verzeichnis, Projekt

Format: history=1

line

Zeilennummer im Quellcode.

Rein numerische Angabe.

Nur bei file= sinnvoll und zulässig.

plain

Pfad zu einem einzelnen Text; meist ASCII-Notes wie README.

Gerrit bis 6. Juni 2013: a=blob_plain

project

Einzel-Quellcode-Projekt (repository).

Vorgabe: MW (früher mediawiki/core)

• Callsign
• Voller Name eines Phabricator-Repository
• Bis 2014 bereits verwendeter Name eines GIT-Repository

Gerrit bis 6. Juni 2013: p=

Alle Projekte

title

Abweichender Linktitel für Quellcodes.

Beispiele

<syntaxhighlight lang="wikitext"> resources/lib/jquery resources/lib/jquery/jquery.cookie.js history: resources/lib/jquery/jquery.cookie.js rMWc6dfcfc rSVN115794 mediawiki/core/* /resources/ mediawiki/extensions/Scribunto/* phab:T14345 (Bugzilla:12345) That thing with 410 (Bugzilla:12345 #c1) #MediaWiki-History-or-Diffs #MediaWiki-General-or-Unknown phab:T123 Mattflaschen clarifies @PerfektesChaos </syntaxhighlight>

• resources/lib/jquery
• resources/lib/jquery/jquery.cookie.js
• history: resources/lib/jquery/jquery.cookie.js
• rMWc6dfcfc
• rSVN115794
• mediawiki/core/*
• /resources/
• mediawiki/extensions/Scribunto/*
• phab:T14345 (Bugzilla:12345)
• That thing with 410 (Bugzilla:12345 #c1)
• #MediaWiki-History-or-Diffs
• #MediaWiki-General-or-Unknown
• phab:T123
• Mattflaschen clarifies
• @PerfektesChaos

Siehe auch

• Vorlage:Phabricator

Werkzeuge

Bei technischen Fragen zu dieser Vorlage kannst du dich auch an die Vorlagenwerkstatt wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite. Sie können ggf. auch an eine passende Redaktion, Portal usw. gerichtet werden.

• Verwendungen dieser Vorlage
• Cirrus-Suche zu Einbindungen dieser Vorlage (zunächst nur ANR) mit weiteren Möglichkeiten
• Anzahl der Einbindungen
• Liste der Unterseiten.
• Diese Dokumentation befindet sich auf einer eingebundenen Unterseite [Bearbeiten].
• Test-/Beispielseite erstellen.