diff --git a/doc/kate/configdialog01.png b/doc/kate/configdialog01.png index 50fad46cd..e1459e145 100644 Binary files a/doc/kate/configdialog01.png and b/doc/kate/configdialog01.png differ diff --git a/doc/kate/configuring.docbook b/doc/kate/configuring.docbook index 6fd464609..444e62544 100644 --- a/doc/kate/configuring.docbook +++ b/doc/kate/configuring.docbook @@ -1,274 +1,274 @@ &Anders.Lund; &Anders.Lund.mail; Configuring &kate; Overview configure settings preferences &kate; offers several means of tweaking the application to behave as desired. The most important ones are: The Configuration Dialog The main configuration tool, allowing you to configure the &kate; application, the editor component and the usage of plugins. The Settings Menu Allows you to change often used settings, and to launch the configuration dialogs. The View Menu Allows you to split the current frame, as well as to display the icons and line numbers pane for the currently edited document. The embedded terminal uses the configuration defined in the &systemsettings;, and may also be configured by clicking the right mouse button to display a context menu. The Main Configuration Dialog The &kate; configuration dialog displays a tree of topics on the left, and a configuration page corresponding to the selected topic on the right. The configuration is divided into two groups, namely Application configuration Editor component configuration The &kate; Application Configuration This group contains pages to configure the main &kate; application General This section contains a few global options for &kate; Behavior Warn about files modified by foreign processes When enabled, &kate; will notify you about files modified from outside the application whenever the main window receives input focus. You will be able to deal with several modified files at once, you can reload, save or discard changed files in groups. If not enabled, &kate; will prompt you for action when an externally modified file receives focus within the application. Meta Information Keep meta-information past sessions When enabled, &kate; will store meta data such as bookmarks and session configuration even when you close your documents. The data will be used if the document is unchanged when reopened. Delete unused meta information after Set the maximum number of days to keep meta information for previously opened files. This helps keeping the database of meta information reasonably sized. Sessions This section contains options related to using sessions. Elements of Sessions Include window configuration If enabled, &kate; will save the window configuration with each session. Behavior on Application Startup Select how you want &kate; to behave at startup. This setting can be overridden by specifying what to do on the command line. Start new session With this option, &kate; will start a new, unnamed session when you start the application. Load last-used session &kate; will use the most recently opened session at startup. This is good if you want to use the same session always or switch rarely. Manually choose a session &kate; will display a small dialog that lets you choose your preferred session, or load the default session if none have been saved. This is the default behavior. Nice if you use a lot of different sessions frequently. Any changes to the session data (opened files and, if enabled, window configuration) will always be saved. Plugins This page provides a list of installed plugins for the &kate; application. Each plugin is represented with its name and a short description. You can check the checkbox with an item to enable the plugin it represents. If a plugin provides configuration options, a section to access those will appear as a child of this page. For more information about the available plugins, see . Documents Background Shading This section allows you to enable or disable the background shading visualization of your recent activity, and chose which colors to use if enabled. See the section about The Document List for more about this feature. Sort By Set how you want the document list sorted. This can be set from the &RMB; menu in the document list as well. View Mode This provides two options that effect the display of the Documents tool view. The Tree View option will display the documents in a tree underneath the folders they are in, while the List View option will display a flat list of documents. Show Full Path When Tree View and this option are enabled, the folder entries displayed in the Documents tool view will display the full filesystem path to the folder in addition to the name of the folder. It has no effect in List View. The Editor Component Configuration For information about this section of the configuration dialog, see the -Editor Component +Editor Component Configuration section of the &katepart; Handbook. Configuring With Document Variables For information about using document variables with &kate;, see the -Configuring with Document +Configuring with Document Variables section of the &katepart; Handbook. diff --git a/doc/kate/development.docbook b/doc/kate/development.docbook index 22f20846f..1c7041102 100644 --- a/doc/kate/development.docbook +++ b/doc/kate/development.docbook @@ -1,86 +1,69 @@ &TC.Hollingsworth; &TC.Hollingsworth.mail; Extending &kate; Introduction Like any advanced text editor, &kate; offers a variety of ways to extend its functionality. You can write simple scripts to add functionality with JavaScript, add enhanced functionality to the editor component with Editor Component Plugins, or add even more functionality to the editor itself with -&kate; Application Plugins written in C++ or -&pate; Plugins written in Python. Finally, once -you have extended &kate;, you are welcome to +&kate; Application Plugins written in C++. +Finally, once you have extended &kate;, you are welcome to join us and share your enhancements with the world! Working with Syntax Highlighting For information about adding or modifying syntax highlighting definitions, -see the Working with Syntax +see the Working with Syntax Highlighting section of the Development chapter of the &katepart; Handbook. Scripting with JavaScript For information about scripting with JavaScript, see the -Scripting with JavaScript +Scripting with JavaScript section of the Development chapter of the &katepart; Handbook. Editor Component Extensions For information about writing &katepart; plugins, see the -Editor Component Extensions +Editor Component Extensions section of the Development chapter of the &katepart; Handbook. &kate; (C++) Application Plugins Kate Application Plugins extend the functionality of the &kate; editor itself in any way you can imagine, using the same programming language &kate; is written in, C++. To get started, see the Writing a &kate; Plugin tutorial on the &kate; website. There is also a classic Hello, world! example plugin included with the &kate; source code. - -&pate; Python Plugins - -&pate; Plugins also allow you to extend the -functionality of &kate; in any way you like, using the Python programming -language. - -To get started, see the - -Python plugin developer guide on the &kate; website. - -You can also access the API reference in the -&pate; Configuration screen. - - - diff --git a/doc/kate/fundamentals.docbook b/doc/kate/fundamentals.docbook index 45232ae87..f01658542 100644 --- a/doc/kate/fundamentals.docbook +++ b/doc/kate/fundamentals.docbook @@ -1,824 +1,781 @@ The Fundamentals If you have ever used a text editor, you will have no problem using &kate;. In the next two sections, Starting &kate; and in Working with &kate;, we will show you everything you need to get up and running quickly. Starting &kate; -You can start &kate; from the &kmenu; or from the +You can start &kate; from the application launcher or from the command line. From the Menu Open the &kde; program menu by clicking on the -big K icon on the toolbar at the bottom left of your +application launcher icon on the toolbar at the bottom left of your screen. This will raise a menu. Move your cursor up the menu to the ApplicationsUtilities Advanced Text Editor &kate; menu item. From the Command Line You can start &kate; by typing its name on the command line. If you give it a file name, as in the example below, it will open or create that file. %kate If you have an active connection, and permission, you can take advantage of &kde;'s network transparency to open files on the internet. %kate Command Line Options &kate; accepts following command line options: kate -This lists the most basic options available at the command line. - - - - - -kate - - - -This lists the options available for changing the way &kate; interacts -with &Qt;. - - - - - -kate - - -This lists the options available for changing the way &kate; interacts -with &kde;. +This lists the options available at the command line. kate name Starts kate with the session name. The session is created if it does not exist already. If a &kate; instance running the specified session exists, the specified files are loaded in that instance. When used with the option, an instance running this session will be used as well. - -kate - URL - - -Causes &kate; to use an existing instance if there is one. This is now the -default behavior, but this option remains for compatibility. - - - - kate PID Only reuses an instance with the specified PID (Process ID). Used with the option. kate encoding URL Uses the specified encoding for the document. kate line URL Navigates to the specified line after opening the document. kate column URL Navigates to the specified column after opening the document. kate Reads the document content from STDIN. This is similar to the common option used in many command line programs, and allows you to pipe command output into &kate;. kate Start &kate; with a new anonymous session, implies . kate Force start of a new &kate; instance (is ignored if is used and another &kate; instance already has the given session opened), forced if no parameters and no URLs are given at all. kate If using an already running &kate; instance, block until it exits, if URLs given to open. You can use &kate; with this option as editor for typing in commit messages for version control systems like Git or Subversion. These systems expect to block the editor till you have entered your message, because they then open the temporary file, which would be empty if kate immediately returned to the caller. This option is also needed with KIO (&kde; Input/Output), if you open a remote file (which has been downloaded to a temporary) and should be reuploaded, after you saved it. kate -Since &kate; 2.5.1 this standard &kde; option is supported. -When used, the specified files are treated as temporary files and +When used, the specified files are treated as temporary files and deleted (if they are local files and you have sufficient permissions) when closed, unless they were modified since they were opened. - -kate - - - -This lists all of the command line options. - - - - kate Lists &kate;'s authors in the terminal window. kate -Lists version information for &Qt;, &kde;, and &kate;. +Lists version information for &kate;. kate Shows license information. Drag and Drop &kate; uses the &kde; Drag and Drop protocol. Files may be dragged and dropped onto &kate; from the Desktop, the filemanager &dolphin; or some remote ftp site opened in one of &dolphin;'s windows. Working with &kate; Quick Start will show you how to toggle four simple options that will let you configure some of &kate;'s more powerful features right away. Shortcuts lays out some of the default keystroke shortcuts for those who can't or don't want to use a mouse. Quick Start This section will describe some of the items on the View menu so that you can quickly configure &kate; to work the way you want it. When you start &kate; for the first time you will see two windows with white backgrounds. Above the two windows is a toolbar with the usual labeled icons. And above that, a menubar. The left-hand window is a side bar. It combines the Documents and Filesystem Browser windows. Switch between the two by clicking on the tabs to the left of the window. If you've started &kate; with a file, the right-hand window will show the file you are editing and the Documents on the side bar will show the name of the file. Use the Filesystem Browser window to open files. You can toggle the Documents and Filesystem Browser window on and off in ViewTool Views menu. This menu offers you your first glimpse into &kate;'s power and flexibility. In this section we'll look at three items: Show Documents Toggles the Documents on and off. Shortcuts Many of &kate;'s keystroke commands (shortcuts) are configurable by way of the Settings menu. By default &kate; honors the following key bindings. Insert Toggle between Insert and Overwrite mode. When in insert mode the editor will add any typed characters to the text and push any previously typed data to the right of the text cursor. Overwrite mode causes the entry of each character to eliminate the current character. Left Arrow Move the cursor one character to the left Right Arrow Move the cursor one character to the right Up Arrow Move the cursor up one line Down Arrow Move the cursor down one line Page Up Move the cursor up one page Page Down Move the cursor down one page &Backspace; Delete the character to the left of the cursor Home Move the cursor to the beginning of the line End Move the cursor to the end of the line Delete Delete the character to the right of the cursor (or any selected text) &Shift;&Enter; Insert newline including leading characters of the current line which are not letters or numbers. It is useful ⪚ to write comments in the code: At the end of the line // some text press this shortcut and the next line starts already with // . So you do not have to enter the comment characters at the beginning of each new line with comments. &Shift;Left Arrow Mark text one character to the left &Shift;Right Arrow Mark text one character to the right F1 Help &Shift;F1 What's this? &Ctrl;F Find F3 Find again &Ctrl;B Set a Bookmark &Ctrl;C Copy the marked text to the clipboard &Ctrl;N New document &Ctrl;P Print &Ctrl;Q Quit - close active copy of editor &Ctrl;R Replace &Ctrl;S Save your file &Ctrl;V Paste &Ctrl;X Delete the marked text and copy it to the clipboard &Ctrl;Z Undo &Ctrl;&Shift;Z Redo Working With the &kate; <acronym>MDI</acronym> Overview Window, View, Document, Frame, Editor... What are they all in the terminology of &kate;, and how do you get the most out of it? This chapter will explain all of that, and even more. The Main Window Main window The &kate; Main Window is a standard &kde; application window, with the addition of side bars containing tool views. It has a menubar with all the common menus, and some more, and a toolbar providing access to commonly used commands. The most important part of the window is the editing area, by default displaying a single text editor component, in which you can work with your documents. The docking capabilities of the window is used for the tool windows: The Documents List The Filesystem Browser The Built in Terminal Emulator And possibly other tool views, for example provided by plugins. Tool views can be positioned in any sidebar, to move a tool right click its sidebar button and select from the &RMB; menu A tool view can be marked as persistent in the &RMB; menu for its sidebar button. The sidebar can contain more tools at one time so that when a tool is persistent other tools can be shown simultaneously. The Editor area Editing Area &kate; is capable of having more than one document open at the same time, and also of splitting the editing area into any number of frames, similar to how for example &konqueror; or the popular emacs text editor works. This way you can view several documents at the same time, or more instances of the same document, handy for example if your document contains definitions in the top that you want to see often for reference. Or you could view a program source header in one frame, while editing the implementation file in another. When a document is available in more than one editor, changes made in one editor will immediately be reflected in the others as well. This includes changing the text as well as selecting text. Search operations or cursor movement is only reflected in the current editor. It is currently not possible to have more instances of the same document open in the sense that one instance will be edited while the other will not. When splitting an editor into two frames, it is divided into two equally sized frames, both displaying the current document of that editor. The new frame will be at the bottom (in the case of a horizontal split) or at the right (for a vertical split). The new frame gets the focus, which is visualized by the blinking cursor bar in the focused frame. The Documents List Documents list The documents list displays a list of all documents currently open in &kate;. Modified files will have a small floppy disk icon on their left to indicate that state. By default, the Documents list appears in Tree Mode, which displays the folder structure surrounding all currently open documents. Also available is List Mode, which displays a simple list of all open documents. You can switch modes by right-clicking on the list and selecting from the View Mode menu. If two or more files with the same name (located in different folders) are open in List Mode, the names of the second will be prepended (2) and so on. The tool-tip for the file will display its full name including the path, allowing you to choose the desired one. To display a document in the currently active frame, click the document name in the list. You can sort the list in a few different ways by right clicking the list and selecting from the Sort By menu. The options are: Opening Order Lists the documents in the order of opening. Document Name Lists the documents alphabetically by their name. Document Path Lists the documents alphabetically by the path to them. The document list will per default visualize your history by shading the entries for the most recent documents with a background color. If the document was edited, an extra color is blended in. The most recent document has the strongest color, so that you can easily find the documents you are working on. This feature can be disabled in the Documents page of the configuration dialog. The default location of the document list in the &kate; window is to the left of the editing area. Using Sessions Sessions is how &kate; lets you keep more than one list of files and GUI configuration around. You can have as many named sessions as you want, and you can use unnamed or anonymous sessions for files you want to use only once. Currently &kate; can save the list of open files, and the general window configuration in the session; future versions of &kate; may add more features that can be saved in sessions. With the introduction of sessions, &kate; also allows you to open any number of instances of the application instead of just one as it used to do as the default behavior. Sessions are supported in three areas: Command line options that lets you select and start sessions when launching kate from the command line. The Sessions menu that lets you switch, save, start and manage your sessions. Configuration options that lets you decide how sessions generally should behave. When starting a new session, the GUI configuration of Default Session is loaded. To save window configuration in the default session, you need to enable saving window configuration in the sessions configuration page of the configuration dialog and then load the default session, set up the window as desired and save the session again. When a named session is loaded, &kate; will display the session name at the start of the window title, which then has the form "Session Name: Document name or &URL; - &kate;" When opening files on the command line with or if a session is selected using the session chooser, the specified session is loaded prior to the files specified on the command line. To open files from the command line in a new, unnamed session, configure kate to start a new session as default in the session page of the configuration dialog or use with an empty string: ''. Since &kate; 2.5.1 the PID of the current instance is exported to the environment variable KATE_PID. When opening files from the built in terminal Kate will automatically select the current instance if nothing else is indicated on the command line. Restoring old style &kate; behavior When you get used to using sessions you will hopefully see that they provide a very simple and efficient tool for working in different areas. However, if you prefer the old &kate; behavior (one instance opens all files), you can easily achieve that by following this simple strategy: Make kate always start with the parameter by adding that to the command in the application preferences, and additionally using a shell alias. Configure &kate; to load the last used session at startup. Configure &kate; to save the file list when closing a session. Load the default session once. Getting Help With &kate; This manual Offers detailed documentation on all menu commands, configuration options, tools, dialogs, plugins &etc; as well as descriptions of the &kate; window, the editor and various concepts used in the application. Press F1 or use the Help &kate; Handbook menu topic to view this manual. What's This Help What's This help offers immediate help with single elements of graphical windows, such as buttons or other window areas. We strive to provide What's This help for any elements for which it makes sense. It is available throughout the configuration dialog, and in many other dialogs as well. To employ What's This help, press &Shift;F1 or use the HelpWhat's This menu item to enable What's This mode. The cursor will turn into an arrow with a question mark, and you can now click any element in the window to read the What's This help for that element, if it is available. Help Buttons in Dialogs Some dialogs have a Help Button. Pressing it will start the &khelpcenter; and open the relevant documentation. With Your Text Files &kate; does not (yet!) provide any means for reading document related documentation. Depending on the file you are editing, you may find the Built in Terminal Emulator helpful for viewing related &UNIX; manual pages or info documentation, or you can use &konqueror;. Articles on &kate; &kate;'s homepage provides some Articles and Howtos with further information beyond the scope of this handbook. diff --git a/doc/kate/index.docbook b/doc/kate/index.docbook index 2c53659d9..3aad43072 100644 --- a/doc/kate/index.docbook +++ b/doc/kate/index.docbook @@ -1,323 +1,321 @@ - GDB"> - ]> The &kate; Handbook &Anders.Lund; &Anders.Lund.mail; &Seth.Rothberg; &Seth.Rothberg.mail; &Dominik.Haumann; &Dominik.Haumann.mail; &TC.Hollingsworth; &TC.Hollingsworth.mail; 2000 2001 &Seth.Rothberg; 200220032005 &Anders.Lund; 20052009 &Dominik.Haumann; 2011201220132014 &TC.Hollingsworth; &FDLNotice; -2013-02-22 -5.0 &kde; 5.0 +2015-07-31 +Applications 15.12 &kate; is a programmer's text editor for &kde; 4 and above. -This handbook documents &kate; Version 3.11 +This handbook documents &kate; Version 15.12 KDE kdebase Kate text editor programmer programming projects MDI Multi Document Interface terminal console Introduction Welcome to &kate;, a programmer's text editor for &kde; version 4 and above. Some of &kate;'s many features include configurable syntax highlighting for languages ranging from C and C++ to &HTML; to bash scripts, the ability to create and maintain projects, a multiple document interface (MDI), and a self-contained terminal emulator. But &kate; is more than a programmer's editor. Its ability to open several files at once makes it ideal for editing &UNIX;'s many configuration files. This document was written in &kate;. Editing this manual... &fundamentals-chapter; Working with the &kate; Editor For information about the basics of working with the editor component underlying &kate;, see the -Working with the +Working with the &katepart; Editor chapter of the &katepart; Handbook. &plugins-chapter; Advanced Editing Tools For information about the advanced editing tools included with &kate;, -see the Advanced Editing Tools chapter +see the Advanced Editing Tools chapter of the &katepart; Handbook. &development-chapter; The VI Input Mode For information about &kate;'s VI input mode, see the -VI Input Mode chapter +VI Input Mode chapter of the &katepart; Handbook. &menu-chapter; &configuring-chapter; Credits and License &kate;. Program copyright 2000, 2001, 2002 - 2005 by the &kate; developer team. The &kate; team: &Christoph.Cullmann; &Christoph.Cullmann.mail; Project Manager & Core Developer &Anders.Lund; &Anders.Lund.mail; Core Developer, Perl syntax highlighting, documentation &Joseph.Wenninger; &Joseph.Wenninger.mail; Core Developer, syntax highlighting Michael Bartl michael.bartl1@chello.at Core Developer Phlip phlip_cpp@my-deja.com The project compiler &Waldo.Bastian; &Waldo.Bastian.mail; The cool buffer system Matt Newell newellm@proaxis.com Testing... Michael McCallum gholam@xtra.co.nz Core Developer Jochen Wilhemly digisnap@cs.tu-berlin.de &kwrite; Author &Michael.Koch; &Michael.Koch.mail; &kwrite; port to KParts &Christian.Gebauer; gebauer@bigfoot.com Unspecified &Simon.Hausmann; &Simon.Hausmann.mail; Unspecified Glen Parker glenebob@nwlink.com &kwrite; Undo History, KSpell integration Scott Manson sdmanson@alltel.net &kwrite; &XML; syntax highlighting support &John.Firebaugh; &John.Firebaugh.mail; Various Patches &Dominik.Haumann; &Dominik.Haumann.mail; Developer, Highlight wizard Many other people have contributed: Matteo Merli merlim@libero.it Highlighting for RPM Spec-Files, Diff and more Rocky Scaletta rocky@purdue.edu Highlighting for VHDL Yury Lebedev Highlighting for SQL Chris Ross Highlighting for Ferite Nick Roux Highlighting for ILERPG &John.Firebaugh; Highlighting for &Java;, and much more &Carsten.Niehaus; Highlighting for LaTeX Per Wigren Highlighting for Makefiles, Python Jan Fritz Highlighting for Python &Daniel.Naber; Small bugfixes, &XML; plugin Documentation copyright 2000,2001 &Seth.Rothberg; &Seth.Rothberg.mail; Documentation copyright 2002, 2003, 2005 &Anders.Lund; &Anders.Lund.mail; &underFDL; &underGPL; Regular Expressions For information about using regular expressions in &kate;, see the -Regular Expressions appendix +Regular Expressions appendix to the &katepart; Handbook. Installation To learn how to install &kate; and other &kde; applications on your system, see the Installing chapter of the &kde; Fundamentals documentation. &documentation.index; diff --git a/doc/kate/kate.png b/doc/kate/kate.png index 6b20f2876..12940a9c1 100644 Binary files a/doc/kate/kate.png and b/doc/kate/kate.png differ diff --git a/doc/kate/menus.docbook b/doc/kate/menus.docbook index dec96c4cf..6e65d2738 100644 --- a/doc/kate/menus.docbook +++ b/doc/kate/menus.docbook @@ -1,1863 +1,1862 @@ Menu Entries The File Menu &Ctrl;N File New This command starts a new document in the editing window. In the Documents list on the left the new file is named Untitled. &Ctrl;O File Open... Displays a standard &kde; Open File dialog. Use the file view to select the file you want to open, and click on Open to open it. File Open Recent This is a shortcut to open recently saved documents. Clicking on this item opens a list to the side of the menu with several of the most recently saved files. Clicking on a specific file will open it in &kappname; - if the file still resides at the same location. File Open With This submenu presents a list of applications known to handle the mime type of your current document. Activating an entry will open the current document with that application. In addition, an entry Other... launches the open with dialog box that allows you to select another application to open the active file. Your file will still be open in &kate;. &Ctrl;S File Save This command saves your file. Use it often. If the file is Untitled then Save becomes Save As. File Save As... Name and rename files with this command. It launches the save file dialog box. This dialog works just as the open file dialog box does. You can use it to navigate through your file system, preview existing files, or filter your file view with file masks. Type the name you want to give the file you are saving in the Location combo box and press the OK button. &Ctrl;L File Save All This command saves all modified open files. F5 File Reload Reloads the active file. This command is useful if another program or process has changed the file while you have it open in &kate; File Reload All Reloads all opened files.. &Ctrl;P File Print... Print the active file. File Export as &HTML;... Save the currently open document as an &HTML; file, which will be formatted using the current syntax highlighting and color scheme settings. This menu item is displayed by the Exporter editor component extension, which is enabled by default. &Ctrl;W File Close Close the active file with this command. If you have made unsaved changes, you will be prompted to save the file before &kate; closes it. File Close Other Close other open documents. File Close All This command closes all the files you have open in &kate;. File Close Orphaned Close all documents in the file list, which could not be reopened during startup, because they are not accessible anymore. File Close Except Close all documents in the file list, except those which match the path selected from this submenu. This menu item is displayed by the Close Except/Like plugin, which is enabled by default. File Close Like Close all documents in the file list which match the path selected from this submenu. This menu item is displayed by the Close Except/Like plugin, which is enabled by default. &Ctrl;Q File Quit This command closes &kate; and any files you were editing. If you have made unsaved changes to any of the files you were editing, you will be prompted to save them. The Edit Menu The Edit menu contains a host of commands, all to work with the currently active document. Menu Entries &Ctrl;Z Edit Undo Undo the last editing command (typing, copying, cutting etc.) This may undo several editing commands of the same type, like typing in characters. &Ctrl;&Shift;Z Edit Redo Redo the last undo step. &Ctrl;X Edit Cut Removes selected text if any, and places a copy of the removed text in the clipboard. &Ctrl;C Edit Copy Copies selected text, if any, to the clipboard. &Ctrl;V Edit Paste Copies the first item in the clipboard into the editor at cursor position. If Overwrite Selection is enabled, the pasted text will overwrite the selection, if any. Edit Clipboard History This submenu will display the beginning of portions of text recently copied to the clipboard. Select an item from this menu to paste it in the currently open file. Edit Copy as &HTML; Copy the selection as &HTML;, formatted using the current syntax highlighting and color scheme settings. &Ctrl;A Edit Select All Selects all text in the editor. &Ctrl;&Shift;A Edit Deselect Deselects the selected text in the editor if any. &Ctrl;&Shift; B Edit Block Selection Mode Toggles Selection Mode. When the Selection Mode is BLOCK, you can make vertical selections, ⪚ select column 5 to 10 in lines 9 to 15. The status bar shows the current state of the Selection Mode, either LINE or BLOCK. Meta&Ctrl;V EditVI input Mode Switch to a vi-like, modal editing mode. This mode supports the most used commands and motions from vim's normal and visual mode and has an optional vi mode status bar. This status bar shows commands while they are being entered, output from commands and the current mode.The behavior of this mode can be configured in the -Vi +Vi Input Mode section of the Editing page in &kappname;'s settings dialog. Ins EditOverwrite Mode Toggles the Insert/Overwrite modes. When the mode is INS, you insert characters where the cursor is. When the mode is OVR, writing characters will replace the current characters if your cursor is positioned before any character. The status bar shows the current state of the Overwrite Mode, either INS or OVR. &Ctrl;F Edit Find... Launch the incremental search bar to allow you to search for text in the edited document. F3 EditFind Variants Find Next Go to the nearest downwards match of the last text or regular expression searched for, starting from cursor position &Shift;F3 EditFind Variants Find Previous Go to the nearest upwards match of the last text or regular expression searched for, starting from cursor position &Ctrl;H EditFind Variants Find Selected Finds next occurrence of selected text. &Ctrl;&Shift;H EditFind Variants Find Selected Backwards Finds previous occurrence of selected text. &Ctrl;R Edit Replace... Launch the power search and replace bar to replace one or more instances of a defined text with something else. &Ctrl;G Edit Go to Line... Launches the Go To Line bar, allowing you to enter the number of a line to find in the document Edit Search in Files Launches the Search and Replace tool view. This provides more advanced functionality than the Replace menu item described above, which can only search in the currently open document. It allows you to search either within all open files, in a directory of your choosing, or within the currently open project. This menu item is displayed by the Search & Replace plugin, which is enabled by default. For more information, see Edit Go to Next Match Go to the next match in a search performed by the Search and Replace plugin. To go to the next match in a single file search initiated by the Find command, use Find Next. This menu item is displayed by the Search & Replace plugin, which is enabled by default. Edit Go to Previous Match Go to the previous match in a search performed by the Search and Replace plugin. To go to the previous match in a single file search initiated by the Find command, use Find Previous. This menu item is displayed by the Search & Replace plugin, which is enabled by default. The View Menu The View menu allows you to manage settings specific to the active editor, and to manage frames. Menu Items View New Window Opens another instance of &kate;. The new instance will be identical to your previous instance. &Alt;Left View Previous Document Opens the document displayed above the currently open document in the Documents list. &Alt;Right View Next Document Opens the document displayed below the currently open document in the Documents list. View Show Active Displays the currently open document in the Documents list. &Ctrl;&Alt;O View Quick Open Show a search field and a list of opened files in the editor area. While entering text in the search field the document names and document &URL;s are searched for matching text. While entering text in the search field you can use the cursor keys Up and Down to navigate in the list view. Pressing the &Enter; key or double clicking on an item in the list switches the view to the document selected in the list view. This makes switching between documents easier, if there are a lot of them open. &Shift;F8 ViewSplit View Previous Split View Focus the previous document view, if you have split the editor area in more views. F8 ViewSplit View Next Split View Focus the next document view, if you have split the editor area in more views. &Ctrl;&Shift;L ViewSplit View Split Vertical This will split the frame (which may be the main editing area) in two equally sized frames, the new one to the left of the current one. The new frame gets the focus, and will display the same document as the old one. See also Working with the &kate; MDI &Ctrl;&Shift;T ViewSplit View Split Horizontal Splits the current frame (which may be the main editing area) in two equally sized frames, the new one below the current one. The new frame gets the focus, and displays the same document as the old one. See also Working with the &kate; MDI &Ctrl;&Shift;R ViewSplit View Close Current View Closes the active frame, which can be identified as the one displaying a blinking cursor. This is disabled, if there is only one frame (the main editing area). No documents get closed by closing a frame – they will still be available in the View Menu as well as in the File List. See also Working with the &kate; MDI ViewSplit View Close Inactive Views Closes all frames except the active frame (the one with a blinking cursor). This is disabled, if there is only one frame (the main editing area). No documents get closed by closing a frame – they will still be available in the View Menu as well as in the File List. ViewSplit View Move Splitter Left When Split View is enabled, this will move the border between two vertically split documents further left. ViewSplit View Move Splitter Right When Split View is enabled, this will move the border between two vertically split documents further right. ViewSplit View Move Splitter Up When Split View is enabled, this will move the border between two horizontally split documents further up. ViewSplit View Move Splitter Down When Split View is enabled, this will move the border between two horizontally split documents further down. ViewTool Views &Ctrl;&Alt;&Shift;F ViewTool Views Show Sidebars Toggles the display of the sidebar button rows. This command does not affect the display of the sidebar content widgets, any sidebar that is visible will stay visible, and if you assigned shortcuts to the commands below those will of course continue to work. ViewTool Views Show Documents Toggle the display of &kate;'s Documents list ViewTool Views Show Search and Replace Displays the advanced Search and Replace tool view, which supports searching through multiple files. For more information, see . This menu item is displayed by the Search & Replace plugin, which is enabled by default. ViewTool Views Show Projects Displays the Projects sidebar, which allows you to view a list of open projects and a list of files in those projects. This menu item is displayed by the Project plugin, which is enabled by default. ViewTool Views Show Current Project Displays the Current Project tool view, which allows you to access details about the code contained within the currently open project. This menu item is displayed by the Project plugin, which is enabled by default. F7 ViewSwitch to Command Line This command will toggle the display of the -built-in +built-in command line. ViewShow the Javascript Console This opens a tool view that allows you to run Javascript code interactively. For more information, see Extending &kate; with Scripts. ViewSchema This menu lists the available color schemes. You can change the schema for the current view here, to change the default schema you need to -use the Fonts +use the Fonts & Colors page of the config dialog. F10 ViewDynamic Word Wrap Toggles dynamic word wrap in the current view. Dynamic word wrap makes all the text in a view visible without the need for horizontal scrolling by rendering one actual line on more visual lines as needed. View Dynamic Word Wrap Indicators Choose when and how the dynamic word wrap indicators should be displayed. This is only available if the Dynamic Word Wrap option is checked. ViewShow Static Word Wrap Marker Toggles the display of a vertical line indicating the position of the wrap width as configured in the -config +config dialog. This feature requires that you use a true fixed-width font. F6 View Show Icon Border This is a toggle item. Setting it to be checked will make the Icon Border visible in the left side of the active editor, and vice versa. The Icon Border indicates the positions of the marked lines in the editor. F11 View Show Line Numbers This is a toggle Item. Setting it to be checked will make a pane displaying the line numbers of the document visible in the left border of the active editor, and vice versa. ViewShow Scrollbar Marks Toggles the visualization of bookmarks (and other marks) on the vertical scrollbar. When enabled, a mark is represented by a thin line in the mark color at the scrollbar, clicking the &MMB; on the line will scroll the view to a position near the mark. ViewShow Scrollbar Minimap This will replace the scrollbar with a visualization of the current document. For more information on the scrollbar minimap, see the -Scrollbar Minimap +Scrollbar Minimap section of the &katepart; Handbook. F9 ViewShow Folding Markers Toggles the display of the folding marker pane in the left side of the view. See -Using Code +Using Code Folding. ViewCode Folding These options pertain to -code +code folding: Fold Current Node Collapse the region that contains the cursor. Unfold Current Node Expand the region that contains the cursor. &Ctrl; &Shift;- Fold Toplevel Nodes Collapse all toplevel regions in the document. Click on the right pointing triangle to expand all toplevel regions. &Ctrl; + ViewEnlarge Font This increases the display font size. &Ctrl; - ViewShrink Font This decreases the display font size. The Projects Menu The Projects menu allows you to switch between currently open projects. It is displayed by the Project plugin, which is enabled by default. Menu Items &Ctrl;&Alt;Left Projects Back Switch to the previous project. &Ctrl;&Alt;Right Projects Forward Switch to the next project. The Bookmarks Menu The Bookmarks menu allows you to work with the bookmarks in the currently active document. Below the entries described here, one entry for each bookmark in the active document will be available. The text will be the first few words of the marked line. Choose an item to move the cursor to the start of that line. The editor will scroll as necessary to make that line visible. Menu Items &Ctrl;B Bookmarks Set Bookmark Sets or removes a bookmark in the current line of the active document. (If it's there, it is removed, otherwise one is set.) Bookmarks Clear All Bookmarks Clears (removes) all bookmarks in the active document. &Alt; PgUp BookmarksPrevious This will move the cursor to beginning of the first above line with a bookmark. The menuitem text will include the line number and the first piece of text on the line. This item is only available when there is a bookmark in a line above the cursor. &Alt; PgDown BookmarksNext This will move the cursor to the beginning of the next line with a bookmark. The menuitem text will include the line number and the first piece of text on the line. This item is only available when there is a bookmark in a line below the cursor. The Sessions Menu This menu contains entries for using and managing &kate; sessions. For more information, read Using Sessions. Sessions New Creates a new empty session. All currently open files will be closed. SessionsOpen Session... Open an existing session. The Session Chooser dialog is displayed to let you choose one. SessionsQuick Open Session This submenu lets you open an existing session. SessionsSave Session Save the current session. If the session is anonymous, you will be prompted for a session name. SessionsSave Session As... Save the current session under a new name. You are prompted for a name to use. SessionsManage Sessions... Displays the Session Manager dialog which allows you to rename and delete sessions. The Tools Menu Tools Read Only Mode Set the current document to Read Only mode. This prevents any text addition and any changes in the document formatting. Tools Mode Choose the filetype scheme you prefer for the active document. This overwrites the global -filetype +filetype mode set in Settings Configure &kate;... in the Filetypes tab for your current document only. Tools Highlighting Choose the Highlighting scheme you prefer for the active document. This overwrites the global highlighting mode set in Settings Configure Editor... for your current document only. Tools Indentation -Choose the style of +Choose the style of indentation you want for your active document. This overwrites the global indentation mode set in Settings Configure Editor... for your current document only. Tools Encoding You can overwrite the default encoding set in Settings Configure Editor... in the Open/Save page to set a different encoding for your current document. The encoding you set here will be only valid for your current document. Tools End of Line Choose your preferred end of line mode for your active document. This overwrites the global end of line mode set in Settings Configure Editor... for your current document only. Tools Add Byte Mark Order (BOM) Checking this action you can explicitly add a byte order mark for unicode encoded documents. The byte order mark (BOM) is a Unicode character used to signal the endianness (byte order) of a text file or stream, for more information see Byte Order Mark. Tools Scripts This submenu contains a list of all scripted actions. The list can easily be modified by -writing +writing your own scripts. This way, &kate; can be extended with user-defined tools. -There is a complete list of +There is a complete list of scripts in the &katepart; documentation. &Ctrl;Space Tools Invoke Code Completion Manually invoke command completion, usually by using a shortcut bound to this action. Tools Word Completion Reuse Word Below (&Ctrl; 9) and Reuse Word Above (&Ctrl; 8) complete the currently typed text by searching for similar words backward or forward from the current cursor position. Shell Completion pops up a completion box with matching entries. &Ctrl;&Shift;O ToolsSpelling Automatic Spell Checking When Automatic Spell Checking is enabled, wrongly spelled text is underlined in the document on-the-fly. ToolsSpellingSpelling... This initiates the spellchecking program - a program designed to help the user catch and correct any spelling errors. For more information on how to use the &kde; spellchecking program, see the Check Spelling section of the &kde; Fundamentals documentation. ToolsSpelling Spelling (from cursor)... This initiates the spellchecking program but it starts from where your cursor is instead of at the beginning of the document. ToolsSpelling Spellcheck Selection... Spellchecks the current selection. ToolsSpelling Change Dictionary Displays a drop down box with all available dictionaries for spellchecking at the bottom of the editor window. This allows easy switching of the spellcheck dictionary ⪚ for automatic spellchecking of text in different languages. ToolsClean Indentation This cleans the indentation for the current selection or for the line the cursor is currently in. Cleaning the indentation ensures that all your selected text follows the indentation mode you choose. Tools Align Causes a realign of the current line or selected lines using the indentation mode and indentation settings in the document. &Ctrl;D Tools Comment This adds one space to the beginning of the line where the text cursor is located or to the beginning of any selected lines. &Ctrl;&Shift;D Tools Uncomment This removes one space (if any exist) from the beginning of the line where the text cursor is located or from the beginning of any selected lines. &Ctrl;U Tools Uppercase Put the selected text or the letter after the cursor in uppercase. &Ctrl;&Shift;U Tools Lowercase Put the selected text or the letter after the cursor in lowercase. &Alt;&Ctrl;U Tools Capitalize Capitalize the selected text or the current word. &Ctrl;J Tools Join Lines Joins the selected lines, or the current line and the line below with one white space character as a separator. Leading/trailing white space on joined lines is removed in the affected ends. Tools Apply Word Wrap Apply static word wrapping on all the document. That means that a new line of text will automatically start when the current line exceeds the length specified by the Wrap words at option in the Editing tab in SettingsConfigure Editor... Tools Create Snippet Create a new snippet, which is a reusable chunk of text you may insert in any part of any document. Tools Snippets... Display a list of available snippets. Menu items for the selected -plugins +plugins are displayed at the end of this menu. The Settings Menu The Settings menu allows you to change the properties of the main window, such as showing/hiding toolbars, and provides access to the configuration dialogs. Settings Show Toolbar When this is checked, this displays a movable toolbar containing buttons used to initiate frequently used commands. When unchecked the toolbar is hidden. SettingsShow Statusbar When checked, this displays a small bar at the bottom of the editor containing information about the status of the current document. When unchecked the status bar is hidden. SettingsShow Path in Titlebar When selected, this displays in the titlebar the path (its location in the file system) of the current document. When unchecked the path is hidden. &Ctrl;&Shift;F SettingsFull Screen Mode Toggles full screen display. Settings Configure Shortcuts... Display the familiar &kde; Keyboard Shortcut Configuration Dialog. For more information on using this, see the Using and Customizing Shortcuts section of the &kde; Fundamentals documentation. Settings Configure Toolbars... Display the familiar &kde; Toolbar Configuration Dialog. For more information on using this, see the Customizing Toolbars section of the &kde; Fundamentals documentation. Settings Configure &kate;... Launch the Main Configuration Dialog The Help Menu Apart from standard &kde; Help menu items -described below you will have menu entries to show the -Tip of the Day and the About +described below you will have a menu entriy to show the About Editor Component information. &help.menu.documentation; diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook index d0bb18382..605d867ea 100644 --- a/doc/kate/plugins.docbook +++ b/doc/kate/plugins.docbook @@ -1,2748 +1,2081 @@ &Anders.Lund; &Anders.Lund.mail; Working with Plugins &kate; offers several types of plugin. There are plugins for the &kate; editor component, which are available to any application using the editor component, such as KDevelop, Quanta, Kile, &kwrite; and many others. There are also plugins only available in the &kate; editor itself. There are two types of these plugins: some are written in native C++, while others are written in the Python programming language. There are subtle differences in these, described below. You can enable any type of plugin in the configuration dialog, which also provides access to additional configuration options for plugins that require it. There are many plugins for various purposes available and you can search the web for more. A few plugins are shipped with the editor component, for inserting automatic braces, inserting files, and exporting text as &HTML;. Editor Component Extensions For information about available plugins, see the -Editor Component +Editor Component Extensions section of the &katepart; Handbook. &kate; Application 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;. Open &kate;'s configuration dialog with SettingsConfigure &kate;... Select ApplicationPlugins to choose the wanted plugins. The available application plugins are: Backtrace Browser - Backtrace navigation tool view Build Plugin - Compile or Make and parse error messages Close Except/Like - Close group of documents based on a common path or file extension CTags - Look up definitions/declarations with CTags -File system browser - - File system browser tool view +Document switcher - Quick document switching with &Alt; behavior -File Templates - - Create new files from templates +File system browser - + File system browser tool view &gdb; - Provides a simple &gdb; frontend -Jovie Text-to-Speech - Adds a menu entry for speaking the text - - -Mail files - Send files - via email +Icon picker - Invokes Cuttlefish icon picker -Multiline Tab Bar - Add a tab bar with multiple rows to &kate;'s main window +Lumen - Lumen is a Autocompletion Plugin for D, using the DCD autocompletion server Open Header - Opens the corresponding .h/[.cpp|.c] file Project Plugin - Project plugin for kate -Python Plugins - &pate; host for Python plugins +Replicode + + +Rust code completion - Code completion for Rust source code Search & Replace - Search or replace patterns in opened documents or in files on disk Snippets tool view - Tool view embedding the snippets management SQL Plugin - Execute query on SQL databases Symbol Viewer - Extract and show reference symbols from source -Tab Bar - Adds a standard tab bar to &kate;'s main window - - - Terminal tool view - Tool view embedding a terminal widget Text Filter - Easy text filtering &XML;Completetion - Lists &XML; elements, attributes, attribute values and entities allowed by DTD - -&XML; Validation- Validates &XML; files using xmllint - - -Python &pate; Plugins - -The &pate; Python Plugin host makes available many plugins written in the -Python programming language. - -To enable &pate; plugins, you must first enable the -Python Plugins plugin in the -Plugins page of -&kate;'s configuration dialog. You may then enable, disable, and -configure them in the Python Plugins page of the -configuration dialog. For more information about configuring &pate; plugins, see -. - - -Available Plugins - - - - -block - -Plugins to help code editing - - - - -cmake_utils - -CMake helper plugin - - - - -color_tools - -Class encapsuling the ability to show color swatches (colored tooltips) - - - - -commentar - -Move an inlined comment before the current line with the same indentation level - - - - -django_utils - -Django utilities: Snippets, and template utilities - - - - -expand - -User-defined text expansions. - -Each text expansion is a simple function which must return a string. -This string will be inserted into a document by the expandAtCursor action. -For example, if you have a function foo in the -all.expand file which is defined as: - - -def foo: - return 'Hello from foo!' - - -after typing foo, the action will replace foo -with Hello from foo!. The expansion function may have parameters -as well. For example, the text_x-c++src.expand file -contains the cl function which creates a class (or class template). This will -expand cl(test) into: - - -/** - * \\brief Class \c test - */ -class test -{ -public: - /// Default constructor - explicit test() - { - } - /// Destructor - virtual ~test() - { - } -}; - - -but cl(test, T1, T2, T3) will expand to: - - -/** - * \\brief Class \c test - */ -template <typename T1, typename T2, typename T3> -class test -{ -public: - /// Default constructor - explicit test() - { - } - /// Destructor - virtual ~test() - { - } -}; - - - - - -format - -Plugins to work with C++ code formatting - - - - - - -gid - -Browse the tokens in a GNU idutils ID file, and -use it to navigate within a codebase. - -The necessary parts of the ID file are held in memory to allow sufficient -performance for token completion, when looking up the usage of a token, or -jumping to the definition. etags(1) is used to locate the -definition. - - - -js_utils - -JavaScript utilities: Autocomplete, Autocomplete jQuery, Checker JSLint, Pretty -JSON, Snippets - - - - -python_autocomplete - -Python Autocompletion (beta, only for Python 2) - - - - -python_console_classic - -Interactive console for inspecting &kate;'s internals and playing about - - - - -python_console_ipython - -IPython console for hacking &kate; and doing science - - - - -python_utils - -Python Utilities: Parse Checker, PEP8 Checker, Pyflakes Checker, Snippets - - - - -xml_pretty - -A simple &XML; pretty printer. It formats &XML; with good indentation. - - - - - - - -Configuring &pate; - - -The <guilabel>Manager</guilabel> Tab - -This tab contains a list of &pate; plugins. To enable or disable them, -simply select or unselect the checkbox to the left of the plugin name. - -To refresh the list of plugins, reload any currently running plugins, or -start any newly selected plugins, select the -Reload Plugins button at the bottom of the window. - -Reloading a plugin may have unpredictable effects. Consider -saving your work before using this command. - - - - -The <guilabel>Documentation</guilabel> Tab - -The Documentation tab contains information about the -actions, menu items, keyboard shortcuts, and configuration pages offered by -&pate; plugins, as well as a reference for programmers using the functionality -of the plugins. - -The following tabs are available: - - - - -Actions -Lists all the actions offered by the plugin, including the menu -item, icon, and keyboard shortcut that will invoke the action. - - - -Configuration Pages -Lists all the configuration pages offered by the plugin, -including their titles and icons. - - - -Programmer's Reference -Includes information about all the modules, classes, and -functions offered by a plugin, as generated by pydoc. - - - - - - - - - - - - - - - -&Anders.Lund; &Anders.Lund.mail; - - -File Templates - - The File Templates plugin allows you to create files based on other - files. - When you first install &kate;, you need to enable the plugin: - - - - Click SettingsConfigure &kate; - - - - - In the tree on the left of the screen, click Plugins. - - - - - In the Plugin Manager panel on the right, select File Templates, and then click OK. - - - - You can now use any file as a template (this creates a copy of the - file with an empty &URL;.) Special template files can contain - macros to fill in information such as your name, email address, the - current date, and position the cursor at a - convenient position in the new file. - You can easily create a new template from an open document. - Templates that you save to the template folder are - listed under the menu item FileNew from - Template. - The template folder is part of the &kde; file system, and - consists of at least - - - - $KDEDIR/share/applications/kate/plugins/katefiletemplates/templates - - - - - $KDEHOME/share/applications/kate/plugins/katefiletemplates/templates. - - - - If your KDEDIRS environment variable contains additional directories, those are - searched for a similar subdirectory as well. If equally named templates are - found, the one in the local (KDEHOME) folder is chosen. - - Menu Structure - - - - - - File - New From Template - Any File... - - - Presents you with an Open File dialog that allows - you to use any file as a template. If the chosen file has the - extension katetemplate it will be parsed - for template information and macros. - - - - - - File - New From Template - - - The remainder of submenus contain links to - templates. Click a menu item to create a file as described by - the menu item text. - - - - - - - SettingsManage - Templates... - This will launch a dialog with a list of all templates - found within the template directories, along with options to add, - edit or remove templates. - - - - - - Using a &kate; Template - When creating a file from a template that contains template - macros, some macros appear as editable variables in the text. Such - variables appear as underlined words in the text. - The first variable will be selected, so you just have to type to edit - it. If the document text contains more instances of the same variable, - they are changed as you edit. To move to the next editable variable, - press the key. When the last variable is edited, the list is - dropped, and your key works as normal. - - - - Creating your own templates - To create a new template, use the - Settings - Manage Templates Item to launch - the template management dialog. In that, click - New... to launch the File Template Wizard. You - will be asked for an optional file to turn into a template and prompted - for template information settings, and a template file will be created for - you. Alternatively, you can create a template manually by - adding template information to the top of any file, add text and macros, - and save it with the katetemplate extension. - The template menu is automatically updated if you chose to store - your template in the template directory. - - - - Editing templates - To edit a template, use the - Settings - Manage Templates.... Select the - template you want to work on and click Edit..., - and the template file will be opened. Close the dialog, edit the template - file as desired, save it and close it. Changes to templates take - immediate effect; you can activate the template to test your changes after - saving it. - - - - The &kate; Template Format - If you use files with the extension - katetemplate, they will be parsed for template - information, macros and a cursor position. - - - Template information - While reading in the file, the parser keeps - lines beginning with the phrase - katetemplate: and searches them for - template information in the form VARIABLENAME=VALUE. The first line not - starting with katetemplate: will be taken as the - start of the template contents. VALUE may contain any character but - equal sign (=). Legal variable names are: - - - Template - This is the template name, displayed in the - FileNew from - Template menu. - - - Group - The group places the template in a submenu of - the FileNew from - Template menu. - - Name - This is the name that will be set for the - document, and displayed in the file list and title bar. If the - name contains %N that will be replaced - with a number, incrementing if more documents have the same - name. - - - Highlight - The plugin will try to set the Highlight for - the new document to the value of this variable. The value - should be the name, as found in - Tools - Highlighting - . - - - - Description - A short informative description of the - template. This is currently used to set a What's this? string for - the menu item, but may be used for additional purposes in the - future. - - Author - A string identifying the author, for example - in the form Name <email address>. - This is currently used to set a What's this? string for the menu - item, but may be used for additional purposes in the - future. - - - - - - - - Template Macros - - While parsing the template contents, macros in the form - %{NAME} or ${NAME} are - expanded. If you use the $ prefix, the - expanded macro will be treated as a editable variable when a document - is created from the template, whereas if you use - % it is not, unless expanding failed. - The following macros are expanded: - - time - Expands to the current time in your locale - format. - - - date - Expands to the current date in short - format. - - - datetime - Expands to the current date and time, - formatted as a string according to your - locale. - - - year - The current year as a four digit - number. - - - month - The full name of the current month, according - to your locale. - - day - Expands to the current day of the month. - - - hostname - Expands to the hostname of your computer. - - - index - Expands to 'i'. - - fullname - Expands to your full name, as defined in the - owner addressee in your standard &kde; - addressbook. - - firstname - Expands to your first name, as defined in the owner - addressee in your standard &kde; addressbook. - - - lastname - Expands to your last name, as defined in the owner - addressee in your standard &kde; addressbook. - - - - - email - Expands to your email address, as defined in - the owner address in your standard &kde; - addressbook. - - - - - Any macro not in the above list is treated as an editable variable - no matter the prefix. - If the same variable occurs multiple times in the template, they can be - edited at once after creating a document from the template. - - - - Setting the cursor position - The special macro ${cursor} will be replaced - with a vertical bar and added to the end of the list of editable variables, - independent of its location in the text. - - - - - Thanks and Acknowledgments - - &kate; Plugin File Templates copyright 2004 &Anders.Lund; - &Anders.Lund.mail;. - - Documentation copyright 2004 &Anders.Lund; - - - - - - -&Daniel.Naber; &Daniel.Naber.mail; - - - -&XML; Validation - -This plugin checks &XML; files for validity and being well-formed. -This plugin checks the current file. A list of warnings and errors -will appear at the bottom of &kate;'s main window. You can click on an error message -to jump to the corresponding place in the file. If the file has a DOCTYPE -the DTD given with this doctype will be used to check the file for validity. The -DTD is expected at a position relative to the current file, ⪚ if the doctype -refers to DTD/xhtml1-transitional.dtd and the file is /home/peter/test.xml -the DTD is expected to be located at /home/peter/DTD/xhtml1-transitional.dtd. -However, remote DTDs specified via http are supported. - -If the file has no doctype it will be checked for being well-formed. - -To learn more about &XML; check out the official W3C &XML; pages. - -Internally this plugin calls the external command xmllint, which -is part of libxml2. If this command is not correctly installed on your system, the plugin -will not work. - -A temporary file needs to be written to the same folder as the file -that is being checked is in, so you need to have write access to that folder. - -To load this plugin open &kate;'s configuration dialog under Settings -Configure &kate;.... -Then select &XML; Validation which will appear -in the Application / Plugins section and close the dialog. - - - -Menu Structure - - - - - -&XML; -Validate &XML; - - -This will start the check, as described above. - - - - - - -Thanks and Acknowledgments - -&kate; Plugin &XML; Validation copyright 2002 &Daniel.Naber; -&Daniel.Naber.mail;. - -Documentation copyright 2002 &Daniel.Naber; - - - - &Daniel.Naber; &Daniel.Naber.mail; &XML; Completion This plugin gives hints about what is 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 open tag on the left. The DTD must exist in &XML; format, as produced by the Perl program dtdparse. We will call a DTD in this format meta DTD. Some meta DTDs are supplied. They are installed in $KDEDIR/share/apps/katexmltools/, which is also the default folder when you choose Assign Meta DTD.... To produce your own meta DTDs, get dtdparse from http://dtdparse.sourceforge.net. How to Use Start &kate; and open the configuration dialog under Settings Configure &kate;.... Then select &XML; Completion which will appear in the Application/Plugins section and close the dialog. After that, select &XML;Assign Meta DTD.... If your document contains no DOCTYPE or the doctype is unknown, you will have to select a meta DTD from the file system. Otherwise the meta DTD that matches the current document's DOCTYPE will be loaded automatically. You can now use the plugin while typing your text: < (less than key) This will trigger a list of possible elements unless the cursor is inside a tag already. Note that you currently cannot use this to insert the top level element (⪚ <html>). </(less than key + slash) Entering these characters will offer to close the current element (nearest open one to the left of the cursor). Press &Enter; to accept the suggestion. Unlike the Close Element menu item, this works only with a DTD assigned. " (quote key) The quote key will trigger a list of possible attribute values (if there are any) if you are inside a tag.   (space key) This key will trigger a list of possible attributes for the current element if you are inside a tag. & (ampersand key) This key will trigger a list of named entities. Features and Limitations You can test all functions and limitations by loading $KDEDIR/share/apps/katexmltools/testcases.xml into &kate; and following the instructions. Menu Structure &Ctrl;Return &XML; Insert Element... This will open a dialog that lets you insert an &XML; element. The <, > characters and the closing tag will be inserted automatically. If you have selected text when this menu item is selected, the selected text will be surrounded by the opening and the closing tag. The dialog also offers completion of all elements that may be inserted at the current cursor position if you have assigned a meta DTD by using Assign Meta DTD.... &Ctrl;< &XML; Close Element This will search your text for a tag that is not yet closed and will close it by inserting the corresponding closing tag. The search starts at the cursor position and goes left. If it cannot find an open tag nothing will happen. &XML; Assign Meta DTD... This will tell the plugin which meta DTD to use for the current document. Note that this assignment will not be saved. You will have to repeat it when you start &kate; the next time. Thanks and Acknowledgments &kate; Plugin &XML; Completion copyright 2001,2002 &Daniel.Naber; &Daniel.Naber.mail;. KDE SC 4 version copyright 2010 Tomáš Trnka Documentation copyright 2001,2002 &Daniel.Naber; Exporter Menu Structure File Export as &HTML;... Export your file in &HTML; format so your document can be viewed as a web page. Edit Copy as &HTML;... Copies selected text with the syntax highlight as &HTML; text. &TC.Hollingsworth; &TC.Hollingsworth.mail; Search & Replace Introduction &kappname;'s Search & Replace plugin allows you to search for text or -regular expressions +regular expressions in many different files at once. You can search all open files, all the files in one directory and optionally its subdirectories, or all files in the current project. You can even filter by filename, for instance searching only files that end with a particular file extension. Interface Search Query The following options are always displayed at the top of the Search in Files tool view: New Tab You can have as many searches as you want open at the same time. Simply click the New Tab button at the top-left corner of the Search tool view and a new results tab will open permitting you to perform another search. Toggle Results The down arrow in the top right-corner of the Search in Files tool view will toggle the bottom half of the tool view between displaying additional options for the Search in Folder mode and the results of your search. Find This is where you type in what you want to find. You may enter standard text, or a regular expression if enabled. Replace (text box) Replacement text that will be added to file(s) in place of the text in the Find text box. Search When you've finished configuring everything, just press the Search button to perform your search. You may also press &Enter; in the Find text box to do the same. Replace When you've finished configuring everything, just press the Replace button to replace the text entered in the Find text box with that of the Replace text box. You may also press &Enter; in the Replace text box to do the same. Next Go to the next match of your search query, switching files if necessary. Replace checked The same as Replace, but will only perform replacements in files that are checked in the pane below. Search in Folder Options These options are displayed below the aforementioned query options. If search results are being displayed instead, press the Toggle Results button to display them. Match case Restricts search results to only those that have the exact same combination of upper and lower case letters as your search query. Regular expressions -Permits you to use regular +Permits you to use regular expressions instead of simple text as your search query. Expand results Display all the results found in each file, instead of just a list of files that contain the search query. Search This has three options. Select in Open files to search all files currently open in &kappname;. Select in Folder to search inside a folder and optionally its subfolders. Select in Project to search all the files listed in the currently open project. Folder You may enter the path of the folder you wish to search. For instance, you might enter ~/development/kde/kate/ if you wished to search the &kate; source code. This option is only available when using in Folder mode. Open file dialog Press this button to locate the folder in your desktop's folder browser. This button only works when using in Folder mode. Up Press this button to change Folder to the parent of the currently selected folder. This button only works when using in Folder mode. Restore Current Folder This button will set the Folder entry to the folder in which the currently open document is located. This button only works when using in Folder mode. Filter This permits you to only search filenames that match a particular pattern. For instance, to only search files written in C++, change it to *.cpp. To search only files beginning with kate, change it to kate*. You can enter multiple filters separated with a comma (,). This option is not available when using in Open files mode. Exclude The opposite of Filter, this prevents &kappname; from searching files that match the specified patterns. As with Filter, you can enter multiple patterns separated with a comma (,). This option is not available when using in Open files mode. Recursive If this option is enabled, &kappname; will also search in all subfolders of the selected folder. This option is only available when using in Folder mode. Include hidden If this option is enabled, &kappname; will also search in files or folders that are typically hidden by your &OS;. This option is only available when using in Folder mode. Follow symbolic links The Search in Files plugin typically doesn't follow symbolic links. When this option is enabled, the plugin will follow them instead and search inside the files or folders they reference. This option is only available when using in Folder mode. It's possible for symbolic links to reference a folder that is the parent of the folder currently being searched, or other folders that contain symbolic links to their parent. If there is such a link in the folder being searched and this option is enabled, &kappname; will repeatedly follow the link and search the folder, and the search will never complete. Include binary files If enabled, &kappname; will also search in files that do not appear to be text files. Search Results The results of your search are displayed below the query options. If options for Search in Folder mode are displayed, simply press the Toggle Results button to display them. They will also automatically be displayed as soon as a search is performed. The search results display a list of files that contains text that matches your search query, followed by the number of matches found in that file. To see a list of matches in that file, simply click the expansion arrow to the left of the file name. (If you selected the Expand results option, this will already be done for you.) The line number each match is found on will be displayed, followed by the contents of that line, with your search query indicated in bold text. To open the file your result was found in, simply double-click it. &kappname; will open the file if needed. You can also move the cursor to the location of a particular match by double-clicking on its listing instead of the file name. Menu Structure Edit Search in Files Launches the Search and Replace tool view. Edit Go to Next Match Go to the next match in a search performed by the Search and Replace plugin. Edit Go to Previous Match Go to the previous match in a search performed by the Search and Replace plugin. ViewTool Views Show Search and Replace Toggle the display of &kappname;'s Search and Replace tool. - - -Mail Files - - -Menu Structure - - - - - -File -Mail... - - - - -Open your mail client and attach the file in the mail. - - - - - - - - Filesystem Browser The Filesystem Browser is a folder viewer, allowing you to open files from a displayed folder in the current frame. Menu Structure ViewTool Views Show Filesystem Browser Toggle the display of &kate;'s Filesystem Browser. Interface From the top down, the Filesystem Browser consists of the following elements: A Toolbar This contains standard navigations tool buttons: Back Causes the folder view to cd to the previously displayed folder in the history. This button is disabled, if there is no previous item. Forward Causes the folder view to cd to the next folder in the history. This button is disabled, if there is no next folder. Bookmarks Opens a submenu to edit or add bookmarks and to add a new bookmark folder. Current Document Folder This button will cause the folder view to cd to the folder of the currently active document if possible. This button is disabled, if the active document is a new, unsaved file, or the folder in which it resides can not be decided. Options Short View Displays only the filenames. Detailed View Displays Name, Date, Size and Type of the files. Tree View Like Short View, but folders can be expanded to view their contents. Detailed Tree View This also allows folders to be expanded, but displays the additional columns available in Detailed View. Show Hidden Files Displays files normally hidden by your &OS;. Automatically synchronize with current document When this option is enabled the filesystem browser will automatically cd to the folder of the document currently open in the editing area every time it changes. A Location Entry This displays a breadcrumb navigation to the currently open folder, similarly to &dolphin;. You can click on a any folder to browse to it, or click on one of the arrows to the left of a folder to select any folders beneath it. You may also select from your list of Places by clicking the leftmost icon in the breadcrumb navigation, which displays an icon that represents your current Place. You can also click to the right of the breadcrumbs to change them to a text box where you can type the path of a folder to browse. The &URL; entry maintains a list of previously typed paths. To choose one, use the arrow button to the right of the entry. The &URL; entry has folder auto-completion. The completion method can be set using the &RMB; menu of the text entry. A Folder View This is a standard &kde; folder view. A Filter Entry The Filter entry allows you to enter a filter for the files displayed in the folder view. The filter uses standard globs; patterns must be separated by white space. Example: *.cpp *.h *.moc To display all files, enter a single asterisk *. The filter entry saves the last 10 filters entered between sessions. To use one, press the arrow button on the right of the entry and select the desired filter string. You can disable the filter by pressing the Clear text button to the left of the autocompletion arrow button. Configuration This plugin can be configured on the Filesystem Browser page of &kate;'s configuration. Toolbar Configure the buttons on the Filesystem Browser toolbar by moving the ones you want enabled to the Selected Actions list, and order them using the arrow buttons at the side of the list. Salma Sultana &TC.Hollingsworth; &TC.Hollingsworth.mail; Build Plugin Introduction The Build plugin allows you to run actions like build, clean and compile on a project. Using the Build Plugin The Build plugin adds a Build Output tool view at the bottom and a Build menu on the menubar. The tool view can be used to configure build target settings, while the menu can be used to perform build, clean and compile actions. The Build Output tool view has three tabs: Target Settings Output Errors & Warnings Target Settings tab The target settings tab can be used to configure various build targets. Each target contains four configuration options: Working Directory You can set the path to the project here. Leave this empty to use the directory the current document is located in. Build This option lets you define the build command. It is set to make by default. Clean The option lets you define the clean command. It is set to make clean by default. Quick Compile This option lets you define the quick compile command. It is set to gcc -Wall -g %f by default. One can create a new target by using the New button. The Copy button can be used to make a copy of an existing target. To delete a target, use the Delete button. Output tab The Output tab shows the console output generated by the last command. Errors & Warnings The Errors & Warnings tab lists the errors and warnings generated by the last command. Each line contains a message and the file name and line number if available. Clicking on the error or warning takes you to the appropriate file and places the cursor on the corresponding line number. There are Errors, Warnings, and Others buttons at the top that allow you to show or hide those categories of output. To navigate to the previous error, press &Ctrl;&Alt;Left. To navigate to the next error, press &Ctrl;&Alt;Right. Menu Structure BuildBuild Runs the Build command for the currently selected target. BuildClean Runs the Clean command for the currently selected target. BuildQuick Compile Runs the Quick Compile command for the currently selected target. &Ctrl;&Alt;Left BuildPrevious Error Moves the cursor to the location of the previous error in the document. &Ctrl;&Alt;Right BuildNext Error Moves the cursor to the location of the next error in the document. BuildTargets Select from a list of targets configured by the user. BuildNext Target Switch to the next target configured by the user. Thanks and Acknowledgments The &kate; Build Plugin was written by Kåre Särs. Special thanks to Google Code-In 2011 participant Salma Sultana for writing much of this section. Ömer Faruk ORUÇ &TC.Hollingsworth; &TC.Hollingsworth.mail; SQL Plugin Introduction The Structured Query Language (SQL) is a specialized language for updating, deleting, and requesting information from databases. The &kate; SQL Plugin allows you to: Create a database Connect to existing databases Insert and delete data in the database Execute queries Display results in a table Connecting to a Database Select Add Connection from the SQL menu or toolbar, and then select the Qt database driver you want to use (including QSQLITE, QMYSQL3, QMYSQL, QODBC3, QODBC, QPSQL7, and QPSQL). If you can't see the desired driver, you need to install it. Then, press Next. If the database you selected uses a file, simply indicate the database's location and press the Next button. If it requires connecting to a server, you must enter the hostname of the server, your username and password, and any other information that particular driver may require. Then press Next. Finally, give a name to your connection, and press Finish. Running Queries INSERT/DELETE/UPDATE You can insert, delete, and update data using the SQL plugin just as you would from the command line or from within a program. Simply enter a query and press the Run query. Some Example Queries INSERT INSERT INTO table_name ("feature1", "feature2", "feature3", "feature4", "feature5") VALUES ("value1", "value2", "value3", "value4", "value5" ) DELETE DELETE FROM table_name WHERE name = "text" UPDATE UPDATE table_name SET "feature1" = "text", "feature2" = "text", "feature3" = "text", "feature4" = "text", "feature5" = "text" SELECT After running a SELECT query, you can view the results as a table that will appear in the SQL Data Output tool view at the bottom of &kappname;, or as text in the SQL Text Output. If there is an error, you can see it in the text output. Example <command>SELECT</command> Query SELECT * FROM table_name In the SQL Data Output tool view, there are several buttons: Resize columns to contents Changes the size of columns to fit their contents. Resize rows to contents Changes the size of rows to fit their contents. Copy Selects all of the table contents and copies it to the clipboard buffer. Export Exports all of the table contents to a file, the clipboard, or the current document in the Comma Separated Values format. Clear Removes everything from the table view You can now change the colors displayed in the table in the SQL section of SettingsConfigure &kate; . Browsing You can browse your database using the SQL Schema Browser tool view on the left. The information displayed varies depending on which database driver you are using. To refresh this list, right-click anywhere in the tool view and select Refresh. To generate a query on any entry in the list, right-click on an entry, select Generate, and select the query type (SELECT, UPDATE, INSERT, or DELETE) from the submenu that appears. Menu Structure SQLAdd connection... Adds a new connection using any database driver. SQLRemove connection Removes the selected connection. SQLEdit connection... Edits the current connection's settings. Connections All database connections you have created are listed between the Edit connection and Run query menu items. Select one to run queries or make modifications to it. &Ctrl;E SQLRun query Runs your query. Thanks and Acknowledgments The SQL Plugin was written by Marco Mentasti. Special thanks to Google Code-In 2011 participant Ömer Faruk ORUÇ for writing much of this section. Martin Gergov &TC.Hollingsworth; &TC.Hollingsworth.mail; &gdb; Plugin Introduction &kappname;'s &gdb; plugin provides a simple frontend to the popular &GNU; Project Debugger. Previous experience with &gdb; is strongly recommended. For more information on using &gdb;, visit the &gdb; website. You can enable the &gdb; plugin in the Plugins section of &kappname;'s configuration. For the plugin to work properly, you must have a source file (of any type supported by &gdb;) and an executable. If you compile using &gcc;/g++ you might want to use the -ggdb command line argument. After these preparations are made, open the source file in &kappname;, enter the path to the executable in the Settings tab of the Debug View tool view, and select DebugStart Debugging from the menu to get started. Menu and Toolbar Structure All of these options are available in &kappname;'s menus, and many are available on the Debug toolbar as well. ViewTool ViewShow Debug View Shows a tool view containing &gdb; output, the &gdb; command line used, and other settings. ViewTool ViewShow Locals Shows a list of all currently loaded variables and their values. ViewTool ViewShow Call Stack Shows a &gdb; backtrace. DebugTargets A submenu containing a list of targets (executables). DebugArg Lists A submenu containing all argument lists. DebugStart Debugging Starts &gdb; with a target. DebugKill / Stop Debugging Stops &gdb;. DebugRestart Debugging Restarts &gdb;. DebugToggle Breakpoint / Break Set a breakpoint at the current cursor position. DebugStep In Execute the present statement (function call will be debugged). DebugStep Over Execute the present statement (function call will not be debugged). DebugStep Out Resumes execution until the program that is executing terminates. DebugMove PC Move program counter (next execution). DebugRun To Cursor Runs the program until it reaches current cursor position. DebugContinue Ignores any breakpoints and executes program until it terminates (successfully or not). DebugPrint Value Prints the value of the variable that the cursor is currently pointing to. SettingsToolbars Shown&gdb; Plugin Display the debugging toolbar. Debug View The Debug View tool view consists of several tabs: &gdb; Output Contains output from &gdb; and a &gdb; command line. The Output Tab The Output tab. The Output tab displaying the output from a debugging session. Settings Target Path to the target (executable) for debugging. Working Directory The current working directory provided to the target. Arg List Arguments passed to the program. Keep focus Keeps focus on the &gdb; command line. Redirect IO Opens a new IO tab in the Debug View where you can view output and provide input to the running program. The Settings Tab The Settings tab. The Settings tab displaying the configuration of a debugging session. IO Contains an area that displays output from the running program and a command line where you may provide input to it. The IO Tab The IO tab. The IO tab displaying output from a simple test program. Call Stack and Locals The Call Stack tool view contains a list of the formatted backtrace returned from &gdb;. The &gdb; Call Stack Tool View The Call Stack tool view. The &gdb; Plugin's Call Stack tool view. The Locals tool view contains a list of all currently loaded variables from the program and their corresponding values. The &gdb; Locals Tool View The Locals tool view. The &gdb; Plugin's Locals tool view. Thanks and Acknowledgments Special thanks to Google Code-In 2011 participant Martin Gergov for writing much of this section. Terminal Tool View Plugin Terminal emulator The built in Terminal Emulator is a copy of the &kde; &konsole; terminal application, for your convenience. It is available from the ViewTool Views Show Terminal menu item and will get the focus whenever displayed. Additionally, if the Automatically synchronize the terminal with the current document when possible option is enabled, it will change to the directory of the current document if possible when it is displayed, or when the current document changes. The default location in the &kate; window is at the bottom, below the editing area. You can configure the &konsole; using its &RMB; menu, for more information, see the &konsole; manual. The built-in terminal emulator is provided by the Terminal Tool View plugin, which is enabled by default. Menu Structure ViewTool Views Show Terminal Toggles the display of the built-in terminal emulator. When activated for the first time, the terminal will be created. When the terminal emulator is displayed, it will get the focus, so that you can start typing in commands immediately. If the Automatically synchronize the terminal with the current document when possible option is enabled in the Terminal page of the Main configuration dialog the shell session will change to the directory of the active document, if it is a local file. ToolsPipe to Terminal Feed the currently selected text into the built-in terminal emulator. No newline is added after the text. Tools Synchronize Terminal with Current Document This will cause the built-in Terminal to cd into the directory of the active document. Alternatively, you can configure &kappname; to always keep the terminal in sync with the current document. See for more information. Tools Focus/Defocus Terminal Switch the focus from the current document to the terminal and vice versa. Configuration You can configure the Terminal Tool View plugin on the Terminal page of the configuration dialog. The following options are available: Automatically synchronize the terminal with the current document when possible This will cause the built-in terminal to cd into the directory of the active document when launched and when a new document gets the focus. If not enabled, you have to do all your navigation in the terminal on your own. Set EDITOR environment variable to 'kate -b' This sets the EDITOR environment variable so programs run in the built-in terminal that automatically open a file in an editor will open them in &kate; instead of the default editor configured in your shell. You will not be able to continue using the terminal until you have closed the file in &kate;, so the calling program is aware you have finished editing the file. diff --git a/doc/katepart/index.docbook b/doc/katepart/index.docbook index bf22973a1..bc91dbf30 100644 --- a/doc/katepart/index.docbook +++ b/doc/katepart/index.docbook @@ -1,214 +1,213 @@ - ]> The &katepart; Handbook &Thad.McGinnis; &Thad.McGinnis.mail; &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; &Anders.Lund; &Anders.Lund.mail; &TC.Hollingsworth; &TC.Hollingsworth.mail; &Christoph.Cullmann; &Christoph.Cullmann.mail; &Lauri.Watts; &Lauri.Watts.mail; 20002001 &Thad.McGinnis; 2005 &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; &Anders.Lund; &Anders.Lund.mail; 2011201220132014 &TC.Hollingsworth; &TC.Hollingsworth.mail; &FDLNotice; -2014-02-22 -5.0 (&kde; 5.0) +2015-07-31 +Applications 15.12 &katepart; is a fully featured editor component for &Qt; and &kde; applications. KDE KatePart KWrite text editor Introduction &katepart; is a fully featured text editor component used by many &Qt; and &kde; applications. &katepart; is more than a text editor; it is meant to be a programmer's editor, and could be considered as at least a partial alternative to more powerful editors. One of &katepart;'s main features is the colorized syntax, customized for many different programming languages such as: C/C++, &Java;, Python, Perl, Bash, Modula 2, &HTML;, and Ada. &kwrite; is a simple text editor application based on &katepart;. It has a single document interface (SDI) allowing you to edit one file at the time per window. Since &kwrite; is a very simple implementation of &katepart;, it does not require its own documentation. If you know how to use &kwrite;, you can use &katepart; anywhere! &fundamentals-chapter; &part-chapter; &menus-chapter; &advanced-chapter; &dev-chapter; &configuring-chapter; Credits and License &katepart; and &kwrite; Copyright 2001-2014 by the &kate; team. Based on the original &kwrite;, which was Copyright 2000 by Jochen Wilhelmy digisnap@cs.tu-berlin.de Contributions: &Christoph.Cullmann; &Christoph.Cullmann.mail; Michael Bartl michael.bartl1@chello.at Phlip phlip_cpp@my-deja.com &Anders.Lund; &Anders.Lund.mail; Matt Newell newellm@proaxis.com &Joseph.Wenninger; &Joseph.Wenninger.mail; Jochen Wilhelmy digisnap@cs.tu-berlin.de &Michael.Koch; &Michael.Koch.mail; &Christian.Gebauer; &Christian.Gebauer.mail; &Simon.Hausmann; &Simon.Hausmann.mail; Glen Parker glenebob@nwlink.com Scott Manson sdmanson@altel.net &John.Firebaugh; &John.Firebaugh.mail; The &katepart; documentation is based on the original &kwrite; documentation, modified to be relevant to all &katepart; consumers. The original &kwrite; documentation was written by &Thad.McGinnis; &Thad.McGinnis.mail;, with lots of modifications from &Cristian.Tibirna; &Cristian.Tibirna.mail;. Converted to docbook/proofreading by &Lauri.Watts; &Lauri.Watts.mail; and updated by &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; and &Anders.Lund; &Anders.Lund.mail; The current &katepart; documentation is maintained by &TC.Hollingsworth; &TC.Hollingsworth.mail;. Please send comments or suggestions to the &katepart; development mailing list at kwrite-devel@kde.org or file a bug in the KDE Bugtracking System. &underFDL; &underGPL; &vi-appendix; ®exp-appendix; &documentation.index; diff --git a/doc/katepart/menus.docbook b/doc/katepart/menus.docbook index 5554c8fe6..05ef55082 100644 --- a/doc/katepart/menus.docbook +++ b/doc/katepart/menus.docbook @@ -1,1642 +1,1641 @@ The Menu Entries The File Menu &Ctrl;N File New This starts a new document in a new and independent editor window. &Ctrl;O File Open... Displays a standard &kde; Open File dialog. Use the file view to select the file you want to open, and click on Open to open it. File Open Recent This is a shortcut to open recently saved documents. Clicking on this item opens a list to the side of the menu with several of the most recently saved files. Clicking on a specific file will open it in &kappname; - if the file still resides at the same location. &Ctrl;S File Save This saves the current document. If there has already been a save of the document then this will overwrite the previously saved file without asking for the user's consent. If it is the first save of a new document the save as dialog (described below) will be invoked. File Save As... This allows a document to be saved with a new file name. This is done by means of the file dialog box described above in the Open section of this help file. F5 File Reload Reloads the active file from disk. This command is useful if another program or process has changed the file while you have it open in &kappname;. &Ctrl;P File Print... Opens a simple print dialog allowing the user to specify what, where, and how to print. File Export as HTML Export your file in &HTML; format so your document can be viewed as a web page. This item is only displayed when the plugin Exporter is loaded. &Ctrl;W File Close Close the active file with this command. If you have made unsaved changes, you will be prompted to save the file before &kappname; closes it. &Ctrl;Q File Quit This will close the editor window, if you have more than one instance of &kappname; running, through the New or New Window menu items, those instances will not be closed. The Edit Menu &Ctrl;Z Edit Undo This is used to eliminate or reverse the most recent user action or operation. &Ctrl;&Shift;Z EditRedo This will reverse the most recent change (if any) made using Undo &Ctrl;X EditCut This command deletes the current selection and places it on the clipboard. The clipboard is a feature of &kde; that works invisibly to provide a way to transfer data between applications. &Ctrl;C EditCopy This copies the currently selected text to the clipboard so that it may be pasted elsewhere. The clipboard is a feature of &kde; that works invisibly to provide a way to transfer data between applications. &Ctrl;V EditPaste This will insert the contents of the clipboard at the cursor position. The clipboard is feature of &kde; that works invisibly to provide a way to transfer data between applications. Edit Clipboard History This submenu will display the beginning of portions of text recently copied to the clipboard. Select an item from this menu to paste it in the currently open file. EditCopy as HTML This copies the currently selected text to the clipboard as &HTML;. This item is only displayed when the plugin Exporter is loaded. &Ctrl;A EditSelect All This will select the entire document. This could be very useful for copying the entire file to another application. &Ctrl;&Shift;A EditDeselect Deselects the selected text in the editor if any. &Ctrl;&Shift;B EditBlock Selection Mode Toggles Selection Mode. When the Selection Mode is BLOCK, you can make vertical selections, ⪚ select column 5 to 10 in lines 9 to 15. The status bar shows the current state of the Selection Mode, either BLOCK or LINE. Meta&Ctrl;V EditVI input Mode Switch to a vi-like, modal editing mode. This mode supports the most used commands and motions from vim's normal and visual mode and has an optional vi mode statusbar. This status bar shows commands while they are being entered, output from commands and the current mode.The behavior of this mode can be configured in the Vi Input Mode section of the Editing page in &kappname;'s settings dialog. Ins EditOverwrite Mode Toggles the Insert/Overwrite modes. When the mode is INS, you insert characters where the cursor is. When the mode is OVR, writing characters will replace the current characters if your cursor is positioned before any character. The status bar shows the current state of the Overwrite Mode, either INS or OVR. &Ctrl;F EditFind... This opens the incremental search bar at the bottom of the editor window. On the left side of the bar is a button with an icon to close the bar, followed by a small text box for entering the search pattern. When you start entering characters of your search pattern, the search starts immediately. If there is a match in the text this is highlighted and the background color of the entry field changes to light green. If the search pattern does not match any string in the text, this is indicated by a light red background color of the entry field and Not found is displayed at the right side of the bar. Use the Next or Previous button to jump to the next or previous match in the document. You can choose whether the search should be case sensitive. Selecting Match Case will limit finds to entries that match the case (upper or lower) of each of the characters in the search pattern. Click on the button with a green arrow icon at the right side of the incremental search bar to switch to the power search and replace bar. F3 EditFind VariantsFind Next This repeats the last find operation, if any, without calling the incremental search bar. &Shift;F3 EditFind Variants Find Previous This repeats the last find operation, if any, without calling the incremental search bar, and searching backwards instead of forwards through the document. &Ctrl;H EditFind VariantsFind Selected Finds next occurrence of selected text. &Ctrl;&Shift;H EditFind VariantsFind Selected Backwards Finds previous occurrence of selected text. &Ctrl;R EditReplace... This command opens the power search and replace bar. On the upper left side of the bar is a button with an icon to close the bar, followed by a small text box for entering the search pattern. You can control the search mode by selecting Plain text, Whole words, Escape sequences or Regular expression from the drop down box. If Escape sequences or Regular expression are selected, the Add... menuitem at the bottom of the context menu of the text boxes will be enabled and allows you to add escape sequences or regular expression items to the search or replace pattern from predefined lists. Use the Next or Previous button to jump to the next or previous match in the document. Enter the text to replace with in the text box labeled Replace and click the Replace button to replace only the highlighted text or the Replace All button to replace the search text in the whole document. You can modify the search and replace behavior by selecting different options at the bottom of the bar. Selecting Match Case will limit finds to entries that match the case (upper or lower) of each of the characters in the search pattern. Selection Only will search and replace within the current selection only. The Find All button highlights all matches in the document and shows the number of found matches in a small popup. Click on the button with a green arrow icon at the right side of the power search and replace bar to switch to the incremental search bar. &Ctrl;G Edit Go to Line... This opens the goto line bar at the bottom of the window which is used to have the cursor jump to a particular line (specified by number) in the document. The line number may be entered directly into the text box or graphically by clicking on the up or down arrow spin controls at the side of the text box. The little up arrow will increase the line number and the down arrow decrease it. Close the bar with a click on the button with an icon on the left side of the bar. The View Menu The View menu allows you to manage settings specific to the active editor, and to manage frames. View New Window Create another window containing the current document. All changes to the document in one window are reflected in the other window and vice versa. F7 View Switch to Command Line Displays the Katepart command line at the bottom of the window. In the command line, type help to get help and help list to get a list of commands. For more information on the command line, see The Editor Component Command Line. ViewShow the Javascript Console This opens a tool view that allows you to run Javascript code interactively. For more information, see Extending &kate; with Scripts View Schema Select a font schema. F10 View Dynamic Word Wrap The text lines will be wrapped at the view border on the screen. View Dynamic Word Wrap Indicators Choose when and how the dynamic word wrap indicators should be displayed. This is only available if the Dynamic Word Wrap option is checked. View Show Static Word Wrap Marker If this option is checked, a vertical line will be drawn at the word wrap column as defined in the Settings Configure Editor... in the Editing tab. Please note that the word wrap marker is only drawn if you use a fixed pitch font. F6 View Show Icon Border This is a toggle item. Setting it on checked will make the Icon Border visible in the left side of the active editor, and vice versa. The Icon Border indicates the positions of the marked lines in the editor. F11 View Show Line Numbers This is a toggle Item. Setting it on checked will make a pane displaying the line numbers of the document visible in the left border of the active editor, and vice versa. View Show Scrollbar Marks If this option is checked, the view will show marks on the vertical scrollbar. The marks are equivalent to the marks on the Icon Border. ViewShow Scrollbar Minimap This will replace the scrollbar with a visualization of the current document. For more information on the scrollbar minimap, see F9 View Show Folding Markers If this option is checked, the marks for code folding will be shown. View Code Folding Fold Current Node Collapse the region that contains the cursor. Unfold Current Node Expand the region that contains the cursor. &Ctrl; &Shift;- Fold Toplevel Nodes Collapse all toplevel regions in the document. Click onto the right pointing triangle to expand all toplevel regions. View Enlarge Font This increases the display font size. View Shrink Font This decreases the display font size. The Bookmarks Menu &Ctrl;B Bookmarks Set Bookmark Sets or removes a bookmark in the current line of the active document. (If it's there, it is removed, otherwise one is set). Bookmarks Clear All Bookmarks This command will remove all the markers from the document as well as the list of markers which is appended at the bottom of this menu item. &Alt; PgUp BookmarksPrevious This will move the cursor to beginning of the first above line with a bookmark. The menuitem text will include the line number and the first piece of text on the line. This item is only available when there is a bookmark in a line above the cursor. &Alt; PgDown BookmarksNext This will move the cursor to beginning of the next line with a bookmark. The menuitem text will include the line number and the first piece of text on the line. This item is only available when there is a bookmark in a line below the cursor. At the bottom of this menu, a list of bookmarks appears if any bookmarks are available for this window. The Tools Menu Tools Read Only Mode Set the current document to Read Only mode. This prevents any text addition and any changes in the document formatting. Tools Mode Choose the filetype scheme you prefer for the active document. This overwrites the global filetype mode set in Settings Configure Editor... in the Filetypes tab for your current document only. Tools Highlighting Choose the Highlighting scheme you prefer for the active document. This overwrites the global highlighting mode set in Settings Configure Editor... for your current document only. Tools Indentation Choose the style of indentation you want for your active document. This overwrites the global indentation mode set in Settings Configure Editor... for your current document only. Tools Encoding You can overwrite the default encoding set in Settings Configure Editor... in the Open/Save page to set a different encoding for your current document. The encoding you set here will be only valid for your current document. Tools End of Line Choose your preferred end of line mode for your active document. This overwrites the global end of line mode set in Settings Configure Editor... for your current document only. Tools Add Byte Mark Order (BOM) Checking this action you can explicitly add a byte order mark for unicode encoded documents. The byte order mark (BOM) is a Unicode character used to signal the endianness (byte order) of a text file or stream, for more information see Byte Order Mark. Tools Scripts This submenu contains a list of all scripted actions. The list can easily be modified by writing your own scripts. This way, &katepart; can be extended with user-defined tools. ToolsScripts Emmet ToolsScriptsEmmet Expand abbreviation Converts the selected text to a pair of opening and closing &HTML; or &XML; tags. For example, if div is selected, this item will replace that with <div></div>. ToolsScriptsEmmet Wrap with tag Wraps the selected text with the tag provided on the -command -line. +command line. ToolsScriptsEmmet Select &HTML;/&XML; tag contents inwards When the cursor is inside a pair of &HTML;/&XML; tags, this option will change the selection to include the contents of those &HTML;/&XML; tags, without selecting the tags themselves. ToolsScriptsEmmet Select &HTML;/&XML; tag contents outwards When the cursor is inside a pair of &HTML;/&XML; tags, this item will change the selection to include the contents of those &HTML;/&XML; tags, including the tags themselves. ToolsScriptsEmmet Move cursor to matching tag If the cursor is inside an opening &HTML;/&XML; tag, this item will move it to the closing tag. If the cursor is inside the closing tag, it will instead move it to the opening tag. ToolsScriptsEmmet Toggle Comment If the selected portion is not a comment, this item will enclose that portion in &HTML;/&XML; comments (⪚ <!-- selected text -->). If the selected portion is a comment, the comment tags will be removed instead. ToolsScriptsEmmet Delete tag under cursor If the cursor is presently inside a &HTML;/&XML; tag, this item will delete the entire tag. ToolsScriptsEmmet Decrement number by 1 This item will subtract one from the currently selected text, if it is a number. For example, if 5 is selected, it will become 4. ToolsScriptsEmmet Decrement number by 10 This item will subtract 10 from the currently selected text, if it is a number. For example, if 15 is selected, it will become 5. ToolsScriptsEmmet Decrement number by 0.1 This item will subtract 0.1 from the currently selected text, if it is a number. For example, if 4.5 is selected, it will become 4.4. ToolsScriptsEmmet Increment number by 1 This item will add one to the currently selected text, if it is a number. For example, if 5 is selected, it will become 6. ToolsScriptsEmmet Increment number by 10 This item will add 10 to the currently selected text, if it is a number. For example, if 5 is selected, it will become 15. ToolsScriptsEmmet Increment number by 0.1 This item will add 0.1 to the currently selected text, if it is a number. For example, if 4.5 is selected, it will become 4.6. ToolsScripts Navigation &Alt;&Shift;Up ToolsScriptsNavigation Move cursor to previous matching indent Moves the cursor to the first line above the current line that is indented at the same level as the current line. &Alt;&Shift;Down ToolsScriptsNavigation Move cursor to next matching indent Moves the cursor to the first line below the current line that is indented at the same level as the current line. ToolsScripts Editing ToolsScriptsEditing Sort Selected Text Sorts the selected text or whole document in ascending order. &Ctrl;&Shift;Down ToolsScriptsEditing Move Lines Down Move selected lines down. &Ctrl;&Shift;Up ToolsScriptsEditing Move Lines Up Move selected lines up. &Ctrl;&Alt;Down ToolsScriptsEditing Duplicate Selected Lines Down Duplicates the selected lines down. &Ctrl;&Alt;Up ToolsScriptsEditing Duplicate Selected Lines Up Duplicates the selected lines up. ToolsScriptsEditing URI-encode selected text Encodes the selected text so that it can be used as part of a query string in a &URL;, replacing the selection with the encoded text. ToolsScriptsEditing URI-decode selected text If part of the query string of a &URL; is selected, this will decode it and replace the selection with the original raw text. &Ctrl;Space Tools Invoke Code Completion Manually invoke command completion, usually by using a shortcut bound to this action. Tools Word Completion Reuse Word Below (&Ctrl; 9) and Reuse Word Above (&Ctrl; 8) complete the currently typed text by searching for similar words backward or forward from the current cursor position. Shell Completion pops up a completion box with matching entries. &Ctrl;&Shift;O ToolsSpelling Automatic Spell Checking When Automatic Spell Checking is enabled, wrong text is underlined in the document on-the-fly. ToolsSpellingSpelling... This initiates the spellchecking program - a program designed to help the user catch and correct any spelling errors. Clicking on this entry will start the checker and bring up the speller dialog box through which the user can control the process. There are four settings lined up vertically in the center of the dialog with their corresponding labels just to the left. Starting at the top they are: Unknown word: Here, the spellchecker indicates the word currently under consideration. This happens when the checker encounters a word not in its dictionary - a file containing a list of correctly spelled words against which it compares each word in the editor. Replace with: If the checker has any similar words in its dictionary the first one will be listed here. The user can accept the suggestion, type in his or her own correction, or choose a different suggestion from the next box. Language: If you have installed multiple dictionaries, here you can select which dictionary/language should be used. On the right side of the dialog box are 6 buttons that allow the user to control the spellcheck process. They are: Add to Dictionary Pressing this button adds the Unknown word to the checker's dictionary. This means that in the future the checker will always consider this word to be correctly spelled. Suggest The checker may list here a number of possible replacements for the word under consideration. Clicking on any one of the suggestions will cause that word to be entered in the Replace with box, above. Replace This button has the checker replace the word under consideration in the document with the word in the Replace with box. Replace All This button causes the checker to replace not only the current Unknown word: but to automatically make the same substitution for any other occurrences of this Unknown word in the document. Ignore Activating this button will have the checker move on without making any changes. Ignore All This button tells the checker to do nothing with the current Unknown word: and to pass over any other instances of the same word. This only applies to the current spellcheck run. If the checker is run again later it will stop on this same word. Three more buttons are located horizontally along the bottom of the spellcheck dialog. They are: Help This invokes the &kde; help system with the help page for this dialog. Finished This button ends the spellcheck process, and returns to the document. Cancel This button cancels the spellcheck process, all modifications are reverted, and you will return to your document. ToolsSpelling Spelling (from cursor)... This initiates the spellchecking program but it starts where your cursor is instead of at the beginning of the document. ToolsSpelling Spellcheck Selection... Spellchecks the current selection. ToolsSpelling Change Dictionary Displays a drop down box with all available dictionaries for spellchecking at the bottom of the editor window. This allows easy switching of the spellcheck dictionary ⪚ for automatic spellcheck of text in different languages. ToolsClean Indentation This cleans the indentation for the current selection or for the line the cursor is currently in. Cleaning the indentation ensures that all your selected text follows the indentation mode you choose. Tools Align Causes a realign of the current line or selected lines using the indentation mode and indentation settings in the document. &Ctrl;D Tools Comment This adds one space to the beginning of the line where the text cursor is located or to the beginning of any selected lines. &Ctrl;&Shift;D Tools Uncomment This removes one space (if any exist) from the beginning of the line where the text cursor is located or from the beginning of any selected lines. &Ctrl;U Tools Uppercase Put the selected text or the letter after the cursor in uppercase. &Ctrl;&Shift;U Tools Lowercase Put the selected text or the letter after the cursor in lowercase. &Ctrl;&Alt;U Tools Capitalize Capitalize the selected text or the current word. &Ctrl;J Tools Join Lines Joins the selected lines, or the current line and the line below with one white space character as a separator. Leading/trailing white space on joined lines is removed in the affected ends. Tools Apply Word Wrap Apply static word wrapping on all the document. That means that a new line of text will automatically start when the current line exceeds the length specified by the Wrap words at option in the Editing tab in SettingsConfigure Editor... Tools Create Snippet Create a new snippet, which is a reusable chunk of text you may insert in any part of any document. Tools Snippets... Display a list of available snippets. If the plugin Insert File is enabled, you will find here an additional menu item Insert File.... The Settings Menu SettingsShow Statusbar When checked, this displays a small bar at the bottom of the editor containing information about the status of the current document. When unchecked the status bar is hidden. Settings Show Toolbar When checked, this displays a movable toolbar containing buttons used to initiate frequently used commands. When unchecked the toolbar is hidden. SettingsShow Path When selected, this displays in the titlebar the path (its location in the file system) of the current document. When unchecked the path is hidden. Settings Configure Editor... This menu item opens a dialog whereby several different settings may be adjusted. SettingsConfigure Shortcuts... Displays the familiar &kde; Keyboard Shortcut Configuration Dialog. For more information on using this, see the Using and Customizing Shortcuts section of the &kde; Fundamentals documentation. SettingsConfigure Toolbars... Displays the familiar &kde; Toolbar Configuration Dialog. For more information on using this, see the Customizing Toolbars section of the &kde; Fundamentals documentation. The Help Menu &help.menu.documentation; \ No newline at end of file diff --git a/doc/kwrite/index.docbook b/doc/kwrite/index.docbook index d6ecd1403..d336a4d77 100644 --- a/doc/kwrite/index.docbook +++ b/doc/kwrite/index.docbook @@ -1,151 +1,151 @@ ]>
The &kwrite; Handbook &TC.Hollingsworth; &TC.Hollingsworth.mail; &Christoph.Cullmann; &Christoph.Cullmann.mail; 2014 &TC.Hollingsworth; &TC.Hollingsworth.mail; &FDLNotice; -2014-10-21 -5 +2015-07-31 +Applications 15.12 &kwrite; is a text editor for &kde; allowing you to edit one file at the time per window. KDE KWrite text editor Introduction &kwrite; is more than a text editor for the &kde; Desktop. It is meant to be a programmer's editor, and could be considered as at least a partial alternative to more powerful editors. It may be best used in conjunction with &konqueror; or &dolphin; for source file browsing for different languages. &kwrite; also works very well as a simple text editor. One of &kwrite;'s main features is the colorized syntax, customized for many different programming languages such as: C/C++, &Java;, Python, Perl, Bash, Modula 2, &HTML;, and Ada. &kwrite; has a single document interface (SDI) allowing you to edit one file at the time per window. &kwrite; is a simple interface to the &katepart; component also used by &kate;, KDevelop, and other applications from &kde; that require advanced text editing. Therefore, complete documentation for all the features of &kwrite; can be found in the &katepart; Handbook. Credits and License &kwrite; Copyright 2001-2014 by the &kate; team. Based on the original &kwrite;, which was Copyright 2000 by Jochen Wilhelmy digisnap@cs.tu-berlin.de Contributions: &Christoph.Cullmann; &Christoph.Cullmann.mail; Michael Bartl michael.bartl1@chello.at Phlip phlip_cpp@my-deja.com &Anders.Lund; &Anders.Lund.mail; Matt Newell newellm@proaxis.com &Joseph.Wenninger; &Joseph.Wenninger.mail; Jochen Wilhelmy digisnap@cs.tu-berlin.de &Michael.Koch; &Michael.Koch.mail; &Christian.Gebauer; &Christian.Gebauer.mail; &Simon.Hausmann; &Simon.Hausmann.mail; Glen Parker glenebob@nwlink.com Scott Manson sdmanson@altel.net &John.Firebaugh; &John.Firebaugh.mail; &underFDL; &underGPL; &documentation.index;