User:AndyZ/peerreviewer/guide - Wikipedia


Article Images

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 WP:MOS. Other topics covered by the script include: WP:CONTEXT, WP:GTL, WP:LEAD, WP:LINK, WP:SS, WP:FOOTNOTE, WP:PDATA, WP:AWT, and several subpages of WP:MOS including WP:MOSDATE. These tips tend to appear (based on my experiences) on WP:PR, WP:FAC, and WP:FARC (most of these tips are covered by my suggestions page). 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 WP:FAC or WP:GAC), nor will completing them guarantee that the article will pass both. The goal of the script is to supplement the advice of manual reviews by looking for common issues often overlooked by editors, as well as setting up a starting point for problems to work on while editors review articles with more comprehensiveness. Comments/questions about the suggestions can be placed directly on the PR/A page (I'll try to address all questions placed there) or at other locations, like the actual peer review for other editors to elaborate upon or my talk page.

Note: AZPR is not a BOT – it can be considered a semi-bot. The current automated peer review listings can be found at Wikipedia:Peer review/Automated/October 2024.

Some FAQs:

What is an automated peer review? And why is it called a peer review, if it is automated?

An automated peer review is a list of suggestions generated by JavaScript by searching an article for certain errors, mainly based on stylistic problems.

Peer is misleading; as the review is automated, it clearly is not by a peer (the script was written by peers though!). It is there simply to specify its purpose (instead of Featured Article Review, for example).

I'm confused. I clicked on the link, and I can't understand anything there.

First, make sure that you're at the right article (read the headings, or scroll back up to the Table of Contents). Though it may look daunting at first, it actually isn't that bad. If any of the suggestions are confusing, click on the provided links; if those don't help, notify me and I'll try to clarify it.

I don't like the automated peer reviews; I find them useless/overwhelming/rude.

Feel free to delete my notice if you find the autoPR unhelpful.

If you wish for me to skip over the article, add a comment somewhere on the Wikipedia:Peer review page saying <!--No User:AndyZ/peerreviewer--> (be sure that the User:AndyZ/peerreviewer part is typed exactly like that, the "No" is not necessary). You can still find the review at Wikipedia:Peer review/Automated/October 2024 though.

I found it helpful; where can I get an updated review?

To get an updated autoPR,

  • drop a note on my talk page (or that of any other user who has installed the script)
  • run the script yourself. To install it, see the simple installation instructions. If you don't wish to install it, there is an alternative method to run it quickly (though it might not work with the same effectiveness) — see here.

What can/do I do with the suggestions?

Pretty much anything. Feel free to strike out incorrect/nonapplicable/completed items, move them to other pages (talk, sandboxes, etc), or anything else.

I've installed the script, and it isn't working.

There are multiple reasons why this might happen. Some possibilities:

  • make sure the .js file is lowercased, and make sure that it matches your current skin (monobook is the default one).
  • if there has been recent activity in the history for User:AndyZ/peerreviewer.js, it is possible that I've accidentally made a mistake. If so, wait for a while before trying again, and hopefully I will have noticed it and fixed it by then.
  • there could be a conflicting script (however, I think that is highly unlikely now, unless you have the script installed twice).
  • remember to bypass your cache.
  • if nothing is happening, go to the edit mode for any main namespace article (like test). There should be a "peer review" link right next to the "log out" link, which is what you should click (don't click on the "send to WP:PR" tab!)

Suggestions specifics

lead

Content User:AndyZ/PR/lead
  • Please expand the lead to conform with guidelines at Wikipedia:Lead. The article should have an appropriate number of paragraphs as is shown on WP:LEAD, and should adequately summarize the article.[?]
Description The lead should conform to guidelines at WP:LEAD; it should have enough content to adequately summarize the article.
This appears because JavaScript looks for the number of new lines starting with actual letters (other characters, like {|<'[ will be ignored).

This message appears if:

  • there is one paragraph
  • there are only two paragraphs and the article is > 30,000 characters (30kb)
Known errors If a paragraph in the lead starts with some sort of wiki-syntax (a template, bold, a comment, etc.), it might not be counted as a paragraph. It also only looks at uppercase letters; for certain articles (like iPod), this could be a problem.

leadlong

Content User:AndyZ/PR/leadlong
  • The lead of this article may be too long, or may contain too many paragraphs. Please follow guidelines at WP:LEAD; be aware that the lead should adequately summarize the article.
Description The lead should conform to guidelines at WP:LEAD; the lead should be a concise but compelling summary of the article.
This appears because JavaScript looks for the number of new lines starting with actual letters (other characters, like {|<'[ will be ignored).

This message appears if:

  • there are more than 4 paragraphs
  • there are 4 paragraphs and the article is < 30,000 characters (30kb)
  • there are 3 paragraphs and the article is < 15,000 characters (15kb)
Known errors Since this is automated, not manual, it cannot tell the different between a newline in a table/comment and an actual paragraph; if the table/comment/other syntax is written in an unique fashion, like
{{infobox person |
name = whoever

instead of

{{infobox person
| name = whoever

extra paragraphs may be counted.

leaddetail

Content User:AndyZ/PR/leaddetail
  • The lead is for summarizing the rest of the article, and should not introduce new topics not discussed in the rest of the article, as per WP:LEAD. Please ensure that the lead adequately summarizes the article.[1]
Description
This appears because In the script, JavaScript searches for the number of paragraphs in the lead (using the method noted above). It does not actually check the content of the lead; this message only appears if the number of paragraphs in the lead exceeds 5.
Known errors See the errors listed at #leadlong.

infobox

Content User:AndyZ/PR/infobox
Description Articles often benefit from infoboxes, which can provide quick and easy-to-see information or link to related topics.
This appears because In the script, JavaScript searches for an infobox (or taxobox). If it doesn't find one, it displays the note.
Known errors Many articles will not have applicable infoboxes. If so, don't waste your time . Generally, articles that parallel other articles will have infoboxes (cities, mammals, military people, etc).

contxt

Content User:AndyZ/PR/contxt
Description Articles should follow MOS:DATE and WP:CONTEXT.
This appears because In the script, JavaScript searches for stand-alone linked years (like 2024), linked days of the week (Monday), and stand-alone linked month (March).
Known errors There is considerable debate surrounding if years should be linked or not at MOS:DATE. In general, the concensus is to link dates that provide context for the article.

linkdate

Content User:AndyZ/PR/linkdate
  • Years (2008) or months (January) by themselves are typically not linked. Per Wikipedia:Context, dates should not be linked purely for autoformatting purposes. In general, dates should not be linked unless there is a reason to do so.
Description Date linking allows the users to view them different depending upon their date preferences. Read more at MOS:DATE.
This appears because In the script, JavaScript searches for dates with years that have not been linked (like October 6, 2024 instead of October 6, 2024).
Known errors This may occur if retrieval dates in <ref> tags or other inline citations are not linked.

dateth

Content User:AndyZ/PR/dateth
Description Dates should not use ordinal suffices, namely [1]'st', [2]'nd', [3]'rd', [4-9]'th'.
This appears because In the script, JavaScript searches for dates in the format of: MONTH 1-2 digit NUMBER th and other layouts.
Known errors No known errors.

time

Content User:AndyZ/PR/time
  • Per WP:MOS, avoid using words/phrases that indicate time periods relative to the current day. [3]
Description Since we wish Wikipedia to continue on until the future, don't use times that are relative to today/now.
This appears because In the script, JavaScript searches for terms like 'soon' and 'recently'. Other terms like 'last day/month/year' are no longer searched for due to heavy inaccuracy.
Known errors This is no longer used (by default) in the script. If you wish to search for this and have installed the PR script, add a new line saying

mostime_PR = true;

nbsp

Content User:AndyZ/PR/nbsp
  • Per Wikipedia:Manual of Style (numbers), there should be a non-breaking space - &nbsp; between a number and the unit of measurement. For example, instead of 18mm, use 18 mm, which when you are editing the page, should look like: 18&nbsp;mm.[4]
Description To prevent units of measurements from falling off onto the next line, we use a non-breaking space. This is similar to a regular space, except it prevents the next word from falling off onto the next line when viewed on the webpage. If you had a measurement of, for example, 100 centimeters (250in), write instead 100&nbsp;centimeters (250&nbsp;in).
This appears because In the script, JavaScript searches for a regular expression
Known errors Before, 'in' was often interpreted as inch incorrectly. As a result, it is no longer searched for. The most common error for such would be in a link to another article (article titles don't include &nbsp;) or in an external link.

spellnum

Content User:AndyZ/PR/spellnum
Description Spell out units in text (but not conversions). Thus, 100 centimeters (250 in), not 100 cm (250 inches).
This appears because In the script, JavaScript searches standard abbreviations following numbers that are not trailed by a closing parenthesis.
Known errors In infoboxes, tables, and other templates, space is of concern, so it is proper to use abbreviations there.

abbrev

Content User:AndyZ/PR/abbrev
Description Use standard abbreviations for units of measurements in conversions (see example above).
This appears because In the script, JavaScript searches for measurements written out completely followed by a closing parenthesis.
Known errors No known errors.

headingthe

Content User:AndyZ/PR/headingthe
Description To avoid redundancy, do not start headings with articles ('a', 'an', 'the') unless necessary.
This appears because In the script, JavaScript searches for headings that start with the aforementioned articles.
Known errors Sometimes, the articles are necessary; in the majority of the cases they are not.

headingre

Content User:AndyZ/PR/headingre
Description Don't repeat the title of the article in headings, as the title is implied as the subject for the section. Otherwise, it would be redundant.
This appears because In the script, JavaScript searches for the title (without disambiguation parentheses information) in all lines that are headings (start with ==).
Known errors The title should be repeated for the names of proper nouns. (A fictitious example: if Washington had a heading for the capitol of the United States, it would be ==Washinton D.C.==, not ==D.C.==).

Content User:AndyZ/PR/headinglink
Description Avoid linking words in headings. This is for style and readability. Instead, use the link in the first sentence after the heading.
This appears because In the script, JavaScript searches for a [[ blah ]] in headings (lines that start with ==).
Known errors No known errors.

gtl

Content User:AndyZ/PR/gtl
Description The order of the final few sections is:
  • See also
  • [Foot]Notes
  • References
  • Further reading
  • External links

References can also go before Notes.

This appears because In the script, JavaScript searches for the sections see also, references/footnotes, and external links, and compares their relative positions.
Known errors No known errors.

Content User:AndyZ/PR/overlink
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

Content User:AndyZ/PR/underlink
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

bold

Content User:AndyZ/PR/bold
  • Please do not extraneously bold items outside of the bolding in the lead.
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

footspace

Content User:AndyZ/PR/footspace
  • As done in WP:FOOTNOTE, footnotes usually are located right after a punctuation mark (as recommended by the CMS, but not mandatory), such that there is no space inbetween. For example, the sun is larger than the moon [2]. is usually written as the sun is larger than the moon.[2]
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

alpha

Content User:AndyZ/PR/alpha
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

how

Content User:AndyZ/PR/how
  • Please avoid including instruction manuals, tutorials, etc. or other 'how-to's per WP:NOT.
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

ref

Content User:AndyZ/PR/ref
  • The article will need references. See WP:CITE and WP:V for more information.
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

Content User:AndyZ/PR/foot
  • This article needs footnotes, preferably in the cite.php format recommended by WP:WIAFA. Simply, enclose inline citations, with WP:CITE or WP:CITE/ES information, with <ref>THE FOOTNOTE</ref>. At the bottom of the article, in a section named “References” or “Footnotes”, add <div class="references-small"><references/></div>.[7]
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

noimg

Content User:AndyZ/PR/noimg
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

leadimg

Content User:AndyZ/PR/leadimg
  • See if possible if there is a free use image that can go on the top right corner of this article.[9]
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

imgtag

Content User:AndyZ/PR/imgtag
  • Images need proper image copyright tags and source information. Several images are missing proper tags.
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

imgfu

Content User:AndyZ/PR/imgfu
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

caption

Content User:AndyZ/PR/caption
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

ig

Content User:AndyZ/PR/ig
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

toc

Content User:AndyZ/PR/toc
  • Per WP:WIAFA, this article's table of contents (ToC) may be too long- consider shrinking it down by merging short sections or using a proper system of daughter pages as per Wikipedia:Summary style.[11]
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

expand

Content User:AndyZ/PR/expand
  • This article is a bit too short, and therefore may not be as comprehensive as WP:WIAFA critera 2(b) is looking for. Please see if anything can be expanded upon.
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

sectexpand

Content User:AndyZ/PR/sectexpand
  • There are a few sections that are too short and that should be either expanded or merged.
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

SS

Content User:AndyZ/PR/SS
  • This article may need to undergo summary style, where a series of appropriate subpages are used. For example, if the article is United States, than an appropriate subpage would be History of the United States, such that a summary of the subpage exists on the mother article, while the subpage goes into more detail.
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

copyedit

Content User:AndyZ/PR/copyedit
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

awt

Content User:AndyZ/PR/awt
  • There are a few occurrences of weasel words in this article- please observe WP:AWT. Certain phrases should specify exactly who supports, considers, believes, etc., such a view. [13]
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

list

Content User:AndyZ/PR/list
  • This article may be a bit list-weighty; in other words, some of the lists should be converted to prose (paragraph form). [14]
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

trivia

Content User:AndyZ/PR/trivia
  • Generally, trivia sections are looked down upon; please either remove the trivia section or incorporate any important facts into the rest of the article.
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors

persondata

Content User:AndyZ/PR/persondata
  • If this article is about a person, please add {{persondata}} along with the required parameters to the article - see Wikipedia:Persondata for more information.
Description
This appears because In the script, JavaScript searches for a regular expression
Known errors
  1. ^ See footnote
  2. ^ See footnote
  3. ^ See footnote
  4. ^ See footnote
  5. ^ See footnote
  6. ^ See footnote
  7. ^ See footnote
  8. ^ See footnote
  9. ^ See footnote
  10. ^ See footnote
  11. ^ See footnote
  12. ^ See footnote
  13. ^ See footnote
  14. ^ See footnote