Be advised that even when using these scripts, you take full responsibility for any action done using them. You must understand the Wikipedia policies and use this tool within that policy, or risk being blocked for its misuse.

Welcome to Friendly.

[edit] What is Friendly?

Friendly is a collection of JavaScripts that provide an interface similar to Twinkle (by using the morebits JavaScript library) for Wikipedia's more friendly, collaboration-oriented tasks.

Currently, the implemented features are welcome templates, shared IP address tagging, article space templates, talkback, tab shortening and a handy UTC clock that will purge the current page when clicked. This functionality is provided via tabs labeled "tb", "wel" and "shared ip" when on a user talk page and "tag" when in article space. A "welcome" link is also placed on diff pages next to users that have empty talk pages.

More features are always in the pipeline and Friendly is under ongoing development, so be sure to report any bugs or request new features on Friendly's talk page.

[edit] Notes

• All scripts on this page are only tested on Mozilla Firefox 3. They may not work on other browsers.
• The script is compatible with Twinkle, and will add additional Twinkle style function tabs.
• If using Windows, ZoneAlarm might break these scripts.
• Norton Internet Security (specifically, AntiSpam) will hijack the HTTP stream and append data, with the result that the data is malformed XML (the XML standard requires one root node only), breaking Friendly. This can be fixed by disabling popup blocking.
• If using the Vector skin or the Beta interface, Friendly must be loaded via gadget or your vector.js file.

[edit] Functionality

Friendly adds additional features to various parts of Wikipedia. Each tab's ID is given to assist with further customization via additional user CSS or JavaScript.

[edit] All Namespaces

[edit] friendlyclock

The friendlyclock feature inserts an updating UTC clock in the top right-hand corner of the screen so that the UTC time is always visible and handy. This feature also allows the ability to easily purge the current page by simply clicking on the clock. If you have other scripts or gadgets installed that add a UTC clock to the screen, you may want to disable them, or disable this feature of Friendly. The feature can be entirely disabled by setting the enableClock configuration parameter to false.

This feature is not available if you have Friendly installed as a gadget.

Element ID: friendly-clock

[edit] "welcome" from Diff

Friendly's welcome option displayed in diff.

A welcome link will appear next to a user in a diff view if the user's talk page is empty. This allows you to quickly welcome the user with the template specified in the quickWelcomeTemplate parameter (by default) or easily open the user's talk page with Friendly's welcome dialogue already visible (if the quickWelcomeMode parameter is set to semiauto). This feature is available when viewing any diff across all namespaces.

[edit] friendlytabs

The friendlytabs feature can be used to shorten all of the common, long tab names that Wikipedia uses. For example, "edit this page" is changed to "edit" and "discussion" to "talk", by default. This gives Friendly users more room for a variety of extra function tabs by shortening the amount of space that common tabs take up. This feature can be configured or disabled; see the configuration section for details.

[edit] User Talk Namespace

[edit] "tb" Tab

The tb tab will allow you to easily leave {{talkback}} templates on other users' talk pages. It supports all of the talkback template's options that you would have available as if you were leaving the template by hand.

Tab element ID: friendly-talkback

[edit] "wel" Tab

Friendly's welcome functionality.

The wel tab will welcome the user with selected template.

If an article is specified in the input field, and the template supports an article link, Friendly will automatically link the template to the article you specified. All templates that support this are marked with an asterisk ("*"). In the case of normal welcome templates, the article would be one that the user contributed positively to. In the case of problem user welcome templates, the article would be one that the user vandalized or did not contribute positively to. This input field is automatically populated if the vanarticle URL parameter is found, which is populated by Twinkle after doing a rollback.

Friendly is capable of supporting a custom list of templates that displays below the standard set of Welcome templates. If you have installed Friendly, you can add a list of templates that you would like to be added to the Welcome dialogue by properly defining the customWelcomeList parameter in Friendly's configuration. Any templates added to this list, when selected, will simply be placed on the user's talk page with no heading, no arguments, and will be followed by your signature.

Tab element ID: friendly-welcome

[edit] "shared ip" Tab

Friendly's shared IP functionality.

The shared ip tab will tag the IP as a shared IP address.

Most of the Shared IP templates require that the name of the organization that owns or operates the IP address be input. If one of these templates is selected, Friendly will require that you fill in the "Organization name" input field, which does support wikitext.

Tab element ID: friendly-shared

[edit] Article Namespace

[edit] "tag" Tab

