MediaWiki:Gadget-Adiutor-AIV

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

Adiutor Administrator Intervention Against Vandalism Module Documentation

Overview

The Adiutor Administrator Intervention Against Vandalism module is a JavaScript script designed to enhance the Wikipedia editing experience by providing a user interface for reporting vandalism and requesting actions by administrators. This script is part of the Adiutor tool created by the author Vikipolimer.

Features

- Reporting vandalism and requesting actions. - Selection of rationale for reporting. - Creation of report text. - Posting reports to the administrators' noticeboard.

Usage

This module is intended to be used within the Wikipedia editing environment to report vandalism and request actions by administrators. To use the Adiutor Administrator Intervention Against Vandalism 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 Administrator Intervention Against Vandalism module code into your environment. This can typically be done by adding the script to your user or common JavaScript pages.

3. When you encounter vandalism or an issue that requires administrator intervention, 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 provide a dialog interface for reporting the issue. Follow the on-screen instructions to select the appropriate rationale and provide the necessary details.

5. When you submit the report, the module will create a report text and post it to the administrators' noticeboard for review and action by administrators.

Key Components

The Adiutor Administrator Intervention Against Vandalism module consists of several key components and functions:

1. RevisionDeleteRequestDialog Class: This class represents the dialog interface for reporting vandalism and requesting actions. 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 report. It collects user-selected options, creates report text, and interacts with the Wikipedia API to post the report to the administrators' noticeboard.

4. API Interactions: The script interacts with the MediaWiki API (`api`) to post reports to the administrators' noticeboard and update user preferences.

Licensing

The Adiutor Administrator Intervention Against Vandalism 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.

he JavaScript code of the module goes here.