Updated 5.2 Troubleshooting (markdown)

5.2-Troubleshooting.md

@@ -1,51 +1,49 @@
 Besides asking and guessing, the only way to find the cause(s) of why something doesn't work as expected, is to **methodically** eliminate preferences. And only after it is confirmed that the user.js is the cause, by replicating the problem in a new profile with no extensions.
 
-### :small_orange_diamond: Did an extension break?
+---
 
-We have an "unofficial" sticky issue [here](https://github.com/arkenfox/user.js/issues/391) for prefs that can break extensions
+### 🟪 PRE-CHECKS
 
-### :small_orange_diamond: Check your `"parrot"` and console
+- 🔹 Check the wiki list of [common overrides](https://github.com/arkenfox/user.js/wiki/3.2-Overrides-%5BCommon%5D)
+- 🔹 Check our [override recipes](https://github.com/arkenfox/user.js/issues/1080)
+- 🔹 Check items tagged with `[SETUP-` in the user.js
+- 🔹 Check already [answered](https://github.com/arkenfox/user.js/issues?q=is%3Aissue+label%3Aanswered) issues
+- 🔹 Check your `"parrot"` and console for syntax errors <sup>1</sup>
+- 🔹 Check, if applicable, the "unofficial" [prefs that break extensions](https://github.com/arkenfox/user.js/issues/391) issue
+- 🔹 Check the Browser Console
+   - Open the Browser Console (`Ctrl+Shift+J`) and clear it. Then repeat the action / task that is not working as intended, and see if the console logs anything. If it does but you can't decipher what it means, feel free to post the error message in a new issue and maybe we can help. But do try and dig a little deeper first
+
+<sup>1</sup> PARROTS
 
 When you modify your user.js, such as adding any overrides, sometimes syntax errors happen. Open about:config and check your `"parrot"`. Arkenfox uses `_user.js.parrot` throughout the user.js. You can use any pref name you like, as long as it's different (to avoid confusion).
+> ```js
+> /* my overrides */
+> user_pref("canary.in.a.coalmine", "overrides: started"); // parrot, canary, whatever you like
+> user_pref("pref.name.example", "green"); // I like green
+> user_pref("canary.in.a.coalmine", "overrides: success");
+> ```
 
-example
+[Not all](https://blog.mozilla.org/nnethercote/2018/03/09/a-new-preferences-parser-for-firefox/) syntax errors cause the user.js parsing to be aborted. After Firefox opens, open the Browser Console (`Ctrl+Shift+J`) and check for any **pref-parsing related** warnings/errors
-```js
-/* my overrides */
-user_pref("canary.in.a.coalmine", "overrides: started"); // parrot, canary, whatever you like
 
-user_pref("toolkit.legacyUserProfileCustomizations.stylesheets", true); // userChrome/userContent
+> ![](https://github.com/arkenfox/user.js/blob/master/wikipiki/parseError.png)
-user_pref("ui.key.menuAccessKey", 0); // disable alt key toggling the menu bar [RESTART]
-user_pref("browser.tabs.extraDragSpace", false); // stop theme turning drag space on
 
-user_pref("canary.in.a.coalmine", "overrides: success");
-```
-**Note**: [not all](https://blog.mozilla.org/nnethercote/2018/03/09/a-new-preferences-parser-for-firefox/) syntax errors cause the user.js parsing to be aborted. After Firefox opens, open the Browser Console (`Ctrl+Shift+J`) and check for any **pref-parsing related** warnings/errors, fe:<br>
 
-![](https://github.com/arkenfox/user.js/blob/master/wikipiki/parseError.png)
+---
 
-### :small_orange_diamond: Use the Browser Console
+#### 🟪 SCRIPT
-
-Open the Browser Console (`Ctrl+Shift+J`) and clear it. Then repeat the action / task that is not working as intended, and see if the console logs anything. If it does but you can't decipher what it means, feel free to post the error message in a new issue and maybe we can help. But do try and dig a little deeper first
-
-### :small_orange_diamond: Tags
-
-While not 100% definitive, we have included `[SETUP*` tags for troubleshooting (and setting up). Some examples
- * `[SETUP-WEB]` can cause some websites to break
- * `[SETUP-CHROME]` changes how Firefox itself behaves (i.e. NOT directly website related)
- * `[SETUP-PERF]` may impact performance
-
-### :small_orange_diamond: Use our scratchpad script
 
 Before you go on to the laborious task of manual troubleshooting you should try our [troubleshooter script](https://raw.githubusercontent.com/arkenfox/user.js/master/scratchpad-scripts/troubleshooter.js) first. In many cases it will be able to either directly identify the culprit or at least narrow it down to a more manageable number of prefs for manual troubleshooting. You can just run the script and follow the instructions but we strongly recommend to watch the [demo video](https://anonfile.com/6eZ9v9d9b6/troubleshooter_vid.zip) first (webm, 62mb, 16m26s).
 
-<b>Mozilla removed the Scratchpad in FF72 but you can still run the script via the Web Console:</b>
+To run the script:
-* Load `about:config` and press Ctrl+Shift+K to open the Web Console for about:config
+* Load `about:config` and press `Ctrl+Shift+K` to open the Web Console for about:config
-* Switch to multi-line editor mode (Ctrl+B toggles between single- and multi-line editor mode)
+* Switch to multi-line editor mode (`Ctrl+B` toggles between single- and multi-line editor mode)
 * Load (or paste) the troubleshooter script, run it and follow the instructions
 
-### :small_orange_diamond: Manual troubleshooting
+---
 
-1. Download and unpack a portable Firefox
+#### 🟪 MANUAL
+
+1. [Optional] Download and unpack a portable Firefox
    * Current stable Firefox portable is always [here](https://portableapps.com/apps/internet/firefox_portable)
    * Older versions are [here](https://sourceforge.net/projects/portableapps/files/Mozilla%20Firefox%2C%20Portable%20Ed./)
 2. Create a profile and test the problem
@@ -53,15 +51,15 @@ Before you go on to the laborious task of manual troubleshooting you should try
    * Verify that the problem does not exist in a vanilla Firefox setup.
 3. Set up a profile-master for quick resets
    * Close Firefox
-   * Go to the `\FirefoxPortable\Data\profile` folder and create an empty user.js file
+   * Go to the `profile` folder and create an empty user.js file
-   * Then go up a directory to the `\FirefoxPortable\Data\` folder and COPY the `profile` folder. Rename it `profile-master` (we can use this to quickly restore to a vanilla profile)
+   * Then go up a directory and COPY the profile folder (we can use this to quickly restore to a vanilla profile)
 4. Make sure the user.js is the cause
    * Replace the user.js in your `profile` folder with the full user.js.
    * Restart Firefox and confirm the problem exists
 5. Reset the profile folder
    * Close Firefox
-   * Go to the `\FirefoxPortable\Data\` folder and delete the `profile` folder.
+   * Delete the profile
-   * COPY the `profile-master` folder and rename it `profile`
+   * COPY the backed up folder and rename it
 6. Addition method (do step 6 or 7)
    * In your `profile` user.js (which initially should be empty), paste in the section (or sections) you suspect might be the culprit, save the changes and restart Firefox.
    * Test if the problem exists. If not repeat the above step until you find it.