Copyright © 2001
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
This is the handbook for the plugins for Kate, KDE's Advanced Text Editor.
Table of Contents
- 1. Kate plugins
- 2. Hello World
- 3. HTML Tools
- 4. Insert Command
- 5. Open Header
- 6. Project Manager
- 7. Text Filter
- 8. XML Tools
- 9. Credits and License
- A. Installation
Kate plugins
Kate plugins are additional functions for the Kate editor. They can add extra menus and shortcuts, and extend Kate's features. You can install as many or as few as you like, from within Kate.
More information on using Kate and enabling the plugins you want is available in the Kate handbook.
The plugins installed in this handbook are:
Hello World
The Kate plugin ‘Hello World’ currently has no documentation. If you are interested in rectifying that situation, please contact Lauri Watts <lauri@kde.org>, KDE's Documentation Team coordinator.
Menu Structure
Configuration
Thanks and Acknowledgements
Kate Plugin “Hello World” copyright 2001 < >.
Documentation copyright 2001
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.
HTML Tools
The Kate plugin ‘HTML Tools’ currently has no documentation. If you are interested in rectifying that situation, please contact Lauri Watts <lauri@kde.org>, KDE's Documentation Team coordinator.
Menu Structure
Configuration
Thanks and Acknowledgements
Kate Plugin “HTML Tools” copyright 2001 Joseph Wenninger <jowenn@bigfoot.com>.
Documentation copyright 2001
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.
Insert Command
The ‘Insert Command’ plugin allow you to insert shell command output into a document open in kate.
To use the pluign, Insert command from the Edit menu, which will present you with a small dialog for entering the command, choose a working directory and select whether to include errors (STDERR output) in the inserted text. You may also have the command string printed above the output.
The plugin will remember a number of commands as chosen in the configuration page. Theese are used for autocompletion, and can be selected from a list in the command entry.
Per default, the command will be run in the working directory of the kate process, usually your home directory, but this can be tweaked in the configuration page for the plugin.
Notice, that any shell command that requires user input (for example passwd) or uses a ncurses interfase or something similar (for example top) will fail to produce the expected output.
Configuration
To configure the “Insert Command” plugin, open the Kate configuration dialog from the Settings menu and choose the Plugins/Insert Command page.
The following configuration options are available:
This setting, presented as a spin box, lets you decide how many commands are remembered. Any number from 0 to 99 is legal.
This setting, presented as a set of radio buttons, allows you to decide how the working directory of a command is chosen. The options are the working directory of the kate process (usually your home directory when kate is started from the K menu), the directory of the document (if any, otherwise the above option is used) or the working directory of the last command run in the plugin.
Thanks and Acknowledgements
Kate Plugin “Insert Command” copyright 2001 Anders Lund <anders@alweb.dk>.
Documentation copyright 2001 Anders Lund <anders@alweb.dk>
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.
Open Header
The Kate plugin ‘Open Header’ currently has no documentation. If you are interested in rectifying that situation, please contact Lauri Watts <lauri@kde.org>, KDE's Documentation Team coordinator.
Menu Structure
Configuration
Thanks and Acknowledgements
Kate Plugin “Open Header” copyright 2001 Joseph Wenninger <jowenn@bigfoot.com>.
Documentation copyright 2001
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.
Project Manager
The Kate plugin ‘Project Manager’ currently has no documentation. If you are interested in rectifying that situation, please contact Lauri Watts <lauri@kde.org>, KDE's Documentation Team coordinator.
Menu Structure
Configuration
Thanks and Acknowledgements
Kate Plugin “Project Manager” copyright 2001 Christoph Cullmann <crossfire@babylon2k.de>.
Documentation copyright 2001
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.
Text Filter
The Kate plugin ‘Text Filer’ currently has no documentation. If you are interested in rectifying that situation, please contact Lauri Watts <lauri@kde.org>, KDE's Documentation Team coordinator.
Menu Structure
Configuration
Thanks and Acknowledgements
Kate Plugin “Text Filter” copyright 2001 Joseph Wenniger <jowenn@bigfoot.com>.
Documentation copyright 2001
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.
XML Tools
Daniel Naber
This plugin supports writing XML files by listing allowed tags and more.
This plugin gives hints about what's allowed at a certain position in an XML file, according to the file's DTD. It will list possible elements, attributes, attribute values or entities, depending on the cursor position (all entities are listed if the character on the left of the cursor is ‘&’). It's also possible to close the nearest not-yet-closed tag on the left.
The DTD must exist in XML format, as produced by the Perl program dtdparse (note that this XML format of the DTD is not XML Schema). I'll call these kind of DTDs ‘meta DTDs’. Some meta DTDs are supplied. They are installed in $KDEDIR/share/apps/katexmltools/, which is also the default directory when you choose Assign Meta DTD.... To produce your own meta DTDs, get dtdparse from http://dtdparse.sourceforge.net.
You can test all functions and limitations by loading $KDEDIR/share/apps/katexmltools/testcases.xml into Kate and following the instructions. Note that working with more than one document is not yet supported correctly, you can only use one meta DTD for all documents.
Menu Structure
- XML Plugin->Insert XML...
This will list all allowed elements, attributes or attribute values, depending on your cursor position and the DTD. To use this, you must have assigned a meta DTD by using Assign Meta DTD....
- XML Plugin->Insert Entity...
This will list all available entities, according to the current DTD. To use this, you must have assigned a meta DTD by using Assign Meta DTD....
- XML Plugin->Close Element
This will search your text for a tag which is not yet closed and will close it by inserting a corresponding closing tag. The search starts at the cursor position and goes left. If it can't find an open tag nothing will happen.
- XML Plugin->Assign Meta DTD...
This will tell the plugin which meta DTD to use for all currently opened documents. Note that this assignment won't be saved, you'll have to repeat it when you start Kate the next time.
Thanks and Acknowledgements
Kate Plugin “XML Tools” copyright 2001,2002 Daniel Naber <daniel.naber@t-online.de>.
Documentation copyright 2001 Daniel Naber
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.
Credits and License
Copyrights for each applet is listed in the applicable chapter.
This documentation is licensed under the terms of the GNU Free Documentation License.
This program is licensed under the terms of the GNU General Public License.
Installation