QuickRef

[Rablador]

QuickRef

Having a hard time remembering your favourite commands and key bindings in Sublime Text 2? QuickRef gives you instant access to all of them from the easy-to-use command palette!

All OS:s supported!

Installation

Package Control
Easiest and quickest way to install is through Package Control: http://wbond.net/sublime_packages/package_control

Git
Clone https://bitbucket.org/rablador/quickref into your Sublime Text 2 "Packages" directory:

Download
Download the latest source from https://bitbucket.org/rablador/quickref and copy the QuickRef folder to your Sublime Text 2 "Packages" directory.

Usage

Basic
* Use a keyboard shortcut (eg. alt+p on Windows) to bring up the QuickRef command palette.
* All commands are searchable.
* Selecting a command will execute it.

Adding commands
1. Pick your favourite (or hardest to memorize) commands from any ".sublime-keymap" file (or write your own).
2. Add as many as you like to the *user* settings file. Make sure that both the commands and the settings file in general are formatted correctly (see default settings file)!
3. Add a caption (optional).
4. Optionally add more key bindings from the user/default key bindings files.

Adding favourites
1. Use a keyboard shortcut (eg. alt+shift+p on Windows) to bring up the QuickRef command palette in add/remove favourites mode.
2. Simply select the command you want to mark and immediately see it get pefixed with a (*). If "Sort alphabetically" is on, all favourites will be displayed at the top of the list.

Features

Hardcore mode
Hardcore mode will not allow you to run any commands from the command palette, thus forcing you to remember them instead.

Sort alphabetically
Sort commands alphabetically or in the order that they are added to the settings file.

Beautify captions
Beautify captions. E.g.: "clear_fields" -> "Clear fields". Great for users who don't want to add captions manually.

Favourites
Show favourite commands in the QuickRef command palette. Favourites will be displayed at the top of the list with a prefixed (*).

User commands
Choose whether to show or hide user added commands.

User key bindings
Choose whether to show or hide commands from the user bindings file.

Default key bindings
Choose whether to show or hide commands from the default bindings file.

Remove duplicates
When choosing to show commands from the default key bindings file, this feature removes duplicates.

Shortcut key filter
Filter out commands by shortcut keys.

Command contexts
Show contexts for commands. They will be displayed in parenthesis after a command.

Remove duplicate contexts
Remove commands with duplicate contexts and thereby reduce potentially superfluous items.

Change log

Ver 1.0

First release!

Ver 1.05

Fixed bug that made alphabetical sorting not work as intended in all cases.
Added setting to sort commands alphabetically or in the order that they are added to the settings file.

Ver 1.06

Temporarily fixed bug where missing setting in user's settings file results in QuickRef not leading. Proper fix in next update.

Ver 1.5

New features
Beautify captions
Beautify captions. E.g.: "clear_fields" -> "Clear fields". Great for users who don't want to add captions manually.

User commands
Choose whether to show or hide user added commands.

User key bindings
Choose whether to show or hide commands from the user bindings file.

Default key bindings
Choose whether to show or hide commands from the default bindings file.

Remove duplicates
When choosing to show commands from the default key bindings file, this feature removes duplicates.

Shortcut key filter
Filter out commands by shortcut keys.

Bugs
Proper fix of bug from version 1.06.
Fixed path not working in OSX (made QuickRef not start at all!).

Ver 1.6

New features
Command contexts
Show contexts for commands. They will be displayed in parenthesis after a command.

Remove duplicate contexts
Remove commands with duplicate contexts and thereby reduce potentially superfluous items.

Ver 2.0

Major release! Users may now filter out favourite commands right from the command palette.

New features
Add/remove favourites mode
How to:
1. Use a keyboard shortcut (eg. alt+shift+p on Windows) to bring up the QuickRef command palette in add/remove favourites mode.
2. Simply select the command you want to mark and immediately see it get pefixed with a (*). If "Sort alphabetically" is on, all favourites will be displayed at the top of the list.

Show favourites
Show favourite commands in the QuickRef command palette. Favourites will be displayed at the top of the list with a prefixed (*).

Error messages
Now showing error messages when QuickRef is seriously misbehaving (no more guessing who's doing it wrong).

About

QuickRef is created by Rablador. The code is free. As in do whatever you like with it.

[Rablador]

Ver 2.1

Rablador presents: QuickRef for Sublime Text 3!
Note: The two versions of QuickRef are not interchangeable. You need the correct build for the version of Sublime Text that you are using.
ST2: https://bitbucket.org/rablador/quickref
ST3: https://bitbucket.org/rablador/quickref-st3

New features (QuicRef for ST3)
All the features from QuickRef for Sublime Text 2 .

New features (QuicRef for ST2/ST3)
Show update "splash" item in command list when QuickRef is updated.

[robertcollier4]

Trying quickref-st3:

Code: Select all

  File "D:\PortableApps\SublimeText\Data\Packages\quickref\QuickRef.py", line 68, in run
    with zipfile.ZipFile(default_key_bindings_path, 'r') as myzip:
  File "X/zipfile.py", line 897, in __init__
FileNotFoundError: [Errno 2] No such file or directory: 'D:/Programs/Portable/SublimeText3/Packages/Default.sublime-package'

On Line 62 of QuickRef.py, you have hardcoded an absolute path. Can you use a relative path instead?

Code: Select all

      default_key_bindings_path = 'D:/Programs/Portable/SublimeText3/Packages/Default.sublime-package'


[Rablador]

My apologies! And my thanks for pointing it out!

The path was left unchanged since alpha testing and I simply forgot about it. It has now been changed. Please give the updated code a spin and get back to me if you find anything else that needs fixing.