User:AWeenieMan/furme

From Wikipedia, the free encyclopedia

Be advised that you take full responsibility for any action performed using FurMe. You must understand Wikipedia policies and use this tool within these policies, or risk being blocked.

Shortcut: WP:FURME

FurMe is a set of JavaScripts that gives registered users a convenient way to add 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 TWINKLE doc page for more information).

Notes

1. This script is tested only on Mozilla Firefox (and unofficially Opera). It will not work on Microsoft Internet Explorer.

Contents 1 Installation 2 Functionality of FurMe 2.1 Auto fill-in of fields 2.2 Removal of templates 2.3 Removal of categories 2.4 Preview/Saving changes 2.5 General Cleanup 3 Functionality of FurMeScroller 3.1 Image lists for FurMeScroller 4 Configuration 4.1 actionOnSubmit 4.2 cleanAmazonURLs 4.3 furmeLocation 4.4 imageRemovalMethod 4.5 linkFreeLogo 4.6 openAllArticles 4.7 openArticleMode 4.8 renameMethod 4.9 scrollerMax 4.10 scrollerSkipDone 4.11 watchMyEdits 4.12 windowHeight

[edit] Installation

To install FurMe, including all future updates and additions:

• If you have TWINKLE or FRIENDLY installed, copy the text below and paste it into the bottom of your monobook.js file:

  importScript('User:AWeenieMan/furme.js');

• If you do not have either TWINKLE or FRIENDLY installed, copy the text below and paste it into the bottom of your monobook.js file:

  importScript('User:AzaToth/morebits.js');
  importScript('User:AWeenieMan/furme.js');

• If you would also like FurMeScroller functionality, copy the text below and paste it into the bottom of your monobook.js file:

  importScript('User:AWeenieMan/furmeScroller.js');

• Save the new monobook.js page, and
• Completely refresh your browser by bypassing your cache (Firefox: Control-Shift-R / Firefox Mac: Command-Shift-R / Explorer: Control-F5)
• Done!

[edit] 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.

• {{non-free use rationale}}
• {{logo fur}}
• {{album cover fur}}
• {{book cover fur}}
• {{film cover fur}}

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

[edit] Auto fill-in of fields

FurMe attempts to fill in certain fields, as described below.

• {{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.

• {{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.

• {{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

• {{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

• {{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

[edit] 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).

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

[edit] Removal of categories

FurMe will remove the following categories from pages it edits.

• Category:Disputed non-free images (and date based subcategories)

[edit] 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 Configuration section for details on how to change this behavior.

[edit] General Cleanup

FurMe makes the following minor cleanup to the page.

• Will change ==Summary== to == Summary ==
• Will add == Summary == (if it does not already exist)
• Will add == Licensing == (if it does not already exist) above the non-free license template
• Will clean Amazon URLs, stripping extraneous parameters and normalizing format

[edit] 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 Configuration section for removal options.

By default, FurMeScroller goes through ten images at a time. See the Configuration section for details on how to change this behavior.

[edit] Image lists for FurMeScroller

The following image lists are available. They are updated periodically (or upon request).

• Album Covers
  • All disputed fair use album covers
  • Fair use album covers used in one article
  • Fair use album covers used in two articles
  • Fair use album covers used in three or more articles
• Book Covers
  • All disputed fair use book covers
  • Fair use book covers used in one article
  • Fair use book covers used in two articles
  • Fair use book covers used in three or more articles
• Historic Images
  • All disputed fair use historic images
  • Fair use historic images used in one article
  • Fair use historic images used in two articles
  • Fair use historic images used in three or more articles
• Logos
  • All disputed fair use logos
  • Fair use logos used in one article
  • Fair use logos used in two articles
  • Fair use logos used in three or more articles
• Video Covers
  • All disputed fair use video covers
  • Fair use video covers used in one article
  • Fair use video covers used in two articles
  • Fair use video covers used in three or more articles

[edit] Configuration

To configure FurMe, copy the text below called FurMeConfig, and paste it in your monobook.js file.

This is the default configuration:

FurMeConfig = {
        actionOnSubmit                  :  'diff',
        cleanAmazonURLs                 :  true,
        furmeLocation                   :  'tab',
        imageRemovalMethod              :  'comment',
        linkFreeLogo                    :  false,
        openAllArticles                 :  false,
        openArticleMode                 :  'none',
        renameMethod                    :  'ifd',
        scrollerMax                     :  10,
        scrollerSkipDone                :  true,
        watchMyEdits                    :  false,
        windowHeight                    :  660
};

[edit] 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'

[edit] cleanAmazonURLs

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

Argument is a boolean.

[edit] 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

[edit] 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 <!-- Non-free image removed [[Image:Example.png]] -->

'nonfreeimageremoved'

replaces image with Image:NonFreeImageRemoved.svg

'pixel'

replaces image with Image:Pixel.gif

[edit] 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 {{PD-textlogo}} license in its place. This option will place the new link using the furmeLocation option.

Argument is a boolean.

[edit] 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 set to 'none' or 'window.'

Argument is a boolean.

[edit] 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

[edit] renameMethod

Defines the template used to mark an image for renaming.

Argument is a string with the following values:

'ifd'

Uses the {{ifd}} template

'bot'

Uses the {{rename media}} template. Please note, to use this method you must be on the approved users list. See Wikipedia:Image renaming.

[edit] scrollerMax

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

Argument is an integer value.

[edit] scrollerSkipDone

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

Argument is a boolean.

[edit] watchMyEdits

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

Argument is a boolean.

[edit] 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.