Pikipedia

User:Espyo/Pikan: Difference between revisions

User page Discussion

User:Espyo/Pikan (view source)

Revision as of 23:26, September 30, 2023

4,110 bytes added ,  1 year ago
m
no edit summary
No edit summary
mNo edit summary
 
(32 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[File:Pikan 1.jpg|thumb|The button created by Pikan.]]
'''Pikan''' is a Javascript script I made for Pikipedia. The name is short for "'''Pik'''ipedia '''an'''alyzer", and it creates a new button on the editing interface that, when pressed, runs an analyzer that reports problems with the page. These range from important things that need to be fixed as soon as possible (like old page links linking to Wikia), to stylistic issues (like pointless spaces at the end of lines). Its use is completely optional, but if you want to make sure that your edit is spotless, you should run it.
'''Pikan''' is a Javascript script I made for Pikipedia. The name is short for "'''Pik'''ipedia '''an'''alyzer", and it creates a new button on the editing interface that, when pressed, runs an analyzer that reports problems with the page. These range from important things that need to be fixed as soon as possible (like old page links linking to Wikia), to stylistic issues (like pointless spaces at the end of lines). Its use is completely optional, but if you want to make sure that your edit is spotless, you should run it.


Line 6: Line 7:


==Source==
==Source==
{{see|User:Espyo/pikan.js}}
{{see|MediaWiki:Gadget-Pikan-core.js}}
{{see|MediaWiki:Gadget-Pikan-pikipedia.js}}


==Analyzing==
==Analyzing==
[[File:Pikan 2.jpg|thumb|500px|Example of Pikan finding a problem.]]
The problems are split into four categories:
The problems are split into four categories:


*'''Problem''': General problem; something bad on the page that you should really fix.
*'''Problem''': General problem; something bad on the page that you should really fix.
*'''Policy''': A problem that contradicts Pikipedia's policy, explicit or implied (i.e. either a policy on the [[Pikipedia:Policy|policy]] pages, or a "common sense" policy, like "Pikmin" with a lowercase p).
*'''Policy''': A problem that contradicts Pikipedia's policy, explicit or implied (i.e. either a policy on the [[Pikipedia:Policies and guidelines|policy]] pages, or a "common sense" policy, like "Pikmin" with a lowercase p).
*'''Question''': The analyzer found something, but it can't tell for sure if the match is a problem or not. It's up to you to decide what to do, even if that means ignoring the analyzer's result.
*'''Question''': The analyzer found something, but it can't tell for sure if the match is a problem or not. It's up to you to decide what to do, even if that means ignoring the analyzer's result.
*'''Style''': Problems that won't affect the reader, but that should still be fixed to make sure the analyzer runs well, and that future editors will have a nice clean editing experience.
*'''Style''': Problems that won't affect the reader, but that should still be fixed to make sure the analyzer runs well, and that future editors will have a nice clean editing experience.


The following is a list of all problems it checks for:
The following is a list of all problems it checks for:
{{clear}}
===Problem===
===Problem===
{{columns|2|
{{columns|2|
Line 30: Line 34:
* Finds game names without italicization.
* Finds game names without italicization.
* Finds "Pikmin 1", "Pikmins", and "Pikmin" without lowercase p.
* Finds "Pikmin 1", "Pikmins", and "Pikmin" without lowercase p.
* Finds links to the ambiguous page [[Pikmin]],
* Finds links to the ambiguous pages [[Pikmin]] and [[Challenge Mode]].
* Finds Pikmin type names in lowercase.
* Finds Pikmin type names, "Onion", and "Poko" that start in lowercase.
* Finds words that start in uppercase needlessly.
* Finds words that start in uppercase needlessly.
* Finds "NTSC", "PAL", "beta" and "alpha".
* Finds "NTSC", "PAL", "beta" and "alpha".
* Finds ''Pikmin'' area names without the "The" (and capitalized as such).
* Finds ''Pikmin'' area names without the "The" (and capitalized as such).
* Finds references that aren't using {{tem|refs}}.
* Finds references that aren't using {{tem|refs}}.
* Finds links to Wikipedia that aren't using {{tem|w}}.
* Finds missing "see also" sections.
* Finds missing "see also" sections.
* Finds "strategy" and "external links" sections with bad names.
* Finds "strategy" and "external links" sections with bad names.
Line 55: Line 60:
* Finds "captain", and suggests "leader" instead.
* Finds "captain", and suggests "leader" instead.
* Finds gendered nouns.
* Finds gendered nouns.
* Finds quotes and italics and suggests the usage of {{tem|transcript}} instead.
}}
}}


Line 78: Line 84:


===Changelog===
===Changelog===
''Still on version 1.0.0.''
Small bug fixes, typos, etc. will not be counted for here. If there was an update recently and you cannot see the changes on your end, try refreshing the page while bypassing the cache (usually you do this by pressing Ctrl+F5).
 
====Pre-split====
*1.0.0 ({{date|4|June|2015}}):
**Initial version.
*1.1.0 ({{date|17|June|2015}}):
**Made it find links to the ambiguous page [[Challenge Mode]].
*1.2.0 ({{date|8|July|2015}}):
**Made it find italics and quotes, and suggest {{tem|transcript}} instead.
*2.0.0 ({{date|11|July|2015}}):
**Split the core module from the Pikipedia module. This increases portability. Unfortunately, this removes Greasemonkey support.
 
====Post-split core====
*2.1.0 ({{date|23|November|2015}}):
**Added the script's core and module version to the help tooltip (the [?] next to the scan button).
*2.2.0 ({{date|30|January|2017}}):
**Fixed Pikan not working randomly if the advanced editor is enabled.
 