Friendly's tag functionality.

The tag tab will tag the article with the template(s) of your choice.

All templates that are checked will be added to the article in their proper respective locations. Templates that support it will automatically be added with the date parameter populated to the current month and year. If the "Group into {{Article issues}} if possible" checkbox is ticked, Friendly will group supported templates into an {{Article issues}} template, if there are four or more. All other selected templates are then added to the article normally. If there are three or fewer selected templates that are supported by the {{Article issues}} template, the setting is ignored, and all templates are added to the article normally.

Three templates in the list, {{globalize}}, {{notability}}, and {{current}}, allow you to select from a list of subcategories of the respective templates. The standard template is the default, and selecting a subcategory is not required, but it does place a more specific version of the template on the article. If a {{globalize}} subcategory is selected and templates are being grouped into {{Article issues}}, the subcategory is ignored as {{Article issues}} only supports the standard {{globalize}} template. The {{notability}} subcategories are ignored in the same way when grouping.

If the redirect URL parameter is set to "no" and there is no rcid URL parameter, the tag tab will assume that you are viewing a redirect page. Instead of presenting you with a normal set of article tags, the tab will present you with a set of redirect categorization tags, from Category:Redirect templates.

Tab element ID: friendly-tag

[edit] Installation

To install all Friendly modules, including all future updates and additions:

1. copy the text below and paste it into the bottom of your monobook.js file:

    importScript('User:Ioeth/friendly.js'); 

2. save the new monobook.js page, and
3. completely refresh your browser by bypassing your cache (hit Control-Shift-R in Firefox).

You may wish to re-configure Friendly's default settings after installation. See below for instructions.

[edit] Individual modules

If you just want to use one or more of the individual modules, here they are listed with their dependencies. The line importScript('User:AzaToth/morebits.js'); is only needed once in your monobook.js, and Twinkle already includes it (so you don't need it if you're a Twinkle user already). It is recommended that you do not import any script more than once, as it would just be a duplicate, but the importScript(); function has a check to make sure that a script is not imported more than once.

For the welcome functionality, add:

 importScript('User:AzaToth/morebits.js'); importScript('User:Ioeth/friendlywelcome.js'); 

For the shared IP tagging functionality, add:

 importScript('User:AzaToth/morebits.js'); importScript('User:Ioeth/friendlyshared.js'); 

For the tagging functionality, add:

 importScript('User:AzaToth/morebits.js'); importScript('User:Ioeth/friendlytag.js'); 

For the clock functionality, add:

 importScript('User:AzaToth/morebits.js'); importScript('User:Ioeth/friendlyclock.js'); 

For the tabs functionality, add:

 importScript('User:AzaToth/morebits.js'); importScript('User:Ioeth/friendlytabs.js'); 

For the talkback functionality, add:

 importScript('User:AzaToth/morebits.js'); importScript('User:Ioeth/friendlytalkback.js'); 

[edit] Configuration

Optionally, to configure Friendly, copy the text below and paste it in your monobook.js file. It does not matter if you put the config before or after the includes or have Friendly installed as a gadget. Each line contains a specific setting which is described below. You can remove any settings that you do not want to change from the default, but do not remove the first line. When changing settings, make sure not to remove the semicolon from the end of each line.

[edit] Default Configuration

This is the default configuration:

 if( typeof( FriendlyConfig ) == 'undefined' ) FriendlyConfig = {}; // DO NOT REMOVE THIS LINE - ALL FRIENDLY SETTINGS AFTER THIS FriendlyConfig.clockStyle			=	"dynamic"; FriendlyConfig.enableClock			=	true; FriendlyConfig.groupByDefault			=	true; FriendlyConfig.idsToRename			=	[ 		{ id: 'ca-nstab-main', name: 'Main', mainPageOnly: true }, 		{ id: 'ca-nstab-help', name: 'Help' }, 		{ id: 'ca-nstab-special', name: 'Special' }, 		{ id: 'ca-nstab-project', name: 'Project' }, 		{ id: 'ca-nstab-user', name: 'User' }, 		{ id: 'ca-edit', name: 'Edit' }, 		{ id: 'ca-viewsource', name: 'Source' }, 		{ id: 'ca-talk', name: 'Talk' }, 		{ id: 'ca-undelete', name: 'Undelete' }, 		{ id: 'ca-addsection', name: '+' } 	]; FriendlyConfig.insertHeadings			=	true; FriendlyConfig.insertSignature			=	true; FriendlyConfig.insertUsername			=	true; FriendlyConfig.markSharedIPAsMinor		=	true; FriendlyConfig.markTaggedPagesAsMinor		=	true; FriendlyConfig.markTaggedPagesAsPatrolled	=	true; FriendlyConfig.markTalkbackAsMinor		=	true; FriendlyConfig.markWelcomesAsMinor		=	true; FriendlyConfig.maskTemplateInSummary		=	true; FriendlyConfig.quickWelcomeMode		=	"auto"; FriendlyConfig.quickWelcomeTemplate		=	"Welcome"; FriendlyConfig.summaryAd			=	" using [[WP:FRIENDLY|Friendly]]"; FriendlyConfig.talkbackHeading			=	"== Talkback =="; FriendlyConfig.topWelcomes			=	false; FriendlyConfig.watchTaggedPages		=	true; FriendlyConfig.watchWelcomes			=	true; FriendlyConfig.welcomeHeading			=	"== Welcome =="; 

