View source for Wikipedia:FurMe

{{Historical}}
{{Mbox
 |type  = move
 |image = [[Image:Merge-arrows.svg|50px|alt=|link=]]
 |text  = FurMe is no longer functional, but image maintenance tagging has been partially [[WP:MERGE|merged]] with [[WP:Twinkle]]
}}
{{tool warning}}
{{shortcut|WP:FURME}}

'''FurMe''' was a set of [[JavaScript]]s that gives [[WP:REGISTER|registered users]] a convenient way to manage Image namespace specific tasks, primarily to generate [[WP:FURG|non-free use rationales]] to images that lack them. FurMe is based on the morebits.js library, and therefore is subject to all usage restrictions inherited from that library (please see the [[WP:TW|TWINKLE]] doc page for more information).

'''Notes'''
# This script is tested only on [[Mozilla Firefox]] (and unofficially [[Opera (web browser)|Opera]] and [[Safari (web browser)|Safari]]). It will not work on [[Microsoft Internet Explorer]].

== Installation ==

To install FurMe, including all future updates and additions:

* If you have [[Wikipedia:Twinkle|Twinkle]] installed, copy the text below and paste it into the bottom of [[Special:Mypage/skin.js|your skin.js]] file:
   mw.loader.load('//en.wikipedia.org/w/index.php?title=User:AWeenieMan/furme.js&action=raw&ctype=text/javascript');
* If you do not have Twinkle installed, copy the text below and paste it into the bottom of [[Special:Mypage/skin.js|your skin.js]] file:
   mw.loader.load('//en.wikipedia.org/w/index.php?title=User:AzaToth/morebits.js&action=raw&ctype=text/javascript');
   mw.loader.load('//en.wikipedia.org/w/index.php?title=User:AWeenieMan/furme.js&action=raw&ctype=text/javascript');
