MediaWiki:Gadget-Adiutor-BDM

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

Adiutor Batch Deletion Module Documentation

Overview

The Adiutor Batch Deletion module is a JavaScript script designed to streamline the process of deleting multiple pages from a specific category on Wikipedia. This module is part of the Adiutor tool created by the author Vikipolimer.

Features

- Batch deletion of pages from a specified category. - Selection of deletion reasons. - Customizable deletion reasons. - User interface for managing the deletion process.

Usage

This module is intended to be used within the Wikipedia editing environment to perform batch deletions of pages from a designated category. To use the Adiutor Batch Deletion 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 Batch Deletion module code into your environment. This can typically be done by adding the script to your user or common JavaScript pages.

3. When you need to delete multiple pages from a specific category, initiate the 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 fetch a list of pages from the designated category and present them in a list with checkboxes.

5. Select the pages you want to delete by checking the checkboxes.

6. Choose a deletion reason from the dropdown menu. You can also provide a custom reason if needed.

7. Click the "Save" button to initiate the batch deletion process. The selected pages will be deleted, and a success notification will be displayed.

Key Components

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

1. 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.

2. Fetching Pages to Delete: The script fetches a list of pages from a specific category (`Category:Other speedy deletions`) using the MediaWiki API. It processes the retrieved pages and creates CheckboxMultioptionWidgets for each page, allowing the user to select pages for deletion.

3. Select All and Clear Selection: The module provides "Select All" and "Clear Selection" buttons to simplify the page selection process.

4. Deletion Reasons: Deletion reasons are retrieved from JSON data and displayed in a dropdown menu. Users can select predefined reasons or provide custom reasons.

5. Batch Deletion Dialog: The module presents a dialog interface for users to select pages, deletion reasons, and initiate the batch deletion process.

6. API Interactions: The script interacts with the MediaWiki API (`api`) to delete selected pages and their corresponding talk pages. It also handles notifications upon successful deletion.

Licensing

The Adiutor Batch Deletion 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.

```javascript // The JavaScript code of the module goes here.