[edit] Custom Configuration

Alternatively, you can copy only the settings you wish to change in the following format:

 if( typeof( FriendlyConfig) == 'undefined' ) FriendlyConfig= {}; // DO NOT REMOVE THIS LINE - ALL FRIENDLY SETTINGS AFTER THIS FriendlyConfig.key	=	value; FriendlyConfig.key	=	value;   /* ... */ FriendlyConfig.key	=	value; 

[edit] Parameter Descriptions

[edit] clockStyle

Defines whether a static or dynamic clock should be displayed. The dynamic clock will update the time continuously, while the static clock will always display the time that you loaded the page. Valid parameter values are dynamic and static.

Argument is a String, default to dynamic.

[edit] enableClock

Defines whether Friendly's clock should be shown.

Argument is a boolean, default to true.

[edit] groupByDefault

Defines if the checkbox for template grouping should be checked by default.

It is recommended that you not change this option.

Argument is a boolean, default to true.

[edit] idsToRename

Defines the document ids for the tabs that Friendly's tab feature should rename. It is an array of hashes, with each hash containing an id that must be a string and a name that must be a string. If a matching id is found on the page you are currently browsing, Friendly changes the link name to what is defined in the name. If renaming the article tab (id: 'ca-nstab-main') you can also specify a boolean parameter called mainPageOnly in the hash. If set to true, the particular name for the id in this hash will only be used on Wikipedia's main page.

Argument is an array of hashes, default to:

 idsToRename                     :       [ 		{ id: 'ca-nstab-main', name: 'Main', mainPageOnly: true }, 		{ id: 'ca-nstab-help', name: 'Help' }, 		{ id: 'ca-nstab-special', name: 'Special' }, 		{ id: 'ca-nstab-project', name: 'Project' }, 		{ id: 'ca-nstab-user', name: 'User' }, 		{ id: 'ca-edit', name: 'Edit' }, 		{ id: 'ca-viewsource', name: 'Source' }, 		{ id: 'ca-talk', name: 'Talk' }, 		{ id: 'ca-undelete', name: 'Undelete' }, 		{ id: 'ca-addsection', name: '+' } 	] 

To remove all tab renaming, replace this line with [],

[edit] insertHeadings

Defines whether a heading is added to a welcome template that does not already contain one.

Argument is a boolean, default to true.

[edit] insertSignature

Defines whether a signature (~~~~) is added after the welcome template if the template has no signature.

It is recommended that you not change this option.

Argument is a boolean, default to true.

[edit] insertUsername

Defines if your username should be added to the template, if the template supports it. Example: {{welcome|Ioeth}}.

Argument is a boolean, default to true.

[edit] markSharedIPAsMinor

Defines if adding a shared IP template should be marked as a minor edit.

Argument is a boolean, default to true.

[edit] markTaggedPagesAsMinor

Defines if adding a tag should be marked as a minor edit.

Argument is a boolean, default to true.

[edit] markTaggedPagesAsPatrolled

Defines if tagging should automatically mark the page as patrolled.

Argument is a boolean, default to true.

[edit] markTalkbackAsMinor

Defines if adding a talkback template should be marked as a minor edit.

Argument is a boolean, default to true.

[edit] markWelcomesAsMinor

Defines if adding a welcome should be marked as a minor edit.

Argument is a boolean, default to true.

[edit] maskTemplateInSummary

