View source for Template:Script doc auto/doc

{{documentation subpage}}
{{used in system}}
{{cascade-protected template}}
{{lua|Module:Script doc auto}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

This is the {{tl|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:

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

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

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

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:

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

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

=== See also ===

* [[MediaWiki:Clearyourcache]] – The system message that uses this template.
* [[Wikipedia:WikiProject User scripts/Scripts]] – Lists many user scripts.

<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:MediaWiki namespace templates]]

}}</includeonly>