Template:Script doc auto


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


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:

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

The above boxes are not transparent, instead they use the same background color as the blue 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.

Technical details

Internally this template uses the {{str len}} template. Since {{str len}} is heavy on the servers this template only calls it once, then it feeds the result to {{script doc auto/core}} which contains most of the code for this template, that template then in turn calls {{script doc auto/core2}} which renders the green doc box and the actual text messages.

Note to admins: MediaWiki does not parse and convert HTML wikimarkup in system messages the same way as it does for normal pages. This means for instance that <br> is not automatically converted to <br /> and missing </td> and </tr> tags are not automatically added. Thus see to that any HTML code you use in this template is valid XHTML. That is, close all tags that you begin. However, regular wikimarkup works fine in most system messages.

See also