Git/firefox-user.js
1
0
Fork 0
mirror of https://github.com/arkenfox/user.js.git synced 2024-11-26 20:41:38 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated 1.1 Overview (markdown)

Thorin-Oakenpants 2020-09-15 11:02:32 +00:00
parent 5d2ce3b1b4
commit ac4a4d80f7
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
1.1-Overview.md

@ -1,11 +1,11 @@
Before you go jumping in, all excited, and dive in at the deep end, let's get some basics out the way. Before you go jumping in, all excited, and dive in at the deep end, let's get some basics out the way.
And after this page, at the very least you need to read the [implementation](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.3-Implementation) page, as it contains important information regarding a few `ghacks user.js` settings. And after this page, at the very least you need to read the [implementation](https://github.com/arkenfox/user.js/wiki/1.3-Implementation) page, as it contains important information regarding a few `arkenfox user.js` settings.
## Table of Contents ## Table of Contents
* [What is it, what does it do, and why would I want one?](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.1-Overview#small_orange_diamond-what-is-it-what-does-it-do-and-why-would-i-want-one) * [What is it, what does it do, and why would I want one?](https://github.com/arkenfox/user.js/wiki/1.1-Overview#small_orange_diamond-what-is-it-what-does-it-do-and-why-would-i-want-one)
* [Working with a user.js](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.1-Overview#small_orange_diamond-working-with-a-userjs) * [Working with a user.js](https://github.com/arkenfox/user.js/wiki/1.1-Overview#small_orange_diamond-working-with-a-userjs)
* [Resetting preferences](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.1-Overview#small_orange_diamond-resetting-preferences) * [Resetting preferences](https://github.com/arkenfox/user.js/wiki/1.1-Overview#small_orange_diamond-resetting-preferences)
### :small_orange_diamond: What is it, what does it do, and why would I want one? ### :small_orange_diamond: What is it, what does it do, and why would I want one?
@ -35,7 +35,7 @@ tl;dr: firefox starts :arrow_right: user.js active preferences :arrow_right: pre
That's a bit to digest, so here is a pretty picture showing a preference with the same value as status `user set`/`modified` and `default`. In `about:config's` search box, you can use wildcards (e.g `network*policy`) to save time typing, and it is case insensitive. That's a bit to digest, so here is a pretty picture showing a preference with the same value as status `user set`/`modified` and `default`. In `about:config's` search box, you can use wildcards (e.g `network*policy`) to save time typing, and it is case insensitive.
![](https://github.com/ghacksuserjs/ghacks-user.js/blob/master/wikipiki/overview03.png) ![](https://github.com/arkenfox/user.js/blob/master/wikipiki/overview03.png)
And why would you want a `user.js`? And why would you want a `user.js`?
* It is used to reset settings on a restart, making certain preferences more or less "permanent". You can still change preferences via about:config for testing * It is used to reset settings on a restart, making certain preferences more or less "permanent". You can still change preferences via about:config for testing
@ -47,11 +47,11 @@ And why would you want a `user.js`?
The `user.js` file is a `javascript` file and is text based. If you use Windows, make sure you unhide extensions for known filetypes in Folder Options, so that the file isn't really called `user.js.txt`. It is recommended that you use an editor that supports syntax highlighting. You can edit and work on your `user.js` while Firefox is open, it is only ever read when Firefox is started. The `user.js` file is a `javascript` file and is text based. If you use Windows, make sure you unhide extensions for known filetypes in Folder Options, so that the file isn't really called `user.js.txt`. It is recommended that you use an editor that supports syntax highlighting. You can edit and work on your `user.js` while Firefox is open, it is only ever read when Firefox is started.
![](https://github.com/ghacksuserjs/ghacks-user.js/blob/master/wikipiki/overview01.png) ![](https://github.com/arkenfox/user.js/blob/master/wikipiki/overview01.png)
Preferences must follow Mozilla's syntax which is `user_pref("prefname", value);`. Note that the preference name must be wrapped in quotation marks, and do not forget the semi-colon at the end. The value must also be wrapped in quotation marks, but only if it is a string. Preferences are case sensitive. Preferences must follow Mozilla's syntax which is `user_pref("prefname", value);`. Note that the preference name must be wrapped in quotation marks, and do not forget the semi-colon at the end. The value must also be wrapped in quotation marks, but only if it is a string. Preferences are case sensitive.
![](https://github.com/ghacksuserjs/ghacks-user.js/blob/master/wikipiki/overview02.png) ![](https://github.com/arkenfox/user.js/blob/master/wikipiki/overview02.png)
### :small_orange_diamond: Resetting preferences ### :small_orange_diamond: Resetting preferences
@ -72,6 +72,6 @@ user_pref("browser.link.open_newwindow.restriction", 2); // 0-disable, 2=enable
user_pref("browser.link.open_newwindow.restriction", 2); user_pref("browser.link.open_newwindow.restriction", 2);
``` ```
Note: Resetting values, or editing the `user.js` every time you update it is not ideal. It is recommended that you use an `overrides section` - see our [maintenance](https://github.com/ghacksuserjs/ghacks-user.js/wiki#small_orange_diamond-maintenance) section Note: Resetting values, or editing the `user.js` every time you update it is not ideal. It is recommended that you use an `overrides section` - see our [maintenance](https://github.com/arkenfox/user.js/wiki#small_orange_diamond-maintenance) section
Now you know the "what, why, where and how" of a `user.js`, you can check out how to [backup](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.2-Backing-Up) before [implementing](https://github.com/ghacksuserjs/ghacks-user.js/wiki/1.3-Implementation). Now you know the "what, why, where and how" of a `user.js`, you can check out how to [backup](https://github.com/arkenfox/user.js/wiki/1.2-Backing-Up) before [implementing](https://github.com/arkenfox/user.js/wiki/1.3-Implementation).