Wikipedia:Ultraviolet/Documentation/Troubleshooting

Bugs and issues can sometimes pop up while using Ultraviolet, which can sometimes be a bother to deal with. In order to properly look into what's happening, the Ultraviolet team will require some information from the user, which may include screenshots or browser information. This page will guide you through the process of identifying whether or not a problem is caused by Ultraviolet, and help you collect the information required for proper troubleshooting.

For the purposes of this document, team member refers to a member of the official Ultraviolet development team. Although other users may help you, it is advised that you only send browser information (which can contain sensitive content, although we do our best to avoid that) to team members.

Determining if Ultraviolet caused a problem

If

A. The issue appeared after installing Ultraviolet

B. The issue appeared directly after running a Ultraviolet action (e.g. dialog opened, warning issued)

then this is likely a problem caused by Ultraviolet. Please send us a message on our talk page or tag the team in the Discord server so that we can take a look into the problem.

If

C. The issue appeared while using a user script that used to work when Ultraviolet was not installed

D. The issue appeared while using a browser extension that used to work when Ultraviolet was not installed

E. The issue appeared while using Ultraviolet on a different browser than what you used when using Ultraviolet before

then this is likely a compatibility issue caused by Ultraviolet. Likewise, please send us a message on our talk page or tag the team in the Discord server. Compatibility issues are given special treatment, as they may sometimes require interaction between the Ultraviolet team and other parties (i.e. the ones who made the other script).

If

F. The issue appeared after installing another user script (i.e. not Ultraviolet)

then this is likely not an issue caused by Ultraviolet. You can send us a message at the talk page, but the support we give may be limited.

Collecting required information

When the Ultraviolet team asks for information, it is to aid in determining the root cause of the problem. In the event that you prefer not to provide us with information that may be sensitive, please inform us so that we can work around it.

Taking a screenshot

Uploading the image is detailed in a lower section. Please refer to that section once you have taken a screenshot.

Windows

To take a screenshot on Windows 10, hold down ⊞ Win and ⇧ Shift, then press S. You can then select a portion of the screen to take a screenshot of by dragging your mouse across the desired region. The screenshot will be saved to your clipboard. Click on the notification to draw, edit and save the screenshot as a file.

Alternatively, you can hold the ⊞ Win key and press the Prnt Scr key (this may also be labeled Print Screen or PrtSc) to take a screenshot. The screenshot will be saved in your Pictures folder in the "Screenshots" folder. This link will bring you to the correct folder when executed using Run or when placed into the Windows Explorer's address bar.

%USERPROFILE%\Pictures\Screenshots

If you prefer to navigate to this folder manually, %USERPROFILE% may be substituted with your user profile folder's path (e.g. C:\Users\MyUsername).

This image may be uploaded already, however you may wish to remove sensitive parts. Use any editing tool you prefer (whether it be Microsoft Photos, Microsoft Paint, etc.) to crop out the specific area where the problem is seen in order to minimize the chance of leaking private information. If you happened to accidentally leak private information, we will silently message Oversight in order to protect your identity.

To take a screenshot on Windows 8 and 8.1, Windows 7, or Windows Vista, open the Snipping Tool. Select the "New" button at the top of the window (refer to the screenshot), and drag your cursor over the area where the problem can be seen. Afterwards, click the floppy disk icon on the ribbon (i.e. the set of icons and tools at the top of the window) and save the image somewhere on your computer. You may now upload the image.

If you're using Windows XP or older, please note that Ultraviolet may not run on your browser, as browsers stopped supporting these operating systems a long time ago. This may lead to deficits in browser features, which can cause Ultraviolet to fail. To take a screenshot with Windows XP or older, please refer to a different online guide.

macOS

See the Apple support article on how to take a screenshot.

Linux

Taking screenshots on Linux will vary between distributions, windowing systems, and desktop enviroments.

For GNOME (the default environment for most Linux distributions, including Ubuntu), use the Screenshot app which is pre-installed. To open it, press Super (usually the ⊞ Win key) or click Activities in the top left corner, and search for Screenshot in the applications list. Most other user-friendly (i.e. not power-user) enviroments will have a similar application; try searching for 'Screenshot' or even just 'shot' in your environment's launcher/applications list/menu.

For any other desktop environment running on X (not Wayland), the maim tool is probably available in your system package repositories. To use it, install it in the usual method from the your package manager, then open a terminal and type maim > output.png (where 'output.png' is the filename to save the resulting image to) - this will take a screenshot of the entire screen. Alternatively, change the maim to maim -s to enable interactive selection of the area to screenshot.

Uploading images

For us to see your image, you first need to upload it. To prevent possible licensing issues, we suggest that you upload the image to a different website. If you wish to use Wikimedia Commons anyway, there's nothing stopping you from doing that. If you happened to upload the image to Commons, simply insert the image into the talk page like usual.

