Wikipedia:Ultraviolet/Documentation

From Wikipedia, the free encyclopedia

Welcome to the Ultraviolet Documentation!
This community built page documents all the features of Ultraviolet. To report a bug or issue, or start a discussion or feature request with Ultraviolet's users and developers, do so at the project talk page. Feel free to help expand it!

Ultraviolet is an installable user script with a strong focus on counter-vandalism. It can be used by any auto-confirmed user to revert and control vandalism, as well as patrolling recent changes and reviewing pending changes.

Installation[edit]

Use the installation wizard at Wikipedia:Ultraviolet/Install to get started.

Toolbar[edit]

You can use Ultraviolet by interacting with the icons at the top of a page, known as the toolbar.

The most obvious and noticeable difference is the toolbar. This is a row of icons above the title line of all pages giving you multiple actions you can perform. The location of the toolbar varies based on your preferences.

Talk Pages[edit]

New message[edit]

The "new message" button () opens the "New Talk Page Message" dialog. This dialog works similarly to Wikipedia's built-in "new section" tool on talk pages, however you type the contents in standard WikiText in the box that appears. To preview your message, click the preview button () situated to the top-right of the dialog. Once you've finished your message, press the Send Message button which will edit the target users talk page and add your message.

Warn User[edit]

A screenshot showing the Warn User interface

The Warn User button () allows you to add multiple different warning templates (with parameters) to a user's talkpage. On clicking the icon, the "Warn User" dialog pops up. From here you are able to change multiple parameters:

  • The most important field is the reason field. Here you can choose from almost 100 warnings that the target user will receive. To search, just start typing with the list open. You can select the first item from the list by pressing ENTER.
  • On templates that are not single-use, radio buttons will appear below the reason field, allowing you to select the warning level. Based on previous warnings, Ultraviolet will adjust the level accordingly to match the warning that should be next given, however, if this is not appropriate you should change it.
  • The related page field allows you to enter the page that the notice is referring to.
  • In the additional info field, you can add a comment that will appear below the notice.

Manage Page Protection[edit]

Clicking the Manage Page Protection button () will open the Manage Page Protection dialog, in which you can request for protection or unprotection of any page you are on. In the dialog, you will first need to select the protection level you would like to request, the current level will be greyed out. Click to select a higher protection level to request page protection, or lower protection level to request unprotection to that level. Once that is complete, select a reason and elaborate any extra details in the space provided so administrators have all the information they need to respond to your request. Once you have completed the form, click Protect to then submit your request to requests for page protection.

Alert on Change[edit]

After pressing the Alert on Change button (), you will receive a push notification every time a change to the selected page is detected. Once you go to the tab that has the page, it will automatically load the diff of the change.

Latest Revision[edit]

The Latest Revision button ()... shows you the latest revision (believe it or not).

More Options Dialog[edit]

the default More Options dialog when on a normal page

Ultraviolet includes a "More Options" dialog (), the contents of which differ based on if you access it via the top icon on a normal page, a page in the userspace or the icon in the rollback options. Additional rollback options can be found here, alongside the preferences "Report User" options. It also includes 2 reporting actions that can be performed on diffs. These are the "Report edit to Wikimedia Trust and Safety" (), and "Report edit to Oversight" () buttons.

Preferences[edit]

See § Preferences.

Rollback[edit]

Some of the icons in the updated rollback menu

One of the most useful features of Ultraviolet is the updated rollback menu, which offers many different ways to rollback an edit. When you go to the most recent revision of a page, you will be presented with multiple rollback icons. More options can be accessed from the More Options Dialog (), the options that appear can be customised in preferences. These options vary from a quick rollback with no reason, to a rollback for copyright infringement. If you see something that doesn't meet any of the options, you can simply click the blue button simply labelled "rollback" () to write a custom reason.

Please keep in mind that unless an edit is clearly done with an intent to harm Wikipedia, you must not use rollback without an edit summary (nor explicitly mark an edit as "vandalism", which using rollback in this manner is interpreted as by convention). Two related mistakes to avoid: i) edits that are patently poor and/or inappropriate, but which could have been made in good faith, are not to be treated as vandalism; ii) new users often make test edits ("can I really make live changes to a Wikipedia article?"); if you ask yourself whether an edit could have reasonably been a test, and you can't tell (and the user has not been previously warned for such possible test edits), it's not to be marked as vandalism.

Sometimes, multiple users have made separate edits, and you need to revert to a previous revision. To revert to a previous diff, simply preview the diff and press the "Restore this Revision" button (). A new dialog will popup prompting you to enter a reason. When you are done, press rollback.

Preferences[edit]

The last icon on the toolbar is the preferences icon (). This opens up the preferences dialog with multiple options. In the preferences dialog you have multiple options:

  • To change the UI colour scheme
  • To change the location of tool icons
  • To change the type of dialog animations
  • To change the order or amount of rollback icons
  • To change the appearance of Ultraviolet Patrol
  • To change the behaviour of Ultraviolet
    • User right-click menu
    • New notice auto-select level
    • What to do on rollback completion
    • When loading latest revision
    • List notices with
    • Rollback method
    • Pending changes review features
    • Page Review: Auto Submit Accept
    • Page Review: Auto Submit Revert

Once you have made your desired change, press the Save Changes button at the bottom of the menu.

Abuse[edit]

Do not forget that you are responsible for all edits made with Ultraviolet. You have the chance to review every action you make, including automated ones. You must use this tool within Wikipedia's policies and guidelines.


If you find any bugs, concerns, or parts where this documentation has been unfinished, please inform us on the Ultraviolet talk, or on our Discord server.