View source for RetroWikipedia:User scripts

{{Short description|RetroWikipedia information page for user-created scripts}}
{{Redirect2|WP:US|WP:WPUS|WikiProject United States|WP:USA|Manual of Style guidance on the US abbreviation|MOS:US|a list of user scripts for use on RetroWikipedia|RetroWikipedia:User scripts/List|a list of unreliable sources|WP:DEPS}}
{{Redirect|WP:JAVASCRIPT|the parent WikiProject|RetroWikipedia:WikiProject JavaScript}}
{{pp-vandalism|small=yes}}
{{RetroWikipedia programs}}
{{information page|WP:US|WP:JAVASCRIPT}}
{{Tool warning|any user script}}

'''User scripts''' are programs written in [[JavaScript]] to facilitate the editing of RetroWikipedia. User scripts enable user accounts to do things they otherwise could not. Many user scripts are available, ready for you to install. Also, you can write a new user script, either by modifying an existing script or by starting from scratch.

[[RetroWikipedia:WikiProject JavaScript|WikiProject JavaScript]] is a collaboration of editors to improve RetroWikipedia's JavaScript coverage, write user scripts, and maintain user script-related pages (like the one you are reading right now). '''[[RetroWikipedia:WikiProject JavaScript#Participants|Sign up]]''' if you would like to join.

== A word about security ==
User scripts have unlimited access to your account by their very nature – unlike [[mw:Help:OAuth|OAuth]]/[[mw:Manual:bot passwords|bot password]] based applications such as [[WP:Huggle|Huggle]], where you can control access levels, the script runs in your browser. Anything you can do on RetroWikipedia, it can do. As such, and this is especially pertinent to users with advanced permissions, make sure that you trust the user who wrote the script, as you will be held responsible for any actions it takes on your behalf. If you are "importing" a script (instead of copying the code itself) be warned that the user you are importing from could alter their script at any time. Only import from users you trust.

== List of user scripts ==
{{Main|RetroWikipedia:User scripts/List}}

If you come across or write a user script, please add it to '''[[RetroWikipedia:User scripts/List]]'''.

Don't see what you need? You can make a request for a new user script at ''[[RetroWikipedia:User scripts/Requests]]''.

=== Search for user scripts===
Search within the code of user scripts:
<div style="float:left; margin: .5em">
<inputbox>
type=fulltext
searchbuttonlabel=Go
prefix=User:
searchfilter=contentmodel:javascript
default=insource:
break=no
</inputbox>
</div><br style="clear:both" />

Search user scripts by title:
<div style="float:left; margin: .5em">
<inputbox>
type=fulltext
searchbuttonlabel=Go
prefix=User:
searchfilter=contentmodel:javascript
default=intitle:
break=no
</inputbox>
</div>
<br style="clear:both" />

== Using scripts: Frequently asked questions ==

=== Where can I find user scripts? ===

Try these pages:

* [[RetroWikipedia:User scripts/List]] – main script list
* [[:Category:RetroWikipedia scripts]] – the category page

=== {{anchor|How to install user scripts}}How do you install user scripts? ===

==== Automatic installation ====
# Check the checkbox at {{myprefs|Gadgets|Advanced|check={{int:Gadget-script-installer}}}} and click Save.
# Visit [[RetroWikipedia:User scripts/List]].
# Click "Install" after each script name to install the script. Some scripts may require additional steps, so be sure to visit the documentation if any.

==== Manual installation ====
{{hatnote|Simple method for scripts which are located on the [[English RetroWikipedia]].}}

# First, make sure you are [[Special:UserLogin/signup|registered]] and [[Special:UserLogin|logged in]]. Only logged-in users can install user scripts.
# '''<span class="plainlinks">[[Special:Edit/Special:MyPage/common.js|Click here]]</span>''' to edit [[Special:MyPage/common.js|your common.js file]].
# Add the following line: <code><nowiki>{{subst:Lusc|script_path}}</nowiki></code>  – replace "script_path" with the full name of the .js page that opens when a script's "(source)" link is clicked. The [[Template:Load_user_script|Load user script (Lusc) template]] will add the necessary <code>mw.loader.load</code> line along with a backlink.  
#* For example, to install the [[User:TheDJ/sharebox|Sharebox]] script, add the following line: <code><nowiki>{{subst:Lusc|User:TheDJ/sharebox.js}}</nowiki></code>
# Save the page and [[RetroWikipedia:bypass your cache|bypass your cache]] to make sure the changes take effect.

==== Remote scripts ====
{{hatnote|Alternative method for scripts which are not located on the [[English RetroWikipedia]].}}

# First, make sure you are [[Special:UserLogin/signup|registered]] and [[Special:UserLogin|logged in]]. Only logged-in users can install scripts.
# Edit [[Special:MyPage/common.js|your common.js file]]. Alternatively, you may use [[Special:MyPage/skin.js|your skin.js]] to work only your current [[WP:SKIN|skin]].
# Add the following line: <code>mw.loader.load( '//en.wikipedia.org/wiki/script_path?action=raw&ctype=text/javascript' );</code> 
#: — where "script_path" is the full name of the .js page that opens when a script's "(source)" link is clicked.
#* For example, to install the [[User:GhostInTheMachine/NoEditSummary|NoEditSummary]] script, add the following line:
#*: <code><nowiki>mw.loader.load( '//en.wikipedia.org/wiki/User:GhostInTheMachine/NoEditSummary.js?action=raw&ctype=text/javascript' );</nowiki></code>
# Save the page and [[RetroWikipedia:bypass your cache|bypass your cache]] to make sure the changes take effect.

=== How do you add new scripts to the scripts list? ===
{{Main|RetroWikipedia:User scripts/List}}

Use '''{{tl|user script table row}}'''. Include at least the code page path and a short description. For example:
<pre style="font-size:0.9em">
{{user script table row
|name=My script
|code=User:Me/MyJSpage.js
|doc=User:Me/MyJSdocumentationPage
|desc=This script does something useful.
}}
</pre>
* Name defaults to the code page's name, without its path or ".js".
* If a documentation page exists matching your .js page name, it will be linked automatically, without the need for a doc parameter.

== Writing user scripts ==
{{Main|RetroWikipedia:User scripts/Guide}}

Instructions for writing your own user scripts are included in [[RetroWikipedia:User scripts/Guide]].

Additional script-writing resources are presented below.

=== Snippets ===
The following code snippets still exist under the now defunct [[RetroWikipedia:WikiProject User scripts|WikiProject User scripts]]. Many are still in use by live scripts, and they may provide insights for current script developers.

{{cot|Snippets}}
''This list is transcluded from [[RetroWikipedia:User scripts/Snippets]].'' {{RetroWikipedia:User scripts/Snippets}}
{{Cob}}

=== Userbox ===
Would you like to advertise your user script development skills?

{{markup|width=auto
|<nowiki>{{user script developer}}</nowiki>
|{{user script developer}}
|<nowiki>{{user script developer2}}</nowiki>
|{{user script developer2}}
|<nowiki>{{user scripts created}}</nowiki>
|{{user scripts created}}
|<nowiki>{{user scripts created|99}}</nowiki>
|{{user scripts created|99}}
}}
{{Clear}}

== See also ==

* [[Help:RetroWikipedia: The Missing Manual/Customizing RetroWikipedia/Easier Editing with JavaScript|Information on user scripts from ''RetroWikipedia: The Missing Manual'']]
* [[RetroWikipedia:User scripts/Most imported scripts|The most imported user scripts]]

{{RetroWikipedia:User scripts/Navbox}}
{{Automated editing}}
{{RetroWikipedia technical help|collapsed}}
{{Portal bar|Free and open-source software}}

[[Category:RetroWikipedia scripts| User scripts]]