Quelltext der Seite Vorlage:Phab/Doku

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
{{TemplateData|JSON=
{ "description": "Abstrahierte Verlinkung mit Quellcodes, Bug-Tickets und anderem im jeweiligen Software-Verwaltungssystem von [[MediaWiki]]; zurzeit [[Wikipedia:Technik/Phabricator|Phabricator]].",
  "params":
    { "Anchor":     { "description": "Fragmentnummer des Aufgaben-Kommentars (nur Ziffern)",
                      "type":        "number",
                      "required":    false
                    },
      "Bugzilla":   { "description": "Bugzilla-Nummer, ggf. mit Fragmentnummer des Kommentars",
                      "type":        "line",
                      "required":    false
                    },
      "Engage":     { "label":       "Zuweisung",
                      "description": "Team, Projekt, Board",
                      "type":        "line",
                      "required":    false
                    },
      "File":       { "label":       "Mediendatei",
                      "description": "File-Nummer (mit oder ohne 'F') – nicht 'file='",
                      "type":        "line",
                      "required":    false
                    },
      "Mock":       { "label":       "Mockup",
                      "description": "Mock-Nummer (mit oder ohne 'M')",
                      "type":        "line",
                      "required":    false
                    },
      "Show":       { "label":       "Linktitel",
                      "description": "Abweichender Linktitel für Aufgabenmanageent",
                      "type":        "line",
                      "required":    false
                    },
      "Task":       { "label":       "Aufgabe (Bug)",
                      "description": "Task-Nummer (mit oder ohne 'T'), ggf. mit Nummer des Kommentars",
                      "type":        "line",
                      "required":    false
                    },
      "User":       { "label":       "Benutzer",
                      "description": "Benutzername",
                      "type":        "wiki-user-name",
                      "required":    false
                    },
      "branch":     { "description": "Versionsbezeichnung, etwa: 'REL1_20'",
                      "type":        "line",
                      "required":    false
                    },
      "callsigns":  { "description": "Liste der Phabricator-Shortcuts generieren (1=ausführlich)",
                      "type":        "boolean",
                      "required":    false
                    },
      "commit":     { "description": "Übersicht über einen Beitrag anzeigen (40 Zeichen Hexcode [low])",
                      "type":        "line",
                      "required":    false
                    },
      "commitdiff": { "description": "Versionsunterschied zu einem Beitrag anzeigen (40 Zeichen Hexcode [low])",
                      "type":        "line",
                      "required":    false
                    },
      "diff":       { "description": "Unterschied zur aktuellen Version (HEAD) anzeigen; Angabe der Bezugsversion wie bei branch=",
                      "type":        "line",
                      "required":    false
                    },
      "dir":        { "label":       "Pfad",
                      "description": "Pfad zu einem Verzeichnis",
                      "type":        "line",
                      "required":    false
                    },
      "file":       { "label":       "Pfad",
                      "description": "Pfad zu einem einzelnen Quellcode – nicht 'File='",
                      "type":        "line",
                      "required":    false
                    },
      "history":    { "description": "Versionsgeschichte zu Datei, Verzeichnis, Projekt ('1' angeben)",
                      "type":        "boolean",
                      "required":    false
                    },
      "line":       { "label":       "Zeilennummer",
                      "description": "Zeilennummer im Quellcode (nur Ziffern)",
                      "type":        "number",
                      "required":    false
                    },
      "plain":      { "label":       "Pfad",
                      "description": "Pfad zu einem einzelnen Text; meist ASCII-Notes wie README",
                      "type":        "line",
                      "required":    false
                    },
      "project":    { "description": "Einzel-Quellcode-Projekt (repository); Vorgabe: mediawiki/core",
                      "type":        "line",
                      "required":    false
                    },
      "title":      { "label":       "Linktitel",
                      "description": "Abweichender Linktitel für Quellcodes",
                      "type":        "line",
                      "required":    false
                    }
  },
  "format": "inline"
}
|TOC=1}}

== 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 [[Apache Subversion|SVN]] nach [[Gerrit (Software)|Gerrit]] und Anfang Juni 2013 nach GIT soll möglichst ohne Veränderung der Parameter erfolgen.

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

Eine verwandte Vorlage ist {{Vorlage|Tracked}}.

== Kopiervorlage ==

<pre>
{{Phab|}}
</pre>

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

