Template:Script doc auto/doc: Difference between revisions

Revision as of 18:26, 30 August 2024

Revision as of 19:06, 14 August 2025

Line 7:

This is the {{tl|script doc auto}} template.

It is used in the [[MediaWiki:Clearyourcache]] system message that is shown on top of .css, .js, .json, and .jsvue pages. This template is only loaded when in "User:" spaceand "Mediawiki" namespaces. It produces the small green doc box seen on top of user .css, .js, .json, and .jsvue pages.

{{divbox|1=gray|2=Examples|3=

When this template is called on top of [[User:Davidgothberg/monobook.js]] it produces this output:

Line 17 ⟶ 18:

{{script doc auto| page = User:Davidgothberg/clock.js }}

When this template is called on top of [[MediaWiki:Gadget-Twinkle.js]] it produces this output:

The above boxes are not transparent, instead they use the same background colour as the green doc box.

{{script doc auto| page = MediaWiki:Gadget-Twinkle.js }}

}}

===Skin files===

When this template is called on a user skin file such as "/monobook.css" it gives a link to the accompanying "/monobook.js" file. It shows that link even if the accompanying skin file does not exist, but it then uses slightly different text.

===User scripts===

For .css, .js, .json, and .jsvue pages in user space other than the skin files:

This template links to the documentation page for the script. It shows that link even if the documentation has not been created, but it then uses slightly different text. The doc pages of scripts are the page name but without the ending ".css" or ".js". For instance [[User:Davidgothberg/clock.js]] has its documentation at [[User:Davidgothberg/clock]].

This template also detects if a .css, .js, .json, or .vue page has an accompanying .cssfiles with the other three fileextensions and then links between them. It doesn't show thata link if the other file does not exist.

===Gadgets===

For .css, .js, .json, and .vue pages in the Mediawiki namespace:

This template links to the section of [[Special:Gadgets]] for the gadget. It also shows either the number of users of the gadget or whether it is a hidden or default gadget.

This template also detects if a .css, .js, .json, or .vue page has accompanying files with the other three extensions and then links between them. It doesn't show a link if the other file does not exist.

===Usage===

For testing and demonstration purposes this template can take a parameter named '''page'''. Like this: