Update documentation

facelessuser · Mar 31, 2021 · b2d0250 · b2d0250
1 parent f24848f
commit b2d0250
Show file tree

Hide file tree

Showing 13 changed files with 25 additions and 44 deletions.
diff --git a/docs/src/dictionary/en-custom.txt b/docs/src/dictionary/en-custom.txt
@@ -1,6 +1,7 @@
 API
 CSS
 Control's
+Customizable
 MERCHANTABILITY
 MkDocs
 Multi
@@ -13,6 +14,7 @@ SubNotify
 Tooltip
 Twemoji
 URL
+backtrace
 builtins
 cmd
 ctrl

diff --git a/docs/src/markdown/images/alpha_test.png b/docs/src/markdown/images/alpha_test.png
diff --git a/docs/src/markdown/images/screenshot1.png b/docs/src/markdown/images/screenshot1.png
diff --git a/docs/src/markdown/images/screenshot2.png b/docs/src/markdown/images/screenshot2.png
diff --git a/docs/src/markdown/images/tooltip-copy.png b/docs/src/markdown/images/tooltip-copy.png
diff --git a/docs/src/markdown/images/tooltip-copy_old.png b/docs/src/markdown/images/tooltip-copy_old.png
diff --git a/docs/src/markdown/images/tooltip-example.png b/docs/src/markdown/images/tooltip-example.png
diff --git a/docs/src/markdown/images/tooltip-simple-dark.png b/docs/src/markdown/images/tooltip-simple-dark.png
diff --git a/docs/src/markdown/images/tooltip.png b/docs/src/markdown/images/tooltip.png
diff --git a/docs/src/markdown/index.md b/docs/src/markdown/index.md
@@ -5,27 +5,19 @@
 This is a simple plugin that can get the scope under the cursor(s) in Sublime Text.  This plugin is useful for plugin
 development.
 
-Dark theme with simple output:
+![Screenshot 1](./images/screenshot1.png)
 
-![Tooltip Dark](./images/tooltip-simple-dark.png)
-
-Light theme with advanced output:
-
-![Tooltip Light](./images/tooltip-copy.png)
+![Screenshot 2](./images/screenshot2.png)
 
 ## Features
 All features are configurable via the settings file
 
-- Optionally show output in tooltip (stylesheets are configurable).
-- Optionally auto choose dark or light tooltip theme depending on your color scheme.
-- Optionally dump output to auto-popup panel and/or console.
-- Optionally dump scope to status bar (no multi-select support).
-- Multi-select support for all output except status bar.
-- Optionally log scope extent in line/char format and/or point format.
-- Optionally copy scope(s) to clipboard.
-- Optionally highlight and/or log scope extent.
-- Optionally log color scheme colors and selectors.
-- Optionally log location of Scheme file and Syntax.
+- Tooltip output showing scope, context backtrace, scope extent, color values, links to current syntax and relevant
+  color schemes.
+- Customizable to show only the information you care about.
+- Auto copy scope to clipboard on execution.
+- Quick copy any or all information to the clipboard.
+- Toggle instant scoping to keep showing scope as you move around a file.
 - Supports [SubNotify][subnotify] messages.
 
 --8<-- "refs.txt"
diff --git a/docs/src/markdown/usage.md b/docs/src/markdown/usage.md
@@ -54,9 +54,6 @@ Control the info displayed.  You can keep it to just the scope, or you can exten
     // Show current syntax and color scheme paths
     // (click to open if using tooltips)
     "file_paths": true,
-
-    // Highlight scope extent in view
-    "highlight_extent": true,
 ```
 
 #### `extent_points`
@@ -67,10 +64,6 @@ Show the extent of the scope as view points.
 
 Show the extent of the scope as line/char or row/col format.
 
-#### `highlight_extent`
-
-Highlight the scope extent.
-
 #### `styling`
 
 Show not only the color value, the text styling.
@@ -91,6 +84,9 @@ the scope to use and the supported style as shown below.
     // Highlight Configuration
     ///////////////////////////
 
+    // Highlight scope extent in view
+    "highlight_extent": true,
+
     // Scope to use for the color
     "highlight_scope": "invalid",
 

diff --git a/readme.md b/readme.md
@@ -8,28 +8,19 @@
 This is a simple plugin that can get the scope under the cursor(s) in Sublime Text.  This plugin is useful for plugin
 development.
 
-Dark theme with simple output:
+![Screenshot 1](docs/src/markdown/images/screenshot1.png)
 
-![Tooltip Dark](docs/src/markdown/images/tooltip-simple-dark.png)
-
-Light theme with advanced output:
-
-![Tooltip Light](docs/src/markdown/images/tooltip-copy.png)
-
-# Features
+![Screenshot 2](docs/src/markdown/images/screenshot2.png)
 
+## Features
 All features are configurable via the settings file
 
-- Optionally show output in tooltip (stylesheets are configurable).
-- Optionally auto choose dark or light tooltip theme depending on your color scheme.
-- Optionally dump output to auto-popup panel and/or console.
-- Optionally dump scope to status bar (no multi-select support).
-- Multi-select support for all output except status bar.
-- Optionally log scope extent in line/char format and/or point format.
-- Optionally copy scope(s) to clipboard.
-- Optionally highlight and/or log scope extent.
-- Optionally log color scheme colors and selectors.
-- Optionally log location of Scheme file and Syntax.
+- Tooltip output showing scope, context backtrace, scope extent, color values, links to current syntax and relevant
+  color schemes.
+- Customizable to show only the information you care about.
+- Auto copy scope to clipboard on execution.
+- Quick copy any or all information to the clipboard.
+- Toggle instant scoping to keep showing scope as you move around a file.
 - Supports [SubNotify](https://github.com/facelessuser/SubNotify) messages.
 
 # Documentation

diff --git a/scope_hunter.sublime-settings b/scope_hunter.sublime-settings
@@ -24,13 +24,13 @@
     // (click to open if using tooltips)
     "file_paths": false,
 
-    // Highlight scope extent in view
-    "highlight_extent": true,
-
     ///////////////////////////
     // Highlight Configuration
     ///////////////////////////
 
+    // Highlight scope extent in view
+    "highlight_extent": true,
+
     // Scope to use for the color
     "highlight_scope": "invalid",