Vorlage:Phab/Doku

Aus Regiowiki
Zur Navigation springen Zur Suche springen
Dokumentations-Unterseite Diese Seite ist die Dokumentations-Unterseite der Vorlage:Phab.
TemplateData
Abstrahierte Verlinkung mit Quellcodes, Bug-Tickets und anderem im jeweiligen Software-Verwaltungssystem von MediaWiki; zurzeit Phabricator.

Template parameters

ParameterDescriptionTypeStatus
AnchorAnchor
Fragmentnummer des Aufgaben-Kommentars (nur Ziffern)
Numberoptional
BugzillaBugzilla
Bugzilla-Nummer, ggf. mit Fragmentnummer des Kommentars
Lineoptional
ZuweisungEngage
Team, Projekt, Board
Lineoptional
MediendateiFile
File-Nummer (mit oder ohne 'F') – nicht 'file='
Lineoptional
MockupMock
Mock-Nummer (mit oder ohne 'M')
Lineoptional
LinktitelShow
Abweichender Linktitel für Aufgabenmanageent
Lineoptional
Aufgabe (Bug)Task
Task-Nummer (mit oder ohne 'T'), ggf. mit Nummer des Kommentars
Lineoptional
BenutzerUser
Benutzername
Useroptional
branchbranch
Versionsbezeichnung, etwa: 'REL1_20'
Lineoptional
callsignscallsigns
Liste der Phabricator-Shortcuts generieren (1=ausführlich)
Booleanoptional
commitcommit
Übersicht über einen Beitrag anzeigen (40 Zeichen Hexcode [low])
Lineoptional
commitdiffcommitdiff
Versionsunterschied zu einem Beitrag anzeigen (40 Zeichen Hexcode [low])
Lineoptional
diffdiff
Unterschied zur aktuellen Version (HEAD) anzeigen; Angabe der Bezugsversion wie bei branch=
Lineoptional
Pfaddir
Pfad zu einem Verzeichnis
Lineoptional
Pfadfile
Pfad zu einem einzelnen Quellcode – nicht 'File='
Lineoptional
historyhistory
Versionsgeschichte zu Datei, Verzeichnis, Projekt ('1' angeben)
Booleanoptional
Zeilennummerline
Zeilennummer im Quellcode (nur Ziffern)
Numberoptional
Pfadplain
Pfad zu einem einzelnen Text; meist ASCII-Notes wie README
Lineoptional
projectproject
Einzel-Quellcode-Projekt (repository); Vorgabe: mediawiki/core
Lineoptional
Linktiteltitle
Abweichender Linktitel für Quellcodes
Lineoptional

Format: inline

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

{{Phab|}}

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

{{Phab|dir=resources/lib/jquery}}
{{Phab|file=resources/lib/jquery/jquery.cookie.js}}
{{Phab|file=resources/lib/jquery/jquery.cookie.js|history=1}}
{{Phab|commit=c6dfcfc91c8182699b576afbd8b3d3840a329f6d}}
{{Phab|project=SVN|commit=115794}}
{{Phab}}
{{Phab|dir=resources|title=/resources/}}
{{Phab|project=mediawiki/extensions/Scribunto}}
{{Phab|Bugzilla=12345}}
{{Phab|Bugzilla=12345 #1|Show=That thing with 410}}
{{Phab|Engage=MediaWiki-History-or-Diffs}}
{{Phab|Engage=}}
{{Phab|Task=123}}
{{Phab|Task=1156|Anchor=22155|Show=Mattflaschen clarifies}}
{{Phab|User=PerfektesChaos}}

Siehe auch

Abgerufen von „https://regiowiki.at/w/index.php?title=Vorlage:Phab/Doku&oldid=202635“