Difference between revisions of "Template:GithubDownload"

From RobotX
Jump to navigation Jump to search
m (Text replacement - "</translate>" to "")
m (Text replacement - "<tvar|1>" to "")
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
<div class="plainlinks" style="white-space: nowrap;">
 
<div class="plainlinks" style="white-space: nowrap;">
 
{{#if:{{{snapshot|}}}|
 
{{#if:{{{snapshot|}}}|
[https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/downloads '''<!--T:1--> Download snapshot'''] {{#if:{{{mastertarball|}}}| ([https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/tarball/master <!--T:2--> Git master]) }}<br />
+
[https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/downloads ''' Download snapshot'''] {{#if:{{{mastertarball|}}}| ([https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/tarball/master Git master]) }}<br />
 
|{{#if:{{{mastertarball|}}}|
 
|{{#if:{{{mastertarball|}}}|
[https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/tarball/master '''<!--T:3--> Download master snapshot''']<br />
+
[https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/tarball/master ''' Download master snapshot''']<br />
 
|{{#if:{{{release|}}}|
 
|{{#if:{{{release|}}}|
[https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/releases{{#ifeq:{{{release}}}|1||/{{{release}}}}} '''<!--T:16--> Download release''']<br />
+
[https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/releases{{#ifeq:{{{release}}}|1||/{{{release}}}}} ''' Download release''']<br />
 
}}}}}}
 
}}}}}}
 
GitHub:
 
GitHub:
* [https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/ <!--T:4--> project page]
+
* [https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/ project page]
* [https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}.git <!--T:5--> git repository URL] <sup>[<span></span>[[Special:MyLanguage/Gerrit|<!--T:6--> help]]]</sup>
+
* [https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}.git git repository URL] <sup>[<span></span>[[Special:MyLanguage/Gerrit| help]]]</sup>
* [https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/commits/ <!--T:7--> commit history]<br />
+
* [https://github.com/{{{1|{{{user|}}}}}}/{{{2|{{PAGENAMEE}}}}}/commits/ commit history]<br />
{{#if:{{{translatewiki|}}}||<small>''<!--T:8--> Note:<br /><!--T:9--> No [[<tvar|1>Special:MyLanguage/Localisation#Translation resources</>|localisation]] updates are<br />provided by <tvar|twn>{{ll|translatewiki.net|translatewiki.net}}</>.''</small>}}
+
{{#if:{{{translatewiki|}}}||<small>'' Note:<br /> No [[Special:MyLanguage/Localisation#Translation resources|localisation]] updates are<br />provided by <tvar|twn>{{ll|translatewiki.net|translatewiki.net}}.''</small>}}
 
</div><includeonly>[[Category:Extensions in GitHub version control{{#translation:}}]]</includeonly>
 
</div><includeonly>[[Category:Extensions in GitHub version control{{#translation:}}]]</includeonly>
 
| #default=
 
| #default=
Line 23: Line 23:
  
  
=== Usage === <!--T:10-->
+
=== Usage ===  
 +
 
  
<!--T:11-->
 
 
Transclude the template inside an Extension article to create [[w:GitHub|GitHub]] [[Git]] links.
 
Transclude the template inside an Extension article to create [[w:GitHub|GitHub]] [[Git]] links.
  
<!--T:12-->
 
It is specifically designed to provide links for the download argument used in <tvar|1>{{ll|Template:Extension}}</> and categorizes into <tvar|2>{{ll|Category:Extensions in GitHub version control}}</>.
 
  
<!--T:13-->
+
It is specifically designed to provide links for the download argument used in {{ll|Template:Extension}} and categorizes into {{ll|Category:Extensions in GitHub version control}}.
 +
 
 +
 
 
This template takes two unnamed parameters to form the links, these are:
 
This template takes two unnamed parameters to form the links, these are:
  
* <code>1</code> <!--T:17--> (also as: <code>user</code>): To form the username holding the repository
+
* <code>1</code> (also as: <code>user</code>): To form the username holding the repository
* <code>2</code>: <!--T:18--> to calculate the name of the repository holding the project, This defaults to the pagename that the extension is on
+
* <code>2</code>: to calculate the name of the repository holding the project, This defaults to the pagename that the extension is on
 +
 
  
  
<!--T:19-->
 
 
*Note: '''Spaces must be padded with '_' underscores'''.
 
*Note: '''Spaces must be padded with '_' underscores'''.
  
  
<!--T:20-->
+
 
 
; Snapshots
 
; Snapshots
  
<!--T:21-->
+
 
 
: (Activate by using <nowiki>|<option></nowiki>=1)
 
: (Activate by using <nowiki>|<option></nowiki>=1)
  
<!--T:22-->
+
 
 
* <code>snapshot</code>: Displays a link to your downloads page if you have added any.
 
* <code>snapshot</code>: Displays a link to your downloads page if you have added any.
  
<!--T:23-->
+
 
 
* <code>mastertarball</code>: Displays a download link to a tarball of your <code>master</code> branch.
 
* <code>mastertarball</code>: Displays a download link to a tarball of your <code>master</code> branch.
  
<!--T:24-->
+
 
 
* <code>release</code>: Displays a download link to the list of releases. If the value is <code>latest</code>, it will point to the latest release.
 
* <code>release</code>: Displays a download link to the list of releases. If the value is <code>latest</code>, it will point to the latest release.
  
  
==== Usage example ==== <!--T:14-->
+
==== Usage example ====  
  
 
<code><nowiki>{{GithubDownload|<Repository Username>|<Repository Name>}}</nowiki></code>
 
<code><nowiki>{{GithubDownload|<Repository Username>|<Repository Name>}}</nowiki></code>
  
<!--T:25-->
+
 
 
An example with [https://github.com/torvalds/linux Linus Torvalds's linux repository]: (<code><nowiki>{{GithubDownload|torvalds|linux}}</nowiki></code>)
 
An example with [https://github.com/torvalds/linux Linus Torvalds's linux repository]: (<code><nowiki>{{GithubDownload|torvalds|linux}}</nowiki></code>)
  
Line 68: Line 68:
  
  
<!--T:26-->
+
 
 
or
 
or
  
 
<code><nowiki>{{GithubDownload|<Repository Username>|<Repository Name>|snapshot=1}}</nowiki></code>
 
<code><nowiki>{{GithubDownload|<Repository Username>|<Repository Name>|snapshot=1}}</nowiki></code>
  
<!--T:27-->
+
 
 
An example with [https://github.com/torvalds/linux Linus Torvalds's linux repository]: (<code><nowiki>{{GithubDownload|torvalds|linux|snapshot=1}}</nowiki></code>)
 
An example with [https://github.com/torvalds/linux Linus Torvalds's linux repository]: (<code><nowiki>{{GithubDownload|torvalds|linux|snapshot=1}}</nowiki></code>)
  
Line 79: Line 79:
  
  
<!--T:28-->
+
 
By default a note is added that the extension is not translatable in [[translatewiki.net]]. <!--T:29--> It can be removed by adding the parameter <code>translatewiki=1</code>:
+
By default a note is added that the extension is not translatable in [[translatewiki.net]]. It can be removed by adding the parameter <code>translatewiki=1</code>:
  
 
<code><nowiki>{{GithubDownload|<Repository Username>|<Repository Name>|translatewiki=1}}</nowiki></code>
 
<code><nowiki>{{GithubDownload|<Repository Username>|<Repository Name>|translatewiki=1}}</nowiki></code>
Line 87: Line 87:
  
  
=== See also === <!--T:15-->
+
=== See also ===  
  
 
* {{ll|Template:WikimediaDownload}}
 
* {{ll|Template:WikimediaDownload}}

Latest revision as of 18:19, 21 December 2019


Template documentation

Usage

Transclude the template inside an Extension article to create GitHub Git links.


It is specifically designed to provide links for the download argument used in Template:Extension and categorizes into Category:Extensions in GitHub version control .


This template takes two unnamed parameters to form the links, these are:

  • 1 (also as: user): To form the username holding the repository
  • 2: to calculate the name of the repository holding the project, This defaults to the pagename that the extension is on


  • Note: Spaces must be padded with '_' underscores.


Snapshots


(Activate by using |<option>=1)


  • snapshot: Displays a link to your downloads page if you have added any.


  • mastertarball: Displays a download link to a tarball of your master branch.


  • release: Displays a download link to the list of releases. If the value is latest, it will point to the latest release.


Usage example

{{GithubDownload|<Repository Username>|<Repository Name>}}


An example with Linus Torvalds's linux repository: ({{GithubDownload|torvalds|linux}})


or

{{GithubDownload|<Repository Username>|<Repository Name>|snapshot=1}}


An example with Linus Torvalds's linux repository: ({{GithubDownload|torvalds|linux|snapshot=1}})


By default a note is added that the extension is not translatable in translatewiki.net. It can be removed by adding the parameter translatewiki=1:

{{GithubDownload|<Repository Username>|<Repository Name>|translatewiki=1}}


See also