=== Management (auch Bugs) ===
''Zuletzt Bugzilla. Aktuell Phabricator: „Maniphest“''
* Von <code>Bugzilla</code>, <code>File</code>, <code>Mock</code>, <code>Task</code> darf nur eins angegeben sein.
; Anchor
: Fragmentnummer des Aufgaben-Kommentars (nur Ziffern)
: Wie auch immer ermittelt: {{Phab|Task=1177}} {{Phab|Task=76459}}
; Bugzilla   {{Anker|Bugzilla}}
: Bugzilla-Nummer, ggf. mit Fragmentnummer des Kommentars
:* <code>Bugzilla=123456</code>
:* <code>Bugzilla=123456 #3</code>
:* <code>Bugzilla=123456#c3</code>
; Engage   {{Anker|Engage}}
: Zuweisung, Verknüpfung, Taggen …
: … an oder mit: Team, Projekt, Board
; File   {{Anker|File}}
: Nummer einer Mediendatei (mit oder ohne 'F')
: Nicht mit [[#file|<code>file=</code>]] verwechseln.
; Mock   {{Anker|Mock}}
: Mock-Nummer (mit oder ohne 'M')
; Show   {{Anker|Show}}
: Abweichender Linktitel für Aufgabenmanageent
; Task   {{Anker|Task}}
: Task-Nummer (mit oder ohne 'T'), ggf. mit Nummer des Kommentars
; User   {{Anker|User}}
: Benutzername
; <s>Countdown</s>
: ''reserviert''
; <s>Differential</s>
: ''reserviert''
; <s>Gerrit</s>
: ''reserviert''
; <s>Join</s>
: ''reserviert''
; <s>Paste</s>
: ''reserviert''
; <s>Review</s>
: ''reserviert''

=== Quellcodes und Commits ===
''Quellcodes: SVN, danach GIT. Inzwischen Phabricator: „Diffusion“''<br />
''Commits: Zuletzt noch Gerrit. Zukünftig Phabricator: „Differential“''
* Von <code>branch</code>, <code>commit</code>, <code>commitdiff</code> darf nur eins angegeben sein.
* Von <code>commit</code>, <code>commitdiff</code>, <code>dir</code>, <code>file</code>, <code>plain</code> darf nur eins angegeben sein.
; branch
: Versionsbezeichnung, etwa: <code>REL1_20</code>
: Vorgabe: <code>HEAD</code> (laufende Entwicklung)
: Andere Möglichkeiten wären 40 Zeichen Hexcode (low), etwa: <code>c0825f3f13ff3656e5d589e270a42a6f7844c32d</code>
: <small>Gerrit bis 6. Juni 2013: ''hb='' (hash base); auch noch bei blobdiff@GIT</small>
; callsigns   {{Anker|callsigns}}
: Liste der Phabricator-Shortcuts generieren
: <code>1</code> – ausführlich
; commit
: Übersicht über einen Beitrag anzeigen
: Parameterwert: Versionsbezeichnung; 40 Zeichen Hexcode (low)
: Bei <code>project=SVN</code> 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 <code>commit=</code>, weil dies auch alle Unterschiede enthält
; diff
: Unterschied zur aktuellen Version (HEAD) anzeigen
: Angabe der Bezugsversion wie bei <code>branch=</code>
: Nur bei <code>file=</code> sinnvoll und zulässig.
; dir
: Pfad zu einem Verzeichnis.
: Darf nicht zusammen mit <code>file</code> angegeben werden.
: Vorgabe: <code>file</code> oder sonst das gesamte Projekt.
: <small>Gerrit bis 6. Juni 2013: ''a=tree''</small>
; file   {{Anker|file}}
: Pfad zu einem einzelnen Quellcode.
: Darf nicht zusammen mit <code>dir</code> angegeben werden.
: Nicht mit <code>[[#File|File=]]</code> verwechseln.
: <small>Gerrit bis 6. Juni 2013: ''a=blob''</small>
; history
: Versionsgeschichte zu Datei, Verzeichnis, Projekt
: Format: <code>history=1</code>
; line
: Zeilennummer im Quellcode.
: Rein numerische Angabe.
: Nur bei <code>file=</code> sinnvoll und zulässig.
; plain
: Pfad zu einem einzelnen Text; meist ASCII-Notes wie README.
: <small>Gerrit bis 6. Juni 2013: ''a=blob_plain''</small>
; project
: Einzel-Quellcode-Projekt ''(repository)''.
: Vorgabe: <code>MW</code> (früher <code>mediawiki/core</code>)
:* [[Wikipedia:Technik/Phabricator/Callsigns|Callsign]]
:* Voller Name eines Phabricator-Repository
:* Bis 2014 bereits verwendeter Name eines GIT-Repository
: <small>Gerrit bis 6. Juni 2013: ''p=''</small>
: [https://git.wikimedia.org/repositories/ Alle Projekte]
; title   {{Anker|title}}
: Abweichender Linktitel für Quellcodes.
<!--
a=action
f=file
h=hash
hb=hash base
p=project
-->

== Beispiele ==

<pre style="white-space:pre-wrap;">
{{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}}
</pre>
* {{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 ==
* [[Vorlage:Phabricator]]
<includeonly>
{{Lua-Vorlage|Vorlage:Phab #f}}

[[Kategorie:Vorlage:Linkhilfe]]
</includeonly>