You may use an upload service such as Imgur (link) or ImgBB (link) if you're more on the privacy side. In case upload services are not cut out for you, please inform the team member responding to you so that they may provide an email address to send the image to. Note that by sending the image to a team member through email, they may share the image with other team members unless you tell them not to.

If both options seem unfit, you may go with the nuclear option and Base64-encode your image, and then paste it into the talk page. This is highly unrecommended, but is the last reasonable option that does not go to the lengths of mailing a printed screenshot to a team member's home (hence, "uploading" images, not "sending").

Browser information

When providing your browser, please also mention the operating system you are using. Some minute details may be present between browsers in other operating systems (namely iOS, which requires WebKit for all browsers). Unless you use the latest operating system version, please also mention the version of your operating system. More information on finding out your operating system version can be found online.

Google Chrome

For Google Chrome, click the "More" button (the three vertically-stacked dots at the top right of the browser window). After this, click "Help" and then "About Chrome". The browser version is shown at the center of the screen, below the browser logo and name. For plain Chromium, click on the "More" button, and then on "About Chromium". Alternatively, you can visit chrome://settings/help on either browser.

Firefox

For Firefox, your browser version is usually all that is required. To access your browser version, click on the hamburger button (the three stacked horizontal lines at the top right of the browser window). Click "Help", near the bottom of the menu, and click on "About Firefox". Your browser version will be shown under the logo and update status. For more information and visuals, see the Mozilla Knowledgebase Article on finding your browser version.

Microsoft Edge

For Microsoft Edge (79+), click the "Settings and more" button (the three horizontal dots at the top right of the browser window). After this, click "Help" and then "About Microsoft Edge". The browser version is shown at the center of the screen, below the browser logo and name. Alternatively, you can visit edge://settings/help.

Other installed userscripts

You may have other installed userscripts that conflict with Ultraviolet. If the problems appear following the installation of a new userscript, gadget, or tool, it may be beneficial to provide a list of gadgets that you have enabled (that are not enabled by default, i.e. marked with a "D" in the Gadgets preferences tab). This is not required for userscripts, as the common.js files of users are public to everyone.

If you load userscripts in a different way (such as through a browser extension or Tampermonkey userscript), it may also be beneficial to inform us about scripts or extensions that may be conflicting with Ultraviolet.

Reporting JavaScript errors

Ultraviolet will immediately notify the user in case an error has occurred. However, this may not be the case in exceptional circumstances. If that happens, please refer to the guide below.

This section is an excerpt from Wikipedia:Reporting JavaScript errors § How to open your JavaScript console.[edit]

Where to find your JavaScript console depends on your browser:

How to open the console

Computer	Browser	Windows/Linux	Mac
Desktop/Laptop	Chrome/Chromium Edge (version 79+) Opera (version 15+)	Ctrl+⇧ Shift+J	⌥ Option+⌘ Command+J
	Firefox	F12	⌥ Option+⌘ Command+K
	Safari	Ctrl+Alt+C	⌥ Option+⌘ Cmd+C*
	Internet Explorer Edge (up to version 78)	F12 → Console	–
	Opera (up to version 14)	Page menu → Developer Tools → Error Console
Tablet/Mobile	Mobile operating systems do not usually have developer tools or consoles. However, some mobile browsers support remote debugging, where you connect your mobile device to a desktop via USB, and then you can access developer tools/consoles that way. Firefox USB debugging. Chrome USB debugging.

On some browsers, you may have to click on the "Console" tab once the developer tools pane opens up.

[*] In Safari, you might have to enable the Develop menu first in Preferences (⌘ Cmd+,) → Advanced → check "Show develop menu in menu bar". For OSX, use ⌥ Option+⌘ Command+I then hit esc (escape) to open the JavaScript console. Errors will appear in red.

Extracting the Ultraviolet log

Starting with Ultraviolet (not available in RedWarn), Ultraviolet stores an (ephemeral) log on every tab. This helps in determining the cause of certain bugs. All of the data is stored on your browser unless you choose to send it to us. Your log does not contain critical browser information, so you may choose to send it in any matter you wish. To copy the log, open the "More Options" menu () and select "Copy Ultraviolet log" at the bottom of the dialog. You will receive a Base64-encoded string of Ultraviolet's logs.

In the event that the button does not appear for you, or clicking the "More Options" button cannot be done (due to an existing error), open your browser console (see above section for instructions) and enter btoa(JSON.stringify(rw.Log.dump())), then press ↵ Enter. You can then copy the string that appears by right clicking the set of garbled letters and selecting "Copy Message" (Firefox) or "Copy string contents" (Chrome).

Sending the log

To send the log with the best privacy possible, please email the team through the email listed at Wikipedia:Ultraviolet/Contact or use any private channel there. The log should contain no private information (browser information, login details, etc.) so sending the log using public channels is possible, but out of an abundance of caution (and, in a worst-case scenario, a catastrophic bug with the software), please do send the log using private channels.

When submitting information on the talk page, wrapping the text in <pre> tags and {{collapse top}} and {{collapse bottom}} (so as to not cause much scrolling issues) should suffice.