mirror of
https://github.com/black7375/Firefox-UI-Fix.git
synced 2026-01-30 04:10:32 -08:00
Doc: Preference - update toc, add sync
This commit is contained in:
parent
bb36527880
commit
c178e01f1e
1 changed files with 45 additions and 8 deletions
|
|
@ -6,7 +6,11 @@
|
|||
- [Basics](#basics)
|
||||
- [Default Config](#default-config)
|
||||
- [User Config](#user-config)
|
||||
* [about:config](#about-config)
|
||||
* [prefs.js](#prefsjs)
|
||||
* [user.js](#userjs)
|
||||
- [Using with User Custom CSS](#using-with-user-custom-css)
|
||||
- [Sync](#sync)
|
||||
- [Related Source file](#related-source-file)
|
||||
|
||||
<!-- markdown-toc end -->
|
||||
|
|
@ -33,6 +37,15 @@
|
|||
|
||||
**Preference file RFC**
|
||||
|
||||
Key information on the sets that can be used in the configuration file.
|
||||
|
||||
- `pref()`: Set default pref
|
||||
- `sticky` attr: same as `sticky_pref()`
|
||||
- `locked` attr: cannot change from default.
|
||||
- `sticky_pref()`: Always logged even if the defaults match
|
||||
- `user_pref()`: Set user pref
|
||||
|
||||
The following is a method of operating the configuration file parser.
|
||||
See [EBNF(Extended Backus-Naur form)](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form) if you want to know about syntax.
|
||||
|
||||
```text
|
||||
|
|
@ -57,12 +70,6 @@ See [EBNF(Extended Backus-Naur form)](https://en.wikipedia.org/wiki/Extended_Bac
|
|||
<pref-attr> = "sticky" | "locked" // default pref files only
|
||||
```
|
||||
|
||||
- `pref()`: Set default pref
|
||||
- `sticky` attr: same as `sticky_pref()`
|
||||
- `locked` attr: cannot change from default.
|
||||
- `sticky_pref()`: Always logged even if the defaults match
|
||||
- `user_pref()`: Set user pref
|
||||
|
||||
## Default Config
|
||||
- [`modules/libpref/init/all.js`](https://github.com/mozilla/gecko-dev/blob/master/modules/libpref/init/all.js): all products
|
||||
- [`browser/app/profile/firefox.js`](https://github.com/mozilla/gecko-dev/blob/master/browser/app/profile/firefox.js): only firefox deskstop
|
||||
|
|
@ -93,14 +100,16 @@ It is written to `prefs.js` in a way that can be set by the GUI.
|
|||
- [Support Mozilla: Configuration Editor for Firefox](https://support.mozilla.org/en-US/kb/about-config-editor-firefox)
|
||||
|
||||
### prefs.js
|
||||
**Related Docs**
|
||||
- [mozillaZine: Prefs.js file](https://kb.mozillazine.org/Prefs.js_file)
|
||||
|
||||
**Basics**
|
||||
It exists in the profile directory, and is used to store settings that are changed from *defaults* or when users added *new settings*.
|
||||
|
||||
In general, Do NOT edit `prefs.js` directly.
|
||||
|
||||
- [mozillaZine: Prefs.js file](https://kb.mozillazine.org/Prefs.js_file)
|
||||
|
||||
### user.js
|
||||
**Related Docs**
|
||||
- [mozillaZine: User.js file](https://kb.mozillazine.org/User.js_file)
|
||||
|
||||
**Restrictions**
|
||||
|
|
@ -186,6 +195,34 @@ Test each case by turning on/off the following settings.
|
|||
}
|
||||
```
|
||||
|
||||
## Sync
|
||||
|
||||
**Related Docs**
|
||||
- [Support Mozilla: Sync custom preferences](https://support.mozilla.org/en-US/kb/sync-custom-preferences)
|
||||
|
||||
**How to**
|
||||
|
||||
Firefox Sync allows you to [choose the types of data](https://support.mozilla.org/en-US/kb/how-do-i-choose-what-information-sync-firefox) to sync across all devices.
|
||||
|
||||

|
||||
|
||||
The following options are required to sync custom configs.
|
||||
- `services.sync.prefs.dangerously_allow_arbitrary` to `true`
|
||||
|
||||
Then, subsequently any pref can be pushed there by creating a remote with prefix.
|
||||
- `services.sync.prefs.sync.`
|
||||
|
||||
**Example**
|
||||
|
||||
```javascript
|
||||
// user.js
|
||||
user_pref("services.sync.prefs.dangerously_allow_arbitrary", true); // Must need
|
||||
|
||||
// Sync UI
|
||||
user_pref("services.sync.prefs.sync.browser.uiCustomization.state", true);
|
||||
user_pref("services.sync.prefs.sync.browser.uidensity", true);
|
||||
```
|
||||
|
||||
## Related Source file
|
||||
|
||||
- https://github.com/mozilla/gecko-dev/blob/master/modules/libpref/parser/src/lib.rs
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue