From ba09c43f50c9191cd7a4a640b46a373eca475b24 Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Wed, 12 Feb 2014 17:52:49 +0900 Subject: [PATCH] Kate handbook review - chapter 4,5 additions, chapter 6 --- doc/kate/advanced.docbook | 503 +++++++++++++++-------------------- doc/kate/configuring.docbook | 2 +- doc/kate/mdi.docbook | 82 ++++++ doc/kate/part.docbook | 7 + doc/kate/plugins.docbook | 9 +- 5 files changed, 307 insertions(+), 296 deletions(-) diff --git a/doc/kate/advanced.docbook b/doc/kate/advanced.docbook index a5d5c789e..e0d552c80 100644 --- a/doc/kate/advanced.docbook +++ b/doc/kate/advanced.docbook @@ -3,6 +3,7 @@ &Anders.Lund; &Anders.Lund.mail; &Dominik.Haumann; &Dominik.Haumann.mail; +&tde-authors; @@ -14,8 +15,8 @@ The Comment and Uncomment commands, available from the Tools menu allow you to add or remove comment -markers to the selection, or the current line if no text is selected, -if comments are supported by the format of the text you are +markers to the selection, or to the current line if no text is selected, +if comments are supported by the format of the file you are editing. The rules for how commenting is done are defined in the syntax @@ -56,23 +57,23 @@ action="simul">&Ctrl;&Shift;D. perform various actions from a minimal GUI. The command line is a text entry in the bottom of the editor area, to show it select ViewSwitch to Command Line -or use the shortcut (default is +or use the keyboard shortcut (default is F7). The editor provides a set of commands as documented below, and additional commands can be provided by plugins. -To execute a command, type the comand then press the return key. The -command line will indicate wether it succeded and possibly display a message. If +To execute a command, type the command and then press the enter key. The +command line will indicate whether it succeeded and possibly display a message. If you entered the command line by pressing F7 it will automatically hide after a few seconds. To clear the message and enter a new command, press F7 again. -The command line has a built-in help system, issue the command +The command line has a built-in help system, you can type the command help to get started. To see a list of all available commands -issue help list, to view help for a specific command, do +type help list, to view help for a specific command, do help command. -The command line has a built in history, so you can reuse commands already +The command line has a built-in history too, so you can reuse commands already typed. To navigate the history, use the Up and Down keys. When showing historical commands, the argument part of the command will be selected, allowing you to easily overwrite the @@ -81,23 +82,15 @@ arguments. Standard Command Line Commands - -Commands for Configuring the Editor - -These commands are provided by the editor component, and allows you to -configure the active document and view only. This is handy if you want to use -a setting different from the default settings, for example for indentation. - - Argument types BOOLEAN -This is used with commands that turns things on or off. +This is used with commands that turn things on or off. Legal values are on, off, true, false, -1 or 0 +1, 0 @@ -112,6 +105,14 @@ Legal values are on, off, + +Commands for Configuring the Editor + +These commands are provided by the editor component, and allows you to +configure the active document and view only. This is handy if you want to use +a setting different from the default settings, for example for indentation. + + @@ -195,7 +196,7 @@ enable set-replace-tabs-saveBOOLEAN enable -When enabled, tabs will be replaced with whitespace whenever +When enabled, tabs will be replaced with whitespaces whenever the document is saved. @@ -390,26 +391,26 @@ To use it launch the Editing Command dialog and type char: replace, sed style search, sed style -s///[ig] %s///[ig] +s///[ig] and %s///[ig] This command does a sed-like search/replace operation on the current line, or on the whole file (%s///). -In short, the text is searched for text matching the -search pattern, the regular expression between -the first and the second slash, and when a match is found, the +In short, &kate; searches for text matching the +search pattern (the regular expression between +the first and the second slash), and when a match is found the matching part of the text is replaced with the expression between the -middle and last part of the string. Parentheses in the search pattern +middle and last slash. Parenthesis in the search pattern create back references, that is the command -remembers which part of the match matched in the parentheses; these +remembers which part of the text matched in the parenthesis. These strings can be reused in the replace pattern, referred to as -\1 for the first set of parentheses, +\1 for the first set of parenthesis, \2 for the second and so on. To search for a literal ( or -), you need to escape it using -a backslash character: \(\) +), you need to escape it using +a backslash character: \(, \) If you put an i at the end of the expression, the matching will be case insensitive. If you put a @@ -428,7 +429,7 @@ is not defined. MyClass. You go to line 3902, and instead of trying to find the word in the text, you launch the Editing Command Dialog, enter s/myclass/MyClass/i, hit the -OK button, save the file and compile – +OK button, save the file and compile successfully without the error. @@ -438,62 +439,16 @@ successfully without the error. Imagine that you have a file, in which you mention a Miss Jensen several times, when someone comes in and tells you that -she just got married to Mr Jones. You want, of course, +she just got married to Mr. Jones. You want, of course, to replace each and every occurrence of Miss Jensen with Ms Jones. Enter the command line and issue the command -%s/Miss Jensen/Ms Jones/ and hit return, you +%s/Miss Jensen/Ms. Jones/ and hit enter, you are done. - -A More Advanced Example - -This example makes use of back references -as well as a character class (if you do not know what -that is, please refer to the related documentation mentioned -below). - -Suppose you have the following line: - -void MyClass::DoStringOps( String &foo, String &bar String *p, int &a, int &b ) - -Now you realize that this is not nice code, and decide that you -want to use the const keyword for all -address of arguments, those characterized by the & -operator in front of the argument name. You would also like to -simplify the white space, so that there is only 1 whitespace character -between each word. - -Launch the Editing Command Dialog, and enter: -s/\s+(\w+)\s+(&)/ const \1 \2/g and hit the -OK button. The g at the end of the expression makes -the regular expression recompile for each match to save the backreferences. - -Output: - -void MyClass::DoStringOps( const String &foo, const String &bar String *p, const int &a, const int &b ) - -Mission completed! Now, what happened? Well, we looked for some -white space (\s+) followed by one or more -alphabetic characters (\w+) followed by some more -whitespace (\s+) followed by an ampersand, and in -the process saved the alphabetic chunk and the ampersand for reuse in -the replace operation. Then we replaced the matching part of our line -with one whitespace followed by const followed by one -whitespace followed by our saved alphabetical chunk -(\1) followed by one whitespace followed by our -saved ampersand (\2) - -Now in some cases the alphabetical chunk was -String, in some int, so using the -character class \w and the + -quantifier proved a valuable asset. - - - @@ -543,9 +498,7 @@ following options are supported: r -Do regular expression search. If set, you may use -\N where N is a number to represent captures in the -replacement string. +Do regular expression search. @@ -568,10 +521,10 @@ replacement string. ifindpattern -This command provides as-you-type searching. You +This command provides incremental (as-you-type) searching. You can configure the behavior of the search by appending a colon followed by one or more options, like this: -ifind:options pattern. Allowed options are +ifind:options pattern. Allowed options are: @@ -611,10 +564,10 @@ followed by one or more options, like this: Code folding allows you to hide parts of a document in the editor, making it easier to overview large documents. In &kate; the foldable regions are -calculated using rules defined in the syntax highlight definitions, and -therefore it is only available in some formats - typically program source code, -XML markup and similar. Most highlight definitions supporting code folding -also lets you manually define foldable regions, typically using the +calculated using rules defined in the syntax highlight definitions and +therefore it is only available in some file formats - typically program source code, +XML markup and similar. Most highlight definition files supporting code folding +also let you manually define foldable regions, typically using the BEGIN and END keywords. To use the code folding feature, activate the folding markers using @@ -622,23 +575,22 @@ also lets you manually define foldable regions, typically using the Markers menu item if they are not already visible. The Folding Markers Pane in the left side of the screen displays a graphical view of the foldable regions, with +/- signs to indicate the possible operation -on a given region: a - means that the region is expanded, clicking the - will +on a given region. A - means that the region is expanded; clicking on the - will collapse the region and a + will be displayed instead. Four commands are provided to manipulate the state of folding regions, -see the menu documentation. +see the menu documentation for details. -If you do not want to use the code folding feature, you can disable -the Show folding markers (if available) option in the -Appearance page of the editor -configuration +If you do not want to use the code folding feature, you can disable it +completely using the Show folding markers (if available) option in the +Editor Appearance configuration page -Scripting the editor component with Javascript +Scripting the editor with JS @@ -648,24 +600,15 @@ configuration scripting with ECMA script, also known as JavaScript. Scripts can be used through the built in command line -only. The requirements is that the script is placed in a folder where &kate; -can find it, along with an optional .desktop file that defines the related -properties. The valid folder are named katepart/scripts +linkend="advanced-editing-tools-commandline">the built-in command line +only. The requirements are that the scripts are placed in a folder where &kate; +can find them, along with an optional .desktop file that defines the related +properties. The valid folders are named katepart/scripts in the &tde; data folders. You can find the data folders by running the command -tde-config data +tde-config data. You will usually have at least a system and a personal data folder. Of course scripts in the system data folder are available to all users on the system, -while those in the personal folder are available for you only. - -This feature is experimental and will most likely change during -future development. -We know that many of you will be disappointed because you can't add -your scripts to the menu or assign shortcuts to them. Sorry, sometime -in the future that will likely be possible. -It is also not possible to pass any arguments to your scripts yet. Be -patient, and that may be added in the bright future ;) - +while those in the personal folder are available to you only. @@ -673,33 +616,32 @@ patient, and that may be added in the bright future ;) The Kate JavaScript API -Here is listed the complete set of functions and properties available +Here is the complete set of functions and properties available in the document and view objects. -In addition you can of course use all the standard objects such as +In addition, you can use all the standard objects such as Math, String Regex and so forth. When a script is run, the document object is the current document, and the view object is the current view. -The types of arguments are of course not used in JavaScript at -this time, they are there solely to indicate what sort of value the funcitons -expect. +Types are not used in JavaScript. In this list, they are +there solely to indicate what sort of arguments the functions expect. Global Functions -debug( string) -[function] +debug(string s) +function parameters -string the string to output +s the string to output. Outputs the string to STDERR using kdDebug(). A dedicated output area is used for the output, -which will be prefixed Kate (KJS Scripts): +which will be prefixed by "Kate (KJS Scripts):" @@ -709,19 +651,19 @@ which will be prefixed Kate (KJS Scripts): The <classname>document</classname> API -document.attribute( line -, column ); - [function] +document.attribute(uint line, +uint column) +function Parameters -uint line The line of the position for which +line the line of the position for which to find the attribute. -uint column The column of the position for +column the column of the position for which to find the attribute. Returns the numeric ID of the attribute for the document position -[line,column]. The attribute +[line, column]. The attribute represents the visual appearance or style of the text, and is also used to calculate the syntax highlight for a specific part of the text in mixed formats like HTML or PHP. @@ -729,133 +671,125 @@ like HTML or PHP. -document.canBreakAt( Char c, -uint attribute ); [function] +document.canBreakAt(char c, +attribute attrib) function Parameters -c The character to test -attribute The attribute at the position +c the character to test. +attrib the attribute at the position of c. -Returns whether it is allowed to break the line at a character c with -attribute attribute. The result is decided by querying the highlight owning -attribute for which characters allow breaking the line. +Returns whether it is allowed to break the line at the character +c with attribute attribute. -document.canComment( uint start_attribute, -uint end_attribute ); [function] +document.canComment(attribute start_attrib, +attribute end_attrib) function Parameters -start_attribute The attribute at the +start_attrib the attribute at the start of the range to turn into a comment. -end_attribute The attribute at end of +end_attrib the attribute at end of the range to turn into a comment. -Returns whether start_attribute and end_attribute belongs to the same -syntax highlight system. If they do, it is sane. +Returns whether start_attribute and +end_attribute belongs to the same +syntax highlight system. If they do, it is possible to comment the block. - -using canComment - -if ( document.canComment( document.attribute(1,0), document.attribute(5,0) ) ) { - // 1,0 and 5,0 belongs to the same syntax highlighting system -} - - -document.clear(); [function] +document.clear() function Clears the document. -document.commentStart( uint attribute ); -[function] +document.commentStart(attribute attrib) +function Parameters -attribute The attribute of the text for +attrib the attribute of the text for which to get the commentStart string. Returns the string required to start a multiline comment for a text with -attribute, or an empty string if multiline comments are not supported for that +attribute attrib, or an empty string if multiline comments are not supported for that text. -document.commentMarker( uint attribute ); -[function] +document.commentMarker(attribute attrib) +function Parameters -attribute The attribute of the text for -which to get the commentMarker string +attrib the attribute of the text for +which to get the commentMarker string. Returns the string used to mark the rest of the line as a comment for a -text with attribute or an empty string if single line comments are not supported -for that text. +text with attribute attrib or an empty string if single +line comments are not supported for that text. -document.commentEnd( uint attribute ); -[function] +document.commentEnd(attribute attrib) +function Parameters -attribute The attribute of the text for -which to get the commentEnd string +attrib the attribute of the text for +which to get the commentEnd string. Returns the string required to end a multiline comment for a text with -attribute, or an empty string if multiline comments are not supported for that -text. +attribute attrib, or an empty string if multiline +comments are not supported for that text. -document.editBegin(); [function] +document.editBegin() function -Start an editing group. All actions done until the call of editEnd() will -be grouped as one undo-action. +Starts an editing group. All actions done until the call to editEnd() will +be grouped as a single undo action. -document.editEnd(); [function] +document.editEnd() function -Finish an editing group. +Ends an editing group. -document.highlightMode; [property:read only] +document.highlightMode property, read only The name of the document's highlight mode, such as JavaScript or C++. -If no syntax highlight mode is set for the document, the value is None. Notice -that you need to use the English name in cases where it differs from the +If no syntax highlight mode is set for the document, the value is none. +Notice that you need to use the English name in cases where it differs from the translated one. -document.indentMode; [property:read only] +document.indentMode property, read only The name of the document indent mode, such as normal or cstyle. -Remember that if no indent mode is set, the value is none. +If no indent mode is set, the value is none. -document.indentWidth; [property:read only] +document.indentWidth property, read only The indentation width set for the document. This is used if space indenting is enabled. @@ -863,14 +797,14 @@ indenting is enabled. -document.insertLine( uint line, -string text ); [function] +document.insertLine(uint line, +string text) function Parameters -line document line number +line the document line number. -text text to insert +text the text to insert. Inserts a new line with the text text at the line line. @@ -878,102 +812,97 @@ line line. -document.insertText( uint line, -uint column, string text ); -[function] +document.insertText(uint line, +uint column, string text) +function Parameters -line the line number -column the column -text the text which is to be -inserted +line the line number. +column the column number. +text the text to insert. Inserts the text text in line -line and column column. +line at column column. -document.length(); [function] +document.length() function Returns the document's size in bytes. -document.lines(); [function] +document.lines() function Returns the number of lines in the document. -document.mixedIndent; [property:read only] +document.mixedIndent property, read only A boolean telling whether the mixed-indent setting is enabled for the document. If so, indentation is optimized to contain a mix of tab characters and -spaces like used by the Emacs editor. +spaces like in the Emacs editor. -document.removeLine( uint line ); [function] +document.removeLine(uint line) function Parameters -line line number +line the line number. -Removes the document line line. +Removes the document line line. -document.removeText( uint startLine, +document.removeText(uint startLine, uint startColumn, uint endLine, -uint endColumn ); [function] +uint endColumn) function Parameters -startLine specifies the beginning -line -startColumn specifies the beginning -column -endLine specifies the ending -line -endColumn specifies the ending -column +startLine specifies the beginning line. +startColumn specifies the beginning column. +endLine specifies the ending line. +endColumn specifies the ending column. Removes the text range from line startLine and -column startColumn up to line +column startColumn to line endLine and column endColumn. -document.setText( string text ); -[function] +document.setText(string text) +function Parameters -text document text +text the new document text. Sets the entire document content to text. -document.spaceIndent; [property:read only] +document.spaceIndent property, read only A boolean telling whether space-indent is enabled for the document. -If so, the document is indented with indentWidth spaces pr level, otherwise -indentation is one tab character pr. level. +If so, the document is indented with indentWidth spaces per level, otherwise +indentation is one tab character per level. -document.textFull(); [function] +document.textFull() function Returns the full document text. If the text spans over multiple lines the linefeed character is \n. @@ -981,31 +910,27 @@ linefeed character is \n. -document.textLine( uint line ); [function] +document.textLine(uint line) function Parameters -line the line +line the line number. -Returns the text of line line. +Returns the text at line line. -document.textRange( uint startLine, +document.textRange(uint startLine, uint startColumn, uint endLine, -uint endColumn ); [function] +uint endColumn) function Parameters -startLine specifies the beginning -line -startColumn specifies the beginning -column -endLine specifies the ending line - -endColumn specifies the ending -column +startLine specifies the beginning line. +startColumn specifies the beginning column. +endLine specifies the ending line. +endColumn specifies the ending column. Returns the specified text range. If the range spans over multiple lines the linefeed character is \n. @@ -1018,57 +943,57 @@ the linefeed character is \n. The <classname>view</classname> API -view.clearSelection(); [function] +view.clearSelection() function Deselects all text. -view.cursorColumn(); [function] +view.cursorColumn() function Returns the current cursor column (TAB characters are expanded). -view.cursorColumnReal(); [function] +view.cursorColumnReal() function -Returns the current real cursor column (TAB characters counts one). +Returns the current real cursor column (a TAB character counts as one). -view.cursorLine(); [function] +view.cursorLine() function Returns the current cursor line. -view.hasSelection(); [function] +view.hasSelection() function -Returns true if the view contains selected text, +Returns true if some text in the view has been selected, otherwise false. -view.removeSelectedText(); [function] +view.removeSelectedText() function Removes the selected text, if the view has a selection. -view.selectAll(); [function] +view.selectAll() function Selects all text. -view.selection(); [function] +view.selection() function Returns the selected text. If the selection spans over multiple lines the linefeed character is \n. @@ -1076,84 +1001,79 @@ linefeed character is \n. -view.selectionEndColumn; [property:read only] +view.selectionEndColumn property, read only Returns the ending column of the selection. -view.selectionEndLine; [property:read only] +view.selectionEndLine property, read only Returns the ending line of the selection. -view.selectionStartColumn; [property:read only] +view.selectionStartColumn property, read only Returns the starting column of the selection. -view.selectionStartLine; [property:read only] +view.selectionStartLine property, read only Returns the starting line of the selection. -view.setCursorPosition( uint line, -uint column ); [function] +view.setCursorPosition(uint line, +uint column) function Parameters -line Specifies the line for the -cursor. -column Specifies the column for the -cursor. +line specifies the new line for the cursor. +column specifies the new column for the cursor. -Sets the input cursor position in the view to [line, -col]. This sets the cursor position by visual means, -that is the a TAB character counts up to tabwidth -depending on the position inside the line. The cursor position is made visible. -Both line and column are zero-based. +Sets the input cursor position in the view to (line, +column). TAB characters are expanded and +the cursor position is made visible. Both line +and column are zero-based. -view.setCursorPositionReal( uint line, -uint column ); [function] +view.setCursorPositionReal(uint line, +uint column) function Parameters -line Specifies the line for the -cursor. -column Specifies the column for the -cursor. +line specifies the new line for the cursor. +column specifies the new column for the cursor. -Sets the input cursor position to [line, -col]. This sets the string position, that is a TAB -character counts for 1. The cursor position is made visible. Both line and -column are zero-based. +Sets the input cursor position to (line, +column). This sets the string position, that is a TAB +character counts for 1, and the cursor position is made visible. Both line +and column are zero-based. -view.setSelection( uint startLine, +view.setSelection(uint startLine, uint startColumn, uint endLine, -uint endColumn ); [function] +uint endColumn) function Parameters -startLine specifies the beginning line -startColumn specifies the beginning column -endLine specifies the ending line -endColumn specifies the ending column +startLine specifies the beginning line. +startColumn specifies the beginning column. +endLine specifies the ending line. +endColumn specifies the ending column. Sets a selection from line startLine and column -startColumn up to line endLine +startColumn to line endLine and column endColumn. @@ -1163,13 +1083,13 @@ and column endColumn. A sample script -As an example we will create a small script that uppercases the selection. -It is obvious that we first need to check whether a selection exists, if so we -get the text, change the case and then replace it with the new one. An -implementation could look like this: +As an example we will create a small script that transforms the selected +text to upper case. We first need to check whether a selection exists: if so we +get the text, change the case and then replace the original text with the new one. +An implementation would look something like this: -if ( view.hasSelection() ) +if (view.hasSelection()) { // uppercase selection column = view.selectionStartColumn; @@ -1179,17 +1099,18 @@ if ( view.hasSelection() ) document.editBegin(); view.removeSelectedText(); - document.insertText( line, column, selection ); + document.insertText(line, column, selection); document.editEnd(); } -To group this action together so that they will be reverted by a single -activation of Undo we encapsulate the lines -view.removeSelectedText() and -document.insertText() with a -document.editBegin() and -document.editEnd(). +To group this actions together so that they will be reverted by a single +activation of Undo, we encapsulate the lines + +view.removeSelectedText() +document.insertText() + in a document.editBegin() - +document.editEnd() block. @@ -1202,36 +1123,32 @@ activation of Undo we encapsulate the lines # Example of a .desktop file [Desktop Entry] Encoding=UTF-8 -Name=Kate Part JavaScript Uppercase -Comment=Script to uppercase the selection +Name=Kate Part JavaScript Uppercase Script +Comment=Script to transform the selected text to upper case X-Kate-Command=uppercase-selection X-Kate-Help=<p>Usage: <code>uppercase-selection</code></p> As you can see you can define the Encoding, set a Name, a Comment, a help -text using X-Kate-Help and the command line name via X-Kate-Command. The entries -Name, Comment and X-Kate-Help are automatically translated into other languages -by the KDE translation teams, if the files are in KDE's SVN repository. +text using X-Kate-Help and the command line name via X-Kate-Command. -Putting it togeather +Putting it all together &kate; will search the script folders (see above) for -*.js files. For every file it checks whether there is a -corresponding .desktop file, like for uppercase.js it -would look for uppercase.desktop. -If a .desktop file can not be found the script will -be registered in katepart's command line with the filename without the ending -.js, so in our example this would be uppercase. If the -command-name is fine and you don't need the extra features a -.desktop file provides you do not need a +.js files. For every such file found, &kate; will check +whether there is a corresponding .desktop file with +the same basename (for example script.js and script.desktop). +If a corresponding .desktop file exists, the script +will be registered using the name from the .desktop entry X-Kate-Command. +If a corresponding .desktop file can not be found, the script will +be registered with the file basename (i.e. without the ending .js). +If you only need the command name and none of the extra features +that a .desktop file would provide, you do not need a .desktop file at all. -If a .desktop file exists katepart will read the name -under which the script will be registered from the .desktop-entry -X-Kate-Command, for example X-Kate-Command=uppercase-selection. diff --git a/doc/kate/configuring.docbook b/doc/kate/configuring.docbook index 46a3e4703..f7cd3bff6 100644 --- a/doc/kate/configuring.docbook +++ b/doc/kate/configuring.docbook @@ -484,7 +484,7 @@ wrapped lines. - + Code Folding diff --git a/doc/kate/mdi.docbook b/doc/kate/mdi.docbook index 0402c4d57..993682b6e 100644 --- a/doc/kate/mdi.docbook +++ b/doc/kate/mdi.docbook @@ -286,6 +286,88 @@ information, see the &konsole; manual. + +The Find in Files Panel + +The Find in Files Panel +The Find in Files panel in &kate; allows you to search for text in +multiple files at once. +Results of the search will be displayed in the list at the bottom of the +panel, while search errors will be displayed in a separate dialog. + +The panel offers the following options: + + + + +Pattern +The text to look for. The interpretation of the string +depends on some of the options described below. + + + +Case sensitive + +If enabled, the search will be case sensitive. + + + + +Regular expression + +If checked, the search string will be interpreted as a regular +expression. +See Regular +Expressions for more on these. + + + + +Template (edit field and dropbox) + +Here you can specify an additional context string to be used as a wrapper around +the search pattern. Some default templates are available through the dropbox on the right +of the template edit field. + + + + +Files + +The file name pattern used to select which files to search. +It is possible to specify multiple patterns by separating them with commas +(for example *.h, *.cpp). + + + + +Folder + +The folder to search for files. + + + + +Recursive + +If checked, the search will also recurse in the subfolders of the +specified folder. + + + + + +You can use the Find button to start the search +and the Cancel button to interrupt a running search. + +The Clear button can be used to clear the search +list at the bottom of the panel. + +The default location of the Find in Files panel in &kate; is at the bottom, +below the editing area. + + + External Tools diff --git a/doc/kate/part.docbook b/doc/kate/part.docbook index e99985539..ad74be9c7 100644 --- a/doc/kate/part.docbook +++ b/doc/kate/part.docbook @@ -359,6 +359,7 @@ with the corresponding string capture (parenthesized substring) from the search pattern. A button for listing all available string captures will also be enabled. You can click on any of the available string captures to include them in your replacement string. +Placeholders can only be used when searching using regular expressions. @@ -460,6 +461,12 @@ captured in parenthesized subpatterns of the expression. + +Finding text in multiple files +To search for text in multiple files at once, please refer to the +Find in Files Panel section. + + diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook index 196aae7e8..48c164de2 100644 --- a/doc/kate/plugins.docbook +++ b/doc/kate/plugins.docbook @@ -21,9 +21,14 @@ linkend="configuring-kate-configdialog">configuration dialog, which also provides access to additional configuration options for plugins that requires that. -There are many plugins for various purposes available in the tdeaddons +There are many plugins for various purposes available in the tdeaddons module, and you can search the web for more. A few plugins are shipped with the -editor component, for doing word completion, automatic bookmarks, insert files, +editor component, for doing word completion, insert files, thesaurus and word spell checking and incremental search. +You can find additional information about some of &kate;'s plugins in +The Kate Plugins Handbook accessible from +HelpPlugins Handbook +if the tdeaddons module has been installed on your system +