Wikipedia:WikiProject Articles for creation/Helper script: Difference between revisions

Revision as of 17:57, 24 June 2012

Latest revision as of 17:05, 22 August 2024

(187 intermediate revisions by 49 users not shown)

Line 1:

{{WPAFC-adminpp|small=y}}

__NOTOC__

{{Infobox software

{{redirect|WP:AFCH|the Articles for creation helpdesk|Wikipedia:WikiProject Articles for creation/Help desk}}

| name = AFCH

| title ={{Wikipedia:WikiProject Articles for creation helper script/tabs}}

{{tool warning|the Articles for Creation Helper Script}}

| logo = [[File:AFC-Logo.svg]]

| screenshot = <!-- [[File: ]] -->

| caption =

| collapsible =

| author = [[User:Timotheus Canens]]

| developer = [[User:mabdul]]

| released = <!-- {{Start date|YYYY|MM|DD|df=yes/no}} -->

| latest release version = 4.1.12

| latest release date = {{Start date and age|2012|06|24|df=yes}}

| latest preview version = 4.1.13

| latest preview date = {{Start date and age|2012|06|24|df=yes}}

| programming language = [[JavaScript]] (using [[Ajax (programming)|Ajax]], [[CSS]], and [[HTML]])

| platform = [[web browser]]

| language = English

| status = active development

}}

{{Shortcut|WP:AFCH}}

{{infobox user script

'''Yet another AFC Helper Script''' is a Wikipedia [[WP:JS|script]] designed to help when reviewing Articles for creation [[CAT:AFC|article]] and [[WP:AFC/R|redirect]] submissions.

| name = Articles for Creation Helper Script (AFCH)

| desc = Accept, decline, or reject pages in the draft namespace

| author = [[User:Theopolisme|Theopolisme]]

| maintainer = [[User:Novem Linguae|Novem Linguae]]

| version =

| updated =

| source =

* [[MediaWiki:Gadget-afchelper.js]]

* [[MediaWiki:Gadget-afchelper.css]]

* [[MediaWiki:Gadget-afchelper.js/core.js]]

* [[MediaWiki:Gadget-afchelper.js/submissions.js]]

* [[MediaWiki:Gadget-afchelper.js/tpl-submissions.js]]

* [[MediaWiki:Gadget-afchelper.js/tpl-preferences.js]]

| github = https://github.com/wikimedia-gadgets/afc-helper

| skins =

| browsers =

| logo =

| screenshot = File:AFC Helper Script accept screen.png

| screenshot-caption = The AFCH "accept" screen

}}

The '''Articles for creation helper script''' (AFCH) is a Wikipedia [[WP:Gadget|gadget]] designed to help when reviewing Articles for creation [[CAT:AFC|article submissions]]. It is currently the only script officially recognized and supported by WikiProject Articles for creation. In early 2014, the helper script was completely rewritten and redesigned from the ground up, with a number of new features. This rewritten script is now the default; you can read about what changed at [[/Rewrite]]. The source is located at [[MediaWiki:Gadget-afchelper.js]].

== Installation ==

[[File:AFCHv091.jpg|thumb|450px|Screenshot of the panel that appears when AFCH is launched. Different options appear based on the current review status of the page.]]

