Template:Userscript/sandbox
(Redirected from Template:Userscript/sandbox2)
 | This is the template sandbox page for Template:Userscript (diff). See also the companion subpage for test cases. |
This template is used to create userscript listings, primarily for use at Wikipedia:User scripts, but it can be used on any page.
Usage
[edit]{{userscript |code= [.js address] |name= [script name] |doc= [documentation page address] }}
At least |code= -or- |doc= is required. The template will attempt to determine defaults for any information not entered.
- Check the accuracy of the links after placing this template! If any defaults are incorrect for your script, enter the necessary parameters explicitly.
- If you end up leaving the template with no "(source)" link produced, make sure your documentation page includes complete installation instructions, along with any necessary code page addresses.
- You can make up any name for the
|nameparameter. It is just for display purposes.
Default logic details |
|---|
|
Additional parameters
[edit]- This template enables an automatic installation link for editors who use automatic installer scripts like User:Enterprisey/script-installer or User:Equazcion/ScriptInstaller. If you have reason to disable automatic installation for a particular script (e.g. because it requires more than just the usual importScript line), add the following parameter:
|noautoinstall=yes. - To suppress the creation of a footnote with installation instructions, set
|noref=yes.
Examples
[edit]All parameters specified: {{userscript|name=sharebox!!!!!|code=User:TheDJ/sharebox.js|doc=User:TheDJ/sharebox}}
- Produces: sharebox!!!!![1] (source)
Code only: {{userscript|code=User:TheDJ/sharebox.js}}
Doc only: {{userscript|doc=User:TheDJ/sharebox}}
Use {{reflist}} to produce specific installation instructions:
- ↑ Copy the following code, edit your user JavaScript, then paste:
{{subst:lusc|1=User:TheDJ/sharebox.js}} - ↑ Copy the following code, edit your user JavaScript, then paste:
{{subst:lusc|1=User:TheDJ/sharebox.js}} - ↑ Copy the following code, edit your user JavaScript, then paste:
{{subst:lusc|1= User:TheDJ/sharebox.js}}