Defines whether Friendly will reference the specific template you used in the edit summary. This is useful if you do not want welcomed users to see that you welcomed them with {{welcomevandal}}, for instance.

Argument is a boolean, default to true.

[edit] quickWelcomeMode

Defines which quick welcome mode Friendly will operate in when welcoming a new user directly from a historical diff page. Automatic mode will add the template defined in the quickWelcomeTemplate variable to the user's talk page with no user intervention. Semi-automatic mode will load the user's talk page and then prompt you with the welcome template list as if you clicked the "welcome" tab.

The value of this argument must either be auto or semiauto.

Argument is a string, default to auto.

[edit] quickWelcomeTemplate

Defines which welcome template Friendly will use when welcoming a new user directly from a historical diff page.

The value of this argument must exactly match one of the templates available from the "welcome" tab on a user talk page. Do not include the curly braces, only the template name, and make sure the capitalization matches.

Argument is a string, default to Welcome.

[edit] summaryAd

Defines what summary Ad to be added.

Argument is a string, default to using [[WP:FRIENDLY|Friendly]].

[edit] talkbackHeading

Defines what heading is to be added above talkback templates if insertHeadings is true.

Argument is a string, default to == Talkback ==.

[edit] topWelcomes

Defines if the welcome should be added to the top or bottom of the user's talk page.

Argument is a boolean, default to false.

[edit] watchTaggedPages

Defines if adding a tag should add a page to watchlist.

Argument is a boolean, default to true.

[edit] watchWelcomes

Defines if adding a welcome should add page to watchlist.

Argument is a boolean, default to true.

[edit] welcomeHeading

Defines what heading is to be added to welcome templates if insertHeadings is true and the welcome template has no heading.

Argument is a string, default to == Welcome ==.

[edit] Custom Parameters

Friendly's tag and welcome functionality supports custom maintenance and welcome templates which are provided to the script by adding the customTagList and customWelcomeList parameters to FriendlyConfig. This functionality is somewhat complex to set up, so it is not recommended for users that are inexperienced with JavaScript. If you require assistance, please post a message on the talk page and someone will most likely come along to help you out.

[edit] customTagList

To add custom template functionality to your Friendly tag screen, insert the following code below your other Friendly configuration:

 FriendlyConfig.customTagList	=	[ 		{ 			label: '{{CustomTag}}: Custom maintenance template description', 			value: 'CustomTag' }, 		{ 			label: '{{CustomTag}}: Custom maintenance template description', 			value: 'CustomTag' }, 		{ 			label: '{{CustomTag}}: Custom maintenance template description (now includes parameters!)', 			value: 'CustomTag|para=value' } 	]; 

Simply replace "CustomTag" with the name of the template that you would like to add to the script and either remove or replace the description on the "label" line. This section of your configuration can be extended to include as many custom maintenance templates as you would like. Make sure to use a comma to separate each element in the array while not including one after the last element.

[edit] customWelcomeList

To add custom template functionality to your Friendly welcome screen, insert the following code below your other Friendly configuration:

 FriendlyConfig.customWelcomeList	=	[ 		{ 			label: '{{CustomWelcome}}: Custom welcome template description', 			value: 'CustomWelcome' }, 		{ 			label: '{{CustomWelcome}}: Custom welcome template description', 			value: 'CustomWelcome' }, 		{ 			label: '{{CustomWelcome}}: Custom welcome template description (now includes parameters!)', 			value: 'CustomWelcome|para=value' } 	]; 

Simply replace "CustomWelcome" with the name of the template that you would like to add to the script and either remove or replace the description on the "label" line. This section of your configuration can be extended to include as many custom welcome templates as you would like. Make sure to use a comma to separate each element in the array while not including one after the last element.

[edit] Userboxes

Friendly users may add these userboxes to their userpage.

Userbox	Code
This user welcomes new users with Friendly!	{{User:Xenon54/Userboxes/Friendly}}
This user welcomes new users with Friendly!	{{User:Xenon54/Userboxes/Friendly2}}
{{wikify}} This user tags articles for maintenance with Friendly!	{{User:Xenon54/Userboxes/Friendly3}}
This user welcomes new users with Friendly!	{{User:Arctic Fox/UBX/Friendly}}
This user welcomes new users and tags articles using Friendly {{tag}}	{{User:Powergate92/Userboxes/Friendly}}
{{COI}} This user tags articles with Friendly!	{{User:Skittleys/Userboxes/Friendly|tag=TAGNAME}}