| blob | b1762a20168381a2a9bab1c050b477e240ebda5f |
3 "dtd/kdex.dtd" [
8 ]>
12 <bookinfo>
14 <authorgroup>
19 &Christoph.Cullmann; &Christoph.Cullmann.mail;
20 <!-- <contrib>Core Developer and Maintainer</contrib> -->
21 </othercredit>
24 &Lauri.Watts; &Lauri.Watts.mail;
25 <!-- <contrib>Reviewer</contrib> -->
26 </othercredit>
28 <!-- TRANS:ROLES_OF_TRANSLATORS -->
30 </authorgroup>
32 <copyright>
35 </copyright>
36 <copyright>
40 </copyright>
46 <abstract>
48 </abstract>
50 <keywordset>
55 </keywordset>
57 </bookinfo>
62 <para>
64 to be a programmer's editor, and could be considered as at least a
65 partial alternative to more powerful editors. It may be best used in
66 conjunction with &konqueror; for source file browsing for different
67 languages. &kwrite; also works very well as a simple text editor. One
68 of &kwrite;'s main features is the colorized syntax, customized for many
69 different programming languages such as: C/C++, &Java;, Python, Perl,
71 </para>
73 </chapter>
78 <para>
79 &kwrite; is very simple to use. Anyone that has used a text editor
80 should have no problems.
81 </para>
86 <para>
89 site opened in one of &konqueror;'s windows.
90 </para>
91 </sect1>
96 <para>
98 a desktop icon, it can also be opened at the command line prompt of a
99 terminal window. There are a few useful options that are available when
100 doing this.
101 </para>
106 <para>By specifying the path and name of a particular file the user can
107 have &kwrite; open (or create) that file immediately upon startup. This
108 option might look something like the following:</para>
110 <informalexample><screen>
113 </userinput>
114 </screen>
115 </informalexample>
116 </sect2>
120 <para>The above-mentioned method could even be used to open files on the
121 internet (if the user has an active connection at the time.) An example of
122 this might look like the following:</para>
124 <informalexample><screen>
127 </option></userinput>
128 </screen>
129 </informalexample>
131 </sect2>
138 <variablelist>
139 <varlistentry>
142 <listitem><para>This lists the most basic options available at the command
143 line.</para></listitem>
144 </varlistentry>
145 <varlistentry>
148 <listitem><para>This lists the options available for changing the way
150 </varlistentry>
151 <varlistentry>
154 <listitem><para>This lists the options available for changing the way
156 </varlistentry>
157 <varlistentry>
161 </varlistentry>
162 <varlistentry>
166 window</para></listitem>
167 </varlistentry>
168 <varlistentry>
174 </varlistentry>
175 <varlistentry>
181 </varlistentry>
182 <varlistentry>
187 </para></listitem>
188 </varlistentry>
189 <varlistentry>
193 <listitem><para>Navigate to the specified line after opening the document.
194 </para></listitem>
195 </varlistentry>
196 <varlistentry>
200 <listitem><para>Navigate to the specified column after opening the document.
201 </para></listitem>
202 </varlistentry>
204 </variablelist>
205 </sect2>
206 </sect1>
213 following shortcuts:</para>
214 <informaltable>
216 <tbody>
218 <row><entry><para><keycombo
220 <entry><para> Toggle between Insert and Overwrite mode. When in insert mode the
221 editor will add any typed characters to the text while pushing along any data to
222 the right of the text cursor. Overwrite mode causes the entry of each character
223 to eliminate the character immediately to the right of the text
224 cursor.</para></entry>
225 </row>
226 <row>
228 Arrow</keycap></keycombo></para></entry>
230 </row>
231 <row>
233 Arrow</keycap></keycombo></para></entry>
235 </row>
236 <row>
238 Arrow</keycap></keycombo></para></entry>
240 </row>
241 <row>
243 Arrow</keycap></keycombo></para></entry>
245 </row>
246 <row>
248 Up</keycap></keycombo></para></entry>
250 </row>
251 <row>
253 Up</keycap></keycombo></para></entry>
255 </row>
256 <row>
258 Down</keycap></keycombo></para></entry>
260 </row>
261 <row>
263 Down</keycap></keycombo></para></entry>
265 </row>
266 <row>
267 <entry><para><keycombo
270 </row>
271 <row>
272 <entry><para><keycombo
275 </row>
276 <row>
277 <entry><para><keycombo
280 </row>
281 <row>
282 <entry><para><keycombo
284 <entry><para>Delete the character to the right of the cursor (or any selected
285 text)</para></entry>
286 </row>
287 <row>
289 Arrow</keycap></keycombo></para></entry>
291 </row>
292 <row>
294 Arrow</keycap></keycombo></para></entry>
296 </row>
297 <row>
298 <entry><para><keycombo
301 </row>
302 <row>
303 <entry><para><keycombo
306 </row>
307 <row>
308 <entry><para><keycombo
311 </row>
312 <row>
313 <entry><para><keycombo
316 </row>
317 <row>
318 <entry><para><keycombo
321 </row>
322 <row>
323 <entry><para><keycombo
326 </row>
327 <row>
328 <entry><para><keycombo
331 </row>
332 <row>
333 <entry><para><keycombo
336 </row>
337 <row>
338 <entry><para><keycombo
341 </row>
342 <row>
343 <entry><para><keycombo
346 </row>
347 <row>
348 <entry><para><keycombo
351 </row>
352 <row>
353 <entry><para><keycombo
356 </row>
357 <row>
358 <entry><para><keycombo
361 </row>
362 <row>
363 <entry><para><keycombo
366 </row>
367 <row>
368 <entry><para><keycombo
371 </row>
372 <row>
373 <entry><para><keycombo
376 </row>
377 <row>
378 <entry><para><keycombo
381 </row>
382 <row>
383 <entry><para><keycombo
386 </row>
387 <row>
388 <entry><para><keycombo
391 </row>
392 <row>
393 <entry><para><keycombo
396 </row>
397 <row>
398 <entry><para><keycombo
401 </row>
402 <row>
403 <entry><para><keycombo
407 </row>
408 <row>
409 <entry><para><keycombo
412 </row>
413 <row>
414 <entry><para><keycombo
417 </row>
418 <row>
419 <entry><para><keycombo
422 </row>
423 <row>
424 <entry><para><keycombo
427 </row>
428 <row>
429 <entry><para><keycombo
432 </row>
433 <row>
434 <entry><para><keycombo
436 <entry><para>Delete the marked text and copy it to the clipboard.
437 </para></entry>
438 </row>
439 <row>
440 <entry><para><keycombo
443 </row>
444 <row>
445 <entry><para><keycombo
448 </row>
449 <row>
450 <entry><para><keycombo
453 </row>
454 <row>
455 <entry><para><keycombo
458 </row>
459 <row>
460 <entry><para><keycombo
463 </row>
464 <row>
465 <entry><para><keycombo
468 </row>
469 <row>
470 <entry><para><keycombo
473 </row>
474 <row>
475 <entry><para><keycombo
478 </row>
479 <row>
480 <entry><para><keycombo
483 </row>
484 <row>
485 <entry><para><keycombo
488 </row>
489 <row>
490 <entry><para><keycombo
493 </row>
494 <row>
495 <entry><para><keycombo
498 </row>
499 </tbody>
500 </tgroup>
501 </informaltable>
502 </sect1>
503 </chapter>
511 <variablelist>
513 <varlistentry>
515 <menuchoice>
516 <shortcut>
518 </shortcut>
521 <listitem>
522 <para>
523 This starts a new Document in the editor. If there is a current
524 document with unsaved changes the user is given a chance to save it.
525 </para>
526 </listitem>
527 </varlistentry>
529 <varlistentry>
531 <menuchoice>
532 <shortcut>
534 </shortcut>
537 </menuchoice>
538 </term>
540 <listitem>
541 <!--
542 This is description of a standard dialog and so should go in the UG,
543 with a pointer to it. In fact, I'll probably nick this very stuff for
544 the UG
545 - Phil
546 <para>
547 This command opens a file. It does this by means of a dialog box which
548 allows the user to navigate the file system. The dialog operates like a
549 small file manager. Clicking on folders displayed in the central
550 window directs the dialog to enter that folder - displaying its
551 contents. There is an entry/dropdown box which can be used to type in
552 directly the location and name of the file or by clicking the arrow at
553 the side choose from a drop down box of recently used locations. Below
554 this is a filter which similarly may have data entered directly or
555 chosen from a drop down box of recent filter types. The filter facility
556 lets only files that meet its specifications be displayed in the central
557 window. If the filter contained text such as <literal
558 role="extension">*.txt</literal> then only files with the <literal
559 role="extension">txt</literal> extension would be visible in the
560 selection window. Below the filter is a status bar giving information
561 about the number of files and subfolders within the current
562 folder.
563 </para>
565 <para>
566 The toolbar, which is located at the top of the dialog, has left and
567 right arrow buttons that let the user move back and forth through
568 previously selected folders as well as an up arrow button for moving
569 up the folder tree. The button with the little house takes the user
570 to his or her home folder and the one with the two arrows curved in
571 on each other updates the view of the current folder. The flag button
572 lets the user set a new bookmark at the current folder or go to one
573 that was previously set.
574 </para>
576 <para>
577 The last button on the toolbar allows you to create a new folder, and
578 even change some basic settings for the dialog box, and finally there is
579 dropdown box with a list of some commonly frequented folders.
580 </para>
581 -->
583 dialog. Use the file view to select the file you want to open, and
588 </listitem>
589 </varlistentry>
591 <varlistentry>
593 <menuchoice>
596 </menuchoice>
597 </term>
598 <listitem>
599 <para>
600 This is a shortcut to open recently saved documents. Clicking on this
601 item opens a list to the side of the menu with several of the most
602 recently saved files. Clicking on a specific file will open it in
603 &kwrite; - if the file still resides at the same
604 location.
605 </para>
606 </listitem>
607 </varlistentry>
609 <varlistentry>
611 <menuchoice>
612 <shortcut>
614 </shortcut>
617 </menuchoice>
618 </term>
619 <listitem>
620 <para>
621 This saves the current document. If there has already been a save of
622 the document then this will overwrite the previously saved file without
623 asking for the user's consent. If it is the first save of a new
624 document the save as dialog (described below) will be invoked.
625 </para>
626 </listitem>
627 </varlistentry>
629 <varlistentry>
631 <menuchoice>
634 </menuchoice>
635 </term>
636 <listitem>
637 <para>
638 This allows a document to be saved with a new file name. This is done by
639 means of the file dialog box described above in the <link
641 </para>
642 </listitem>
643 </varlistentry>
645 <varlistentry>
647 <menuchoice>
648 <shortcut>
650 </shortcut>
653 </menuchoice>
654 </term>
655 <listitem>
656 <para>
657 Reloads the active file from disk. This command is useful if another program or
658 process has changed the file while you have it open in &kwrite;.
659 </para>
660 </listitem>
661 </varlistentry>
663 <varlistentry>
665 <menuchoice>
666 <shortcut>
668 </shortcut>
671 </menuchoice>
672 </term>
673 <listitem>
674 <para>
675 Opens a simple print dialog allowing the user to specify what, where,
676 and how to print.
677 </para>
678 </listitem>
679 </varlistentry>
681 <varlistentry>
683 <menuchoice>
686 </menuchoice>
687 </term>
688 <listitem>
689 <para>
690 Export your file in HTML format so your document can be viewed as a web page.
691 </para>
692 </listitem>
693 </varlistentry>
695 <varlistentry>
697 <menuchoice>
698 <shortcut>
700 </shortcut>
703 </menuchoice>
704 </term>
705 <listitem>
706 <para>
707 Close the active file with this command. If you have made unsaved changes, you
708 will be prompted to save the file before &kwrite; closes it.
709 </para>
710 </listitem>
711 </varlistentry>
713 <varlistentry>
715 <menuchoice>
716 <shortcut>
718 </shortcut>
721 </menuchoice>
722 </term>
723 <listitem>
724 <para>
725 This will close the editor window, if you have more than one instance of
728 not be closed.
729 </para>
730 </listitem>
731 </varlistentry>
733 </variablelist>
735 </sect1>
740 <variablelist>
741 <varlistentry>
743 <shortcut><keycombo
747 <listitem>
748 <para>This is used to eliminate or reverse the most recent user action
749 or operation.
750 <!--
751 Just what constitutes such an action may be better
752 understood by referring to the <link linkend="group-undos">Group
753 Undos</link> portion of this help file.
754 -->
755 </para>
756 </listitem>
757 </varlistentry>
759 <varlistentry>
761 <shortcut><keycombo
764 <listitem>
766 </listitem>
767 </varlistentry>
769 <varlistentry>
771 <shortcut><keycombo
774 <listitem>
775 <para>This command deletes the current selection and places it on the
776 clipboard.
777 The clipboard is a feature of &kde; that works invisibly to provide a way to
778 transfer data between applications.</para>
779 </listitem>
780 </varlistentry>
782 <varlistentry>
784 <shortcut><keycombo
787 <listitem>
788 <para>This copies the currently selected text to the clipboard so that it may
789 be pasted elsewhere. The clipboard is a feature of &kde; that works invisibly
790 to provide a way to transfer data between applications.</para>
791 </listitem>
792 </varlistentry>
794 <varlistentry>
797 HTML</guimenuitem></menuchoice></term>
798 <listitem>
800 </listitem>
801 </varlistentry>
803 <varlistentry>
805 <shortcut><keycombo
808 <listitem>
809 <para>This will insert the contents of the clipboard at the cursor position.
810 The clipboard is feature of &kde; that works invisibly to provide a way to
811 transfer data between applications.</para>
812 </listitem>
813 </varlistentry>
815 <varlistentry>
817 <shortcut><keycombo
820 <listitem>
821 <para>This will select the entire document. This could be very useful for
822 copying the entire file to another application.</para>
823 </listitem>
824 </varlistentry>
826 <varlistentry>
828 <shortcut>
830 </shortcut>
832 <listitem>
834 </listitem>
835 </varlistentry>
837 <varlistentry>
839 <shortcut>
841 </shortcut>
843 Selection Mode</guimenuitem></menuchoice></term>
844 <listitem>
845 <para>Toggles Selection Mode. When the Selection Mode is “BLOCK”, you can make
847 The status bar shows the current state of the Selection Mode, either “NORM” or
848 “BLK”.</para>
849 </listitem>
850 </varlistentry>
852 <varlistentry>
854 <shortcut>
856 </shortcut>
858 Mode</guimenuitem></menuchoice></term>
859 <listitem>
861 insert characters where the cursor is. When the mode is "OVR", writing
862 characters will replace the current characters if your cursor is positioned
863 before any character. The status bar shows the current state of the Overwrite
864 Mode, either “INS” or “OVR”.</para>
865 </listitem>
866 </varlistentry>
868 <varlistentry>
870 <shortcut><keycombo
873 <listitem>
875 Find</guilabel> in the document. There is small text box for entering the search
876 pattern which also doubles as a dropdown box. Clicking on the dropdown arrow at
877 the side of the box makes available other recent search patterns. Other
878 parameters are included to make the search more efficient. Selecting
880 case (upper or lower) of each of the characters in the search pattern.
884 prevents the search from stopping on words that contain the searched for
886 from the current position of the cursor within the document rather than from
887 the beginning.</para>
888 </listitem>
889 </varlistentry>
891 <varlistentry>
895 <listitem>
896 <para>This repeats the last find operation, if any, without calling the find
897 dialog box.
898 </para>
899 </listitem>
900 </varlistentry>
902 <varlistentry>
904 <menuchoice>
905 <shortcut>
907 </shortcut>
910 </menuchoice>
911 </term>
912 <listitem>
913 <para>
914 This repeats the last find operation, if any, without calling the find
915 dialog box, and searching backwards instead of forwards through the
916 document.
917 </para>
918 </listitem>
919 </varlistentry>
921 <varlistentry>
923 <shortcut><keycombo
926 <listitem>
927 <para>This command opens the replace dialog box. The replace dialog is
928 almost identical to the above-mentioned find dialog. In addition to the features
930 entry/dropdown box. Using this dialog the user can specify both the text to be
931 found and text with which to replace it. The additional <guilabel>Prompt
933 confirmation before each replacement.
934 </para>
935 </listitem>
936 </varlistentry>
938 <varlistentry>
940 <menuchoice>
941 <shortcut>
943 </shortcut>
946 <listitem>
947 <para>
948 This opens the goto line dialog box which is used to have the cursor
949 jump to a particular line (specified by number) in the document. The
950 line number may be entered directly into the text box or graphically by
951 clicking on the up or down arrow spin controls at the side of the text
952 box. The little up arrow will increase the line number and the down
953 arrow decrease it. There is also a slide control to the right of the
954 text box which allows the user to move the goto point in the document in
955 an analog manner.
956 </para>
957 </listitem>
958 </varlistentry>
959 </variablelist>
961 </sect1>
966 specific to the active editor, and to manage frames.</para>
968 <variablelist>
970 <varlistentry>
971 <term>
973 <menuchoice>
976 </menuchoice>
977 </term>
978 <listitem>
980 </listitem>
981 </varlistentry>
983 <varlistentry>
984 <term>
986 <menuchoice>
987 <shortcut><keycombo
991 </menuchoice>
992 </term>
993 <listitem>
994 <para>Displays the Katepart command line at the bottom of the window.
996 commands.</para>
997 </listitem>
998 </varlistentry>
1000 <varlistentry>
1001 <term>
1003 <menuchoice>
1006 </menuchoice>
1007 </term>
1008 <listitem>
1010 </listitem>
1011 </varlistentry>
1013 <varlistentry>
1014 <term>
1016 <menuchoice>
1020 </menuchoice>
1021 </term>
1022 <listitem>
1023 <para>The text lines will be wrapped at the view
1024 border on the screen.</para>
1025 </listitem>
1026 </varlistentry>
1028 <varlistentry>
1029 <term>
1031 <menuchoice>
1035 </menuchoice>
1036 </term>
1037 <listitem>
1038 <para>Choose when and how the dynamic word wrap indicators should be
1039 displayed. This is only available if the <guilabel>Dynamic Word
1041 </listitem>
1042 </varlistentry>
1044 <varlistentry>
1045 <term>
1047 <menuchoice>
1050 </menuchoice>
1051 </term>
1052 <listitem>
1053 <para>If this option is checked, a vertical line will be drawn at the
1054 word wrap column as defined in the <menuchoice>
1057 Editing tab. Please note that the word wrap marker is only drawn if you
1058 use a fixed pitch font.</para>
1059 </listitem>
1060 </varlistentry>
1062 <varlistentry>
1063 <term>
1065 <menuchoice>
1069 </menuchoice>
1070 </term>
1071 <listitem>
1072 <para>This is a toggle item. Setting it on checked will make the
1073 side of the active editor, and vice versa.</para>
1074 </listitem>
1075 </varlistentry>
1077 <varlistentry>
1078 <term>
1080 <menuchoice>
1084 </menuchoice>
1085 </term>
1086 <listitem>
1087 <para>This is a toggle Item. Setting it on checked will make a pane displaying
1088 the line numbers of the document visible in the left border of the active
1089 editor, and vice versa.</para>
1090 </listitem>
1091 </varlistentry>
1093 <varlistentry>
1094 <term>
1096 <menuchoice>
1099 </menuchoice>
1100 </term>
1101 <listitem>
1102 <para>If this option is checked, the view will show marks on the vertical
1103 scrollbar.</para>
1104 </listitem>
1105 </varlistentry>
1107 <varlistentry>
1108 <term>
1110 <menuchoice>
1113 </menuchoice>
1114 </term>
1115 <listitem>
1116 <para>If this option is checked, the marks for code folding will be
1117 hidden.</para>
1118 </listitem>
1119 </varlistentry>
1121 <varlistentry>
1122 <term>
1124 <menuchoice>
1126 </menuchoice>
1127 </term>
1128 <listitem>
1129 <variablelist>
1130 <varlistentry>
1134 </term>
1136 </varlistentry>
1137 <varlistentry>
1141 </term>
1143 </varlistentry>
1144 <varlistentry>
1148 </term>
1150 </varlistentry>
1151 <varlistentry>
1155 </term>
1157 </varlistentry>
1158 </variablelist>
1159 </listitem>
1160 </varlistentry>
1162 </variablelist>
1164 </sect1>
1168 <variablelist>
1170 <varlistentry>
1172 <menuchoice>
1173 <shortcut>
1175 </shortcut>
1178 </menuchoice>
1179 </term>
1180 <listitem>
1181 <para>
1182 Sets or removes a bookmark in the current line of the active document. (If it's
1183 there, it is removed, otherwise one is set).
1184 </para>
1185 </listitem>
1186 </varlistentry>
1188 <varlistentry>
1190 <menuchoice>
1193 </menuchoice>
1194 </term>
1195 <listitem>
1196 <para>
1197 This command will remove all the markers from the document as well as
1198 the list of markers which is appended at the bottom of this menu item.
1199 </para>
1200 </listitem>
1201 </varlistentry>
1207 </term>
1208 <listitem><para>This will move the cursor to beginning of the first above line
1209 with a bookmark. The menuitem text will include the line number and the first
1210 piece of text on the line. This item is only available when there is a bookmark
1211 in a line above the cursor.</para></listitem>
1212 </varlistentry>
1218 <listitem><para>This will move the cursor to beginning of the next line with a
1219 bookmark. The menuitem text will include the line number and the first piece of
1220 text on the line. This item is only available when there is a bookmark in a line
1221 below the cursor.</para></listitem>
1222 </varlistentry>
1224 </variablelist>
1226 <para>
1227 At the bottom of this menu, a list of markers appears if any markers are
1228 available for this window.
1229 </para>
1231 </sect1>
1236 <variablelist>
1237 <varlistentry>
1241 <listitem>
1242 <para>Set the current document to Read Only mode. This prevents any text
1243 addition and any changes in the document formatting.</para>
1244 </listitem>
1245 </varlistentry>
1247 <varlistentry>
1251 <listitem>
1252 <para>Choose the filetype scheme you prefer for the active document. This
1253 overwrites the global filetype mode set in <menuchoice>
1255 <guimenuitem>Configure
1256 Editor...</guimenuitem></menuchoice> in the Filetypes tab for your current
1257 document only.</para>
1258 </listitem>
1259 </varlistentry>
1261 <varlistentry>
1265 <listitem>
1266 <para>Choose the Highlighting scheme you prefer for the active document. This
1267 overwrites the global highlighting mode set in <menuchoice>
1269 <guimenuitem>Configure
1271 </listitem>
1272 </varlistentry>
1274 <varlistentry>
1278 <listitem>
1279 <para>Choose the style of indentation you want for your active document.
1280 This overwrites the global indentation mode set in <menuchoice>
1282 <guimenuitem>Configure
1284 </listitem>
1285 </varlistentry>
1287 <varlistentry>
1291 <listitem>
1294 <guimenuitem>Configure
1296 to set a different encoding for your current document. The encoding you
1297 set here will be only valid for your current document.</para>
1298 </listitem>
1299 </varlistentry>
1301 <varlistentry>
1305 <listitem>
1306 <para>Choose your prefered end of line mode for your active
1307 document. This overwrites the global end of line mode set in <menuchoice>
1309 <guimenuitem>Configure
1311 </listitem>
1312 </varlistentry>
1314 <varlistentry>
1317 </term>
1319 <listitem><para><action>This initiates the spellchecking program - a program
1320 designed to help the user catch and correct any spelling errors.</action>
1321 Clicking on this entry will start the checker and bring up the speller dialog
1322 box through which the user can control the process. There are four settings
1323 lined up vertically in the center of the dialog with their corresponding labels
1324 just to the left. Starting at the top they are:</para>
1326 <variablelist>
1327 <varlistentry>
1329 <listitem><para>Here, the spellchecker indicates the word currently under
1330 consideration. This happens when the checker encounters a word not in its
1331 dictionary - a file containing a list of correctly spelled words against which
1332 it compares each word in the editor.</para></listitem>
1333 </varlistentry>
1334 <varlistentry>
1336 <listitem><para> If the checker has any similar words in its dictionary the
1337 first one will be listed here. The user can accept the suggestion, type in his
1338 or her own correction, or choose a different suggestion from the next
1339 box.</para></listitem>
1340 </varlistentry>
1341 <varlistentry>
1343 <listitem><para> The checker may list here a number of possible replacements for
1344 the word under consideration. Clicking on any one of the suggestions will cause
1346 above.</para></listitem>
1347 </varlistentry>
1348 <varlistentry>
1350 <listitem><para> If you have installed multiple dictionaries, here you can
1351 select which dictionary/language should be used.</para></listitem>
1352 </varlistentry>
1353 </variablelist>
1356 control the spellcheck process. They are:</para>
1358 <variablelist>
1359 <varlistentry>
1362 Word:</guilabel> box to the checker's dictionary. This means that in the future
1363 the checker will always consider this word to be correctly
1364 spelled.</para></listitem>
1365 </varlistentry>
1366 <varlistentry>
1368 <listitem><para> This button has the checker replace the word under
1369 consideration in the document with the word in the
1371 </varlistentry>
1372 <varlistentry>
1374 <listitem><para> This button causes the checker to replace not only the current
1376 substitution for any other occurrences of this <guilabel>Misspelled
1378 </varlistentry>
1379 <varlistentry>
1381 <listitem><para>Activating this button will have the checker move on without
1382 making any changes.</para></listitem>
1383 </varlistentry>
1384 <varlistentry>
1386 <listitem><para> This button tells the checker to do nothing with the current
1388 the same word.</para> <note><para>This only applies to the current spellcheck
1389 run. If the checker is run again later it will stop on this same
1390 word.</para></note></listitem>
1391 </varlistentry>
1392 </variablelist>
1394 <!--<para>Located horizontally along the bottom of the spellcheck dialog is a
1395 progress bar. As the checking process proceeds the bar will fill from left to
1396 right providing a graphical representation of how far along in the document the
1397 process has reached. In addition, the progress is displayed numerically in
1398 the center of the progress bar.</para>//-->
1400 <!--<note><para>A numerical display of the spellcheck
1401 process is simultaneously displayed in the status bar of the editor. The <link
1402 linkend="show-statusbar">status bar</link> is the horizontal strip at the bottom
1403 of the editor just outside of the text entry area.</para></note>//-->
1405 <para>Three more buttons are located horizontally along the bottom of the
1406 spellcheck dialog. They are:</para>
1408 <variablelist>
1409 <varlistentry>
1412 pages (this document).</para></listitem>
1413 </varlistentry>
1415 <varlistentry>
1417 <listitem><para> This button ends the spellcheck process, and returns to the
1418 document.</para></listitem>
1419 </varlistentry>
1421 <varlistentry>
1423 <listitem><para> This button cancels the spellcheck process, all modifications
1424 are reverted, and you will return to your document.</para></listitem>
1425 </varlistentry>
1426 </variablelist>
1427 </listitem>
1428 </varlistentry>
1429 </variablelist>
1431 <variablelist>
1432 <varlistentry>
1436 <listitem>
1437 <para>This initiates the spellchecking program but it starts where your cursor
1438 is instead of at the beginning of the document.</para>
1439 </listitem>
1440 </varlistentry>
1442 <varlistentry>
1446 <listitem>
1448 </listitem>
1449 </varlistentry>
1451 <varlistentry>
1453 <shortcut>
1455 </shortcut>
1457 <listitem>
1458 <para>This increases the paragraph's indentation by one step. The size of the
1461 </listitem>
1462 </varlistentry>
1464 <varlistentry>
1466 <shortcut>
1468 </shortcut>
1471 <listitem>
1472 <para>This reduces the paragraph's indentation by one step. The size of the step
1476 </listitem>
1477 </varlistentry>
1479 <varlistentry>
1482 Indentation</guimenuitem></menuchoice></term> <listitem>
1483 <para>This cleans the indentation for the current selection or for the
1484 line the cursor is currently in. Cleaning the indentation ensures that
1485 all your selected text follows the indentation mode you choose.</para>
1486 </listitem>
1487 </varlistentry>
1489 <varlistentry>
1493 </menuchoice></term>
1494 <listitem>
1495 <para>Causes a realign of the current line or selected lines using the
1496 indentation mode and indentation settings in the doucment.</para>
1497 </listitem>
1498 </varlistentry>
1500 <varlistentry>
1501 <term><menuchoice>
1502 <shortcut>
1504 </shortcut>
1507 </menuchoice></term>
1508 <listitem><para>This adds one space to the beginning of the line
1509 where the text cursor is located or to the beginning of any
1510 selected lines.</para>
1511 </listitem>
1512 </varlistentry>
1514 <varlistentry>
1515 <term><menuchoice>
1516 <shortcut>
1518 </shortcut>
1521 </menuchoice></term>
1522 <listitem><para>This removes one space (if any exist) from the beginning of the
1523 line where the text cursor is located or from the beginning of any
1524 selected lines.</para></listitem>
1525 </varlistentry>
1527 <varlistentry>
1528 <term><menuchoice>
1529 <shortcut>
1531 </shortcut>
1534 </menuchoice></term>
1535 <listitem><para>Put the selected text or the letter after the cursor in
1536 uppercase.</para></listitem>
1537 </varlistentry>
1539 <varlistentry>
1540 <term><menuchoice>
1541 <shortcut>
1543 </shortcut>
1546 </menuchoice></term>
1547 <listitem><para>Put the selected text or the letter after the cursor in
1548 lowercase.</para></listitem>
1549 </varlistentry>
1551 <varlistentry>
1552 <term><menuchoice>
1553 <shortcut>
1555 </shortcut>
1558 </menuchoice></term>
1559 <listitem><para>Capitalize the selected text or the current
1560 word.</para></listitem>
1561 </varlistentry>
1563 <varlistentry>
1564 <term><menuchoice>
1565 <shortcut>
1567 </shortcut>
1570 </menuchoice></term>
1571 <listitem><para>Joins the selected lines, or the current line and the line below
1572 with one white space character as a separator. Leading/trailing white space on
1573 joined lines is removed in the affected ends.</para></listitem>
1574 </varlistentry>
1576 <varlistentry>
1577 <term><menuchoice>
1580 </menuchoice></term>
1581 <listitem><para>Apply static word wrapping on all the document. That means that
1582 a new line of text will automatically start when the current
1583 line exceeds the length specified by the Wrap words at: option
1584 in the Editing tab in <menuchoice>
1586 Editor...</guimenuitem></menuchoice></para></listitem>
1587 </varlistentry>
1589 </variablelist>
1592 </sect1>
1597 <variablelist>
1598 <varlistentry>
1602 </menuchoice>
1603 </term>
1604 <listitem>
1605 <para>
1606 When checked, this displays a movable toolbar containing buttons used to
1607 initiate frequently used commands. When unchecked the toolbar is hidden.
1608 </para>
1609 </listitem>
1610 </varlistentry>
1612 <varlistentry>
1615 Statusbar</guimenuitem></menuchoice></term>
1616 <listitem>
1617 <para>When checked, this displays a small bar at the bottom of the editor
1618 containing information about the status of the current document. When unchecked
1619 the statusbar is hidden.</para>
1620 </listitem>
1621 </varlistentry>
1623 <varlistentry>
1626 Path</guimenuitem></menuchoice></term>
1627 <listitem>
1628 <para>When selected, this displays in the titlebar the path (its location in the
1629 file system) of the current document. When unchecked the path is hidden.</para>
1630 </listitem>
1631 </varlistentry>
1633 <varlistentry>
1637 </menuchoice>
1638 </term>
1639 <listitem>
1640 <para>
1641 This menu item opens a dialog whereby several different <link
1643 </para>
1644 </listitem>
1645 </varlistentry>
1647 <varlistentry>
1651 </menuchoice>
1652 </term>
1653 <listitem>
1654 <para>
1655 Choose the default text editing component that you wish to use in &kwrite;. You
1659 only available if you have KDevelop installed on your system). If you choose
1661 &kcontrolcenter;. All other choices will override that setting.
1662 </para>
1663 </listitem>
1664 </varlistentry>
1666 <varlistentry>
1669 Shortcuts...</guimenuitem></menuchoice></term>
1670 <listitem>
1673 top of the dialog box shows the list of commands (actions) that can have
1674 keyboard shortcuts. Below the display are three radio buttons. The user may
1675 choose between No Key, Default Key, and Custom Key. (Note that a set of radio
1676 buttons only allows the selection of one of the offered items - in the way that
1677 buttons on a car radio only offer the selection of one preset station. Also,
1678 the Default Key selection is only available for those commands that actually
1679 have a 'default' shortcut.) Selecting the Custom Key option activates the three
1680 check boxes and key button at the bottom of the dialog. The user may then select
1681 a key combination for the command in question by means of the check boxes and
1682 key button. For example, with the About &kde; command selected in the display
1688 </listitem>
1689 </varlistentry>
1691 <varlistentry>
1694 Toolbars...</guimenuitem></menuchoice></term>
1695 <listitem><para>This will open the dialog whereby the toolbar configuration may
1696 be changed. The user can choose which shortcut buttons should appear on the
1697 toolbar. A display window on the left lists the commands available to placed
1698 on the toolbar. A display on the right lists those commands already on the
1699 toolbar. A set of four arrow buttons between the two displays manipulates the
1700 selections. The right pointing arrow places any command selected in the left
1702 The left arrow does just the opposite, removing any action selected in the right
1704 window from the toolbar. The up and down pointing arrows change the position of
1706 an action selected in the right window which changes the position of its button
1708 in the toolbar.</para> </listitem>
1709 </varlistentry>
1713 <!--
1714 <varlistentry>
1715 <term>
1716 <menuchoice><guimenu>>Settings</guimenu><guimenuitem>Configure
1717 Highlighting</guimenuitem></menuchoice></term>
1718 <listitem><para>Opens a dialog box allowing configuration of the syntax
1719 highlighting. The dialog is described in <xref
1720 linkend="pref-highlighting"/>.</para></listitem>
1721 </varlistentry> -->
1723 <!--<varlistentry>
1724 <term>
1725 <menuchoice>
1726 <shortcut>
1727 <keycombo action="simul"><keycap>F6</keycap></keycombo>
1728 </shortcut>
1729 <guimenu>Settings</guimenu>
1730 <guimenuitem>Show Icon Border</guimenuitem>
1731 </menuchoice>
1732 </term>
1733 <listitem>
1734 <para>
1735 Toggle the display of a border on the left of the editing window, where
1736 bookmarks are displayed next to the line they apply to.
1737 </para>
1738 </listitem>
1739 </varlistentry>//-->
1741 <!--<varlistentry>
1742 <term id="vertical-selection">
1743 <menuchoice>
1744 <shortcut>
1745 <keycombo action="simul"><keycap>F4</keycap></keycombo>
1746 </shortcut>
1747 <guimenu>Settings</guimenu>
1748 <guimenuitem>Vertical Selection</guimenuitem>
1749 </menuchoice>
1750 </term>
1751 <listitem>
1752 <para>
1753 This is used to turn on or off the vertical selection feature. Vertical
1754 selection allows text to be selected by column as well as by row. In other
1755 words with this feature the user is able to select text contained in only
1756 particular contiguous columns and rows. In affect the user can select a
1757 rectangular area of text anywhere in the document.
1758 </para>
1759 </listitem>
1760 </varlistentry> //-->
1762 <!--<varlistentry>
1763 <term id="set-highlight">
1764 <menuchoice>
1765 <guimenu>Settings</guimenu>
1766 <guisubmenu>Highlight Mode</guisubmenu>
1767 </menuchoice>
1768 </term>
1769 <listitem>
1770 <para>
1771 This allows the user to choose the style of color highlighting which the
1772 editor uses to display the text. The styles are selected by programming
1773 language. The font/color information is not stored with the document.
1774 </para>
1775 </listitem>
1776 </varlistentry> //-->
1778 <!--<varlistentry>
1779 <term><anchor id="end-of-line"/>
1780 <menuchoice>
1781 <guimenu>Settings</guimenu><guisubmenu>End of
1782 Line</guisubmenu></menuchoice></term>
1783 <listitem>
1784 <para>This opens a sub-menu from which the user can select the type of
1785 <quote>end of
1786 line</quote> code for &kwrite; to use, <abbrev>i.e.</abbrev>, the accepted
1787 standard
1788 used by &UNIX;, &Mac; or MSDOS/&Windows; systems.</para>
1789 </listitem>
1790 </varlistentry> //-->
1792 </variablelist>
1793 </sect1>
1798 &help.menu.documentation;
1800 </sect1>
1801 </chapter>
1806 <para>
1808 Editor...</guimenuitem></menuchoice> from the menu brings up the
1810 used to alter a number of different settings. The settings available
1811 for change vary according to which category the user chooses from a
1812 vertical list on the left side of the dialog. By means of three buttons
1813 along the bottom of the box the user can control the process.
1814 </para>
1816 <para>
1818 current settings and close the dialog by means of the
1824 detailed below.
1825 </para>
1830 <variablelist>
1831 <varlistentry>
1833 <listitem>
1834 <variablelist>
1837 <listitem><para>If this option is checked, the text lines
1838 will be wrapped at the view border on the screen.</para></listitem>
1839 </varlistentry>
1840 <varlistentry>
1842 <listitem><para>Choose when the Dynamic word wrap indicators
1843 should be displayed.
1844 </para></listitem></varlistentry>
1845 <varlistentry>
1846 <term><guilabel>Vertically align dynamically wrapped lines
1847 to indentation depth:
1848 </guilabel></term>
1849 <listitem><para>Enables the start of dynamically wrapped
1850 lines to be aligned vertically to the indentation level of the first
1851 line. This can help to make code and markup more
1852 readable.</para><para>Additionally, this allows you to
1853 set a maximum width of the screen, as a percentage,
1854 after which dynamically wrapped lines will no longer be vertically aligned.
1856 width of the screen will not have vertical alignment applied to subsequent
1857 wrapped lines.</para></listitem>
1858 </varlistentry>
1859 </variablelist>
1860 </listitem>
1861 </varlistentry>
1863 <varlistentry>
1865 <listitem>
1866 <variablelist>
1867 <varlistentry>
1868 <term><guilabel>Show folding markers (if available)
1869 </guilabel></term>
1870 <listitem><para>If this option is checked, the current view will display marks
1871 for code folding, if code folding is available.</para></listitem>
1872 </varlistentry>
1873 </variablelist>
1874 </listitem>
1875 </varlistentry>
1877 <varlistentry>
1879 <listitem>
1880 <variablelist>
1881 <varlistentry>
1882 <term><guilabel>Show icon border
1883 </guilabel></term>
1884 <listitem><para>If this is checked, you will see an icon border on the left
1885 hand side. The icon border shows bookmark signs for instance.</para></listitem>
1886 </varlistentry>
1887 <varlistentry>
1888 <term><guilabel>Show line numbers
1889 </guilabel></term>
1890 <listitem><para>If this is checked, you will see line numbers on the left
1891 hand side.</para></listitem>
1892 </varlistentry>
1893 <varlistentry>
1894 <term><guilabel>Show scrollbar marks
1895 </guilabel></term>
1896 <listitem><para>If this option is checked the current view
1897 will show marks on the vertical scrollbar. These marks will
1898 for instance show bookmarks.</para></listitem>
1899 </varlistentry>
1900 </variablelist>
1901 </listitem>
1902 </varlistentry>
1904 <varlistentry>
1905 <term><guilabel>Sort Bookmarks Menu
1906 </guilabel></term>
1907 <listitem><para>
1908 <variablelist>
1909 <varlistentry>
1910 <term><guilabel>By position
1911 </guilabel></term>
1912 <listitem><para>The bookmarks will be ordered by the line
1913 numbers they are placed at.</para></listitem>
1914 </varlistentry>
1915 <varlistentry>
1916 <term><guilabel>By creation
1917 </guilabel></term>
1918 <listitem><para>Each new bookmark will be added to the bottom,
1919 independently from where it is placed in the document.</para></listitem>
1920 </varlistentry>
1921 </variablelist>
1922 </para></listitem>
1923 </varlistentry>
1925 <varlistentry>
1926 <term><guilabel>Show identation lines
1927 </guilabel></term>
1928 <listitem><para>If this is checked, the editor wil display
1929 vertical lines to help identifying indent lines.</para></listitem>
1930 </varlistentry>
1931 </variablelist>
1932 </sect1>
1937 <para>This section of the dialog lets you configure all fonts and colors in
1938 any color scheme you have, as well creating new schemes or deleting existing
1939 ones. Each scheme has settings for colors, fonts and normal and highlight text
1940 styles.
1941 </para>
1944 work on a different scheme start by selecting that from the
1950 <variablelist>
1953 <listitem>
1955 <variablelist>
1959 <listitem><para>This is the default background for the editor area, it will be
1960 the dominant color on the editor area.</para></listitem>
1961 </varlistentry>
1965 <listitem><para>This is the background for selected text. The default is
1966 the global selection color, as set in your &kde; color preferences.
1967 </para></listitem>
1968 </varlistentry>
1972 <listitem><para>Set the color for the current line. Setting this a bit different
1973 from the Normal text background helps to keep focus on the current line.
1974 </para></listitem>
1975 </varlistentry>
1979 <listitem><para>This combo lets you set overlay colors for various mark types.
1980 The color is mixed into the background color of a marked line, so that a line
1981 with more marks or a marked line that is current has a background that is a mix
1982 of more colors. The mark colors are also used if you enable display of scrollbar
1983 marks.</para></listitem>
1984 </varlistentry>
1986 </variablelist>
1987 </listitem>
1988 </varlistentry>
1992 <listitem>
1993 <variablelist>
1994 <varlistentry>
1996 <listitem><para>This color is used for the marks, line numbers and folding
1997 marker borders in the left side of the editor view when they are displayed.
1998 </para></listitem>
1999 </varlistentry>
2000 <varlistentry>
2002 <listitem><para>This color is used to draw the line numbers on the left side of
2003 the view when displayed.</para></listitem>
2004 </varlistentry>
2005 <varlistentry>
2007 <listitem><para>This color is used to draw the background of matching brackets.
2008 </para></listitem>
2009 </varlistentry>
2010 <varlistentry>
2012 <listitem><para>This color is used to draw a pattern to the left of dynamically
2013 wrapped lines when those are aligned vertically, as well as for the static word
2014 wrap marker.</para></listitem>
2015 </varlistentry>
2016 <varlistentry>
2018 <listitem><para>This color is used to draw white space indicators when enabled.
2019 </para></listitem>
2020 </varlistentry>
2021 </variablelist>
2022 </listitem>
2023 </varlistentry>
2025 </variablelist>
2026 </sect2>
2030 <para>
2031 Here you can choose the font for the schema. You can choose from
2032 any font available on your system, and set a default size. A sample text
2033 displays at the bottom of the dialog, so you can see the effect of your choices.
2034 </para>
2035 </sect2>
2039 <para>The normal text styles are inherited by the highlight text styles,
2040 allowing the editor to present text in a very consistent way, for example comment
2041 text is using the same style in allmost all of the text formats that kate can
2042 highlight.</para>
2043 <para>The name in the list of styles is using the style configured for
2044 the item, providing you with an immediate preview when configuring a style.
2045 </para>
2046 <para>Each style lets you select common attributes as well as foreground
2047 and background colors. To unset a background color, rightclick to use the
2048 context menu.</para>
2049 </sect2>
2053 <para>Here you can edit the text styles used by a specific highlight definition.
2054 The editor preselects the highlight used by your current document. To work on a
2056 above the style list.
2057 </para>
2058 <para>The name in the list of styles is using the style configured for
2059 the item, providing you with an immediate preview when configuring a style.
2060 </para>
2061 <para>Each style lets you select common attributes as well as foreground
2062 and background colors. To unset a background color, rightclick to use the
2063 context menu. In addition you can see if a style is equal to the default style
2064 used for the item, and set it to that if not.</para>
2065 <para>You will notice that many highlights contain other highlights represented
2066 by groups in the style list. For example most highlights import the Alert
2067 highlight, and many source code formats imports the Doxygen highlight. Editing
2068 colors in those groups only affects the styles when used in the edited highlight
2069 format.
2070 </para>
2071 </sect2>
2073 </sect1>
2078 <variablelist>
2080 <varlistentry>
2082 <listitem>
2083 <variablelist>
2084 <varlistentry>
2086 <listitem>
2087 <para>When selected, pressing the home key will cause the cursor to
2088 skip white space and go to the start of a line's text.</para>
2089 </listitem>
2090 </varlistentry>
2091 <varlistentry>
2093 <listitem>
2096 go on to previous/next line at beginning/end of the line, similar to most
2097 editors.</para><para>When off, the insertion cursor cannot be moved left of the
2098 line start, but it can be moved off the line end, which can be very handy for
2099 programmers. When this option is chosen, moving the cursor with the arrow keys
2100 off the end of a line (to the right) causes it to jump down to the beginning of
2101 the next line. Likewise when the cursor is moved past the beginning of a line
2102 (to the left) it jumps up to the end of the preceding line. When this option is
2103 not selected, moving the cursor right past the end of a line merely causes it to
2104 continue horizontally in the same line and trying to move it left past the
2105 beginning does nothing.</para>
2106 </listitem>
2107 </varlistentry>
2108 <varlistentry>
2110 <listitem>
2111 <para>This option changes the behavior of the cursor when the user presses
2113 the text cursor will maintain its relative position within the visible text in
2114 &kwrite; as new text becomes visible as a result of the operation. So if the
2115 cursor is in the middle of the visible text when the operation occurs it will
2116 remain there (except when one reaches the beginning or end.) With this option
2117 selected, the first key press will cause the cursor to move to either the top or
2118 bottom of the visible text as a new page of text is displayed.</para>
2119 </listitem>
2120 </varlistentry>
2121 <varlistentry>
2123 <listitem>
2124 <para>Sets the number of lines to maintain visible above and below the cursor
2125 when possible.</para>
2126 </listitem>
2127 </varlistentry>
2128 </variablelist>
2129 </listitem>
2130 </varlistentry>
2132 <varlistentry>
2134 <listitem>
2135 <variablelist>
2136 <varlistentry>
2138 <listitem>
2139 <para>Selections will be overwritten by typed text and will be lost on
2140 cursor movement.</para>
2141 </listitem>
2142 </varlistentry>
2143 <varlistentry>
2145 <listitem>
2147 </listitem>
2148 </varlistentry>
2149 </variablelist>
2150 </listitem>
2151 </varlistentry>
2153 </variablelist>
2154 </sect1>
2158 <variablelist>
2160 <varlistentry>
2162 <listitem>
2163 <variablelist>
2164 <varlistentry>
2166 <listitem>
2167 <para>When this is enabled the editor will insert a calculated number of spaces
2170 </listitem>
2171 </varlistentry>
2172 <varlistentry>
2174 <listitem>
2176 representation of tabulator characters.</para>
2177 <note><para>This also causes dots to be drawn to indicate trailing white space.
2179 </listitem>
2180 </varlistentry>
2181 <varlistentry>
2184 Spaces</guilabel></link>
2185 option is selected this entry determines the number of
2186 spaces with which the editor will automatically replace
2187 tabs.</para></listitem>
2188 </varlistentry>
2189 </variablelist>
2190 </listitem>
2191 </varlistentry>
2193 <varlistentry>
2195 <listitem><para>
2196 Word wrap is a feature that causes the editor to automatically start a new line
2197 of text and move (wrap) the cursor to the beginning of that new line. &kwrite;
2198 will automatically start a new line of text when the current line reaches the
2201 <variablelist>
2202 <varlistentry>
2204 <listitem>
2206 </listitem>
2207 </varlistentry>
2208 <varlistentry>
2209 <term><guilabel>Show static word wrap markers
2210 (if applicable)</guilabel></term>
2211 <listitem>
2212 <para>If this option is checked, a vertical line will be drawn at the word wrap
2215 Please note that the word wrap marker is only drawn if you use a fixed pitch
2216 font.</para>
2217 </listitem>
2218 </varlistentry>
2219 <varlistentry>
2221 <listitem>
2223 this entry determines the length (in characters) at which the editor will
2224 automatically start a new line.</para>
2225 </listitem>
2226 </varlistentry>
2227 </variablelist>
2228 </listitem>
2229 </varlistentry>
2231 <varlistentry>
2234 at the ends of lines of text.</para></listitem> </varlistentry>
2236 <varlistentry>
2238 the user types a left bracket ([, (, or {) &kwrite; automatically enters the
2239 right bracket (}, ), or ]) to the right of the cursor.</para></listitem>
2240 </varlistentry>
2244 retain in memory for purposes of undoing entries and actions. This means that
2245 the higher the number of steps set the more memory &kwrite; will use for this.
2246 Setting this entry to 10 would mean that the user would be be able reverse the
2252 text from (this will be automatically entered into the Find Text
2253 dialog):
2254 <itemizedlist>
2256 text.</para></listitem>
2258 the current text selection, if available. </para></listitem>
2260 Use the current selection if available, otherwise use the current word.
2261 </para></listitem>
2263 Only:</emphasis> Use the word that the cursor is currently resting on, if
2264 available. </para></listitem>
2266 Use the current word if available, otherwise use the current selection.
2267 </para></listitem>
2268 </itemizedlist>
2269 Note that, in all the above modes, if a
2270 search string has not been or cannot be determined, then the Find Text Dialog
2271 will fall back to the last search text.
2272 </para></listitem>
2273 </varlistentry>
2274 <!--<varlistentry>
2275 <term id="pref-replace-tabs-by-spaces"><guilabel>Replace Tabs By
2276 Spaces</guilabel></term> <listitem><para>&kwrite; will replace any tabs with
2277 the number of spaces indicated in the <link linkend="pref-tab-width">Tab
2278 Width:</link> entry.</para></listitem> </varlistentry>
2280 <varlistentry> <term><guilabel>Show Tabs</guilabel></term>
2281 <listitem><para>The editor will display a symbol to indicate
2282 the presence
2283 of a tab in the text.</para></listitem>
2284 </varlistentry> -->
2285 </variablelist>
2286 </sect1>
2290 <variablelist>
2291 <varlistentry>
2293 <listitem>
2294 <variablelist>
2295 <varlistentry>
2297 <listitem>
2298 <para>Select the automatic indentation mode you want to use as default. It is
2302 </listitem>
2303 </varlistentry>
2304 <varlistentry>
2306 <listitem>
2308 style comment. This setting is only enabled when applicable.</para>
2309 </listitem>
2310 </varlistentry>
2311 </variablelist>
2312 </listitem>
2313 </varlistentry>
2315 <varlistentry>
2317 <listitem>
2318 <variablelist>
2319 <varlistentry>
2321 <listitem>
2324 </listitem>
2325 </varlistentry>
2326 <varlistentry>
2328 <listitem>
2330 </listitem>
2331 </varlistentry>
2332 <varlistentry>
2334 <listitem>
2335 <para>Set the number of spaces you want to use for indentation when you
2337 above.</para>
2338 </listitem>
2339 </varlistentry>
2340 </variablelist>
2341 </listitem>
2342 </varlistentry>
2344 <varlistentry>
2346 <listitem><para>When this is enabled, the editor will not unindent lines in a
2347 selection further when the line with the least indentation becomes unindented.
2348 If you sometimes unindent blocks of indented code, this may be helpful.
2349 </para></listitem>
2350 </varlistentry>
2352 <varlistentry>
2354 <listitem><para>Indentations of more than the selected number of spaces
2355 will not be shortened.</para></listitem>
2356 </varlistentry>
2358 <varlistentry>
2360 <listitem>
2361 <variablelist>
2362 <varlistentry>
2364 <listitem>
2367 </listitem>
2368 </varlistentry>
2369 <varlistentry>
2371 <listitem>
2374 indent.</para>
2375 </listitem>
2376 </varlistentry>
2377 </variablelist>
2378 </listitem>
2379 </varlistentry>
2381 <varlistentry>
2383 <listitem>
2384 <variablelist>
2385 <varlistentry>
2387 <listitem>
2390 characters.</para>
2391 </listitem>
2392 </varlistentry>
2393 <varlistentry>
2395 <listitem>
2398 </listitem>
2399 </varlistentry>
2400 <varlistentry>
2402 <listitem>
2405 line.</para>
2406 </listitem>
2407 </varlistentry>
2408 </variablelist>
2409 </listitem>
2410 </varlistentry>
2412 <!--<varlistentry>
2413 <term><guilabel>Auto Indent</guilabel></term> <listitem><para>This causes
2414 new lines to begin with the same indentation level as the previous
2415 line.</para></listitem>
2416 </varlistentry> -->
2417 </variablelist>
2418 </sect1>
2423 <variablelist>
2425 <varlistentry>
2427 <listitem>
2428 <variablelist>
2429 <varlistentry>
2431 <listitem>
2433 </listitem>
2434 </varlistentry>
2435 <varlistentry>
2437 <listitem>
2438 <para>Choose your prefered end of line mode for your active
2440 </listitem>
2441 </varlistentry>
2442 <varlistentry>
2444 <listitem>
2445 <para>Check this if you want the editor to autodetect the end of line
2446 type. The first found end of line type will be used for the whole file.</para>
2447 </listitem>
2448 </varlistentry>
2449 </variablelist>
2450 </listitem>
2451 </varlistentry>
2453 <varlistentry>
2455 <listitem>
2456 <variablelist>
2457 <varlistentry>
2459 <listitem>
2461 text into memory; if the filesize is bigger than this the other blocks
2462 are swapped to disk and loaded transparently as-needed.</para>
2463 <para>This can cause little delays while navigating in the document; a
2464 larger block count increases the editing speed at the cost of memory.
2465 </para><para>For normal usage, just choose the highest possible block count:
2466 limit it only if you have problems with the memory usage.</para>
2467 </listitem>
2468 </varlistentry>
2469 </variablelist>
2470 </listitem>
2471 </varlistentry>
2473 <varlistentry>
2475 <listitem>
2476 <variablelist>
2477 <varlistentry>
2479 <listitem>
2480 <para>The editor will automatically eliminate extra spaces at the ends of lines
2481 of text while loading/saving the file.</para>
2482 </listitem>
2483 </varlistentry>
2484 </variablelist>
2485 </listitem>
2486 </varlistentry>
2488 <varlistentry>
2490 <listitem>
2491 <variablelist>
2492 <varlistentry>
2494 <listitem>
2495 <para>The editor will search the given number of folder levels upwards
2497 </listitem>
2498 </varlistentry>
2499 </variablelist>
2500 </listitem>
2501 </varlistentry>
2503 <varlistentry>
2508 default. </para>
2509 <variablelist>
2510 <varlistentry>
2512 <listitem>
2513 <para>Check this if you want backups of local files when
2514 saving.</para>
2515 </listitem>
2516 </varlistentry>
2517 <varlistentry>
2519 <listitem>
2521 </listitem>
2522 </varlistentry>
2523 <varlistentry>
2525 <listitem>
2527 </listitem>
2528 </varlistentry>
2529 <varlistentry>
2531 <listitem>
2533 </listitem>
2534 </varlistentry>
2536 </variablelist>
2537 </listitem>
2538 </varlistentry>
2540 </variablelist>
2541 </sect1>
2545 <para>This group of options is used to customize the highlighting styles for
2546 each programming language type. Any changes you made in other areas of this
2547 dialog apply only to this type.</para>
2549 <variablelist>
2550 <varlistentry>
2552 <listitem><para>This is used to choose the language type to
2553 configure.</para></listitem>
2554 </varlistentry>
2556 <varlistentry>
2558 <listitem>
2559 <para>
2560 View the properties of the chosen language highlighting rules:
2561 author name and license.
2562 </para>
2563 </listitem>
2564 </varlistentry>
2566 <varlistentry>
2568 <listitem>
2569 <variablelist>
2570 <varlistentry>
2572 <listitem><para>This is the list of file extensions used to determine which
2573 files to highlight using the current syntax highlight mode.</para></listitem>
2574 </varlistentry>
2575 <varlistentry>
2577 <listitem><para>Clicking the wizard button will display a dialog with a list of
2580 well.</para></listitem>
2581 </varlistentry>
2582 <varlistentry>
2585 </varlistentry>
2586 </variablelist>
2587 </listitem>
2588 </varlistentry>
2590 <varlistentry>
2592 <listitem>
2593 <para>
2594 Click this button to download new or updated syntax highlight descriptions
2595 from the &kate; website.
2596 </para>
2597 </listitem>
2598 </varlistentry>
2600 </variablelist>
2601 <!-- obsolete annma 24 December 2005
2602 <para>The <guilabel>Configure
2603 Highlighting</guilabel> dialog consists of
2604 two pages, <guilabel>Defaults</guilabel> and <guilabel>Highlighting
2605 Modes</guilabel>. The user can select which page to view by
2606 clicking on the appropriate tab at the top of the dialog</para>
2608 <para>Items available on the <guilabel>Defaults</guilabel> page are as
2609 follows:</para>
2611 <variablelist>
2612 <varlistentry>
2613 <term><guilabel>Default Item Styles</guilabel></term>
2614 <listitem>
2615 <para>
2616 The user can configure the default appearance for
2617 particular items. This would allow a programmer to more easily identify
2618 different items (types of entries) in his or her code.
2619 </para>
2621 <variablelist>
2622 <varlistentry>
2623 <term><guilabel>Item</guilabel></term>
2624 <listitem><para>This drop down box offers a variety of items that the user
2625 might want to highlight. They include <guilabel>Normal</guilabel> for
2626 text does not fit in any of the other categories, <guilabel>Comment</guilabel>,
2627 <guilabel>String</guilabel>, <guilabel>Keyword</guilabel> and many more. Not
2628 all of these entries will need to be configured for every language and so may be
2629 selected as needed. The options in the rest of this section apply
2630 to the entry selected in this box.</para></listitem>
2631 </varlistentry>
2632 <varlistentry>
2633 <term><guilabel>Normal</guilabel></term>
2634 <listitem><para>This allows the user to choose the
2635 item's normal (unselected) color. This is done by means
2636 of a color selection dialog box, a further explanation of which
2637 may be found in the <link linkend="prefcolors">Colors</link> section of <link
2638 linkend="pref-dialog">Configure &kwrite;</link>.</para>
2639 </listitem>
2640 </varlistentry>
2642 <varlistentry>
2643 <term><guilabel>Bold</guilabel></term>
2644 <listitem><para>This option determines whether or
2645 not the item should be displayed in bold text.</para></listitem>
2646 </varlistentry>
2647 <varlistentry>
2648 <term><guilabel>Italic</guilabel></term>
2649 <listitem><para>This option determines whether or
2650 not the item should be displayed in italic text.</para></listitem>
2651 </varlistentry>
2653 <varlistentry>
2654 <term><guilabel>Selected</guilabel></term>
2655 <listitem><para>This allows the user to choose the
2656 item's color when selected. This is done by means of a
2657 color selection dialog box, a further explanation of which
2658 may be found in the <link linkend="prefcolors">Colors</link> section of <link
2659 linkend="pref-dialog">Configure &kwrite;</link>.</para>
2660 </listitem>
2661 </varlistentry>
2662 </variablelist>
2663 </listitem>
2664 </varlistentry>
2665 </variablelist>
2667 <para>Items on the <guilabel>Highlight Modes</guilabel> tab allow the
2668 user to define more specific highlighting depending on the language
2669 style.</para>
2671 <para>One need not set every available option, items not configured
2672 specifically will use the default configuration specified on the
2673 previous <guilabel>Defaults</guilabel> tab.</para>
2675 <variablelist>
2676 <varlistentry>
2677 <term><guilabel>Config Select</guilabel></term>
2678 <listitem><para>This group of options is used to customize the
2679 highlighting styles for each programming language type. Any changes you
2680 made in other areas of this dialog apply only to this
2681 type.</para>
2683 <variablelist>
2684 <varlistentry>
2685 <term><guilabel>Highlight</guilabel></term>
2686 <listitem><para>This is used to choose the language
2687 type to configure</para></listitem>
2688 </varlistentry>
2689 <varlistentry>
2690 <term><guilabel>Item</guilabel></term>
2691 <listitem><para>This is to choose the syntax item to
2692 configure. Remember this only configures
2693 <emphasis>this</emphasis> item for
2694 <emphasis>this</emphasis>
2695 language.</para></listitem>
2696 </varlistentry>
2697 </variablelist>
2699 <para>As an example, if the user wished to configure the
2700 appearance of <quote>comments</quote> while writing C++, she or he
2701 could choose C++ in the <guilabel>Highlight</guilabel> drop down box, and then
2702 choose Comment in the <guilabel>Item</guilabel> drop down box. To have
2703 <quote>comments</quote> look the same across all languages, the user would need
2704 to configure this in the <guilabel>Defaults</guilabel> page of this dialog box
2705 while leaving <quote>comments</quote> unconfigured within the more
2706 specific <guilabel>Highlight Modes</guilabel> page.</para>
2707 </listitem> </varlistentry>
2709 <varlistentry>
2710 <term><guilabel>Item Style</guilabel></term>
2711 <listitem><para>Here the user can configure the general
2712 appearance of the above
2713 selected item. Checking the
2714 <guilabel>Default</guilabel> check box causes the
2715 default style as configured on the previous tab to be set, or
2716 the appearance can be configured directly. The available
2717 options are the same as on the
2718 <guilabel>Defaults</guilabel> tab:
2719 <guilabel>Normal</guilabel>,
2720 <guilabel>Selected</guilabel>, <guilabel>Bold</guilabel>
2721 and <guilabel>Italic</guilabel>.</para></listitem>
2722 </varlistentry>
2724 <varlistentry>
2725 <term><guilabel>Highlight Auto Select</guilabel></term>
2726 <listitem><para>&kwrite; can apply syntax highlighting
2727 automatically, depending on the file extension or mime-type of the opened file.
2728 The defaults are fairly comprehensive, but users that regularly edit files with
2729 non-standard extensions can add them here. Wildcards are allowed in the
2730 <guilabel>File Extensions</guilabel> text box. For example, the
2731 default entry for the C++ language is
2732 <userinput>*.cpp;*.cc;*.C;*.h</userinput>. Opening a file called
2733 <filename>foo.h</filename> would automatically apply the
2734 C++ style to it.
2735 </para></listitem>
2736 </varlistentry>
2737 <varlistentry>
2738 <term><guilabel>Item Font</guilabel></term>
2739 <listitem><para>Here the user can choose the font for the
2740 selected item.</para>
2741 <para>The default style can be applied by checking the
2742 <guilabel>Default</guilabel> check box or the user can
2743 choose a specific font
2744 <guilabel>Family</guilabel>, <guilabel>Size</guilabel>
2745 and <guilabel>Charset</guilabel>. The available options are
2746 the same as those on the <guilabel>Defaults</guilabel> tab.</para></listitem>
2747 </varlistentry>
2748 </variablelist>-->
2749 </sect1>
2753 <para>This page allows you to override the default configuration for documents
2754 of specified mimetypes. When the editor loads a document, it will try if it
2755 matches the file masks or mimetypes for one of the defined filetypes, and if so
2756 apply the variables defined. If more filetypes match, the one with the highest
2757 priority will be used.
2758 </para>
2759 <variablelist>
2760 <varlistentry>
2762 <listitem><para>The filetype with the highest priority is the one displayed in
2763 the first drop down box. If more filetypes were found, they are
2764 also listed.</para>
2765 <variablelist>
2766 <varlistentry>
2768 <listitem><para>This is used to create a new filetype. After
2769 you click on this button, the fields below get empty and you
2770 can fill the properties you want for the new filetype.</para></listitem>
2771 </varlistentry>
2772 <varlistentry>
2774 <listitem><para>To remove an existing filetype, select it from the drop down
2775 box and press the Delete button.</para></listitem>
2776 </varlistentry>
2777 </variablelist>
2778 </listitem> </varlistentry>
2780 <varlistentry>
2782 <listitem><para>The filetype with the highest priority is the one displayed in
2783 the first drop down box. If more filetypes were found, they are also
2784 listed.</para>
2785 <variablelist>
2786 <varlistentry>
2788 <listitem><para>The name of the filetype will be the text of the corresponding
2789 menu item. This name is displayed in the
2791 </menuchoice ></para></listitem>
2792 </varlistentry>
2793 <varlistentry>
2795 <listitem><para>The section name is used to organize the file types in
2796 menus. This is also used in the
2799 </varlistentry>
2800 <varlistentry>
2803 files selected by this mimetype using &kwrite; variables. You can set almost any
2804 configuration option, such as highlight, indent-mode, encoding,
2805 etc.</para><para>For a full list of known variables, see the
2806 manual.</para></listitem>
2807 </varlistentry>
2808 <varlistentry>
2810 <listitem><para>The wildcards mask allows you to select files by filename. A
2811 typical mask uses an asterisk and the file extension, for example
2813 masks.</para></listitem>
2814 </varlistentry>
2815 <varlistentry>
2817 <listitem><para>Displays a wizard that helps you easily select
2818 mimetypes.</para></listitem>
2819 </varlistentry>
2820 <varlistentry>
2822 <listitem><para>Sets a priority for this file type. If more than one file type
2823 selects the same file, the one with the highest priority will be
2824 used.</para></listitem>
2825 </varlistentry>
2826 </variablelist>
2827 </listitem> </varlistentry>
2829 </variablelist>
2830 </sect1>
2834 <para>You can change here the shortcut keys configuration. Select an
2836 for this action.</para>
2837 <para>The search line alllows you to look for a specific action and see
2838 its associated shortcut.</para>
2839 </sect1>
2843 <para>This tab lists all available plugins and you can check those you
2844 want to use. Once a plugin is checked, the
2846 in order to configure the highlighted plugin.</para>
2847 </sect1>
2848 </chapter>
2855 <para>
2858 </para>
2862 <itemizedlist>
2863 <listitem>
2865 </listitem>
2867 <listitem>
2869 </listitem>
2871 <listitem>
2873 </listitem>
2875 <listitem>
2877 </listitem>
2879 <listitem>
2881 </listitem>
2883 <listitem>
2885 </listitem>
2887 <listitem>
2889 </listitem>
2891 <listitem>
2893 </listitem>
2895 <listitem>
2897 </listitem>
2899 <listitem>
2901 </listitem>
2903 <listitem>
2905 </listitem>
2907 <listitem>
2909 </listitem>
2911 <listitem>
2913 </listitem>
2914 </itemizedlist>
2916 <para>
2917 Original documentation by &Thad.McGinnis; &Thad.McGinnis.mail;
2918 </para>
2920 <para>
2921 Updated by &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; and
2922 &Anders.Lund; &Anders.Lund.mail;
2923 </para>
2925 <para>
2926 This version of the &kwrite; Handbook is based on the original by
2927 &Cristian.Tibirna; &Cristian.Tibirna.mail;
2928 </para>
2930 <para>
2931 Converted to docbook/proofreading by &Lauri.Watts; &Lauri.Watts.mail;
2932 </para>
2934 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
2936 &underFDL;
2937 &underGPL;
2938 </chapter>
2940 &documentation.index;
2941 </book>
2942 <!--
2943 Local Variables:
2944 mode: sgml
2945 sgml-namecase-general: t
2946 sgml-namecase-entity: nil
2947 sgml-general-insert-case: lower
2948 sgml-minimize-attributes: nil
2949 sgml-omittag: nil
2950 End:
2951 -->