User:AndyZ/peerreviewer

Current Archives General info Installation Guide to tips Source code

Introduction

Despite its name, reviews created by this script aren't by peers, but by a JavaScript (written by peers, though). "Peer" is in there to clarify its purpose.

The suggestions generated by the script focus largely on style issues, e.g. those that can be found on

). Though most of the tips are generally accurate, some will not be accurate/applicable for the article in question.

Fixing the generated issues is not mandatory (for

.

Note:

.

Some FAQs [edit]:

Installation

You do not need to have an account in order to use this tool. (However, if you don't, please make one).

For logged-in users, follow the instructions below. IP users or users who do not wish to install the script (for whatever reason) can follow the directions below. If you still cannot understand the following instructions or receive an error that seemingly can't be fixed no matter what you do, just drop a note on my talk page.

Logged in

For those of you who are familiar with the process, you can skip this section (the source code is at

. In more detail:

1. The following instructions assume you are using the default Vector skin on Wikipedia. If you are using a different skin then you need to edit a different file and ignore references to "vector.js". If you are using the Monobook skin then you need to edit monobook.js and so on.
2. Open your vector.js (link: vector.js).
3. Add the following line to your vector.js:

   {{subst:js|User:AndyZ/peerreviewer.js}}

   which should expand to the contents of Template:js.

4. Save and then
   WP:BYC
   .
5. Go to edit mode for any article (must be in the article namespace). There should be a "peer review" link right next to the "log out" link. On clicking, it presents suggestions for the article generated by the code. (Some suggestions will appear in template form because they contain parameters – the content of these can be found by searching on
   User:AndyZ/PR
   or by copy+pasting the suggestions to a new page [sandbox, talk, etc.] and using the preview/save buttons).

   To have the "peer review" link appear next to the "log out" link for articles while not in edit mode also, add to your monobook.js:

   toolbarLink_PR = true;

   Other configurable options are listed below, at #Options.

Problems? Make sure that you

(and also that JavaScript is not disabled).

If this fails (from Wikipedia:Tools/Navigation popups/FAQ), if you have a lot of stuff in your user javascript file, it's possible that it's conflicting with the script. Remove everything except the PR installation and see if that helps. If it does then you can start adding things back piece by piece to see where the conflict lies.

Note that the script may conflict with itself if it is loaded twice.

Anons/lazy users

IP users and logged-in users who don't wish to install the script directly can still use this script, but it will be less convenient. While in edit mode for an article, replace the URL (address) bar with (be sure to copy the entire thing!):

javascript:importScript('User:AndyZ/peerreviewer.js');output_PR = 'wpTextbox1';JSpeerreview_simple();

Hit Go/Press Enter, and this will simply replace the article with the suggestions (be sure NOT to save!, but you can use the 'Show preview' button to see the suggestions). However, this will lack the options and versatility of directly installing the script. Also note that this will cause several errors, but these shouldn't affect the actual output of the script.

To bookmark/add this to favorites, see /bookmark.

Uninstallation

The uninstallation is simple: search your monobook.js for the following line and delete it, and then

:

importScript('User:AndyZ/peerreviewer.js'); //[[User:AndyZ/peerreviewer.js]]

Features

BSD

) is shown.

Note: whenever I mention monobook.js below, it also applies to the other JS files based on the current skin

The main purpose of the peer reviewer script is to create

).

A secondary feature is to make an automated style cleanup of the article. This will only take care of a few minor issues (from

.

• Configurable:

Basic spell-checking is also provided by the script (similar to User:Lupin's anti-vandal script s spell-checker), but will not work like MS Word's or that of other spell-checking software. Instead, this is based upon common misspellings found at Wikipedia:Lists of common misspellings/For machines (If you think the list of common misspellings is faulty, please view and/or prudently edit it). While the script will take considerably long to execute, it may help to locate some typos. To use this, add spellcheck_PR = true; to your monobook.js.

For maintainers of

. These however will inhibit normal activity on Wikipedia (ex. it opens up the review immediately). To use this, add maintain_PR = true; to your monobook.js.

Also provided in the script is a tab that states "send to WP:PR". Clicking on the tab completes most of the

, and the starting of the actual nomination text. Be sure to use the difference button to check these edits before submitting them. (no longer in use; may attempt to restore later. To try, use sendTo_PR = true;)

---

Transcluded scripts

• Instaview, the Live Preview script written by User:Pilaf (2005-6), is included within the PR script. To use it, add showInstaview_PR = true; on a new line to your monobook.js. It allows you to preview pages without having to reload the page by clicking the 'Show preview' button.

• User:Omegatron's addlink script is included. Alone, the addlink script does nothing; it is a helper script to include tabs/links to execute other functions.

• User:Gimmetrow's ref fixer script, which cleanups footnote spacing problems, is executed with the autoformatting button.

• MOS:NUM
  issues, and can be executed again with the autoformatting button. (The controversial date-delinking part of the script has been excised)

• Several parts of Wikipedia:WikiProject User scripts/Scripts/Formatter (most contributions from User:Bluemoose, User:Mathwiz2020) are also included.

Suggestions

List of things checked by script

Main page: User:AndyZ/peerreviewer/guide

• Length of lead (based on
  WP:LEAD
  )
• Recent terms (
  WP:MOS#Time
  )
• Checking for captions for images (
  WP:CAPTION
  )
• Checks image licensing information – looks for
  fair use
  , it looks for a fair use rationale. (note: there is an occasional bug for images on the wikimedia commons) not currently working¹
• Looks for <gallery> tags, which are discouraged by
  WP:IG
  .
• Looks for infobox/taxobox/etc.
• In biography articles, looks for the metadata template {{persondata}} (
  WP:PDATA
  )
• Checks if numbers +units of measurements are separated by no-breaking spaces (&nbsp;, see
  WP:MOSNUM
  )
• Usage of standard abbreviations in parentheses (again,
  WP:MOSNUM
  )
• Spelling out of units in text (again,
  WP:MOSNUM
  )
• Looks for an 's' appended to standard abbreviations in parentheses (again,
  WP:MOSNUM
  )
• Makes sure that dates aren't followed by th (
  WP:MOSDATE
  )
• Checks that the is not at the front of headings (
  WP:MOS#Headings
  )
• Checks that the title is not repeated in headings (
  WP:MOS#Headings
  )
• Sees if there is a trivia, miscellaneous topics, etc. section
• Sees if there is a "how-to" section, which is disapproved of by
  WP:NOT
• Looks for references (
  WP:V
  )
• Proper order of final sections – See also, References, External links (
  WP:GTL
  )
• categories) in alphabetical order (see #Options
  )
• The length of the TOC and overall of the article (
  WP:SS
  )
• Looks for weasel words (
  WP:AWT
  )
• Checks between American English and British English
• Looks for common redundancies (
  User:Tony1/How to satisfy Criterion 1a
  )
• Searches for
  footnotes
  and posts a reminder if it finds {{fact}}
• If desired, a simple spell-checker (see #Options)¹
• By default, it will post a copyediting reminder
• Have another idea for the script to check? Post a note on the talk page.

¹uses ajax

Formatter

Issues formatted by button

• Bobblewik's scripts, including the unit-formatting (w/ nbsp) and the dates. The delinking section of Bobblewik's dates script has been excised; it can be restored by setting the variable context_PR = true;.
  • The unit formatting script add spaces (but not nbsp;s) between numbers and units and corrects certain units into the proper format.
  • The nbsp unit formatting script then adds   between many numbers and their respective units.
  • The dates script cleans up
    MOS:DATE
    issues, including unnecessary links to days of the week, incorrect date grammar (like 1930's -> 1930s), and others (no delinking of years/centuries).
• Gimmetrow's fixRefs.js corrects footnote spacing problems.
• Parts of Wikipedia:WikiProject User scripts/Scripts/Formatter are incorporated. These include spacing, formatting, and other simple fixes.
• Other random
  WP:PDATA, and a basic conversion of incomplete external link ref citations to use Template:Cite web
  .

Options

To change a configurable option, add a line to your monobook.js:

option = value;

, replacing option with the name of the variable from below, and value with one of the possible values listed below.

Be sure to copy the option exactly as it is written on the table. Only add quotes (single (') or double (")) if the Other values column states to do so. Beneath the table are explanations for some of the more complicated/unique variables.

Configurable options edit

Configurable options

Variable name	Description	Default value	Other values (outside of default)
	Opening suggestions
allSpaces_PR	controls which namespaces the peer review link shows up in	false (only article namespace)	true (all namespaces)
defaultView_PR	how the suggestions are provided: if 0, it will be normal; if 1, it will show suggestions in WP:PR/A or the current PRA page	0	1, 2
select_PR	selects the suggestions text, making it easier for copying+pasting	false	true
popup_PR	places the next suggestions in a new window (not available yet)	false	true
sendTo_PR	adds the send to WP:PR button in edit mode	false	true
toolbarLink_PR	shows the toolbar link even on non-edit mode pages (creates a new window on clicking)	false	true
toolbar_PR	which toolbar the link appears on	"personal"	"cactions", "navigation"
width_PR	the width of the suggestion box	1200	an integer
userSandbox_PR	as of now, it has no use, but it may become useful later – the name of your sandbox	username + "/sandbox" (actual code is: "User:" + wgUserName + "/sandbox")	name of user sandbox, in quotes
	Output
noXHR_PR	disables XMLHTTPRequest ) stops the spellchecker and image licensing checks if turned to true	false	true
spellcheck_PR	does a spell check for the article, based on comon mispelings Note that this causes the script to take a much longer time to execute	false	true
showInstaview_PR	provides a live preview button, [awesome] script (BSD) by Pilaf	false	true
instaview_PR	preview the suggestions provided by the script without having to go through the agonizing process of copy+pasting onto a new page and pressing the diff button	true	false
directRef_PR	uses direct <ref> tags to footnotes on pages like WP:PR/A	false	true
cat_PR	gives a note about categories if they are not alphabetized	false	true
showHeading_PR	shows a level 3 heading containing a link to the article, used mainly for maintenance of WP:PR/A	false	true
initMsg_PR	the message that is automatically shown for the introduction	"The following suggestions were generated by a semi-automatic [[User:AndyZ/peerreviewer.js|javascript program]], and might not be applicable for the article in question."	message, in quotes
endMsg_PR	the message that is automatically shown for the closing	"\nYou may wish to browse through [[User:AndyZ/Suggestions]] for further ideas. Thanks, ~~~~\n\n\n"	message, in quotes
	Style
topBarColor_PR	changes the color of the top (close) bar when the suggestions are displayed	"red"	a web color , in quotes
botBarColor_PR	changes the color of the bottom bar when the suggestions are displayed	"#cccccc"	a web color , in quotes
restoreText_PR	the text for the restoration button (the yellow one)	"[restore]"	text, in quotes
restoreStyle_PR	the style for the restoration button	"background:yellow; position:absolute; margin-left:5px margin-top:120px;"	style attributes, in quotes (note that z-index and visibility have already been defined)
	Autoformat
expandContractions_PR	Attempt to exapand common contractions such as "can't" to "cannot"	true	false
	Other
maintain_PR	some maintenance functions are provided for ease for updating WP:PR pages, opens up suggestions on edit mode immediately, etc.	false	true (not recommended, or turn to false afterwards)

Notes:

• defaultView_PR – if assigned the value of 1, the suggestions will appear in template format (instead of posting the suggestions in prose, it will list almost all of the generated suggestions as {{subst:User:AndyZ/PR/~~}}). Pros: after checking the diffs or saving, the output will exactly match the template, while it may be slightly outdated if it were listed out in prose. Cons: it is hard to understand what the template is dealing with.
• If it is assigned the value of 2, the suggestions will be in prose and will be followed with footnotes. These footnotes link to notes on
  WP:PR/A
  or its subpages)
• toolbar_PR – "cactions" refers to the tabs (similar to the edit, move, etc.); "navigation" refers to the navigation links at the top left hand corner. With both, the peer review link will be at the bottom of the list.
• cat_PR – alphabetizing categories is controversial; therefore, the suggestions will not note about the alphabetization of categories unless this variable is set to true (but it will note
  WP:ILs
  )
• restoreStyle_PR – see
  CSS
  . Style attributes are listed, following by a colon/equal sign and the value for the attributed. Ex. to set the color to orange instead, use restoreStyle_PR = "background:orange";.