To install the script, navigate to [[Special:Preferences#mw-prefsection-gadgets]], click on the check box next to "'''AFC Helper Script'''", and hit "Save". You should be ready to go!

=== How do I launch AFCH? ===

To launch AFCH, click on <code>More ▼</code> in the toolbar on an AFC-applicable page and then on the <code>Review (AFCH)</code> link. In the Monobook skin <code>review (afch)</code> appears as an extra tab in the page's toolbar.

'''''Tip''': You can also launch AFCH using the keyboard access key '''1'''. For instructions on how to use access keys in your browser, see [[Access keys#Access in different browsers|this table]] (typically, Mac: Ctrl + Opt + 1; Windows: Alt + Shift + 1).''

==Instructions==

=== Installation ===

* To install the script, simply add the following line to [[Special:MyPage/common.js|your account's common JavaScript file]]. The tool is tested on Monobook, Modern and Vector (the default skin). So, if you were using Vector, you would add the following to [[Special:MyPage/vector.js]]:

<source lang="javascript">

importScript('User:Timotheus Canens/afchelper4.js'); // Yet another AfC helper script v4.

</source>

* After this, you must [[WP:BYPASS|clear your browser's cache]].

=== UsageDocumentation ===

{{Commonscat|Screenshots of Wikipedia AfC helper}}

If the installation was done properly, you should see a "review" tab on the top of the page when viewing a submission in [[CAT:AFC]] or when reviewing [[WP:AFC/R]]; it may be a drop-down tab. Note that the tab will only appear when viewing a page that is a subpage of [[Wikipedia:Articles for creation]] or [[Wikipedia talk:Articles for creation]]. Misplaced submissions must be moved to the proper ___location first.

''Extended documentation for the helper script can found on GitHub in the [https://github.com/WPAFC/afch-rewrite/wiki AFCH wiki].''

==== Reviewing an article submission ====

===== The "review" tab =====

When clicked, the review tab brings up 5 buttons:

*Accept

*Decline

*Comment

*Mark as reviewing

*Clean the submission

Welcome to AFCH, a powerful tool for reviewing Articles for creation submissions. The tool aims to be largely intuitive; if you find elements of the software unclear, [[WT:AFCH|do let us know]]!

=====Accepting=====

Once you are satisfied that the submission should be accepted, simply click the "accept" button. You will be prompted to enter the title of the page to move to (by default the name of the AFC subpage) and to assess the article. You can also enter some additional wikitext that will be appended to the article (for example, stub tags and categories) and/or its talk page (for example, WikiProject banners).

=== Where does AFCH run? ===

The script currently does the following:

* It extracts the author from the first {{tl|afc submission}} tag, if there is such a tag, and notifies them.

* It moves the submission to mainspace.

* It removes all {{tl|afc submission}} and {{tl|afc comment}} templates from the article.

* It removes all other templates starting with ''{{afc'' from the article and does some additional cleanup. If there are other templates in the template parameters, however, it will not work properly. It cannot remove subst'd templates.

* It optionally appends some text to the article (useful for adding stub tags or categories in one go).

* It records the assessment on the talk page, and optionally adds some extra text.

* It records the creation at [[WP:Articles for creation/recent]].

* It uncomments categories like <nowiki>[[:Category:XXX]]</nowiki>.

AFCH can be launched on AfC-applicable pages that begin with any of the following strings:

'''Known issues''':

* <code>Draft:</code>

* If a page is [[MediaWiki:Titleblacklist|blacklisted]] and the reviewer has neither the [[WP:account creator|account creator right]] nor admin right, the error message "''Error info:hookaborted : The modification you tried to make was aborted by an extension hook''" will occur and the page won't get moved. Please find an admin (or account creator) to accept the page, e.g. by asking at [[WT:AFC]].

* <code>User:</code>

===== DecliningWhat acan submissionI do using AFCH? =====

If the submission should be declined, click the "decline" button. You will be prompted to select or enter a reason for declining. There are also three possible options:

* Notify if possible - if checked, the script will try to notify the creator. On by default.

* Blank - if checked, will replace the content with {{tl|afc cleared}}; on by default if the decline reason is copyvio or BLP; otherwise off by default.

Once you click "submit", the script does the following:

* If you have not entered any reason, it aborts.

* If you have selected a reason ''and'' entered a custom reason, it puts the custom reason as a comment in a {{tl|afc comment}}.

* It notifies the author about the [[WP:TH|Teahouse project]], if requested.

* It blanks the submission, if requested.

* It cleans the submission page.

AFCH has many features. When reviewing a submission, a subset of the following options will be available depending on the automatically parsed submission status.

=====Commenting=====

* Submit

The "comment" button can be used to insert a comment in the page. It is placed right before the first horizontal line, if there is one, or otherwise right after the AfC template. It also cleans the submission page.

* Accept

* Decline/Reject

* Comment ''(always available)''

* Tag for G13 speedy deletion

* Postpone G13 speedy deletion

Additionally, clicking on the '''<code>&lt;&lt;</code>''' to the right of the main buttons reveals the following additional options:

=====Marking as being reviewed=====

* [https://github.com/WPAFC/afch-rewrite/wiki/General-documentation#clean Clean submission] (small Wikicode and Manual of Style fixes)

This should be self-explanatory, it also cleans the submission page.

* Mark/unmark as under review ''(context-sensitive)''

After performing any of these actions, the page will reload in place, allowing you to inspect your changes. Diff links are available for each edit the script made automatically.

=====Clean the submission=====

This should be self-explanatory. At the moment following tasks will be done

*Unnecessary submission templates will be removed (duplicated pending submission, drafted submission if other pending or declined submission is placed)

*removes many [[HTML comment]]s (mostly added through the wizard)

*submission and comment template sorting (and moving to the top

*removes {{tl|userspacedraft}}, {{tl|userspace draft}}, {{tl|user sandbox}}

*commenting out categories (see also [[#Accepting]])

*wikilink correction

**<nowiki>[[http://en.wikipedia.org/wiki/Foo|foo]]</nowiki> --> <nowiki>[[Foo|foo]]</nowiki>

**<nowiki>[[http://en.wikipedia.org/wiki/Foo|bar]]</nowiki> --> <nowiki>[[Foo|bar]]</nowiki>

**<nowiki>[[http://en.wikipedia.org/wiki/Foo foo]]</nowiki> --> <nowiki>[[Foo|foo]]</nowiki>

**<nowiki>[http://en.wikipedia.org/wiki/Foo bar]</nowiki> --> <nowiki>[[Foo|bar]]</nowiki>

**and other variations (e.g. secure links; please report unnoticed variations)

=== Customising AFCH===

====Reviewing redirect and category submissions at [[WP:AFC/R]]====

[[File:AFCH with preferences.jpg|thumb|Screenshot of AFCH with preferences selected]]

At the top of [[WP:AFC/R]], there should be a "review" tab. Click on it, and the script will list all redirects and categories submissions not yet reviewed. Pick an action for some (or all) of them, which may be "accept", "decline", or "comment", fill in the applicable info, click "Done", and the script will do its job.

When AFCH is open on a draft or userpage, click the "(preferences)" link, which will open up a menu for customisation:

*It will not overwrite a page that already exists.

*Set where to see the AFCH option (in the "More" dropdown or as an option in the side toolbar)

*It will not automatically add categories to the pages.

*Logging speedy deletion nominations

*Log accepts, declines, and rejects

== Other notes ==

==Acknowledgement & Disclaimer==

* The WikiProject list used by the script is [[Wikipedia:WikiProject Articles for creation/WikiProject templates.json]].

Great thanks are due to be had by [[User:Mr.Z-man]] and his [[User:Mr.Z-man/closeAFD|closeAFD]] script, from which this script is adapted.

* The templates used by the script are listed at [[Template:AfC submission]].

== Developers ==

The format of this page is shamelessly plagiarized from [[User talk:The Earwig/afc-helper.js]].

[https://github.com/orgs/WPAFC/people A number of developers] have contributed to make AFCH a reality. The current rewrite was completed by {{U|Theopolisme}}, with subsequent maintenance by {{u|Enterprisey}}. You may contact {{u|Novem Linguae}} for urgent issues. We'd love your help! For instructions on how to contribute, see '''[[/Contributing]]'''. Interface administrators can deploy updates to the extension using the work instruction at [[/Deploying]].

A [[Beta_version|beta]] script is available at [[User:Mabdul/afc beta.js]]. Be careful, although the script is already tested, changed or new functionalities might not work properly. Please report (or in general) bug reports and feature requests at [[User talk:Mabdul/afc beta.js]].

{{Wikipedia technical help|collapsed}}