====Post-split Pikipedia module====
*1.1.0 ({{date|10|September|2015}}):
**Made it find "Poko" starting with a lowercase P.
*1.2.0 ({{date|23|November|2015}}):
**Corrected the help URL, and specified the module's version and name.
*1.3.0 ({{date|28|January|2016}}):
**Made it find Wikipedia links that aren't using {{tem|w}}.
*1.4.0 ({{date|12|February|2017}}):
**Updated policy and guideline links.
*1.5.0 ({{date|12|June|2018}}):
**Added {{ssbu}}.
*1.6.0 ({{date|27|October|2018}}):
**Corrected instances of "for 3DS" to "for Nintendo 3DS", when referring to the fourth ''Super Smash Bros.'' game.
*1.7.0 ({{date|24|June|2020}}):
**Corrected the rule that says gallery images should have captions ending in periods, since it was not recognizing galleries with properties.
*1.8.0 ({{date|27|October|2021}}):
**Added {{pb}}.
*1.9.0 ({{date|13|September|2022}}):
**Added {{p4}}.
*1.10.0 ({{date|29|July|2023}}):
**Made it find misspellings of [[Shepherd]].
**Made it find links to [[Piklopedia]].
**Improvements to the way it detects if there is an image in the article.
**Improvements to the way it detects "you" outside of quotes and transcripts.
*1.11.0 ({{date|26|August|2023}}):
**Made the {{game icons}} check not trigger if there's an infobox.
**Made the trailing space check not trigger if it's a template placeholder parameter.


===Future===
===Future===
;Known bugs:
;Known problems:
None at the moment.
* The script detects things like "you" inside of quotes, when it shouldn't.


;Future plants:
;Future plans:
None at the moment.
* Make it suggest spreading out large templates with one argument per line, plus align the templates with spaces for padding.
* Make it not recommend empty line paddings before section headers if there is a {{tem|clear}}.


==Outside use==
==Outside use==
I also made Pikan with flexibility in mind. Feel free to grab the script and change it to your own will. I even added Greasemonkey information so you can run it as a Greasemonkey script. If you want to add the script to your wiki, you can change the problems and matches it checks for simply by editing the pikan.find_problems function. Quick guide:
I also made Pikan with flexibility in mind. If you want to add the script to your wiki, follow these steps:


* Change <code>pikan.url</code> to point to your wiki. This is used for the "[More info]" links.
* Create your own copy of [[MediaWiki:Gadget-Pikan-pikipedia.js|Gadget-Pikan-pikipedia.js]] (naming it whatever you want).
* Change the first few parameters to match your wiki (e.g. wiki_url, module_name, etc.).
* Edit pikan.find_problems to your suiting.
* Edit pikan.find_problems to your suiting.
** To find a simple problem with regex, do it like this:
** To find a simple problem with regex, do it like this:
Line 97: Line 149:
::* You can add one more parameter to regex_check. This is a function that takes one regex match, and returns false if this match doesn't apply to match the problem with.
::* You can add one more parameter to regex_check. This is a function that takes one regex match, and returns false if this match doesn't apply to match the problem with.
:* To create your own code to find a problem, you can add the problem to the list with pikan.save_problem. Check the function in the code for a documentation comment explaining it.
:* To create your own code to find a problem, you can add the problem to the list with pikan.save_problem. Check the function in the code for a documentation comment explaining it.
:* There are more helper functions in the code. I documented all of them. At the end, you'll find code that's more or less Pikipedia-specific, so you can probably delete that.
:* There are more helper functions in the code. I documented all of them. Use those as well, if needed.
* If your wiki has the [[mw:Extension:Gadgets|Gadgets extension]] installed, then add an entry for Pikan to your MediaWiki:Gadgets-definition page:
<pre>* Pikan[ResourceLoader|default|actions=edit]|Pikan-core.js|Pikan-website.js</pre>
And create your own version of [[MediaWiki:Gadget-Pikan-core.js]] by copying its contents or adding just the following line:
<pre>mw.loader.load('https://www.pikminwiki.com/MediaWiki:Gadget-Pikan-core.js?action=raw&ctype=text/javascript');</pre>
* If your wiki doesn't have the Gadgets extension, then on your wiki's MediaWiki:Common.js, import Pikan like so:
<pre>if (mw.config.get('wgAction') === 'edit' || mw.config.get('wgAction') === 'submit') {
  mw.loader.getScript('https://www.pikminwiki.com/MediaWiki:Gadget-Pikan-core.js?action=raw&ctype=text/javascript').then(
    function() {
      mw.loader.load('//your.wiki/url/MediaWiki:Gadget-Pikan-website.js?action=raw&ctype=text/javascript');
    }
  );
}</pre>
Update the second URL to point to the raw source of your own version of Gadget-Pikan-pikipedia.js (again, named whatever it is you wanted).


==FAQ==
==FAQ==
;Why do I have to press search again every time I make a change?
;Why do I have to press search again every time I make a change?
:Because the positions of the old problem matches will be changed when you edit, and there's no reasonable way to keep track of them as you add and delete text.
:Because the positions of the old problem matches will be changed when you edit, and there's no reasonable way to keep track of them as you add and delete text.
;Why can't I see the scan button, or why am I using an older version?
:Pikan should update automatically, but you might be on a cached version of the page that's using old versions of the scripts. You can refresh and skip the cache (normally by pressing Ctrl+F5), or you can add "&debug=true" to the end of the page's URL.
Retrieved from "https://www.pikminwiki.com/Special:MobileDiff/150011...275502"