Wikimore

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Userscript/doc.

This template employs some extremely complicated or esoteric features of template syntax. Please do not attempt to alter it unless you are certain that you understand the setup and are prepared to repair/revert any consequent collateral damage if the results are unexpected. Any experiments should be conducted in a sandbox or your userspace.

Category:Main message boxes Category:Intricate templates

This template is used to create userscript listings. It can be used on any page.

Usage

{{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 |name parameter. It is just for display purposes.

Default logic details

The template will add .js to the documentation page name to get a default code page, or remove .js from the code page name to get a default documentation page.
- Entering |code=User:TheDJ/Sharebox.js will look for a page named User:TheDJ/Sharebox, and if found, will be linked as the documentation page.
- Entering |doc=User:TheDJ/Sharebox will look for a page named User:TheDJ/Sharebox.js, and if found, will be linked as the code page.
If the default pages don't actually exist, they won't be linked (so defaults shouldn't produce red links).
If no name is entered, a default name will be produced from the code or doc page name.

Additional parameters

This template enables an automatic installation link for editors who use automatic installer scripts like w:en:User:Enterprisey/script-installer or w:en: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

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}}

Produces: sharebox^[2] (source)

Doc only: {{userscript|doc=User:TheDJ/sharebox}}

Produces: sharebox

Use {{reflist}} to produce specific installation instructions:

↑ Copy the following code, click here, then paste:
{{subst:lusc|1=User:TheDJ/sharebox.js}}
↑ Copy the following code, click here, then paste:
{{subst:lusc|1=User:TheDJ/sharebox.js}}

Category:User scripts#*

[1] Copy the following code, click here, then paste:
{{subst:lusc|1=User:TheDJ/sharebox.js}}

[2] Copy the following code, click here, then paste:
{{subst:lusc|1=User:TheDJ/sharebox.js}}

[1]

[2]