Difference between revisions 563803 and 563810 on mediawikiwiki

<noinclude>{{Documentation subpage}}
{{timw|{{BASEPAGENAME}}}}
</noinclude>
<!-- PUT HERE THE DOCUMENTATION -->
This generates a link to a file on [[Gerrit]].

The goal is to avoid ugly URLs like
  https://gerrit.wikimedia.org/r/gitweb?p=mediawiki/extensions/examples.git;f=BoilerPlate/README;hb=HEAD
and also future-proof (ha ha) these links against changes and evolution to source code control.

== Usage ==
 <nowiki>{{git_file</nowiki> |project=mediawiki/extensions/''examples'' |file=''BoilerPlate/README'' }}
produces
:{{git_file |project=mediawiki/extensions/examples |file=BoilerPlate/README }}

 <nowiki>{{git_file</nowiki> |project=mediawiki/extensions/ArticleFeedback 
 |file=modules/jquery.articleFeedback/images/star-new-down.png
 |text=star image | action=blob_plain }}
produces
{{git_file |project=mediawiki/extensions/ArticleFeedback 
 |file=modules/jquery.articleFeedback/images/star-new-down.png
 |text=star image |action=blob_plain}}

=== Parameters ===⏎
; project
: mandatory. Must be entire path to project &mdash; always (?) mediawiki/ , usually extensions, then your project &mdash; but not the <tt>.git</tt>
; file
: mandatory. The file within the project.  If you just want to link to the project, use {{tl|gitweb}}. Note this template can be invoked as {{tl|git file}} but to avoid confusion you may want to stick with <nowiki>{{git_file | file=</nowiki>''name''}}.
; text
: optional. The text that's linked.  If not specified, defaults to file.
; action
: optional. You can give a gerrit action, e.g. action=blob_raw, ''TODO: what are they?''

=== Futur Issues: ===
 <nowiki>{{git file</nowiki |project=mediawiki/extensions/examples |file=BoilerPlateREADME
 |branch=xyz |action=blob_raw}}</nowiki>
producing
:{{git file |project=mediawiki/extensions/examples |file=BoilerPlate/README |branch=xyz |format=blob_raw}}

=== Issues ===
* every gerrit project is under mediawiki/ and most under extensions, so maybe one or both is redundant?⏎
* every gerrit project is under mediawiki/ and most under extensions, so maybe one or both is redundant?
* why does the semicolon in the <nowiki>{{#if: TEST|;need that semicolon|}}</nowiki> test introduce whitespace?  (Workaround is to use HTML entity &amp;#59; )
* action= is gerrit-specific, maybe abstract away from gerrit to format=raw/''mimetype''/...
* add branch= parameter⏎
* '''TODO''': Merge with {{tl|Git}}, or maybe {{tl|Gerrit}}, {{tl|MW file}}, etc. but simpler. 
== See also ==
* {{tl|MW file}} generates complicated link to file, used by [[Manual]]
* lots of other fancy templates for extensions on gerrit, see [[:Category:Git]]
<includeonly>
<!-- PUT HERE THE CATEGORIES OF THE TEMPLATE -->
[[Category:Git]]
</includeonly>