Template:PHPLibraryLinks/doc: Difference between revisions

From Bonkipedia
[[mw:]]>Tgr (WMF)
No edit summary
 
m (1 revision imported: Workaround and Utility Templates)
 
(No difference)

Latest revision as of 17:52, 12 November 2022

Copy and paste template

With only the required parameters

{{PHPLibraryLinks
|name = 
}}

With all parameters including optional parameters

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

Example

Example 1

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

Example 2

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

Example 3

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

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.

ParameterDescriptionTypeStatus
Namename

Extension name. Most other properties will be guessed from this when unspecified.

Example
ScopedCallback
Stringrequired
Gerrit repositorygerrit-repo

Gerrit project name, when different from the library name

Example
mediawiki/libs/ScopedCallback
Stringoptional
GitHub repository namegithub-repo

When different from the library name. Always assumed to be under the 'wikimedia' organization.

Stringoptional
Phabricator tag existsphab-tag-exists

Whether the library has a Phabricator project

Suggested values
yes no
Booleanoptional
Phabricator tagphab-tag

Phabricator project name, when different from the library name.

Stringoptional
Packagist vendorpackagist-vendor

Vendor (organization) name for packagist, when not 'wikimedia'

Suggested values
mediawiki
Stringoptional
Packagist package namepackagist-name

When different from the library name.

Example
scoped-callback
Stringoptional
doc.wikimedia.org project namewikimedia-doc

Path to the documentation on doc.wikimedia.org (when different from the library name).

Example
mediawiki-libs-ScopedCallback
Stringoptional
Phabricator callsignphab-callsign

4-character callsign used by Diffusion. Most repos don't have this.

Stringdeprecated