Skip to content

Commit

Permalink
Updated settings documentation to version 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
dusk125 authored Dec 1, 2016
1 parent 2684bfc commit add1561
Showing 1 changed file with 23 additions and 31 deletions.
54 changes: 23 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,47 +52,39 @@ Usage is simple because, basically, BetterBookmarks functions just like the nati
]
```
## Settings
#### verbose (true/false):
Should BetterBookmarks print out things to the console (usually unseen by the user) when it's doing caching operations.

#### auto_save_marks (true/false):
Should BetterBookmarks save marks on when the current file is saved.

#### load_marks_on_load (true/false):
Should BetterBookmarks load saved marks automatically when a file is opened.

#### cleanup_empty_cache_on_close (true/false):
If the cache is empty, should BetterBookmarks delete the cached mark file (for the file being closed).

#### layer_icons (name : {icon, scope}):
What layers should be available in editor. Icon is the path to the icon file. Scope controls the shading of the icon. NOTE: All of those listed in the example can be edited/removed.

#### default_layer (string):
What layer should be selected on start.

#### layer_status_location ([string]):
Where, if anywhere, should BetterBookmarks show the user what layer they're on when they switch layers. This value can be any combination of the following possible values; you don't have to pick just one!

##### Possible values:
* `popup`: Shows a popup with the name of the currently selected layer at the cursor location.
* `temporary`: Shows the layer name in the status bar for a brief amount of time.
* `permanent`: Shows the layer name in the status bar permanently (unless "permanent" is removed from the settings).

#### Example
```
{
"verbose": true,
"auto_save_marks": true,
"load_marks_on_load": true,
// Should BetterBookmarks print out things to the console (usually unseen by the user) when it's doing caching operations.
"verbose": false,
// Should BetterBookmarks save marks on when the current file is saved.
"cache_marks_on_save": true,
// Should BetterBookmarks save marks on when the current file is closed.
"cache_marks_on_close": true,
// Should BetterBookmarks load saved marks automatically when a file is opened.
"uncache_marks_on_load": true,
// If the cache is empty, should BetterBookmarks delete the cached file (for the file being closed).
"cleanup_empty_cache_on_close": true,
// What layers should be available in editor. Icon is the path to the icon file. Scope controls the shading of the icon.
// NOTE: All of those listed in the example can be edited/removed.
"layer_icons": {
// This one is the default Sublime bookmark
"bookmarks": {"icon": "bookmark", "scope": "string"},
"functions": {"icon": "Packages/Better Bookmarks/icons/function.png", "scope": "comment"},
"todos": {"icon": "Packages/Better Bookmarks/icons/todo.png", "scope": "comment"},
},
// What layer should be selected on start.
"default_layer": "bookmarks",
"layer_status_location": ["permanent", "popup"]
/*
* Where, if anywhere, should BetterBookmarks show the user what layer they're on when they switch layers. This value can be any combination of the following possible values; you don't have to pick just one!
*
* Possible values:
* popup: Shows a popup with the name of the currently selected layer at the cursor location.
* temporary: Shows the layer name in the status bar for a brief amount of time.
* permanent: Shows the layer name in the status bar permanently (unless "permanent" is removed from the settings).
*/
"layer_status_location": ["permanent"]
}
```
## License
Copyright (c) 2015 Allen Ray
Expand Down

0 comments on commit add1561

Please sign in to comment.