Git commit a764273083df62f9413bfcf455d2fd2bba15e401 by T.C. Hollingsworth. Committed on 28/11/2013 at 10:12. Pushed by hollingsworth into branch 'master'.
update docs for 4.12 M +41 -20 doc/kate/configuring-part.docbook M +2 -0 doc/kate/configuring.docbook M +15 -8 doc/kate/fundamentals.docbook M +2 -2 doc/kate/index.docbook M +279 -19 doc/kate/menus.docbook M +269 -117 doc/kate/plugins.docbook http://commits.kde.org/kate/a764273083df62f9413bfcf455d2fd2bba15e401 diff --git a/doc/kate/configuring-part.docbook b/doc/kate/configuring-part.docbook index d4999e4..61603c0 100644 --- a/doc/kate/configuring-part.docbook +++ b/doc/kate/configuring-part.docbook @@ -1,4 +1,4 @@ -<!--pulled in by KWrite--> + <!--pulled in by KWrite--> <sect1 id="config-dialog-editor"> <title>The Editor Component Configuration</title> <para>This group contains all pages related to the editor component of @@ -6,7 +6,7 @@ <link linkend="pref-open-save-modes-filetypes">defining a filetype</link>, by <ulink url="help:/kate/config-variables.html">Document Variables</ulink> or by changing them per document during an editing session.</para> -<sect2 id="appearance"> <!-- updated to 4.10 --> +<sect2 id="appearance"> <title>Appearance</title> <sect3 id="appearance-general"> @@ -407,25 +407,25 @@ documentation</ulink>.</para></listitem> <varlistentry> <term><guilabel>Background</guilabel></term> <listitem><para>This color is used by the &kate; Snippets plugin to mark the -background of a snippet. For more information, see +background of a snippet. <!--For more information, see <ulink url="help:/kate/kate-application-plugin-snippets.html">the &kate; Snippets -documentation</ulink>.</para></listitem> +documentation</ulink>.--></para></listitem> </varlistentry> <varlistentry> <term><guilabel>Editable Placeholder</guilabel></term> <listitem><para>This color is used by the &kate; Snippets plugin to mark a -placeholder that you can click in to edit manually. For more information, see +placeholder that you can click in to edit manually. <!--For more information, see <ulink url="help:/kate/kate-application-plugin-snippets.html">the &kate; Snippets -documentation</ulink>.</para></listitem> +documentation</ulink>.--></para></listitem> </varlistentry> <varlistentry> <term><guilabel>Focused Editable Placeholder</guilabel></term> <listitem><para>This color is used by the &kate; Snippets plugin to mark the -placeholder that you are presently editing. For more information, see +placeholder that you are presently editing. <!--For more information, see <ulink url="help:/kate/kate-application-plugin-snippets.html">the &kate; Snippets -documentation</ulink>.</para></listitem> +documentation</ulink>.--></para></listitem> </varlistentry> <varlistentry> @@ -441,6 +441,18 @@ documentation</ulink>.</para></listitem> </listitem> </varlistentry> +<varlistentry id="prefcolors-colors-use-kde-color-scheme"> +<term><guibutton>Use &kde; Color Scheme</guibutton></term> +<listitem> +<para>Clicking this button will set all the above defined colors to match the +current color scheme defined in &kde;'s &systemsettings;. For more information, +see <ulink url="help:/kcontrol/colors/">the documentation for the Colors &kde; +Control Module</ulink>.</para> +<para>If you do not use the &kde; &plasma; Workspaces, this button will have no +effect, and may not be present.</para> +</listitem> +</varlistentry> + </variablelist> </sect3> @@ -466,7 +478,7 @@ highlight.</para> the item, providing you with an immediate preview when configuring a style. </para> <para>Each style lets you select common attributes as well as foreground -and background colors. To unset a background color, rightclick to use the +and background colors. To unset a background color, right-click to use the context menu.</para> </sect3> @@ -481,7 +493,7 @@ above the style list. the item, providing you with an immediate preview when configuring a style. </para> <para>Each style lets you select common attributes as well as foreground -and background colors. To unset a background color, rightclick to use the +and background colors. To unset a background color, right-click to use the context menu. In addition you can see if a style is equal to the default style used for the item, and set it to that if not.</para> <para>You will notice that many highlights contain other highlights represented @@ -517,7 +529,7 @@ At:</link> option.</para> </listitem> </varlistentry> <varlistentry> -<term><guilabel>Show static word wrap markers +<term><guilabel>Show static word wrap marker (if applicable)</guilabel></term> <listitem> <para>If this option is checked, a vertical line will be drawn at the word wrap @@ -585,7 +597,7 @@ bottom of the visible text as a new page of text is displayed.</para> </listitem> </varlistentry> <varlistentry> -<term><guilabel>Autocenter cursor (lines):</guilabel></term> +<term><guilabel>Autocenter cursor:</guilabel></term> <listitem> <para>Sets the number of lines to maintain visible above and below the cursor when possible.</para> @@ -630,7 +642,7 @@ cursor movement.</para> <variablelist> <varlistentry> -<term><guilabel>Default Indentation mode:</guilabel></term> +<term><guilabel>Default indentation mode:</guilabel></term> <listitem> <para>Select the automatic indentation mode you want to use as default. It is strongly recommended to use <userinput>None</userinput> or @@ -692,7 +704,7 @@ if the indentation is divisible by the tab width.</para> <listitem> <variablelist> <varlistentry> -<term><guilabel>Keep Extra Spaces</guilabel></term> +<term><guilabel>Keep extra spaces</guilabel></term> <listitem><para>If this option is disabled, changing the indentation level aligns a line to a multiple of the width specified in <guilabel>Indentation width</guilabel>.</para></listitem> @@ -814,7 +826,7 @@ up a completion box.</para></listitem> <listitem> <variablelist> <varlistentry> -<term><guilabel>Use VI input mode</guilabel></term> +<term><guilabel>Use Vi input mode</guilabel></term> <listitem> <para>When selected, the vi input mode will be enabled when opening a new view. You can still toggle the vi input mode on/off for a particular view in the @@ -839,8 +851,8 @@ Key mapping is used to change the meaning of typed keys. This allows you to move commands to other keys or make special keypresses for doing a series of commands.</para> <para>Example:</para> -<para><keycap>F2</keycap> -> <keycap>I--</keycap> &Esc;</para> -<para>This will prepend <keycap>I--</keycap> to a line when pressing <keycap>F2</keycap>. +<para><keycap>F2</keycap> -> <userinput>I--</userinput> &Esc;</para> +<para>This will prepend <userinput>I--</userinput> to a line when pressing <keycap>F2</keycap>. </para> </listitem> </varlistentry> @@ -943,7 +955,7 @@ specified here. To disable this, set this to <userinput>0</userinput>.</para> </varlistentry> <varlistentry> -<term><guilabel>Automatic Cleanups on Load/Save</guilabel></term> +<term><guilabel>Automatic Cleanups on Save</guilabel></term> <listitem> <variablelist> @@ -951,7 +963,11 @@ specified here. To disable this, set this to <userinput>0</userinput>.</para> <term><guilabel>Remove trailing spaces</guilabel></term> <listitem> <para>The editor will automatically eliminate extra spaces at the ends of lines -of text while loading/saving the file.</para> +of text while saving the file. You can select <guilabel>Never</guilabel> to +disable this functionality, <guilabel>On Modified Lines</guilabel> to do so +only on lines that you have modified since you last saved the document, or +<guilabel>In Entire Document</guilabel> to remove them unconditionally from the +entire document.</para> </listitem> </varlistentry> @@ -1113,6 +1129,7 @@ to enter a valid value manually.</para> Variables</ulink>.</para> </listitem> </varlistentry> + <varlistentry> <term><guilabel>Highlighting:</guilabel></term> <listitem><para>If you create a new file type, this drop down box allows you to @@ -1132,19 +1149,23 @@ typical mask uses an asterisk and the file extension, for example <filename>*.txt; *.text</filename>. The string is a semicolon-separated list of masks.</para></listitem> </varlistentry> + <varlistentry> <term><guilabel>MIME types:</guilabel></term> <listitem><para>Displays a wizard that helps you easily select mimetypes.</para></listitem> </varlistentry> + <varlistentry> <term><guilabel>Priority:</guilabel></term> <listitem><para>Sets a priority for this file type. If more than one file type selects the same file, the one with the highest priority will be used.</para></listitem> </varlistentry> + </variablelist> </listitem> </varlistentry> + <varlistentry> <term><guibutton>Download Highlighting Files...</guibutton></term> <listitem> @@ -1161,7 +1182,7 @@ from the &kappname; website. </sect2> <sect2 id="pref-plugins"> -<title>Extensions</title> <!-- updated to 4.10 --> +<title>Extensions</title> <para>The <guilabel>Extensions</guilabel> tab lists all available plugins and you can check those you want to use. Click on the <guibutton>Information</guibutton> button to open the <guilabel>About</guilabel> dialog of this plugin.</para> diff --git a/doc/kate/configuring.docbook b/doc/kate/configuring.docbook index 2ce621c..7509a7d 100644 --- a/doc/kate/configuring.docbook +++ b/doc/kate/configuring.docbook @@ -251,6 +251,7 @@ View.</para></listitem> </sect2> +<!--terminal tool view plugin disabled by default in 4.12 <sect2 id="config-dialog-general-sync-konsole"> <title>Terminal</title> @@ -279,6 +280,7 @@ so the calling program is aware you have finished editing the file.</para></list </variablelist> </sect2> +--> </sect1> &configuring-part-sections; diff --git a/doc/kate/fundamentals.docbook b/doc/kate/fundamentals.docbook index 19e45f0..438f2a4 100644 --- a/doc/kate/fundamentals.docbook +++ b/doc/kate/fundamentals.docbook @@ -315,24 +315,30 @@ this is in mdi.docbook <listitem> <para> Toggles the Documents on and off. -<!--FIXME no longer in kate 3.10/kde 4.10-->If the Documents/Filesystem Browser window is + +<!--no longer in kate 3.10/kde 4.10 +If the Documents/Filesystem Browser window is not open, &kate; launches the side bar as a separate, undocked, window. To dock the window grab the two thin parallel lines above the tabs by clicking on them with your &LMB; and holding the button down. Drag the window into &kate;'s editing window and release the &LMB; when you have positioned the Documents/Filesystem Browser window as you -prefer. +prefer.--> </para> +<!--no longer in kate 3.10/kde 4.10 <tip> <para> -<!--FIXME no longer in kate 3.10/kde 4.10-->If you have grabbed the two parallel lines successfully your mouse +If you have grabbed the two parallel lines successfully your mouse pointer will turn into two crossed arrows as you drag. </para> </tip> +--> </listitem> </varlistentry> + +<!--neither of these are enabled by default anymore <varlistentry> <term><menuchoice><guimenuitem>Show Filesystem Browser</guimenuitem></menuchoice></term> @@ -355,7 +361,7 @@ window. In other words, it gives you a command line within the application. </para> </listitem> -</varlistentry> +</varlistentry>--> </variablelist> </sect2> @@ -541,7 +547,7 @@ windows:</para> <listitem><para><link linkend="kate-mdi-tools-file-list">The Documents List</link></para></listitem> <listitem><para><link linkend="kate-application-plugin-fsbrowser">The Filesystem Browser</link></para></listitem> -<listitem><para><link linkend="kate-mdi-tools-konsole">The Built in Terminal Emulator</link></para></listitem> +<!--<listitem><para><link linkend="kate-mdi-tools-konsole">The Built in Terminal Emulator</link></para></listitem>--> </itemizedlist> <para>And possibly other tool views, for example provided by @@ -660,6 +666,7 @@ editing area.</para> <!-- command line + Terminal--> +<!--Terminal plugin is disabled by default now <sect2 id="kate-mdi-tools-konsole"> <title>The Built in Terminal Emulator</title> @@ -684,7 +691,7 @@ information, see the <ulink url="help:/konsole/index.htm">&konsole; manual</ulin <para>The built-in terminal emulator is provided by the Terminal Tool View plugin, which is enabled by default.</para> -</sect2> +</sect2>--> </sect1> @@ -827,8 +834,8 @@ documentation.</para> <para>&kate; does not (yet!) provide any means for reading document related documentation. Depending on the file you are editing, you may -find the <link linkend="kate-mdi-tools-konsole">Built in -Terminal Emulator</link> helpful for viewing related &UNIX; manual pages or +find the <!--<link linkend="kate-mdi-tools-konsole">-->Built in +Terminal Emulator<!--</link>--> helpful for viewing related &UNIX; manual pages or info documentation, or you can use &konqueror;.</para> </sect2> diff --git a/doc/kate/index.docbook b/doc/kate/index.docbook index 4cea47e..7a97152 100644 --- a/doc/kate/index.docbook +++ b/doc/kate/index.docbook @@ -56,8 +56,8 @@ </copyright> <legalnotice>&FDLNotice;</legalnotice> -<date>2013-04-15</date> -<releaseinfo>3.11 &kde; 4.11</releaseinfo> +<date>2013-11-28</date> +<releaseinfo>3.12 &kde; 4.12</releaseinfo> <abstract> <para>&kate; is a programmer's text editor for &kde; 4 and above.</para> diff --git a/doc/kate/menus.docbook b/doc/kate/menus.docbook index 851e59a..bfb3ab1 100644 --- a/doc/kate/menus.docbook +++ b/doc/kate/menus.docbook @@ -192,34 +192,35 @@ it open in &kate; <varlistentry> <term> -<anchor id="close-orphaned"/> +<anchor id="print"/> <menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> <guimenu>File</guimenu> -<guimenuitem>Close Orphaned</guimenuitem> +<guimenuitem>Print...</guimenuitem> </menuchoice> </term> <listitem> -<para><action>Close</action> all documents in the file list, which could -not be reopened during startup, because they are not accessible anymore. +<para> +<action>Print the active file</action>. </para> </listitem> </varlistentry> <varlistentry> <term> -<anchor id="print"/> +<anchor id="export-as-html"/> <menuchoice> -<shortcut> -<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> -</shortcut> <guimenu>File</guimenu> -<guimenuitem>Print...</guimenuitem> +<guimenuitem>Export as &HTML;...</guimenuitem> </menuchoice> </term> <listitem> -<para> -<action>Print the active file</action>. -</para> +<para>Save the currently open document as an &HTML; file, which will be +formatted using the current syntax highlighting and color scheme settings.</para> +<para>This menu item is displayed by the Exporter editor component extension, +which is enabled by default.</para> </listitem> </varlistentry> @@ -274,6 +275,54 @@ in &kate;. <varlistentry> <term> +<anchor id="close-orphaned"/> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Close Orphaned</guimenuitem> +</menuchoice> +</term> +<listitem> +<para><action>Close</action> all documents in the file list, which could +not be reopened during startup, because they are not accessible anymore. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<anchor id="close-except"/> +<menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Close Except</guisubmenu> +</menuchoice> +</term> +<listitem> +<para><action>Close</action> all documents in the file list, +<emphasis>except</emphasis> those which match the path selected from this +submenu.</para> +<para>This menu item is displayed by the Close Except/Like plugin, which is +enabled by default.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<anchor id="close-like"/> +<menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Close Like</guisubmenu> +</menuchoice> +</term> +<listitem> +<para><action>Close</action> all documents in the file list which match the path +selected from this submenu.</para> +<para>This menu item is displayed by the Close Except/Like plugin, which is +enabled by default.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> <anchor id="quit"/> <menuchoice> <shortcut> @@ -312,8 +361,8 @@ all to work with the currently active document.</para> </term> <listitem> <para>Undo the last editing command (typing, copying, cutting etc.)</para> -<!-- FIXME how/where to enable/disable grouped undo ? is this really valid for 4.11?--> -<note><para>If grouped undo is enabled, this may undo several editing commands of the same type, like typing in characters.</para></note> +<note><para>This may undo several editing commands of the same type, like typing +in characters.</para></note> </listitem> </varlistentry> @@ -391,6 +440,20 @@ currently open file.</para> <varlistentry> <term> +<anchor id="edit-copy-as-html"/> +<menuchoice> +<guimenu>Edit</guimenu> +<guisubmenu>Copy as &HTML;</guisubmenu> +</menuchoice> +</term> +<listitem> +<para>Copy the selection as &HTML;, formatted using the current syntax +highlighting and color scheme settings.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> <anchor id="edit-select-all"/> <menuchoice> <shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut> @@ -562,6 +625,64 @@ the document</para> </listitem> </varlistentry> +<varlistentry> +<term> +<anchor id="edit-search-in-files"/> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Search in Files</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Launches the Search and Replace tool view. This provides more advanced +functionality than the +<link linkend="edit-replace"><guimenuitem>Replace</guimenuitem></link> 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.</para> +<para>This menu item is displayed by the Search & Replace plugin, which is +enabled by default. For more information, see +<xref linkend="kate-application-plugin-searchinfiles"/></para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<anchor id="edit-go-to-next-match"/> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Go to Next Match</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>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 +<link linkend="edit-find"><guimenuitem>Find</guimenuitem></link> command, use +<link linkend="edit-find-next"><guimenuitem>Find Next</guimenuitem></link>.</para> +<para>This menu item is displayed by the Search & Replace plugin, which is +enabled by default.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<anchor id="edit-go-to-previous-match"/> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Go to Previous Match</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>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 +<link linkend="edit-find"><guimenuitem>Find</guimenuitem></link> command, use +<link linkend="edit-find-previous"><guimenuitem>Find Previous</guimenuitem></link>. +</para> +<para>This menu item is displayed by the Search & Replace plugin, which is +enabled by default.</para> +</listitem> +</varlistentry> + </variablelist> </sect1> @@ -727,7 +848,8 @@ the old one.</para> </menuchoice> </term> <listitem> -<para>Closes the active frame. This is disabled, if there is only one frame +<para>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).</para> <para>No documents get closed by closing a frame – they will still be available in the <link linkend="view-menu"><guimenu>View</guimenu> Menu</link> as well as in @@ -738,6 +860,23 @@ the File List.</para> <para>See also <link linkend="kate-mdi">Working with the <varlistentry> <term> +<anchor id="view-close-inactive"/> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Split View</guisubmenu> +<guimenuitem>Close Inactive Views</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>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).</para> +<para>No documents get closed by closing a frame – they will still be +available in the <link linkend="view-menu"><guimenu>View</guimenu> Menu</link> +as well as in the File List.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> <anchor id="view-move-splitter-left"/> <menuchoice> <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu> @@ -823,6 +962,57 @@ commands below those will of course continue to work.</para></listitem> <varlistentry> <term> +<anchor id="view-toolviews-show-search-and-replace"/> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Search and Replace</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Displays the advanced Search and Replace tool view, which supports +searching through multiple files. For more information, see +<xref linkend="kate-application-plugin-searchinfiles"/>.</para> +<para>This menu item is displayed by the Search & Replace plugin, which is +enabled by default.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<anchor id="view-toolviews-show-projects"/> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Projects</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Displays the Projects sidebar, which allows you to view a list of open +projects and a list of files in those projects.</para> +<para>This menu item is displayed by the Project plugin, which is +enabled by default.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<anchor id="view-toolviews-show-current-project"/> +<menuchoice> +<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> +<guimenuitem>Show Current Project</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Displays the Current Project tool view, which allows you to access details +about the code contained within the currently open project.</para> +<para>This menu item is displayed by the Project plugin, which is +enabled by default.</para> +</listitem> +</varlistentry> + +<!-- +Terminal plugin no longer enabled by default as of 4.12. :-( +<varlistentry> +<term> <anchor id="view-toolviews-show-konsole"/> <menuchoice> <guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> @@ -843,6 +1033,7 @@ change to the directory of the active document, if it is a local file.</para> enabled by default.</para> </listitem> </varlistentry> +--> </variablelist> </listitem> @@ -1036,6 +1227,51 @@ varlistentry> </sect1> +<sect1 id="projects-menu"> +<title>The Projects Menu</title> + +<para>The <guimenu>Projects</guimenu> menu allows you to switch between +currently open projects. It is displayed by the Project plugin, which is +enabled by default.</para> + +<variablelist> +<title>Menu Items</title> + +<!--FIXME: these shortcuts conflict with the preexisting Build plugin + https://bugs.kde.org/show_bug.cgi?id=328170 --> + +<varlistentry> +<term> +<anchor id="projects-back"/> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;&Alt;<keysym>Left</keysym></keycombo></shortcut> +<guimenu>Projects</guimenu> +<guimenuitem>Back</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Switch to the previous project.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<anchor id="projects-forward"/> +<menuchoice> +<shortcut><keycombo action="simul">&Ctrl;&Alt;<keysym>Right</keysym></keycombo></shortcut> +<guimenu>Projects</guimenu> +<guimenuitem>Forward</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Switch to the next project.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + <sect1 id="bookmarks-menu"> <title>The Bookmarks Menu</title> @@ -1168,6 +1404,7 @@ and delete sessions.</para></listitem> <variablelist> +<!--terminal plugin disabled by default as of 4.12 <varlistentry> <term><menuchoice><guimenu>Tools</guimenu><guimenuitem>Pipe to Terminal</guimenuitem></menuchoice></term> @@ -1200,6 +1437,7 @@ sync with the current document. See This menu item is also displayed by the Terminal Tool View plugin.</para> </listitem> </varlistentry> +--> <varlistentry> <term><anchor id="tools-read-only"/><menuchoice> @@ -1524,10 +1762,32 @@ in the Editing tab in <menuchoice> <guimenu>Settings</guimenu><guimenuitem>Configure Editor...</guimenuitem></menuchoice></para></listitem> </varlistentry> -<!--FIXME -Create Snippet - always enabled -Snippet.. ---> + +<varlistentry> +<term><anchor id="tools-create-snippet"/><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Create Snippet</guimenuitem> +</menuchoice></term> +<listitem> +<para>Create a new snippet, which is a resuable chunk of text you +may insert in any part of any document.</para> +<para>This menu item is displayed by the Snippets plugin, which is enabled by +default.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="tools-snippets"/><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Snippets...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Display a list of available snippets.</para> +<para>This menu item is displayed by the Snippets plugin, which is enabled by +default.</para> +</listitem> +</varlistentry> + </variablelist> <para>Menu items for the selected <link linkend="pref-plugins">plugins</link> are displayed at the end of this menu. diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook index f927ba0..da1d650 100644 --- a/doc/kate/plugins.docbook +++ b/doc/kate/plugins.docbook @@ -200,8 +200,6 @@ For example, if <userinput>4.5</userinput> is selected, it will become </variablelist></listitem> </varlistentry> -<!--FIXME: Quick Coding -> Expand Abbreviation (CTRL+ALT+#) --> - <varlistentry id="scripts-navigation"> <term><menuchoice> <guimenu>Tools</guimenu><guisubmenu>Scripts</guisubmenu> @@ -236,6 +234,8 @@ the same level as the current line. </variablelist> </listitem></varlistentry> +<!--FIXME: Quick Coding -> Expand Abbreviation (CTRL+ALT+#) --> + <varlistentry id="scripts-editing"> <term><menuchoice> <guimenu>Tools</guimenu><guisubmenu>Scripts</guisubmenu> @@ -297,6 +297,28 @@ Duplicates the selected lines up. </para></listitem> </varlistentry> +<varlistentry id="scripts-editing-uri-encode"> +<term><menuchoice> +<guimenu>Tools</guimenu><guisubmenu>Scripts</guisubmenu><guisubmenu>Editing</guisubmenu> +<guimenuitem>URI-encode selected text</guimenuitem> +</menuchoice></term> +<listitem><para> +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. +</para></listitem> +</varlistentry> + +<varlistentry id="scripts-editing-uri-decode"> +<term><menuchoice> +<guimenu>Tools</guimenu><guisubmenu>Scripts</guisubmenu><guisubmenu>Editing</guisubmenu> +<guimenuitem>URI-decode selected text</guimenuitem> +</menuchoice></term> +<listitem><para> +If part of the query string of a &URL; is selected, this will decode it and +replace the selection with the original raw text. +</para></listitem> +</varlistentry> + </variablelist></listitem> </varlistentry> @@ -329,10 +351,10 @@ The available application plugins are: <para><link linkend="kate-application-plugin-build">Build Plugin</link> - Compile or Make and parse error messages</para> </listitem> <listitem> -<para>Close Except/Like - Close group of documents</para> +<para>Close Except/Like - Close group of documents based on a common path or file extension</para> </listitem> <listitem> -<para>CTags Plugin - Look up definitions/declarations with CTags</para> +<para>CTags - Look up definitions/declarations with CTags</para> </listitem> <listitem> <para><link linkend="kate-application-plugin-fsbrowser">File system browser</link> - @@ -366,11 +388,11 @@ simple &gdb; frontend</para> <para>Python Plugins - &pate; host for Python plugins</para> </listitem> <listitem> -<para>Search and Replace Plugin - Search or replace patterns in all open files or all files in a folder</para> -<!-- FIXME add info from http://kate-editor.org/2011/06/28/kate-plugin-updates-part-3/--> +<para><link linkend="kate-application-plugin-searchinfiles">Search & Replace</link> - +Search or replace patterns in opened documents or in files on disk</para> </listitem> <listitem> -<para><link linkend="kate-application-plugin-snippets">Snippets tool view</link> - Toolview embedding the snippets management</para> +<para>Snippets tool view - Tool view embedding the snippets management</para> </listitem> <listitem> <para><link linkend="kate-application-plugin-sql">SQL Plugin</link> - Execute @@ -384,18 +406,18 @@ query on SQL databases</para> <!--http://kate-editor.org/2011/04/25/kates-tab-bar-plugins/--> </listitem> <listitem> -<para>Terminal tool view - Toolview embedding a terminal widget</para> +<para>Terminal tool view - Tool view embedding a terminal widget</para> </listitem> <listitem> <para>Text Filter - Easy text filtering</para> </listitem> <listitem> -<para><link linkend="kate-application-plugin-xmlcheck">&XML; Validation</link>- Validates &XML; files using xmllint</para> -</listitem> -<listitem> <para><link linkend="kate-application-plugin-xmltools">&XML;Completetion</link> - Lists &XML; elements, attributes, attribute values and entities allowed by DTD</para> </listitem> +<listitem> +<para><link linkend="kate-application-plugin-xmlcheck">&XML; Validation</link>- Validates &XML; files using xmllint</para> +</listitem> <!-- not in 4.10 <listitem> @@ -435,31 +457,25 @@ configuration dialog. For more information about configuring &pate; plugins, se <title>Available Plugins</title> <variablelist> -<varlistentry id="pate-plugin-cmake_utils"> -<term><guilabel>cmake_utils</guilabel></term> -<listitem><para> -CMake helper plugin -</para></listitem> -</varlistentry> -<varlistentry id="pate-plugin-python_autocomplete"> -<term><guilabel>python_autocomplete</guilabel></term> +<varlistentry id="pate-plugin-block"> +<term><guilabel>block</guilabel></term> <listitem><para> -Python Autocompletion (beta, only for Python 2) +Plugins to help code editing </para></listitem> </varlistentry> -<varlistentry id="pate-plugin-python_console_classic"> -<term><guilabel>python_console_classic</guilabel></term> +<varlistentry id="pate-plugin-cmake_utils"> +<term><guilabel>cmake_utils</guilabel></term> <listitem><para> -Configuration widget for this plugin. +CMake helper plugin </para></listitem> </varlistentry> -<varlistentry id="pate-plugin-python_utils"> -<term><guilabel>python_utils</guilabel></term> +<varlistentry id="pate-plugin-color_tools"> +<term><guilabel>color_tools</guilabel></term> <listitem><para> -Python Utilities: Parse Checker, PEP8 Checker, Pyflakes Checker, Snippets +Class encapsuling the ability to show color swatches (colored tooltips) </para></listitem> </varlistentry> @@ -470,13 +486,6 @@ Move an inlined comment before the current line with the same indentation level </para></listitem> </varlistentry> -<varlistentry id="pate-plugin-format"> -<term><guilabel>format</guilabel></term> -<listitem><para> -Plugins to work with C++ code formatting -</para></listitem> -</varlistentry> - <varlistentry id="pate-plugin-django_utils"> <term><guilabel>django_utils</guilabel></term> <listitem><para> @@ -484,32 +493,6 @@ Django utilities: Snippets, and template utilities </para></listitem> </varlistentry> -<varlistentry id="pate-plugin-python_console_ipython"> -<term><guilabel>python_console_ipython</guilabel></term> -<listitem><para> -IPython console for hacking &kate; and doing science -</para></listitem> -</varlistentry> - -<varlistentry id="pate-plugin-gdb"> -<term><guilabel>gdb</guilabel></term> -<listitem><para> -Use <application>gdb</application>, the GNU debugger, from &kate; -</para></listitem> -</varlistentry> - -<varlistentry id="pate-plugin-gid"> -<term><guilabel>gid</guilabel></term> -<listitem> -<para>Browse the tokens in a <application>GNU idutils</application> ID file, and -use it to navigate within a codebase.</para> - -<para>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. <command>etags(1)</command> is used to locate the -definition.</para></listitem> -</varlistentry> - <varlistentry id="pate-plugin-expand"> <term><guilabel>expand</guilabel></term> <listitem> @@ -572,25 +555,32 @@ public: </listitem> </varlistentry> -<varlistentry id="pate-plugin-xml_pretty"> -<term><guilabel>xml_pretty</guilabel></term> +<varlistentry id="pate-plugin-format"> +<term><guilabel>format</guilabel></term> <listitem><para> -A simple &XML; pretty printer. It formats &XML; with good indentation. +Plugins to work with C++ code formatting </para></listitem> </varlistentry> -<varlistentry id="pate-plugin-color_tools"> -<term><guilabel>color_tools</guilabel></term> +<!--not in 4.12 +<varlistentry id="pate-plugin-gdb"> +<term><guilabel>gdb</guilabel></term> <listitem><para> -Class encapsuling the ability to show color swatches (colored tooltips) +Use <application>gdb</application>, the GNU debugger, from &kate; </para></listitem> </varlistentry> +--> -<varlistentry id="pate-plugin-block"> -<term><guilabel>block</guilabel></term> -<listitem><para> -Plugins to help code editing -</para></listitem> +<varlistentry id="pate-plugin-gid"> +<term><guilabel>gid</guilabel></term> +<listitem> +<para>Browse the tokens in a <application>GNU idutils</application> ID file, and +use it to navigate within a codebase.</para> + +<para>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. <command>etags(1)</command> is used to locate the +definition.</para></listitem> </varlistentry> <varlistentry id="pate-plugin-js_utils"> @@ -601,6 +591,41 @@ JSON, Snippets </para></listitem> </varlistentry> +<varlistentry id="pate-plugin-python_autocomplete"> +<term><guilabel>python_autocomplete</guilabel></term> +<listitem><para> +Python Autocompletion (beta, only for Python 2) +</para></listitem> +</varlistentry> + +<varlistentry id="pate-plugin-python_console_classic"> +<term><guilabel>python_console_classic</guilabel></term> +<listitem><para> +Interactive console for inspecting &kate;'s internals and playing about +</para></listitem> +</varlistentry> + +<varlistentry id="pate-plugin-python_console_ipython"> +<term><guilabel>python_console_ipython</guilabel></term> +<listitem><para> +IPython console for hacking &kate; and doing science +</para></listitem> +</varlistentry> + +<varlistentry id="pate-plugin-python_utils"> +<term><guilabel>python_utils</guilabel></term> +<listitem><para> +Python Utilities: Parse Checker, PEP8 Checker, Pyflakes Checker, Snippets +</para></listitem> +</varlistentry> + +<varlistentry id="pate-plugin-xml_pretty"> +<term><guilabel>xml_pretty</guilabel></term> +<listitem><para> +A simple &XML; pretty printer. It formats &XML; with good indentation. +</para></listitem> +</varlistentry> + </variablelist> </sect2> @@ -1245,15 +1270,16 @@ Export your file in &HTML; format so your document can be viewed as a web page. &TC.Hollingsworth; &TC.Hollingsworth.mail; </author></authorgroup> </sect1info> -<title>Search and Replace</title> +<title>Search & Replace</title> <sect2 id="searchinfiles-intro"> <title>Introduction</title> -<para>&kappname;'s Search in Files plugin allows you to search for text or +<para>&kappname;'s Search & Replace plugin allows you to search for text or <link linkend="regular-expressions">regular expressions</link> in many different -files at once. You can search all open files, or all the files in one directory, -and optionally its subdirectories. You can even filter by filename, for instance -searching only files that end with a particular file extension.</para> +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.</para> </sect2> @@ -1279,10 +1305,27 @@ search. </varlistentry> <varlistentry> -<term>Query</term> +<term><guiicon>Toggle Results</guiicon></term> +<listitem><para> +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. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Find</guilabel></term> <listitem><para> -The long text box at the top is where you type in what you want to find. You may -enter standard text, or a regular expression if enabled. +This is where you type in what you want to find. You may enter standard text, +or a regular expression if enabled. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Replace</guilabel> (text box)</term> +<listitem><para> +Replacement text that will be added to file(s) in place of the text in the +<guilabel>Find</guilabel> text box. </para></listitem> </varlistentry> @@ -1291,37 +1334,33 @@ enter standard text, or a regular expression if enabled. <listitem><para> When you've finished configuring everything, just press the <guibutton>Search</guibutton> button to perform your search. You may also press -&Enter; in the Query text box to do the same. +&Enter; in the <guilabel>Find</guilabel> text box to do the same. </para></listitem> </varlistentry> <varlistentry> -<term><guimenu>Location</guimenu></term> +<term><guibutton>Replace</guibutton></term> <listitem><para> -This has two options. Select <guilabel>in Open Files</guilabel> to search all -files currently open in &kappname;. Select <guilabel>in Folder</guilabel> to -search inside a folder and optionally its subfolders. +When you've finished configuring everything, just press the +<guibutton>Replace</guibutton> button to replace the text entered in the +<guilabel>Find</guilabel> text box with that of the <guilabel>Replace</guilabel> +text box. You may also press &Enter; in the <guilabel>Replace</guilabel> text +box to do the same. </para></listitem> </varlistentry> <varlistentry> -<term><guimenu>Options</guimenu></term> +<term><guibutton>Next</guibutton></term> <listitem><para> -There are two available options. If enabled, <guilabel>Match case</guilabel> -will restrict search results to only those that have the exact same combination -of upper and lower case letters as your search query. <guilabel>Regular -expressions</guilabel> permits you to use -<link linkend="regular-expressions">regular expressions</link> instead of simple -text as your search query. +Go to the next match of your search query, switching files if necessary. </para></listitem> </varlistentry> <varlistentry> -<term><guiicon>Toggle Results</guiicon></term> +<term><guibutton>Replace checked</guibutton></term> <listitem><para> -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. +The same as <guibutton>Replace</guibutton>, but will only perform replacements +in files that are checked in the pane below. </para></listitem> </varlistentry> @@ -1333,24 +1372,59 @@ for the Search in Folder mode and the results of your search. <para>These options are displayed below the aforementioned query options. If search results are being displayed instead, press the <guiicon>Toggle Results</guiicon> -button to display them. These options apply only when Search in Folder mode is -enabled. If Search in Open Files is selected, they will be disabled.</para> +button to display them.</para> <variablelist> <varlistentry> +<term><guilabel>Match case</guilabel></term> +<listitem><para> +Restricts search results to only those that have the exact same combination +of upper and lower case letters as your search query. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Regular expressions</guilabel></term> +<listitem><para> +Permits you to use <link linkend="regular-expressions">regular expressions</link> +instead of simple text as your search query. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Expand results</guilabel></term> +<listitem><para> +Display all the results found in each file, instead of just a list of files +that contain the search query. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Search</guilabel></term> +<listitem><para> +This has three options. Select <guilabel>in Open files</guilabel> to search all +files currently open in &kappname;. Select <guilabel>in Folder</guilabel> to +search inside a folder and optionally its subfolders. Select <guilabel>in +Project</guilabel> to search all the files listed in the currently open project. +</para></listitem> +</varlistentry> + +<varlistentry> <term><guilabel>Folder</guilabel></term> <listitem><para> You may enter the path of the folder you wish to search. For instance, you might enter <userinput>~/development/kde/kate/</userinput> if you wished to search the -&kate; source code. +&kate; source code. This option is only available when using +<guilabel>in Folder</guilabel> mode. </para></listitem> </varlistentry> <varlistentry> <term><guiicon>Open file dialog</guiicon></term> <listitem><para> -Press this button to locate the folder in your desktop's folder browser. +Press this button to locate the folder in your desktop's folder browser. This +button only works when using <guilabel>in Folder</guilabel> mode. </para></listitem> </varlistentry> @@ -1358,7 +1432,8 @@ Press this button to locate the folder in your desktop's folder browser. <term><guiicon>Up</guiicon></term> <listitem><para> Press this button to change <guilabel>Folder</guilabel> to the parent of the -currently selected folder. +currently selected folder. This button only works when using +<guilabel>in Folder</guilabel> mode. </para></listitem> </varlistentry> @@ -1366,7 +1441,8 @@ currently selected folder. <term><guiicon>Restore Current Folder</guiicon></term> <listitem><para> This button will set the <guilabel>Folder</guilabel> entry to the folder in which -the currently open document is located. +the currently open document is located. This button only works when using +<guilabel>in Folder</guilabel> mode. </para></listitem> </varlistentry> @@ -1377,9 +1453,19 @@ This permits you to only search filenames that match a particular pattern. For instance, to only search files written in C++, change it to <userinput>*.cpp</userinput>. To search only files beginning with <literal>kate</literal>, change it to <userinput>kate*</userinput>. You can -enter multiple filters separated with a comma (<userinput>,</userinput>). To -use this to exclude files from the search, append a minus sign -(<userinput>-</userinput>) to the list. +enter multiple filters separated with a comma (<userinput>,</userinput>). This +option is not available when using <guilabel>in Open files</guilabel> mode. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Exclude</guilabel></term> +<listitem><para> +The opposite of <guilabel>Filter</guilabel>, this prevents &kappname; from +searching files that match the specified patterns. As with +<guilabel>Filter</guilabel>, you can enter multiple patterns separated with a +comma (<userinput>,</userinput>). This option is not available when using +<guilabel>in Open files</guilabel> mode. </para></listitem> </varlistentry> @@ -1387,7 +1473,8 @@ use this to exclude files from the search, append a minus sign <term><guilabel>Recursive</guilabel></term> <listitem><para> If this option is enabled, &kappname; will also search in all subfolders of the -selected folder. +selected folder. This option is only available when using +<guilabel>in Folder</guilabel> mode. </para></listitem> </varlistentry> @@ -1395,7 +1482,8 @@ selected folder. <term><guilabel>Include hidden</guilabel></term> <listitem><para> If this option is enabled, &kappname; will also search in files or folders that -are typically hidden by your &OS;. +are typically hidden by your &OS;. This option is only available when using +<guilabel>in Folder</guilabel> mode. </para></listitem> </varlistentry> @@ -1405,7 +1493,8 @@ are typically hidden by your &OS;. The Search in Files plugin typically doesn't follow <ulink url="http://en.wikipedia.org/wiki/Symbolic_link";>symbolic links</ulink>. When this option is enabled, the plugin will follow them instead and search inside -the files or folders they reference. +the files or folders they reference. This option is only available when using +<guilabel>in Folder</guilabel> mode. </para> <warning><para>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 @@ -1415,6 +1504,14 @@ and search the folder, and the search will never complete.</para></warning> </listitem> </varlistentry> +<varlistentry> +<term><guilabel>Include binary files</guilabel></term> +<listitem><para> +If enabled, &kappname; will also search in files that do not appear to be text +files. +</para></listitem> +</varlistentry> + </variablelist> </sect3> @@ -1426,35 +1523,81 @@ options for Search in Folder mode are displayed, simply press the <guiicon>Toggle Results</guiicon> button to display them. They will also automatically be displayed as soon as a search is performed.</para> -<para>The search results displays three columns providing information about each -result of your search query. The <guilabel>File</guilabel> column shows the name -of the file. The <guilabel>Line</guilabel> column displays the line number the -contents of your query were found in. The <guilabel>Text</guilabel> column displays -the full text of that line.</para> +<para>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.</para> + +<para>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 <guilabel>Expand +results</guilabel> 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.</para> <para>To open the file your result was found in, simply double-click it. &kappname; -will open the file if needed, and place the cursor at the beginning of the text -entered as your query as found in the file.</para> +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. +</para> </sect3> </sect2> <sect2 id="searchinfiles-menu"> <title>Menu Structure</title> + <variablelist> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Search in Files</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Launches the Search and Replace tool view.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Go to Next Match</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Go to the next match in a search performed by the Search and Replace +plugin.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Go to Previous Match</guimenuitem> +</menuchoice> +</term> +<listitem> +<para>Go to the previous match in a search performed by the Search and Replace +plugin.</para> +</listitem> +</varlistentry> + <varlistentry> <term> <menuchoice> <guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu> -<guimenuitem>Show Search in Files</guimenuitem> +<guimenuitem>Show Search and Replace</guimenuitem> </menuchoice> </term> <listitem> -<para>Toggle the display of &kappname;'s <guilabel>Search in Files</guilabel> tool. +<para>Toggle the display of &kappname;'s <guilabel>Search and Replace</guilabel> tool. </para> </listitem> </varlistentry> + </variablelist> + </sect2> </sect1> @@ -1844,7 +1987,9 @@ from disk.</para></listitem> </sect2> </sect1>--> - <!--FIXME needs an update to 4.10 --> + <!-- + FIXME: replaced by built-in functionality in 4.12 + lots of this is wrong, other parts need to be moved somewhere else <sect1 id="kate-application-plugin-snippets"> <sect1info> <authorgroup> @@ -1899,7 +2044,7 @@ repositories.</para> <guibutton>Get New Snippets</guibutton> and a window with a list of snippet repositories will open. After downloading the desired snippet, make sure that you have activated it.</para> -<!--FIXME no way to load a local file ?--> +<!- -FIXME no way to load a local file ?- -> <para>You can also load snippet repositories from a local file using the file browser at the bottom of the panel. Click <guibutton>Copy to repository</guibutton> when finished.</para> @@ -2025,6 +2170,7 @@ writing much of this section.</para> </sect2> </sect1> +--> <sect1 id="kate-application-plugin-build"> <!--http://kate-editor.org/2011/06/21/kate-plugin-updates-part-1/ --> @@ -2126,6 +2272,12 @@ warnings generated by the last command.</para> Clicking on the error or warning takes you to the appropriate file and places the cursor on the corresponding line number.</para> +<para>There are <guibutton>Errors</guibutton>, <guibutton>Warnings</guibutton>, +and <guibutton>Others</guibutton> buttons at the top that allow you to show +or hide those categories of output.</para> + +<!--FIXME: These shortcuts now seem to be used by the Project plugin in 4.11. + https://bugs.kde.org/show_bug.cgi?id=328170 --> <para>To navigate to the previous error, press <keycombo action="simul">&Ctrl;&Alt;<keysym>Left</keysym></keycombo>. To navigate to the next error, press