* If you would also like [[#Functionality of FurMeScroller|FurMeScroller]] functionality, copy the text below and paste it into the bottom of [[Special:Mypage/skin.js|your skin.js]] file:
   mw.loader.load('//en.wikipedia.org/w/index.php?title=User:AWeenieMan/furmeScroller.js&action=raw&ctype=text/javascript');
* Save the new skin.js page, and 
* Completely refresh your browser by [[Wikipedia:Bypass your cache|bypassing your cache]] (Firefox: Control-Shift-R / Firefox Mac: Command-Shift-R / Explorer: Control-F5) 
* Done!

== Functionality of FurMe ==
FurMe adds a "fur" tab to the top of pages in the Image namespace. Through this tab, you can select to add one of the following templates to the summary section of the image.

* {{Tl|non-free use rationale}}
* {{Tl|logo fur}}
* {{Tl|album cover fur}}
* {{Tl|book cover fur}}
* {{Tl|film cover fur}}

To make this task easier, you are prompted to enter values into the most commonly used fields

=== Auto fill-in of fields ===
FurMe attempts to fill in certain fields, as described below.

* {{Tl|non-free use rationale}}
** The "Article" field is automatically populated if there is only one field listed in the "File links" section of the page.
** The "Source" field is automatically populated if there is a single external URL in the text of the page.
** The "Low_resolution" field is automatically populated as "Yes" if the image is below 300px in width or height.

* {{Tl|logo fur}}
** The "Website" field is automatically populated if there is a single external URL in the text of the page.
** If there is only one article listed in the "File links" section of the page
*** The "Article" field is automatically populated
*** The infobox option is automatically selected if the image is found in a templated infobox in that article.

* {{Tl|album cover fur}}
** The "Source" field is automatically populated if there is a single external URL in the text of the page.
** If there is only one article listed in the "File links" section of the page
*** The "Article" field is automatically populated
*** The infobox option is automatically selected if the image is found in a templated infobox in that article.
*** The "Album" field is populated with the value from the infobox
*** The "Artist" field is populated with the value from the infobox
*** The "Label" field is populated with the value from the infobox

* {{Tl|book cover fur}}
** The "Website" field is automatically populated if there is a single external URL in the text of the page.
** If there is only one article listed in the "File links" section of the page
*** The "Article" field is automatically populated
*** The infobox option is automatically selected if the image is found in a templated infobox in that article.
*** The "Title" field is populated with the value from the infobox
*** The "Author" field is populated with the value from the infobox
*** The "Publisher" field is populated with the value from the infobox
*** The "Cover Artist" field is populated with the value from the infobox
*** The "Year" field is populated with the value from the infobox

* {{Tl|film cover fur}}
** The "Website" field is automatically populated if there is a single external URL in the text of the page.
** If there is only one article listed in the "File links" section of the page
*** The "Article" field is automatically populated
*** The infobox option is automatically selected if the image is found in a templated infobox in that article.
*** The "Name" field is populated with the value from the infobox
*** The "Distributor" field is populated with the value from the infobox

=== Removal of templates ===
FurMe will remove the following templates from the page (a proper fair use rationale should fix any of the problems described in these templates).

* {{Tl|Di-no source}} (redirects: No source, Unspecified, Unknownsource, Fairuseunknownsource, Fuus, Nosource, No source since, No source notified, No info, Nosources, Di-no-source)
* {{Tl|Di-disputed fair use rationale}} (redirects: Di-disputed rationale, Improve rationale)
* {{Tl|Di-no fair use rationale}} (redirects: No rationale, Fairuse rationale needed, Fu-ra-ne, Norat, Norationale, Di-no rationale)

=== Removal of categories ===
FurMe will remove the following categories from pages it edits.

* [[:Category:Disputed non-free images|Category:Disputed non-free images]] (and date based subcategories)

=== Preview/Saving changes ===
By default, FurMe does not automatically save your changes. After submitting the form, you will be prompted with a diff of the proposed changes. See the [[User:AWeenieMan/furme#Configuration|Configuration]] section for details on how to change this behavior.

=== General Cleanup ===
FurMe makes the following minor cleanup to the page.

* Will change <nowiki>==Summary==</nowiki> to <nowiki>== Summary ==</nowiki>
* Will add <nowiki>== Summary ==</nowiki> (if it does not already exist)
* Will add <nowiki>== Licensing ==</nowiki> (if it does not already exist) above the non-free license template
* Will clean [[Amazon.com|Amazon]] URLs, stripping extraneous parameters and normalizing format

== Tag tab ==
FurMe also adds an additional "Tags" tab to pages in the Image namespace, allowing the management of image templates with a simple checklist, and a dropdown for automatically changing the licence tag of an image.

== Functionality of FurMeScroller ==
FurMeScroller is an add-on to FurMe. It allows for scrolling through a specially crafted list of image links, opening FurMe after each image opens. After the image changes are saved, the next image is opened.

This technique allows for going through a large number of images fairly quickly (note: this technique may not be useful for all image lists, it is useful, however, for album covers used only in one article, for example).

It is possible to have FurMeScroller automatically open any article in which an image is used, but in which it is not used in an infobox. When FurMeScroller opens this article, it will highlight the image in question in pink and give you the option of removing the image. See the [[User:AWeenieMan/furme#Configuration|Configuration]] section for removal options.

By default, FurMeScroller goes through ten images at a time. See the [[User:AWeenieMan/furme#Configuration|Configuration]] section for details on how to change this behavior.

=== Image lists for FurMeScroller ===
The following image lists are available. They are updated periodically (or upon request).

* Album Covers
** [[User:AWeenieMan/furme/DFUI/Album covers|All disputed fair use album covers]]
** [[User:AWeenieMan/furme/DFUI/Album covers/Usage1|Fair use album covers used in one article]]
** [[User:AWeenieMan/furme/DFUI/Album covers/Usage2|Fair use album covers used in two articles]]
** [[User:AWeenieMan/furme/DFUI/Album covers/Usage3|Fair use album covers used in three or more articles]]
* Book Covers
** [[User:AWeenieMan/furme/DFUI/Book covers|All disputed fair use book covers]]
** [[User:AWeenieMan/furme/DFUI/Book covers/Usage1|Fair use book covers used in one article]]
** [[User:AWeenieMan/furme/DFUI/Book covers/Usage2|Fair use book covers used in two articles]]
** [[User:AWeenieMan/furme/DFUI/Book covers/Usage3|Fair use book covers used in three or more articles]]
* Historic Images
** [[User:AWeenieMan/furme/DFUI/Historic images|All disputed fair use historic images]]
** [[User:AWeenieMan/furme/DFUI/Historic images/Usage1|Fair use historic images used in one article]]
** [[User:AWeenieMan/furme/DFUI/Historic images/Usage2|Fair use historic images used in two articles]]
** [[User:AWeenieMan/furme/DFUI/Historic images/Usage3|Fair use historic images used in three or more articles]]
* Logos
** [[User:AWeenieMan/furme/DFUI/Logos|All disputed fair use logos]]
** [[User:AWeenieMan/furme/DFUI/Logos/Usage1|Fair use logos used in one article]]
** [[User:AWeenieMan/furme/DFUI/Logos/Usage2|Fair use logos used in two articles]]
** [[User:AWeenieMan/furme/DFUI/Logos/Usage3|Fair use logos used in three or more articles]]
* Video Covers
** [[User:AWeenieMan/furme/DFUI/Video covers|All disputed fair use video covers]]
** [[User:AWeenieMan/furme/DFUI/Video covers/Usage1|Fair use video covers used in one article]]
** [[User:AWeenieMan/furme/DFUI/Video covers/Usage2|Fair use video covers used in two articles]]
** [[User:AWeenieMan/furme/DFUI/Video covers/Usage3|Fair use video covers used in three or more articles]]

== Configuration ==
To configure FurMe, copy the text below called FurMeConfig, and paste it in [[Special:Mypage/monobook.js|your monobook.js]] file.

This is the default configuration:
<syntaxhighlight lang=javascript>
if( typeof( FurMeConfig ) == 'undefined' ) FurMeConfig = {}; // DO NOT REMOVE THIS LINE - ALL FURME SETTINGS AFTER THIS
FurMeConfig.actionOnSubmit	= 'diff';
FurMeConfig.cleanAmazonURLs	= true;
FurMeConfig.furmeLocation	= 'tab';
FurMeConfig.imageRemovalMethod	= 'comment';
FurMeConfig.linkFreeLogo	= false;
FurMeConfig.linkImageTags	= true;
FurMeConfig.openAllArticles	= false;
FurMeConfig.openArticleMode	= 'none';
FurMeConfig.renameMethod	= 'ifd';
FurMeConfig.scrollerMax	= 10;
FurMeConfig.scrollerSkipDone	= true;
FurMeConfig.tagsImageLicenseFavorites	= [];
FurMeConfig.tagsImageTagFavorites	= [];
FurMeConfig.watchMyEdits	= false;
FurMeConfig.windowHeight	= 660;
</syntaxhighlight>

=== actionOnSubmit ===
Defines the action taken when you hit the "Submit Query" button.

Argument is a string, and the values might be 'none', 'diff', 'preview' and 'save'

=== cleanAmazonURLs ===
Defines if [[Amazon.com|Amazon]] URLs should be cleaned of extraneous URL parameters and normalized to the <nowiki>http://www.amazon.com/o/ASIN/%ASIN%</nowiki> format (note: this is domain sensitive, keeping the link to its current domain).

Argument is a boolean.

=== furmeLocation ===
Defines where the link to initialize FurMe is located.

Argument is a string with following values:
;'filetoc': in the file table of contents (box that says Image, File history, File links, etc)
;'personal': with the personal links (my talk, my preferences, my watchlist, etc)
;'tab': as a tab (discussion, history, etc)
;'toolbox': in the toolbox

=== imageRemovalMethod ===
Defines the method of removing an invalid fair-use image (only used when FurMe auto-opens an article).

Argument is a string with following values:
;'comment': comments the image in the fashion <nowiki><!-- Non-free image removed [[Image:Example.png]] --></nowiki>
;'nonfreeimageremoved': replaces image with [[:Image:NonFreeImageRemoved.svg]]
;'pixel': replaces image with [[:Image:Pixel.gif]]

=== linkFreeLogo ===
Defines if a new tab or link will be visible that allows the removal of non-free use rationales and license templates and places a {{tl|PD-textlogo}} license in its place. This option will place the new link using the [[#furmeLocation|furmeLocation]] option.

Argument is a boolean.

=== linkImageTags ===
Defines if a new tab or link will be visible that allows the replacement of license templates as well as the addition of various other image tags. This option will place the new link using the [[#furmeLocation|furmeLocation]] option.

Argument is a boolean.
                
=== openAllArticles ===
Defines if FurMeScroller will open multiple articles in which the image is used (to a max of ten). This option will not work with [[#openArticleMode|openArticleMode]] set to 'none' or 'window.'

Argument is a boolean.

=== openArticleMode ===
Defines if the article page should be opened when the image is used in only one article and not in that articles infobox.

Argument is a string with following values:
;'window': opens a (named) popup window
;'tab': tries if possible to open in a new tab (may or may not work)
;'blank': similar to window mode, but force it into a clean new window, instead of remembering the window
;'browser': Let the browser choose how to handle the (uniquely named) pop-up window (recommended)
;'none' : do not open the article

=== renameMethod ===
Defines the template used to mark an image for renaming.

Argument is a string with the following values:
;'ifd': Uses the {{Tlx|rename media}} template
;'bot': Uses the {{Tlx|rename media|suggested name}} template. See [[Wikipedia:Image renaming]].

=== scrollerMax ===
Defines the number of images through which to scroll when FurMeScroller is activated.

Argument is an integer value.

=== scrollerSkipDone ===
Defines if FurMeScroller should skip past images that do not have a deletion template.

Argument is a boolean.

=== tagsImageLicenseFavorites ===
Defines the favorites (listed at the top of the menu) for the license menu on the "tags" tab.

Argument is an array. Example:  [ 'PD-self', 'GFDL', 'PD-textlogo' ]

=== tagsImageTagFavorites ===
Defines the favorites section for the templates listed on the "tags" tab.

Argument is an array. Example:  <nowiki>[ '{{Trademark}}', '{{Information}}', '{{ShouldBeSVG}}' ]</nowiki>;

=== watchMyEdits ===
Defines whether to add edits made using FurMe to your watchlist.

Argument is a boolean.

=== windowHeight ===
Defines the height of the FurMe window. It is recommended that you do not include this preference unless you are experiencing problems with the default window height. The default value is subject to change (and will always be large enough to have the FurMe window appear without a scrollbar).

Argument is an integer value.

==Userboxes==
{{usbktop}}
{{usbk|User:Powergate92/Userboxes/FurMe}}
{{usbkbottom}}
{{Wikipedia technical help|collapsed}}
[[Category:Wikipedia scripts| FurMe]]