Caleb Cooper: Created page with "{{Documentation subpage}}NOTOC {{intricate template}} This template is used to create userscript listings, primarily for use at Wikipedia:User scripts, but it can be used on any page. == Usage == `{{userscript |code= [.js address] |name= [script name] |doc= [documentation page address] }}` At least `|code=` ''' -or- ''' `|doc=<..."`


2023-04-19T11:57:41Z
Created page with "{{Documentation subpage}}__NOTOC__ {{intricate template}} <!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->  This template is used to create userscript listings, primarily for use at Wikipedia:User scripts, but it can be used on any page.  == Usage == <code><nowiki>{{userscript |code= [.js address] |name= [script name] |doc= [documentation page address] }}</nowiki></code>  At least <code>|code=</code> ''' -or- ''' <code>|doc=<..."
New page
{{Documentation subpage}}__NOTOC__

{{intricate template}}

<!-- 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:User scripts]], but it can be used on any page.



== Usage ==

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



At least <code>|code=</code> ''' -or- ''' <code>|doc=</code> 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 <code>|name</code> parameter. It is just for display purposes.



{{collapse top|1=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>|code='''User:TheDJ/Sharebox'''.js</code> will look for a page named '''User:TheDJ/Sharebox''', and if found, will be linked as the documentation page.

** Entering <code>|doc='''User:TheDJ/Sharebox'''</code> will look for a page named '''User:TheDJ/Sharebox<span style="color:red">.js</span>''', 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.

{{collapse bottom}}



=== Additional parameters ===

* 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: {{para|noautoinstall|yes}}.

* To suppress the creation of a footnote with installation instructions, set {{para|noref|yes}}.



== Examples ==

All parameters specified: <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 only: <code><nowiki>{{userscript|code=User:TheDJ/sharebox.js}}</nowiki></code>

*Produces: {{userscript|code=User:TheDJ/sharebox.js}}

Doc only: <code><nowiki>{{userscript|doc=User:TheDJ/sharebox}}</nowiki></code>

*Produces: {{userscript|doc=User:TheDJ/sharebox}}



Use <code><nowiki>{{reflist}}</nowiki></code> to produce specific installation instructions:

{{reflist}}



==See also==

* [[Wikipedia:User scripts/List]]



{{Wikipedia:User scripts/Navbox}}

<includeonly>{{Sandbox other||

[[Category:Wikipedia scripts|*]]

[[Category:Wikipedia user script templates]]

}}</includeonly>
Template:Userscript/doc - Revision history
