The Kate Handbook

Anders Lund

Seth Rothberg

Dominik Haumann

T.C. Hollingsworth

Revision 3.12 KDE 4.12 (2013-11-28)

Kate is a programmer's text editor for KDE 4 and above.

This handbook documents Kate Version 3.11


Table of Contents

1. Introduction
2. The Fundamentals
Starting Kate
From the Menu
From the Command Line
Drag and Drop
Working with Kate
Quick Start
Shortcuts
Working With the Kate MDI
Overview
The Editor area
The Documents List
Using Sessions
Restoring old style Kate behavior
Getting Help
With Kate
With Your Text Files
Articles on Kate
3. Working with the Kate editor
Overview
Navigating in the Text
Working with the Selection
Using Block Selection
Using Overwrite Selection
Using Persistent Selection
Copying and Pasting Text
Finding and Replacing Text
The Search and Replace Bars
Finding Text
Replacing Text
Using Bookmarks
Automatically Wrapping text
Using automatic indenting
Line Modification Indicators
The Scrollbar Minimap
4. Working with Plugins
Editor Component Extensions
Scripts
Kate Application Plugins
Python Pâté Plugins
Available Plugins
Configuring Pâté
File Templates
Menu Structure
Using a Kate Template
Creating your own templates
Editing templates
The Kate Template Format
Thanks and Acknowledgments
XML Validation
Menu Structure
Thanks and Acknowledgments
XML Completion
How to Use
Features and Limitations
Menu Structure
Thanks and Acknowledgments
Exporter
Menu Structure
Search & Replace
Introduction
Interface
Menu Structure
Mail Files
Menu Structure
Filesystem Browser
Menu Structure
Interface
Configuration
Build Plugin
Introduction
Using the Build Plugin
Menu Structure
Thanks and Acknowledgments
SQL Plugin
Introduction
Connecting to a Database
Running Queries
Browsing
Menu Structure
Thanks and Acknowledgments
GDB Plugin
Introduction
Menu and Toolbar Structure
Debug View
Call Stack and Locals
Thanks and Acknowledgments
Terminal Tool View Plugin
Menu Structure
Configuration
5. Advanced Editing Tools
Comment/Uncomment
The Editor Component Command Line
Standard Command Line Commands
Using Code Folding
6. Extending Kate
Introduction
Scripting with JavaScript
Indentation Scripts
Command Line Scripts
Scripting API
Editor Component Extensions
Kate (C++) Application Plugins
Pâté Python Plugins
7. The VI Input Mode
VI Input Mode
Incompatibilities with Vim
Switching Modes
Integration with Kate features
Supported normal/visual mode commands
Supported motions
Supported text objects
Supported insert mode commands
The Comma Text Object
Missing Features
8. Menu Entries
The File Menu
The Edit Menu
The View Menu
The Projects Menu
The Bookmarks Menu
The Sessions Menu
The Tools Menu
The Settings Menu
The Help Menu
9. Configuring Kate
Overview
The Main Configuration Dialog
The Kate Application Configuration
General
Sessions
Plugins
Documents
The Editor Component Configuration
Appearance
Fonts & Colors
Editing
Open/Save
Extensions
Configuring With Document Variables
How Kate uses Variables
Available Variables
10. Credits and License
A. Working with Syntax Highlighting
Overview
The Kate Syntax Highlight System
How it Works
Rules
Context Styles and Keywords
Default Styles
The Highlight Definition XML Format
Overview
The Sections in Detail
Available Default Styles
Highlight Detection Rules
The Rules in Detail
Tips & Tricks
B. Regular Expressions
Introduction
Patterns
Escaping characters
Character Classes and abbreviations
Alternatives: matching one of
Sub Patterns
Characters with a special meaning inside patterns
Quantifiers
Greed
In context examples
Assertions
C. Installation