MediaWiki:Gadget-Adiutor-RFD

From wikishia

[[Category:Commons help{{#translation:}}|Adiutor]]

Adiutor Deletion Requests Module Documentation

Overview

The Adiutor Deletion Requests module is a JavaScript script designed to enhance the Wikipedia editing experience by providing a user interface for handling deletion requests. This script is part of the Adiutor tool created by the author Vikipolimer.

Features

  • Creation of deletion request templates.
  • Addition of deletion requests to nomination pages.
  • Logging of deletion nominations.
  • Sending messages to the page creator.
  • Displaying a progress dialog.

Usage

This module is intended to be used within the Wikipedia editing environment. To use the Adiutor Deletion Requests module, follow these steps:

1. Ensure that you have the necessary permissions and prerequisites for running custom JavaScript code in your Wikipedia editing environment.

2. Load the Adiutor Deletion Requests module code into your environment. This can typically be done by adding the script to your user or common JavaScript pages.

3. When editing a Wikipedia page, initiate the Deletion Requests module. This can be done through the Wikipedia interface or a custom UI element, as determined by the Adiutor tool's setup.

4. The module will provide a dialog interface for handling deletion requests. Follow the on-screen instructions to provide the required information and options.

5. When you submit the deletion request, the module will perform the following actions:

  • Create a deletion request template.
  • Add the request to nomination pages.
  • Log the deletion nomination (if enabled).
  • Send a message to the page creator (if enabled).
  • Display a progress dialog.

Key Components

The Adiutor Deletion Requests module consists of several key components and functions:

1. RequestForDeletionDialog Class: This class represents the dialog interface for handling deletion requests. It inherits from `OO.ui.ProcessDialog` and provides the user with options and input fields.

2. Initialization: The script initializes various variables and objects, including `mwConfig`, `api`, `windowManager`, and `dialog`. These are essential for interacting with the Wikipedia environment and creating the user interface.

3. Action Processing: The `getActionProcess` function handles the actions performed when the user submits the deletion request. It collects user-selected options, creates deletion request templates, and interacts with the Wikipedia API to perform actions such as editing, logging, and messaging.

4. API Interactions: The script interacts with the MediaWiki API (`api`) to perform actions such as editing pages, querying information, and sending messages to users.

5. Progress Dialog: The `showProgress` function is responsible for displaying a progress dialog to inform the user about the status of the deletion request.

Licensing

The Adiutor Deletion Requests module is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Author and Source

- Author: Vikipolimer - Learn more: [Adiutor on Meta-Wiki](https://meta.wikimedia.org/wiki/Adiutor)

Compatibility

Please note that the script may require compatibility with specific Wikipedia configurations and the Adiutor tool. Ensure that you have the necessary permissions and configurations to use this module effectively.