Difference between revisions of "Template:Extensioninfobox/doc"

From Lorekeeper Wiki
Jump to navigation Jump to search
(Created page with "<noinclude>{{Documentation subpage}}</noinclude> <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia:Wikidata...")
Tag: 2017 source edit
 
Tag: 2017 source edit
Line 1: Line 1:
 
<noinclude>{{Documentation subpage}}</noinclude>
 
<noinclude>{{Documentation subpage}}</noinclude>
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 +
Provides an at-a-glance summary of an extension.
 
== Usage ==
 
== Usage ==
 +
<pre>{{Extensioninfobox|title=|desc=|auth=|status=|github={{Github|user=|branch=}}|migration=|package=}}</pre>
 +
=== Parameters ===
 +
{| class="wikitable"
 +
! Parameter !! Required? !! Default !! Description
 +
|-
 +
| title || semi || Page title || The title for the infobox. Defaults to the page title, which isn't nice looking due to it including the Extensions: prefix.
 +
|-
 +
| desc || yes || || A short description of the extension.
 +
|-
 +
| auth || yes || || The extension's author(s).
 +
|-
 +
| status || yes || || The extension's approximate status, such as WIP, testing, stable, that sort of thing.
 +
|-
 +
| github || yes || [[Template:Github]] || Link to the github branch the extension is located at. This makes use of the [[Template:Github | Github template]]; see that page for information. As configured here, it expects your github username and the name of the branch the extension is at. The template will sort out the rest.
 +
|-
 +
| migration || no || || Whether or not the extension contains and requires a migration. If so, enter <code>yes</code> for this parameter.
 +
|-
 +
| package || no || || Whether or not the extension makes use of a package. If so, enter <code>yes</code> for this parameter.
 +
|}
  
 
{{sandbox other||
 
{{sandbox other||

Revision as of 10:04, 11 June 2020

Provides an at-a-glance summary of an extension.

Usage

{{Extensioninfobox|title=|desc=|auth=|status=|github={{Github|user=|branch=}}|migration=|package=}}

Parameters

Parameter Required? Default Description
title semi Page title The title for the infobox. Defaults to the page title, which isn't nice looking due to it including the Extensions: prefix.
desc yes A short description of the extension.
auth yes The extension's author(s).
status yes The extension's approximate status, such as WIP, testing, stable, that sort of thing.
github yes Template:Github Link to the github branch the extension is located at. This makes use of the Github template; see that page for information. As configured here, it expects your github username and the name of the branch the extension is at. The template will sort out the rest.
migration no Whether or not the extension contains and requires a migration. If so, enter yes for this parameter.
package no Whether or not the extension makes use of a package. If so, enter yes for this parameter.