View source for Template:PHPLibraryLinks/doc

{{documentation subpage}}
== Copy and paste template ==
=== With only the required parameters ===
<pre>
{{PHPLibraryLinks
|name = 
}}
</pre>

=== With all parameters including optional parameters ===
<pre>
{{PHPLibraryLinks
|name = 
|phab-callsign = 
|gerrit-repo = 
|github-repo = 
|packagist-vendor =
|packagist-name = 
|wikimedia-doc = 
|phab-tag = 
|phab-tag-exists =
}}
</pre>

== Example ==
=== Example 1 ===
; Wikitext
<pre>
{{PHPLibraryLinks
|name = at-ease
|phab-callsign = GATE
}}
</pre>
; Output
{{PHPLibraryLinks
|name = at-ease
|phab-callsign = GATE
}}

=== Example 2 ===
; Wikitext
<pre>
{{PHPLibraryLinks
|name = RelPath
|phab-callsign = GREL
|packagist-name = relpath
|phab-tag-exists = no
}}
</pre>
; Output
{{PHPLibraryLinks
|name = RelPath
|phab-callsign = GREL
|packagist-name = relpath
|phab-tag-exists = no
}}

=== Example 3 ===
; Wikitext
<pre>
{{PHPLibraryLinks
|name = oauthclient-php
|phab-callsign = MOAC
|gerrit-repo = mediawiki/oauthclient-php
|github-repo = mediawiki-oauthclient-php
|packagist-vendor = mediawiki
|packagist-name = oauthclient
|wikimedia-doc = mediawiki-oauthclient-php
|phab-tag = oauth
}}
</pre>

; Output
{{PHPLibraryLinks
|name = oauthclient-php
|phab-callsign = MOAC
|gerrit-repo = mediawiki/oauthclient-php
|github-repo = mediawiki-oauthclient-php
|packagist-vendor = mediawiki
|packagist-name = oauthclient
|wikimedia-doc = mediawiki-oauthclient-php
|phab-tag = oauth
}}

== Usage ==
<templatedata>
{
	"params": {
		"gerrit-repo": {
			"label": "Gerrit repository",
			"description": "Gerrit project name, when different from the library name",
			"example": "mediawiki/libs/ScopedCallback",
			"type": "string"
		},
		"name": {
			"label": "Name",
			"description": "Extension name. Most other properties will be guessed from this when unspecified.",
			"example": "ScopedCallback",
			"type": "string",
			"required": true
		},
		"phab-callsign": {
			"label": "Phabricator callsign",
			"description": "4-character callsign used by Diffusion. Most repos don't have this.",
			"type": "string",
			"deprecated": true
		},
		"github-repo": {
			"label": "GitHub repository name",
			"description": "When different from the library name. Always assumed to be under the 'wikimedia' organization.",
			"type": "string"
		},
		"packagist-vendor": {
			"label": "Packagist vendor",
			"description": "Vendor (organization) name for packagist, when not 'wikimedia'",
			"type": "string",
			"suggestedvalues": [
				"mediawiki"
			]
		},
		"packagist-name": {
			"label": "Packagist package name",
			"description": "When different from the library name.",
			"example": "scoped-callback",
			"type": "string"
		},
		"wikimedia-doc": {
			"label": "doc.wikimedia.org project name",
			"description": "Path to the documentation on doc.wikimedia.org (when different from the library name).",
			"example": "mediawiki-libs-ScopedCallback",
			"type": "string"
		},
		"phab-tag-exists": {
			"label": "Phabricator tag exists",
			"description": "Whether the library has a Phabricator project",
			"type": "boolean",
			"suggestedvalues": [
				"yes",
				"no"
			]
		},
		"phab-tag": {
			"label": "Phabricator tag",
			"description": "Phabricator project name, when different from the library name.",
			"type": "string"
		}
	},
	"description": "Show standard links such as Phabricator or Gerrit for a PHP library (see [[Manual:Developing libraries]]). Typically used at the bottom of the page in an \"External links\" section.",
	"paramOrder": [
		"name",
		"gerrit-repo",
		"github-repo",
		"phab-tag-exists",
		"phab-tag",
		"packagist-vendor",
		"packagist-name",
		"wikimedia-doc",
		"phab-callsign"
	],
	"format": "block"
}
</templatedata>
<includeonly>
[[Category:External link templates]]
</includeonly>