Template:PHPLibraryLinks/doc

This is a documentation subpage for Template:PHPLibraryLinks.
It contains usage information, categories and other content that is not part of the original Template page.

Copy and paste template[edit]

With only the required parameters[edit]

{{PHPLibraryLinks
|name = 
}}

With all parameters including optional parameters[edit]

{{PHPLibraryLinks
|name = 
|phab-callsign = 
|gerrit-repo = 
|github-repo = 
|packagist-vendor =
|packagist-name = 
|wikimedia-doc = 
|phab-tag = 
|phab-tag-exists =
}}

Example[edit]

Example 1[edit]

Wikitext

{{PHPLibraryLinks
|name = at-ease
|phab-callsign = GATE
}}

Output

Example 2[edit]

Wikitext

{{PHPLibraryLinks
|name = RelPath
|phab-callsign = GREL
|packagist-name = relpath
|phab-tag-exists = no
}}

Output

Example 3[edit]

Wikitext

{{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
}}

Output

Usage[edit]

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.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Name	`name`	Extension name. Most other properties will be guessed from this when unspecified. Example ScopedCallback	String	required
Gerrit repository	`gerrit-repo`	Gerrit project name, when different from the library name Example mediawiki/libs/ScopedCallback	String	optional
GitHub repository name	`github-repo`	When different from the library name. Always assumed to be under the 'wikimedia' organization.	String	optional
Phabricator tag exists	`phab-tag-exists`	Whether the library has a Phabricator project Suggested values `yes` `no`	Boolean	optional
Phabricator tag	`phab-tag`	Phabricator project name, when different from the library name.	String	optional
Packagist vendor	`packagist-vendor`	Vendor (organization) name for packagist, when not 'wikimedia' Suggested values `mediawiki`	String	optional
Packagist package name	`packagist-name`	When different from the library name. Example scoped-callback	String	optional
doc.wikimedia.org project name	`wikimedia-doc`	Path to the documentation on doc.wikimedia.org (when different from the library name). Example mediawiki-libs-ScopedCallback	String	optional
Phabricator callsign	`phab-callsign`	4-character callsign used by Diffusion. Most repos don't have this.	String	deprecated