« back to all changes in this revision
Viewing changes to doc/kate/plugins.docbook
- browse files at revision 1.1.4
- compare with another revision
- download diff
- download tarball
- view history from revision 1.1.4
- Committer: Package Import Robot
- Author(s): Jonathan Riddell
- Date: 2011-11-23 14:02:22 UTC
- mto: (1.2.2 experimental)
- mto: This revision was merged to the branch mainline in revision 7.
- Revision ID: package-import@ubuntu.com-20111123140222-fvexvf51k643jxpp
Tags: upstream-4.7.3
Import upstream version 4.7.3
- files modified:
- doc/kate/configuring.docbook
added
removed
doc/kate/plugins.docbook
877
877
</sect2>
878
878
</sect1>
879
879
880
<sect1 id="kate-application-plugin-searchinfiles">
881
<sect1info>
882
<authorgroup><author>
883
<firstname>T.C.</firstname>
884
<surname>Hollingsworth</surname>
885
<affiliation><address><email>tchollingsworth@gmail.com</email></address></affiliation>
886
</author></authorgroup>
887
</sect1info>
888
<title>Search in Files</title>
889
890
<sect2 id="searchinfiles-intro">
891
<title>Introduction</title>
892
<para>&kappname;'s Search in Files plugin allows you to search for text or
893
<link linkend="regular-expressions">regular expressions</link> in many different
894
files at once. You can search all open files, or all the files in one directory,
895
and optionally its subdirectories. You can even filter by filename, for instance
896
searching only files that end with a particular file extension.</para>
897
898
<para>The Search in Files plugin is not enabled by default, as it is new in &kappname;
899
3.7. Enable it in the <link linkend="config-dialog-plugins">Plugins</link> panel
900
of &kappname;'s settings. It will replace the old
901
<link linkend="kate-application-plugin-findinfiles">Find in Files plugin</link>
902
in the next version of &kappname;.</para>
903
904
</sect2>
905
906
<sect2 id="searchinfiles-ui">
907
<title>Interface</title>
908
909
<sect3 id="searchinfiles-ui-query">
910
<title>Search Query</title>
911
912
<para>The following options are always displayed at the top of the Search in
913
Files tool view:</para>
914
915
<variablelist>
916
917
<varlistentry>
918
<term><guiicon>New Tab</guiicon></term>
919
<listitem><para>
920
You can have as many searches as you want open at the same time. Simply click
921
the <guibutton>New Tab</guibutton> button at the top-left corner of the Search
922
tool view and a new results tab will open permitting you to perform another
923
search.
924
</para></listitem>
925
</varlistentry>
926
927
<varlistentry>
928
<term>Query</term>
929
<listitem><para>
930
The long text box at the top is where you type in what you want to find. You may
931
enter standard text, or a regular expression if enabled.
932
</para></listitem>
933
</varlistentry>
934
935
<varlistentry>
936
<term><guibutton>Search</guibutton></term>
937
<listitem><para>
938
When you've finished configuring everything, just press the
939
<guibutton>Search</guibutton> button to perform your search. You may also press
940
&Enter; in the Query text box to do the same.
941
</para></listitem>
942
</varlistentry>
943
944
<varlistentry>
945
<term><guimenu>Location</guimenu></term>
946
<listitem><para>
947
This has two options. Select <guilabel>in Open Files</guilabel> to search all
948
files currently open in &kappname;. Select <guilabel>in Folder</guilabel> to
949
search inside a folder and optionally its subfolders.
950
</para></listitem>
951
</varlistentry>
952
953
<varlistentry>
954
<term><guimenu>Options</guimenu></term>
955
<listitem><para>
956
There are two available options. If enabled, <guilabel>Match case</guilabel>
957
will restrict search results to only those that have the exact same combination
958
of upper and lower-case letters as your search query. <guilabel>Regular
959
expressions</guilabel> permits you to use
960
<link linkend="regular-expressions">regular expressions</link> instead of simple
961
text as your search query.
962
</para></listitem>
963
</varlistentry>
964
965
<varlistentry>
966
<term><guiicon>Toggle Results</guiicon></term>
967
<listitem><para>
968
The down arrow in the top right-corner of the Search in Files tool view will
969
toggle the bottom half of the tool view between displaying additional options
970
for the Search in Folder mode and the results of your search.
971
</para></listitem>
972
</varlistentry>
973
974
</variablelist>
975
</sect3>
976
977
<sect3 id="searchinfiles-ui-folder">
978
<title>Search in Folder Options</title>
979
980
<para>These options are displayed below the aforementioned query options. If search
981
results are being displayed instead, press the <guiicon>Toggle Results</guiicon>
982
button to display them. These options apply only when Search in Folder mode is
983
enabled. If Search in Open Files is selected, they will be disabled.</para>
984
985
<variablelist>
986
987
<varlistentry>
988
<term><guilabel>Folder</guilabel></term>
989
<listitem><para>
990
You may enter the path of the folder you wish to search. For instance, you might
991
enter <userinput>~/development/kde/kate/</userinput> if you wished to search the
992
&kate; source code.
993
</para></listitem>
994
</varlistentry>
995
996
<varlistentry>
997
<term><guiicon>Open file dialog</guiicon></term>
998
<listitem><para>
999
Press this button to locate for the folder in your desktop's folder browser.
1000
</para></listitem>
1001
</varlistentry>
1002
1003
<varlistentry>
1004
<term><guiicon>Up</guiicon></term>
1005
<listitem><para>
1006
Press this button to change <guilabel>Folder</guilabel> to the parent of the
1007
currently selected folder.
1008
</para></listitem>
1009
</varlistentry>
1010
1011
<varlistentry>
1012
<term><guiicon>Restore Current Folder</guiicon></term>
1013
<listitem><para>
1014
This button will set the <guilabel>Folder</guilabel> entry to the folder in which
1015
the currently open document is located.
1016
</para></listitem>
1017
</varlistentry>
1018
1019
<varlistentry>
1020
<term><guilabel>Filter</guilabel></term>
1021
<listitem><para>
1022
This permits you to only search filenames that match a particular pattern. For
1023
instance, to only search files written in C++, change it to
1024
<userinput>*.cpp</userinput>. To search only files beginning with
1025
<literal>kate</literal>, change it to <userinput>kate*</userinput>.
1026
</para></listitem>
1027
</varlistentry>
1028
1029
<varlistentry>
1030
<term><guilabel>Recursive</guilabel></term>
1031
<listitem><para>
1032
If this option is enabled, &kappname; will also search in all subfolders of the
1033
selected folder.
1034
</para></listitem>
1035
</varlistentry>
1036
1037
<varlistentry>
1038
<term><guilabel>Include hidden</guilabel></term>
1039
<listitem><para>
1040
If this option is enabled, &kappname; will also search in files or folders that
1041
are typically hidden by your &OS;.
1042
</para></listitem>
1043
</varlistentry>
1044
1045
<varlistentry>
1046
<term><guilabel>Follow symbolic links</guilabel></term>
1047
<listitem><para>
1048
The Search in Files plugin typically doesn't follow
1049
<ulink url="http://en.wikipedia.org/wiki/Symbolic_link">symbolic links</ulink>.
1050
When this option is enabled, the plugin will follow them instead and search inside
1051
the files or folders they reference.
1052
</para>
1053
<warning><para>It's possible for symbolic links to reference a folder that is the
1054
parent of the folder currently being searched, or other folders that contain
1055
symbolic links to their parent. If there is such a link in the folder being
1056
searched and this option is enabled, &kappname; will repeatedly follow the link
1057
and search the folder, and the search will never complete.</para></warning>
1058
</listitem>
1059
</varlistentry>
1060
1061
</variablelist>
1062
</sect3>
1063
1064
<sect3 id="searchinfiles-ui-results">
1065
<title>Search Results</title>
1066
1067
<para>The results of your search are displayed below the query options. If
1068
options for Search in Folder mode are displayed, simply press the
1069
<guiicon>Toggle Results</guiicon> button to display them. They will also
1070
automatically be displayed as soon as a search is performed.</para>
1071
1072
<para>The search results displays three columns providing information about each
1073
result of your search query. The <guilabel>File</guilabel> column shows the name
1074
of the file. The <guilabel>Line</guilabel> column displays the line number the
1075
contents of your query were found in. The <guilabel>Text</guilabel> column displays
1076
the full text of that line.</para>
1077
1078
<para>To open the file your result was found in, simply double-click it. &kappname;
1079
will open the file if needed, and place the cursor at the beginning of the text
1080
entered as your query as found in the file.</para>
1081
1082
</sect3>
1083
</sect2>
1084
1085
<sect2 id="searchinfiles-menu">
1086
<title>Menu Structure</title>
1087
<variablelist>
1088
1089
<!--<varlistentry>
1090
<term>
1091
<menuchoice>
1092
<guimenu>Edit</guimenu>
1093
<guimenuitem>Find in Files...</guimenuitem>
1094
</menuchoice>
1095
</term>
1096
<listitem>
1097
<para>Launch the <guilabel>Find in Files</guilabel> dialog to allow you to
1098
search for text in the files of a folder.</para>
1099
</listitem>
1100
</varlistentry>-->
1101
1102
<varlistentry>
1103
<term>
1104
<menuchoice>
1105
<guimenu>View</guimenu><guisubmenu>Tool Views</guisubmenu>
1106
<guimenuitem>Show Search in Files</guimenuitem>
1107
</menuchoice>
1108
</term>
1109
<listitem>
1110
<para>Toggle the display of &kappname;'s <guilabel>Search in Files</guilabel> tool.
1111
</para>
1112
</listitem>
1113
</varlistentry>
1114
1115
</variablelist>
1116
</sect2>
1117
</sect1>
1118
880
1119
<sect1 id="kate-application-plugin-mail">
881
1120
<!--<sect1info>
882
1121
<authorgroup><author>
Loggerhead is a web-based interface for Breezy
Version: 2.0.1