User talk:AndyZ/peerreviewer.js/options

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 template format; if 2, it will show footnotes which can be found on 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 ajax (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/A and its subpages: automatically saves notices on WP:PR pages, opens up suggestions on edit mode immediately, etc.	false	true (not recommended, or turn to false afterwards)