Manual:Pywikibot/Scripts/script

From mediawiki.org
Documentation

This template is to include script information onto the scripts overview.

Template parameters

ParameterDescriptionTypeStatus
script name1

Script name in core

Linerequired
description2

Short description of what the script does

Contentsuggested
core status3

Support in Pywikibot core: “y” (supported), “n” (unsupported) or “-” (unknown)

Default
-
Lineoptional
porting taskport

Phabricator ID for task to port script from compat to core, only used if status is “n”

Example
T1234
Lineoptional
bug IDbug

Phabricator ID for a bug that makes core script not working, only used if status is “n”

Example
T5678
Lineoptional
core folderfolder

The folder where the script is located, if not in “scripts/”

Default
scripts/
Lineoptional
compat namecompatname

Script name in compat, if different from the core one

Lineoptional
compat foldercompatfolder

The folder where the compat script is located

Lineoptional
{{Manual:Pywikibot/Scripts/script
| 1 = 
| 2 = 
| 3 = 
| 4 =
| port = 
| bug = 
| folder = 
| compatname = 
| compatfolder = 
}}

Examples

{{Manual:Pywikibot/Scripts/part|
  {{Manual:Pywikibot/Scripts/script|scriptname|This is a short description of the script|n| port = T1234}}
}}
Name Description Code
scriptname.py This is a short description of the script compattask
{{Manual:Pywikibot/Scripts/part|
  {{Manual:Pywikibot/Scripts/script|scriptname|This is a short description of the script|n| bug = T5678}}
}}
Name Description Code
scriptname.py This is a short description of the script bug
{{Manual:Pywikibot/Scripts/part|
  {{Manual:Pywikibot/Scripts/script|scriptname|This is a short description of the script|y}}
}}
Name Description Code
scriptname.py This is a short description of the script core