Difference between revisions 585538 and 585541 on mediawikiwiki

< previous diff
next diff >
Template:Git file/doc
<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
(contracted; show full)
; 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. Also action=tree (gerrit/gitweb should be smart enough to infer this)... ''TODO: what are the other values?''
; line

;: optional. line=42 will add a fragment that jumps to line 42o the URL that positions the browser at line 42 of the file.

== Issues ==
* 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''/...
* TODO: add branch= parameter
* TODO: add line='nnn' parameter (for #l1427 fragment identifier)⏎
* '''TODO''': Merge with {{tl|Git}}, or maybe {{tl|Gerrit}}, {{tl|MW file}}, etc. but simpler.

== See also ==
* this replaces Template:GitwebFile that had almost exactly the same functionality (but undocumented and uncategorized so spage missed it)
* {{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>