doc

From Encyclopedia of Scientonomy
Jump to navigation Jump to search

Template:Mbox

This template provides an alternative to Template:Tl for linking to source code.

This uses the GitHub mirror instead of Diffusion the Gitblit server at git.wikimedia.org (WMF is deprecating gitblit and git.wikimedia.org in 2015). Editors may find GitHub's interface more user-friendly, faster responding, visually appealing, or otherwise preferable. Compare:

Usage

Basic

 {{github |file=composer.json }}
 {{github |repo=mediawiki-extensions-Flow |file=composer.json }}

produces:

composer.json
composer.json

Action

{{github |repo=mediawiki-extensions-EventLogging 
 |file=server/bin/eventlogging-devserver
 |text=development server | action=raw }}

produces:

development server

Line number

{{github |file=tests/phpunit/includes/MessageTest.php |line=152 }}

produces:

tests/phpunit/includes/MessageTest.php

<templatedata> { "params": { "repo": { "description": "Full repository name (e.g. \"mediawiki\" or \"mediawiki/extensions/EventLogging\"). Must not include any \".git\" suffix.", "type": "string", "default": "mediawiki" }, "action": { "description": "A GitHub repo action. One of \"blob\", \"raw\", \"blame\", \"commits\", or \"tree\"", "type": "string", "default": "blob" }, "branch": { "type": "string", "default": "master" }, "file": { "type": "string", "default": "", "required": true }, "line": { "type": "number" }, "text": { "description": "Custom label for the link created by this template.", "type": "string", "default": "The file path" } }, "description": "A convenient way of linking to source code.", "paramOrder": [ "repo", "action", "branch", "file", "line", "text" ] } </templatedata>

See also