Template:Script doc auto/sandbox

This is the template sandbox page for Template:Script doc auto (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used in system messages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

Preview message: Transclusion count updated automatically (see documentation).

This template can only be edited by administrators because it is transcluded onto one or more cascade-protected pages.

This template uses Lua:

Module:Script doc auto (sandbox)

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

It is used in the MediaWiki:Clearyourcache system message that is shown on top of .css and .js pages. This template is only loaded when in "User:" space. It produces the small green doc box seen on top of user .css and .js pages.

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

The accompanying .css page for this skin is at User:Davidgothberg/monobook.css.

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

This user script seems to have a documentation page at User:Davidgothberg/clock.

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

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.

For .css and .js 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 .js page has an accompanying .css file and then links between them. It doesn't show that link if the other file does not exist.

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

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

The page parameter makes this template behave exactly as if on that page.