The SideKick plugin for jEdit is a structural browsing framework that provides language-aware text completion, navigation, and code structure trees. Because SideKick is an abstract framework, it does nothing by itself; it requires a language-specific companion plugin (such as the XML, JavaSideKick, or CtagsSideKick plugins) to actively parse your code. 🛠️ Setting Up SideKick
Install a Parser Plugin: Navigate to Plugins > Plugin Manager > Install tab. Search for and install a companion plugin like XML or JavaSideKick. jEdit will automatically download the core SideKick plugin as a dependency.
Open the SideKick Tree Window: Go to Plugins > SideKick > SideKick. This opens a dockable sidebar displaying a visual tree hierarchy of the functions, classes, or tags within your active document. 🔍 Core Features & How to Use Them Code Navigation via the Structure Tree
Jump to Code: Click a node in the SideKick tree to immediately jump your cursor to that specific tag, function, or class definition.
Select Entire Blocks: Shift + Click a node in the tree to highlight the entire method or block of code in the text editor.
Sync Cursor Tracking: As you click and scroll through your document, the highlighted node in the tree will automatically follow your cursor in real time. Space-Saving Toolbar Alternative
If the sidebar tree uses too much screen space, you can switch it to a dropdown format: Go to Plugins > SideKick > General. Check Show the assets in a combo-box (inside a toolbar).
This displays your code hierarchy inside compact drop-down menus at the top of the editor. Keyboard Navigation & Shortcuts
You can navigate code files rapidly without touching the mouse:
Expand/Collapse Nodes: Use the Right and Left Arrow keys within the tree pane. Move Between Sibling Blocks: Press Up and Down Arrow keys.
Jump via Editor Caret: Press Ctrl + Up Arrow or Ctrl + Down Arrow while typing to skip back and forth between consecutive functions/assets. Auto-Completion & Parsing
Trigger Code Completion: Type part of a word and press Ctrl + Space (or your designated shortcut) to see a drop-down list of valid syntax objects, keywords, or variables within scope.
On-the-fly Errors: Go to Plugins > SideKick and check Parse on Keystroke. This enables background compiling that flags syntax errors as you type. 🧱 Essential Companion Plugins
To use SideKick effectively, you must pair it with a language parser from jEdit Plugin Central:
XML Plugin: Handles schema validations, real-time tree mapping, and auto-indentation for XML, HTML, and CSL files.
JavaSideKick: Offers syntax checking and comprehensive code completion for Java environments.
CtagsSideKick: Uses exuberant ctags to generate structures for over 20 programming languages (including C++, Python, Bash, and Ruby).
What specific programming language or file type are you writing in jEdit? If you let me know, I can recommend the exact companion plugin and configurations you need to get SideKick running. jEdit – Plugin Central SideKick plugin user’s guide
Leave a Reply