Sublime Text QuickRef

By Victor Wheeler

Version 0.1

10-May-2025 16:15: V.Wheeler — Created

Note

This project is under active development.

Contents:

• 1. Introduction
  • 1.1. Getting Sublime Text
  • 1.2. Basics
  • 1.3. Additional Resources
• 2. Editing
  • 2.1. Keyboard Editing
  • 2.2. Editing with the Mouse
  • 2.3. File Diffing
• 3. Settings
• 4. Projects
  • 4.1. Creating a New Project
  • 4.2. Project File Format
  • 4.3. Template Project File
• 5. Commands
  • 5.1. Adding Existing Commands to Command Palette
  • 5.2. Further Reading
• 6. Command List
  • 6.1. Default
  • 6.2. A File Icon
  • 6.3. Diff
  • 6.4. HTML
  • 6.5. Package Control
  • 6.6. User
• 7. Scope, Selectors and Context
  • 7.1. Scope
  • 7.2. Scope Name
  • 7.3. Selector
  • 7.4. Selector Match
  • 7.5. Logical Operators in Selectors
  • 7.6. Context
  • 7.7. API
• 8. Key Bindings
  • 8.1. Recommended Key Binding Changes
  • 8.2. Keymap Files
  • 8.3. How Key Bindings are Chosen
  • 8.4. Multi-Keypress Bindings
  • 8.5. Key-Binding Definitions
  • 8.6. Blocking a Key Binding
  • 8.7. Diagnosing Binding Problems
  • 8.8. Key Binding Conflicts
• 9. Default Key Bindings
  • 9.1. Default Key Bindings (Windows)
  • 9.2. Default Key Bindings (Linux)
  • 9.3. Default Key Bindings (OSX)
• 10. Mouse Bindings
• 11. Default Mouse Bindings
• 12. Menus
  • 12.1. Customizing Menus
  • 12.2. Menu-Item Structure
  • 12.3. Adding to Existing Sub-Menus
  • 12.4. Dynamically Changing Menu Items
  • 12.5. Customizing Existing Menu Items
  • 12.6. Controlling Menu Item Locations in Existing Menus
  • 12.7. Side Bar “Magic”
  • 12.8. Other Context Menu “Magic”
  • 12.9. Lastly
  • 12.10. Further Reading
• 13. Completions
  • 13.1. Using Completions
  • 13.2. Creating Your Own Completions
  • 13.3. Completions File Format
  • 13.4. Implementing Completions in a Plugin
  • 13.5. Further Reading
• 14. Snippets
  • 14.1. Snippets vs Completions
  • 14.2. Snippet Files
  • 14.3. Smart-Template Syntax
  • 14.4. Creating Snippets
  • 14.5. Finding Snippets
  • 14.6. Further Reading
• 15. Build Systems
  • 15.1. Selecting a Build System
  • 15.2. Launching a Build
  • 15.3. Navigating Among Results
  • 15.4. Creating Your Own Build System
  • 15.5. Further Reading
• 16. Plugins
  • 16.1. Creating Commands
  • 16.2. Other Command Methods
  • 16.3. More on Text Commands
  • 16.4. Adding Python Packages
  • 16.5. Example Basic Plugin with Package Settings
  • 16.6. Generating Reports
• 17. Packages
  • 17.1. Sublime Text Packages vs Python Packages
  • 17.2. Locations
  • 17.3. Overriding
  • 17.4. Creating a New Package
  • 17.5. Sharing Your Package
  • 17.6. Further Reading
• 18. Input Handlers
  • 18.1. Flow of Execution
• 19. Event Listeners
  • 19.1. Creating an Event Listener
  • 19.2. Example
  • 19.3. Notes on on_query_context()
• 20. Event list
  • 20.1. EventListener
  • 20.2. ViewEventListener
  • 20.3. TextChangeListener
• 21. Dialog Boxes and User Messaging
• 22. Clipboard Utilities Available to Plugins
• 23. View Settings List Example
• 24. Paths
• 25. Popups
• 26. Phantoms
• 27. Viewport
  • 27.1. What Is a View’s Viewport?
  • 27.2. Viewport Terminology
  • 27.3. Enhanced Viewport API
  • 27.4. Example
• 28. Color Schemes
• 29. Themes
• 30. Indexing
• 31. Glossary
• 32. Troubleshooting
  • 32.1. Safe Mode
  • 32.2. Diagnosing Trouble from the Data Directory
• 33. Notes
  • 33.1. Features I Would Like

Indices and Tables

• Index

• Module Index

• Search Page

TODOs

Todo

fill in

(The original entry is located in E:\Vics Documents\References\Sublime_Text\quickref\src\color_schemes.rst, line 12.)

Todo

fill in

(The original entry is located in E:\Vics Documents\References\Sublime_Text\quickref\src\default_mouse_bindings.rst, line 13.)

Todo

Mouse Features details.

(The original entry is located in E:\Vics Documents\References\Sublime_Text\quickref\src\editing.rst, line 1448.)

Todo

fill in

(The original entry is located in E:\Vics Documents\References\Sublime_Text\quickref\src\editing.rst, line 1464.)

Todo

fill in

(The original entry is located in E:\Vics Documents\References\Sublime_Text\quickref\src\indexing.rst, line 34.)

Todo

fill in

(The original entry is located in E:\Vics Documents\References\Sublime_Text\quickref\src\mouse_bindings.rst, line 14.)

Todo

Fill in how to depend on another Package

(The original entry is located in E:\Vics Documents\References\Sublime_Text\quickref\src\plugins.rst, line 601.)

Todo

fill in

(The original entry is located in E:\Vics Documents\References\Sublime_Text\quickref\src\themes.rst, line 12.)