Template:Userscript/doc: Difference between revisions

Revision as of 06:15, 2 October 2013

Revision as of 08:53, 6 October 2013

Line 2:

<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

This template is used to create [[WP:US|userscript]] listings, primarily for use at [[Wikipedia:WikiProject User scripts/Scripts]], but it can be used on any page.

== Usage ==

All parameters are optional except for "name", however the template is not of much use without at least a .js path or a documentation path.

<code><nowiki>{{ userscript |name= [script name] |code= [.js address] |doc= [documentation page address] }}</nowiki></code>

=== ExampleNotes ===

* If a documentation page exists with a name that matches the code page name (without its .js extension), that documentation page will be linked automatically, with no <code>|doc=</code> parameter required. You can still enter a <code>|doc=</code> parameter explicitly if you want to override the automatic link.

* All parameters are optional except for "name", however the template is not of much use without at least a .js path or a documentation path.

=== Examples ===

<code><nowiki>{{userscript|name=Sharebox|code=User:TheDJ/sharebox.js|doc=User:TheDJ/Sharebox}}</nowiki></code>

'''Produces:''' {{userscript|name=Sharebox|code=User:TheDJ/sharebox.js|doc=User:TheDJ/Sharebox}}

<code><nowiki>{{userscript|name=Sharebox|code=User:TheDJ/sharebox.js}}</nowiki></code>

'''Produces:''' {{userscript|name=Sharebox|code=User:TheDJ/sharebox.js}}

=== Additional parameter ===