summaryrefslogtreecommitdiffstats
path: root/doc/kwrite/index.docbook
blob: b21989121f8bd92dde61c11baada704f289aed20 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
  <!ENTITY kappname "&kwrite;">
  <!ENTITY package "tdebase">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>

<book lang="&language;">

<bookinfo>
<title>The &kwrite; Handbook</title>
<authorgroup>
<author>&Thad.McGinnis; &Thad.McGinnis.mail;</author>
<author>&Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail;</author>
<author>&Anders.Lund; &Anders.Lund.mail;</author>
<othercredit role="developer">
&Christoph.Cullmann; &Christoph.Cullmann.mail;
<!-- <contrib>Core Developer and Maintainer</contrib> -->
</othercredit>

<othercredit role="reviewer">
&Lauri.Watts; &Lauri.Watts.mail;
<!-- <contrib>Reviewer</contrib> -->
</othercredit>

<!-- TRANS:ROLES_OF_TRANSLATORS -->

</authorgroup>

<copyright>
<year>2000</year><year>2001</year>
<holder>&Thad.McGinnis;</holder>
</copyright>
<copyright>
<year>2005</year>
<holder>&Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail;</holder>
<holder>&Anders.Lund; &Anders.Lund.mail;</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>

<date>2005-12-27</date>
<releaseinfo>4.5.0</releaseinfo>

<abstract>
<para>&kwrite; is a text editor for &tde;</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>KWrite</keyword>
<keyword>text</keyword>
<keyword>editor</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>
&kwrite; is more than a text editor for the &tde; Desktop. It is meant
to be a programmer's editor, and could be considered as at least a
partial alternative to more powerful editors.  It may be best used in
conjunction with &konqueror; for source file browsing for different
languages. &kwrite; also works very well as a simple text editor.  One
of &kwrite;'s main features is the colorized syntax, customized for many
different programming languages such as: C/C++, &Java;, Python, Perl,
Bash, Modula 2, &HTML;, and Ada.
</para>

</chapter>

<chapter id="on-screen-fundamentals">
<title>Some Fundamentals</title>

<para>
&kwrite; is very simple to use. Anyone that has used a text editor
should have no problems.
</para>

<sect1 id="drag-and-drop">
<title>Drag and Drop</title>

<para>
&kwrite; uses the &tde; Drag and Drop protocol. Files may be dragged and
dropped onto &kwrite; from the Desktop, &konqueror; or some remote &FTP;
site opened in one of &konqueror;'s windows.
</para>
</sect1>

<sect1 id="command-line-options">
<title>Command Line Options</title>

<para>
Though &kwrite; may most often be started from the &tde; program menu, or
a desktop icon, it can also be opened at the command line prompt of a
terminal window.  There are a few useful options that are available when
doing this.
</para>

<sect2 id="specify-a-file">
<title>Specify a File</title>

<para>By specifying the path and name of a particular file the user can
have &kwrite; open (or create) that file immediately upon startup.  This
option might look something like the following:</para>

<informalexample><screen>
<prompt>%</prompt> <userinput><command>kwrite</command>
<option><replaceable>/home/myhome/docs/myfile.txt</replaceable></option>
</userinput>
</screen>
</informalexample>
</sect2>
<sect2 id="editing-files-on-the-internet">
<title>Specify a file on the internet</title>

<para>The above-mentioned method could even be used to open files on the
internet (if the user has an active connection at the time.)  An example of
this might look like the following:</para>

<informalexample><screen>
<prompt>%</prompt> <userinput><command>kwrite</command>
<option><replaceable>ftp://ftp.kde.org/pub/kde/Welcome.msg</replaceable>
</option></userinput>
</screen>
</informalexample>

</sect2>

<sect2 id="other-command-line-options">
<title>Other Command Line Options</title>

<para>The following command line help options are available</para>

<variablelist>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--help</option></userinput></term>
<listitem><para>This lists the most basic options available at the command
line.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--help-qt</option></userinput></term>
<listitem><para>This lists the options available for changing the way
&kwrite; interacts with &Qt;.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--help-kde</option></userinput></term>
<listitem><para>This lists the options available for changing the way
&kwrite; interacts with &tde;.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--help-all</option></userinput></term>
<listitem><para>This lists all of the command line options.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--author</option></userinput></term>
<listitem><para>Lists &kwrite;'s authors in the terminal
window</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--version</option></userinput></term>
<listitem><para>Lists version information for &Qt;, &tde;, and &kwrite;. Also
available through <userinput><command>kwrite</command>
<option>-v</option></userinput> </para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--stdin</option></userinput></term>
<listitem><para>Causes &kwrite; to read the document content from STDIN. This
is similar to the common option <option>-</option> used in many command line
programs, and allows you to pipe command output into &kwrite;.</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--encoding</option> <parameter>encoding</parameter>
<parameter>&URL;</parameter></userinput></term>
<listitem><para>Causes &kwrite; to use the specified encoding for the document.
</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--line</option> <parameter>line</parameter>
<parameter>&URL;</parameter></userinput></term>
<listitem><para>Navigate to the specified line after opening the document.
</para></listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>kwrite</command>
<option>--column</option> <parameter>column</parameter>
<parameter>&URL;</parameter></userinput></term>
<listitem><para>Navigate to the specified column after opening the document.
</para></listitem>
</varlistentry>

</variablelist>
</sect2>
</sect1>

<sect1 id="keybindings">
<title>Shortcuts</title>

<para>Many of the shortcuts are configurable by way of the <link
 linkend="settings">Settings</link> menu.  By default &kwrite; honors the
following shortcuts:</para>
<informaltable>
<tgroup cols="2">
<tbody>

<row><entry><para><keycombo
action="simul"><keycap>Insert</keycap></keycombo></para></entry>
<entry><para> Toggle between Insert and Overwrite mode. When in insert mode the
editor will add any typed characters to the text while pushing along any data to
the right of the text cursor. Overwrite mode causes the entry of each character
to eliminate the character immediately to the right of the text
cursor.</para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Left
Arrow</keycap></keycombo></para></entry>
<entry><para>Move the cursor one character to the left </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Right
Arrow</keycap></keycombo></para></entry>
<entry><para> Move the cursor one character to the right </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Up
Arrow</keycap></keycombo></para></entry>
<entry><para> Move the cursor up one line  </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Down
Arrow</keycap></keycombo></para></entry>
<entry><para> Move the cursor down one line </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Page
Up</keycap></keycombo></para></entry>
<entry><para> Move the cursor up one page  </para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Alt;<keycap>Page
Up</keycap></keycombo></para></entry>
<entry><para>Previous Bookmark  </para></entry>
</row>
<row>
<entry><para><keycombo action="simul"><keycap>Page
Down</keycap></keycombo></para></entry>
<entry><para>Move the cursor down one page  </para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Alt;<keycap>Page
Down</keycap></keycombo></para></entry>
<entry><para>Next Bookmark  </para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>Backspace</keycap></keycombo></para></entry>
<entry><para> Delete the character to the left of the cursor </para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>Home</keycap></keycombo></para></entry>
<entry><para> Move the cursor to the beginning of the line </para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>End</keycap></keycombo></para></entry>
<entry><para> Move the cursor to the end of the line </para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>Delete</keycap></keycombo></para></entry>
<entry><para>Delete the character to the right of the cursor (or any selected
text)</para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Shift;<keycap>Left
Arrow</keycap></keycombo></para></entry>
<entry><para> Mark text one character to the left </para></entry>
</row>
<row>
<entry><para><keycombo action="simul">&Shift;<keycap>Right
Arrow</keycap></keycombo></para></entry>
<entry><para> Mark text one character to the right </para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>F1</keycap></keycombo></para></entry>
<entry><para> Help</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Shift;<keycap>F1</keycap></keycombo></para></entry>
<entry><para>What's this?</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>F3</keycap></keycombo></para></entry>
<entry><para><link linkend="find-again"> Find again</link></para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Shift;<keycap>F3</keycap></keycombo></para></entry>
<entry><para><link linkend="find-previous"> Find Previous</link></para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>A</keycap></keycombo></para></entry>
<entry><para>Select All</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo></para></entry>
<entry><para>Deselect</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo></para></entry>
<entry><para>Block Selection Mode</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>B</keycap></keycombo></para></entry>
<entry><para>Set a Bookmark</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>C</keycap></keycombo></para></entry>
<entry><para> Copy the marked text to the clipboard.</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>D</keycap></keycombo></para></entry>
<entry><para> Comment</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;&Shift;<keycap>D</keycap></keycombo></para></entry>
<entry><para> Uncomment</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>F</keycap></keycombo></para></entry>
<entry><para><link linkend="find"> Find</link></para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>G</keycap></keycombo></para></entry>
<entry><para> Go to line...</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>I</keycap></keycombo></para></entry>
<entry><para> Indent selection</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;&Shift;<keycap>I</keycap></keycombo></para></entry>
<entry><para> Unindent selection</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>J</keycap></keycombo></para></entry>
<entry><para>Join Lines</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>N</keycap></keycombo></para></entry>
<entry><para> <link linkend="new">New</link> document</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>O</keycap></keycombo></para></entry>
<entry><para><link linkend="open">Open a document</link> </para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>P</keycap></keycombo></para></entry>
<entry><para><link linkend="print">Print</link> </para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>Q</keycap></keycombo></para></entry>
<entry><para>Quit - close active copy of editor </para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>R</keycap></keycombo></para></entry>
<entry><para><link linkend="replace"> Replace</link></para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>S</keycap></keycombo></para></entry>
<entry><para>Invokes the <link
linkend="save"><guilabel>Save</guilabel></link> command.</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>U</keycap></keycombo></para></entry>
<entry><para>Uppercase</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;&Shift;<keycap>U</keycap></keycombo></para></entry>
<entry><para>Lowercase</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Alt;&Ctrl;<keycap>U</keycap></keycombo></para></entry>
<entry><para>Capitalize</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>V</keycap></keycombo></para></entry>
<entry><para> Paste the clipboard text into line edit.</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>W</keycap></keycombo></para></entry>
<entry><para><link linkend="close">Close</link> </para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>X</keycap></keycombo></para></entry>
<entry><para>Delete the marked text and copy it to the clipboard.
</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>Z</keycap></keycombo></para></entry>
<entry><para><link linkend="undo">Undo</link></para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></para></entry>
<entry><para><link linkend="redo">Redo</link></para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>-</keycap></keycombo></para></entry>
<entry><para>Collapse One Local Level</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;&Shift;<keycap>-</keycap></keycombo></para></entry>
<entry><para>Collapse Toplevel</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;<keycap>+</keycap></keycombo></para></entry>
<entry><para>Expand One Local Level</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul">&Ctrl;&Shift;<keycap>+</keycap></keycombo></para></entry>
<entry><para>Expand Toplevel</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>F5</keycap></keycombo></para></entry>
<entry><para><link linkend="reload"> Reload</link></para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>F6</keycap></keycombo></para></entry>
<entry><para>Show/Hide Icon Border</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>F7</keycap></keycombo></para></entry>
<entry><para> Switch to Command Line</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>F9</keycap></keycombo></para></entry>
<entry><para> Show/Hide Folding Markers</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>F10</keycap></keycombo></para></entry>
<entry><para> Dynamic Word Wrap</para></entry>
</row>
<row>
<entry><para><keycombo
action="simul"><keycap>F11</keycap></keycombo></para></entry>
<entry><para> Show/Hide Line Numbers</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect1>
</chapter>

<chapter id="the-menu-entries">
<title>The Menu Entries</title>

<sect1 id="file">
<title>The <guimenu>File</guimenu> Menu</title>

<variablelist>

<varlistentry>
<term id="new">
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New</guimenuitem></menuchoice></term>
<listitem>
<para>
This starts a new Document in the editor. If there is a current
document with unsaved changes the user is given a chance to save it.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="open">
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem>
</menuchoice>
</term>

<listitem>
<!--
This is description of a standard dialog and so should go in the UG,
with a pointer to it. In fact, I'll probably nick this very stuff for
the UG
- Phil
<para>
This command opens a file.  It does this by means of a dialog box which
allows the user to navigate the file system.  The dialog operates like a
small file manager. Clicking on folders displayed in the central
window directs the dialog to enter that folder - displaying its
contents.  There is an entry/dropdown box which can be used to type in
directly the location and name of the file or by clicking the arrow at
the side choose from a drop down box of recently used locations. Below
this is a filter which similarly may have data entered directly or
chosen from a drop down box of recent filter types.  The filter facility
lets only files that meet its specifications be displayed in the central
window. If the filter contained text such as <literal
role="extension">*.txt</literal> then only files with the <literal
role="extension">txt</literal> extension would be visible in the
selection window. Below the filter is a status bar giving information
about the number of files and subfolders within the current
folder.
</para>

<para>
The toolbar, which is located at the top of the dialog, has left and
right arrow buttons that let the user move back and forth through
previously selected folders as well as an up arrow button for moving
up the folder tree. The button with the little house takes the user
to their home folder and the one with the two arrows curved in on
each other updates the view of the current folder. The flag button
lets the user set a new bookmark at the current folder or go to one
that was previously set.
</para>

<para>
The last button on the toolbar allows you to create a new folder, and
even change some basic settings for the dialog box, and finally there is
dropdown box with a list of some commonly frequented folders.
</para>
-->
<para>Displays a standard &tde; <guilabel>Open File</guilabel>
dialog. Use the file view to select the file you want to open, and
click on <guibutton>Open</guibutton> to open it. You can find more
information about the &tde; <guilabel>Open File</guilabel> dialog in
the &tde; User Guide.</para>

</listitem>
</varlistentry>

<varlistentry>
<term id="open-recent">
<menuchoice>
<guimenu>File</guimenu>
<guisubmenu>Open Recent</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>
This is a shortcut to open recently saved documents. Clicking on this
item opens a list to the side of the menu with several of the most
recently saved files. Clicking on a specific file will open it in
&kwrite; - if the file still resides at the same
location.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="save">
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This saves the current document.  If there has already been a save of
the document then this will overwrite the previously saved file without
asking for the user's consent.  If it is the first save of a new
document the save as dialog (described below) will be invoked.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="save-as">
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This allows a document to be saved with a new file name. This is done by
means of the file dialog box described above in the <link
linkend="open">Open</link> section of this help file.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="reload">
<menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F5</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Reload</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Reloads the active file from disk. This command is useful if another program or
process has changed the file while you have it open in &kwrite;.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="print">
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Print...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Opens a simple print dialog allowing the user to specify what, where,
and how to print.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="export-as-html">
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Export as HTML...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Export your file in HTML format so your document can be viewed as a web page.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="close">
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Close</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Close the active file with this command. If you have made unsaved changes, you
will be prompted to save the file before &kwrite; closes it.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="quit">
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This will close the editor window, if you have more than one instance of
&kwrite; running, through the <guimenuitem>New View</guimenuitem> or
<guimenuitem>New Window</guimenuitem> menu items, those instances will
not be closed.
</para>
</listitem>
</varlistentry>

</variablelist>

</sect1>

<sect1 id="edit">
<title>The <guimenu>Edit</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term id="undo"><menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Undo</guimenuitem></menuchoice></term>
<listitem>
<para>This is used to eliminate or reverse the most recent user action
or operation.
<!--
Just what constitutes such an action may be better
understood by referring to the <link linkend="group-undos">Group
Undos</link> portion of this help file.
-->
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="redo"/><menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Redo</guimenuitem></menuchoice></term>
<listitem>
<para>This will reverse the most recent change (if any) made using Undo</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="cut"/><menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;<keycap>X</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem></menuchoice></term>
<listitem>
<para>This command deletes the current selection and places it on the
clipboard.
The  clipboard is a feature of &tde; that works invisibly to provide a way to
transfer data between applications.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="copy"/><menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;<keycap>C</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice></term>
<listitem>
<para>This copies the currently selected text to the clipboard so that it may
be pasted elsewhere.  The clipboard is a feature of &tde; that works invisibly
to provide a way to transfer data between applications.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="copy-as-html"/><menuchoice>
<guimenu>Edit</guimenu><guimenuitem>Copy as
HTML</guimenuitem></menuchoice></term>
<listitem>
<para>This copies the currently selected text to the clipboard as HTML.</para>
 </listitem>
</varlistentry>

<varlistentry>
<term><anchor id="paste"/><menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;<keycap>V</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem></menuchoice></term>
<listitem>
<para>This will insert the contents of the clipboard at the cursor position.
The clipboard is feature of &tde; that works invisibly to provide a way to
transfer data between applications.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="select-all"/><menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Select All</guimenuitem></menuchoice></term>
<listitem>
<para>This will select the entire document. This could be very useful for
copying the entire file to another application.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="deselect"/><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu><guimenuitem>Deselect</guimenuitem></menuchoice></term>
<listitem>
<para>Deselects the selected text in the editor if any.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="block-selection-mode"/><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu><guimenuitem>Bloc
Selection Mode</guimenuitem></menuchoice></term>
<listitem>
<para>Toggles Selection Mode. When the Selection Mode is “BLOCK”, you can make
vertical selections, ie select column 5 to 10 in lines 9 to 15.
The status bar shows the current state of the Selection Mode, either “NORM” or
“BLK”.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="overwrite-mode"/><menuchoice>
<shortcut>
<keycombo action="simul"><keycap>Insert</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu><guimenuitem>Overwrite
Mode</guimenuitem></menuchoice></term>
<listitem>
<para>Toggles the Insert/Overwrite modes. When the mode is "INS", you
insert characters where the cursor is. When the mode is "OVR", writing
characters will replace the current characters if your cursor is positioned
before any character. The status bar shows the current state of the Overwrite
Mode, either “INS” or “OVR”.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="find"/><menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Find</guimenuitem></menuchoice></term>
<listitem>
<para>This opens the find dialog which is used to specify the <guilabel>Text to
Find</guilabel> in the document. There is small text box for entering the search
pattern which also doubles as a dropdown box. Clicking on the dropdown arrow at
the side of the box makes available other recent search patterns. Other
parameters are included to make the search more efficient. Selecting
<guilabel>Case Sensitive</guilabel> will limit finds to entries that match the
case (upper or lower) of each of the characters in the search  pattern.
<guilabel>Find Backwards</guilabel> directs the search to proceed in an upwardly
direction. The <guilabel>Selected Text</guilabel> option keeps the  search
within currently selected text. Checking <guilabel>Whole Words Only</guilabel>
prevents the search from stopping on words that contain the searched for
pattern. The <guilabel>Search from Cursor</guilabel> option begins the search
from the current position of the cursor within the document rather  than from
the beginning.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="find-again"/><menuchoice>
<shortcut><keycombo action="simul"><keycap>F3</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Find Next</guimenuitem></menuchoice></term>
 <listitem>
<para>This repeats the last find operation, if any, without calling the find
dialog box.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="find-previous">
<menuchoice>
<shortcut>
<keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Find Previous</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This repeats the last find operation, if any, without calling the find
dialog box, and searching backwards instead of forwards through the
document.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="replace"/><menuchoice>
<shortcut><keycombo
action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut>
<guimenu>Edit</guimenu><guimenuitem>Replace...</guimenuitem></menuchoice></term>
<listitem>
<para>This command opens the replace dialog box. The replace dialog is
almost identical to the above-mentioned find dialog. In addition to the features
in the find dialog it contains a <guilabel>Replace With:</guilabel> text
entry/dropdown box.  Using this dialog the user can specify both the text to be
found and text with which to replace it. The additional <guilabel>Prompt
On Replace</guilabel> option allows the user to have &kwrite; ask for
confirmation before each replacement.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="go-to-line">
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Go to line</guimenuitem></menuchoice></term>
<listitem>
<para>
This opens the goto line dialog box which is used to have the cursor
jump to a particular line (specified by number) in the document.  The
line number may be entered directly into the text box or graphically by
clicking on the up or down arrow spin controls at the side of the text
box. The little up arrow will increase the line number and the down
arrow decrease it.  There is also a slide control to the right of the
text box which allows the user to move the goto point in the document in
an analog manner.
</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>
<sect1 id="view-menu">
<title>The <guimenu>View</guimenu> menu</title>

<para>The <guimenu>View</guimenu> menu allows you to manage settings
specific to the active editor, and to manage frames.</para>

<variablelist>

<varlistentry>
<term>
<anchor id="view-new-window"/>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>New Window</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Opens a new window with the same text.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-command-line"/>
<menuchoice>
<shortcut><keycombo
action="simul"><keycap>F7</keycap></keycombo></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Switch to Command Line</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Displays the Katepart command line at the bottom of the window.
In the command line, type "help" to get help and "help list" to get a list of
commands.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-schema"/>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Schema</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Select a font schema.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-dynamic-word-wrap"/>
<menuchoice>
<shortcut><keycombo action="simul"><keycap>F10</keycap></keycombo></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Dynamic Word Wrap</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>The text lines will be wrapped at the view
border on the screen.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-dynamic-word-wrap-indicators"/>
<menuchoice>
<shortcut><keycombo action="simul"><keycap>F10</keycap></keycombo></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Dynamic Word Wrap Indicators</guimenuitem>
</menuchoice>
</term>
<listitem>
 <para>Choose when and how the dynamic word wrap indicators should be
displayed. This is only available if the <guilabel>Dynamic Word
Wrap</guilabel> option is checked.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-show-static-word-wrap"/>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Show Static Word Wrap Marker</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>If this option is checked, a vertical line will be drawn at the
word wrap column as defined in the <menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Editor...</guimenuitem></menuchoice> in the
Editing tab. Please note that the word wrap marker is only drawn if you
use a fixed pitch font.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-show-icon-border"/>
<menuchoice>
<shortcut><keycombo action="simul"><keycap>F6</keycap></keycombo></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Show Icon Border</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>This is a toggle item. Setting it on checked will make the
side of the active editor, and vice versa.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-show-line-numbers"/>
<menuchoice>
<shortcut><keycombo action="simul"><keycap>F11</keycap></keycombo></shortcut>
<guimenu>View</guimenu>
<guimenuitem>Show Line Numbers</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>This is a toggle Item. Setting it on checked will make a pane displaying
the line numbers of the document visible in the left border of the active
editor, and vice versa.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-scrollbar-marks"/>
<menuchoice>
<guimenu>View</guimenu>
<guisubmenu>Show Scrollbar Marks</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>If this option is checked, the view will show marks on the vertical
scrollbar.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-hide-folding-markers"/>
<menuchoice>
<shortcut><keycombo action="simul"><keycap>F9</keycap></keycombo></shortcut>
<guimenuitem>Hide Folding Markers</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>If this option is checked, the marks for code folding will be
hidden.</para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<anchor id="view-code-folding"/>
<menuchoice>
<guimenuitem>Code Folding</guimenuitem>
</menuchoice>
</term>
<listitem>
<variablelist>
<varlistentry>
<term><menuchoice><shortcut><keycombo action="simul"><keycap>Ctrl</keycap>
<keycap>Shift</keycap><keycap>-</keycap></keycombo></shortcut>
<guimenuitem>Collapse Toplevel</guimenuitem></menuchoice>
</term>
<listitem><para>Collapse all toplevel regions in the document.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut><keycombo action="simul"><keycap>Ctrl</keycap>
<keycap>Shift</keycap><keycap>+</keycap></keycombo></shortcut>
<guimenuitem>Expand Toplevel</guimenuitem></menuchoice>
</term>
<listitem><para>Expand all toplevel regions in the document.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut><keycombo action="simul"><keycap>Ctrl</keycap>
<keycap>-</keycap></keycombo></shortcut>
<guimenuitem>Collapse One Local Level</guimenuitem></menuchoice>
</term>
<listitem><para>Collapse the region closest to the cursor.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><shortcut><keycombo action="simul"><keycap>Ctrl</keycap>
<keycap>+</keycap></keycombo></shortcut>
<guimenuitem>Expand One Local Level</guimenuitem></menuchoice>
</term>
<listitem><para>Expand the region closest to the cursor.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

</variablelist>

</sect1>

<sect1 id="go">
<title>The <guimenu>Bookmarks</guimenu> Menu</title>
<variablelist>

<varlistentry>
<term id="set-bookmark">
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo>
</shortcut>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Set Bookmark</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Sets or removes a bookmark in the current line of the active document. (If it's
there, it is removed, otherwise one is set).
</para>
</listitem>
</varlistentry>

<varlistentry>
<term id="clear-bookmarks">
<menuchoice>
<guimenu>Bookmarks</guimenu>
<guimenuitem>Clear All Bookmarks</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This command will remove all the markers from the document as well as
the list of markers which is appended at the bottom of this menu item.
</para>
</listitem>
</varlistentry>

<varlistentry id="bookmarks-previous">
<term><menuchoice><shortcut><keycombo action="simul"><keycap>Alt</keycap>
<keycap>Page Up</keycap></keycombo></shortcut>
<guimenu>Bookmarks</guimenu><guimenuitem>Previous</guimenuitem></menuchoice>
</term>
<listitem><para>This will move the cursor to beginning of the first above line
with a bookmark. The menuitem text will include the line number and the first
piece of text on the line. This item is only available when there is a bookmark
in a line above the cursor.</para></listitem>
</varlistentry>

<varlistentry id="bookmarks-next">
<term><menuchoice><shortcut><keycombo action="simul"><keycap>Alt</keycap>
<keycap>Page Down</keycap></keycombo></shortcut>
<guimenu>Bookmarks</guimenu><guimenuitem>Next</guimenuitem></menuchoice></term>
<listitem><para>This will move the cursor to beginning of the next line with a
bookmark. The menuitem text will include the line number and the first piece of
text on the line. This item is only available when there is a bookmark in a line
below the cursor.</para></listitem>
</varlistentry>

</variablelist>

<para>
At the bottom of this menu, a list of markers appears if any markers are
available for this window.
</para>

</sect1>

<sect1 id="tools">
<title>The <guimenu>Tools</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><anchor id="tools-read-only"/><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Read Only Mode</guimenuitem></menuchoice></term>
 <listitem>
<para>Set the current document to Read Only mode. This prevents any text
addition and any changes in the document formatting.</para>
 </listitem>
</varlistentry>

<varlistentry>
<term><anchor id="tools-filetype"/><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Filletype</guimenuitem></menuchoice></term>
 <listitem>
<para>Choose the filetype scheme you prefer for the active document. This
overwrites the global filetype mode set in <menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure
Editor...</guimenuitem></menuchoice> in the Filetypes tab for your current
document only.</para>
 </listitem>
</varlistentry>

<varlistentry>
<term><anchor id="tools-highlighting"/><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Highlighting</guimenuitem></menuchoice></term>
 <listitem>
<para>Choose the Highlighting scheme you prefer for the active document. This
overwrites the global highlighting mode set in <menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure
Editor...</guimenuitem></menuchoice> for your current document only.</para>
 </listitem>
</varlistentry>

<varlistentry>
<term><anchor id="tools-indentation"/><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Indentation</guimenuitem></menuchoice></term>
 <listitem>
<para>Choose the style of indentation you want for your active document.
This overwrites the global indentation mode set in <menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure
Editor...</guimenuitem></menuchoice> for your current document only.</para>
 </listitem>
</varlistentry>

<varlistentry>
<term><anchor id="tools-encoding"/><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Encoding</guimenuitem></menuchoice></term>
 <listitem>
<para>You can overwrite the default encoding set in <menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure
Editor...</guimenuitem></menuchoice> in the <guilabel>Open/Save</guilabel> tab
to set a different encoding for your current document. The encoding you
set here will be only valid for your current document.</para>
 </listitem>
</varlistentry>

<varlistentry>
<term><anchor id="tools-end-of-line"/><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>End of Line</guimenuitem></menuchoice></term>
 <listitem>
<para>Choose your prefered end of line mode for your active
document. This overwrites the global end of line mode set in <menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure
Editor...</guimenuitem></menuchoice> for your current document only.</para>
 </listitem>
</varlistentry>

<varlistentry>
<term><anchor id="Spelling..."/><menuchoice>
<guimenu>Tools</guimenu><guimenuitem>Spelling...</guimenuitem></menuchoice>
</term>

<listitem><para><action>This initiates the spellchecking program - a program
designed to help the user catch and correct any spelling errors.</action>
Clicking on this entry will start the checker and bring up the speller dialog
box through which the user can control the process.  There are four settings
lined up vertically in the center of the dialog with their corresponding labels
just to the left.  Starting at the top they are:</para>

<variablelist>
<varlistentry>
<term><guilabel>Unknown word:</guilabel></term>
<listitem><para>Here, the spellchecker indicates the word currently under
consideration.  This happens when the checker encounters a word not in its
dictionary - a file containing a list of correctly spelled words against which
it compares each word in the editor.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Replace with:</guilabel></term>
<listitem><para> If the checker has any similar words in its dictionary the
first one will be listed here.  The user can accept the suggestion, type in his
or her own correction, or choose a different suggestion from the next
box.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Suggested Words:</guilabel></term>
<listitem><para> The checker may list here a number of possible replacements for
the word under consideration.  Clicking on any one of the suggestions will cause
that word to be entered in the <guilabel>Replacement:</guilabel> box,
above.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Language:</guilabel></term>
<listitem><para> If you have installed multiple dictionaries, here you can
select which dictionary/language should be used.</para></listitem>
</varlistentry>
</variablelist>

<para>On the right side of the dialog box are 5 buttons that allow the user to
control the spellcheck process.  They are:</para>

<variablelist>
<varlistentry>
<term><guibutton>Add to Dictionary</guibutton></term>
<listitem><para>Pressing this button adds the word in the <guilabel>Misspelled
Word:</guilabel> box to the checker's dictionary. This means that in the future
the checker will always consider this word to be correctly
spelled.</para></listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Replace</guibutton></term>
<listitem><para> This button has the checker replace the word under
consideration in the document with the word in the
<guilabel>Replacement:</guilabel> box.</para></listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Replace All</guibutton></term>
<listitem><para> This button causes the checker to replace not only the current
<guilabel>Unknown word:</guilabel> but to automatically make the same
substitution for any other occurrences of this <guilabel>Misspelled
Word:</guilabel> in the document.</para></listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Ignore</guibutton></term>
<listitem><para>Activating this button will have the checker move on without
making any changes.</para></listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Ignore All</guibutton></term>
<listitem><para> This button tells the checker to do nothing with the current
<guilabel>Unknown word:</guilabel> and to pass over any other instances of
the same word.</para> <note><para>This only applies to the current spellcheck
run.  If the checker is run again later it will stop on this same
word.</para></note></listitem>
</varlistentry>
</variablelist>

<!--<para>Located horizontally along the bottom of the spellcheck dialog is a
progress bar.  As the checking process proceeds the bar will fill from left to
right providing a graphical representation of how far along in the document the
process has reached.  In addition, the progress is displayed numerically in
the center of the progress bar.</para>//-->

<!--<note><para>A numerical display of the spellcheck
process is simultaneously displayed in the status bar of the editor.  The <link
linkend="show-statusbar">status bar</link> is the horizontal strip at the bottom
of the editor just outside of the text entry area.</para></note>//-->

<para>Three more buttons are located horizontally along the bottom of the
spellcheck dialog.  They are:</para>

<variablelist>
<varlistentry>
<term><guibutton>Help</guibutton></term>
<listitem><para> This invokes the &tde; help system starting at the &kwrite; help
pages (this document).</para></listitem>
</varlistentry>

<varlistentry>
<term><guibutton>Finished</guibutton></term>
<listitem><para> This button ends the spellcheck process, and returns to the
document.</para></listitem>
</varlistentry>

<varlistentry>
<term><guibutton>Cancel</guibutton></term>
<listitem><para> This button cancels the spellcheck process, all modifications
are reverted, and you will return to your document.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>

<variablelist>
<varlistentry>
<term><anchor id="tools-spelling-from-cursor"/><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Spelling (from cursor)...</guimenuitem></menuchoice></term>
 <listitem>
<para>This initiates the spellchecking program but it starts where your cursor
is instead of at the beginning of the document.</para>
 </listitem>
</varlistentry>

<varlistentry>
<term><anchor id="tools-spellcheck-selection"/><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Spellcheck Selection...</guimenuitem></menuchoice></term>
 <listitem>
<para>Spellchecks the current selection.</para>
 </listitem>
</varlistentry>

<varlistentry>
<term><anchor id="indent"/><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu><guimenuitem>Indent</guimenuitem></menuchoice></term>
<listitem>
<para>This increases the paragraph's indentation by one step. The size of the
step depends on the <link linkend="pref-indent"> indentation
settings</link>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="unindent"/><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>I</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu><guimenuitem>Unindent</guimenuitem></menuchoice></term>

<listitem>
<para>This reduces the paragraph's indentation by one step. The size of the step

depends on the <link linkend="pref-indent"> indentation settings</link>.</para>

</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="cleanindent"/><menuchoice>
<guimenu>Tools</guimenu><guimenuitem>Clean
Indentation</guimenuitem></menuchoice></term>  <listitem>
<para>This cleans the indentation for the current selection or for the
line the cursor is currently in. Cleaning the indentation ensures that
all your selected text follows the indentation mode you choose.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="tools-align"/><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Align</guimenuitem>
</menuchoice></term>
<listitem>
<para>Causes a realign of the current line or selected lines using the
indentation mode and indentation settings in the doucment.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>D</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Comment</guimenuitem>
</menuchoice></term>
<listitem><para>This adds one space to the beginning of the line
where the text cursor is located or to the beginning of any
selected lines.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>D</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Uncomment</guimenuitem>
</menuchoice></term>
<listitem><para>This removes one space (if any exist) from the beginning of the
line where the text cursor is located or from the beginning of any
selected lines.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Uppercase</guimenuitem>
</menuchoice></term>
<listitem><para>Put the selected text or the letter after the cursor in
uppercase.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>U</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Lowercase</guimenuitem>
</menuchoice></term>
<listitem><para>Put the selected text or the letter after the cursor in
lowercase.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Alt;&Ctrl;<keycap>U</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Capitalize</guimenuitem>
</menuchoice></term>
<listitem><para>Capitalize the selected text or the current
word.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Delete Line</guimenuitem>
</menuchoice></term>
<listitem><para>Delete the current line.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo>
</shortcut>
<guimenu>Tools</guimenu>
<guimenuitem>Join Lines</guimenuitem>
</menuchoice></term>
<listitem><para>Joins the selected lines, or the current line and the line below
with one white space character as a separator. Leading/trailing white space on
joined lines is removed in the affected ends.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Word Wrap Document</guimenuitem>
</menuchoice></term>
<listitem><para>Apply static word wrapping on all the document. That means that
a new line of text will automatically start when the current
line exceeds the length specified by the Wrap words at: option
in the Editing tab in <menuchoice>
<guimenu>Settings</guimenu><guimenuitem>Configure
Editor...</guimenuitem></menuchoice></para></listitem>
</varlistentry>

</variablelist>


</sect1>

<sect1 id="settings">
<title>The <guimenu>Settings</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><anchor id="show-toolbar"/><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
When checked, this displays a movable toolbar containing buttons used to
initiate frequently used commands. When unchecked the toolbar is hidden.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="show-statusbar"/><menuchoice>
<guimenu>Settings</guimenu><guimenuitem>Show
Statusbar</guimenuitem></menuchoice></term>
<listitem>
<para>When checked, this displays a small bar at the bottom of the editor
containing information about the status of the current document.  When unchecked
the statusbar is hidden.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="show-path"/><menuchoice>
<guimenu>Settings</guimenu><guimenuitem>Show
Path</guimenuitem></menuchoice></term>
<listitem>
<para>When selected, this displays in the titlebar the path (its location in the
file system) of the current document.  When unchecked the path is hidden.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="preferences"/><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Editor...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This menu item opens a dialog whereby several different <link
linkend="pref-dialog">settings</link> may be adjusted.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="choose-editor"/><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Choose Editor...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Choose the default text editing component that you wish to use in &kwrite;. You
can choose <guilabel>System Default</guilabel>, <guilabel>Embedded
Advanced Text Editor</guilabel> or <guilabel>&Qt; Designer Based
Text Editor</guilabel> (note that the &Qt; Designer Based Text Editor is
only available if you have KDevelop installed on your system). If you choose
<guilabel>System Default</guilabel>, &kwrite; will honor your changes in
&kcontrolcenter;.  All other choices will override that setting.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="configure-keybindings"/><menuchoice>
<guimenu>Settings</guimenu><guimenuitem>Configure
Shortcuts...</guimenuitem></menuchoice></term>
<listitem>
<para>This command opens a dialog box whereby the <link
linkend="keybindings">shortcuts</link> may be changed.  A display window at the
top of the dialog box shows the list of commands (actions) that can have
keyboard shortcuts.  Below the display are three radio buttons.  The user may
choose between No Key, Default Key, and Custom Key.  (Note that a set of radio
buttons only allows the selection of one of the offered items - in the way that
buttons on a car radio only offer the selection of one preset station.  Also,
the Default Key selection  is only available for those commands that actually
have a 'default' shortcut.)  Selecting the Custom Key option activates the three
check boxes and key button at the bottom of the dialog. The user may then select
a key combination for the command in question by means of the check boxes and
key button. For example, with the About &tde; command selected in the display
window, the user could select &Ctrl; and <keycap>Alt</keycap>, click on  the key
button, and then press the <keycap>K</keycap> key on the keyboard.  This would
mean that anytime they held down the &Ctrl; and  <keycap>Alt</keycap>
buttons and pressed <keycap>K</keycap> (while using
&kwrite;) the About &tde; display box would be called.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><anchor id="configure-toolbars"/><menuchoice>
<guimenu>Settings</guimenu><guimenuitem>Configure
Toolbars...</guimenuitem></menuchoice></term>
<listitem><para>This will open the dialog whereby the toolbar configuration may
be changed.   The user can choose which shortcut buttons should appear on the
toolbar. A display window on the left lists the commands available to placed
on the toolbar.  A display on the right lists those commands already on the
toolbar.  A set of four arrow buttons between the two displays manipulates the
selections.  The right pointing arrow places any command selected in the left
pane onto the right pane, <abbrev>i.e.</abbrev>, it is added to the toolbar.
The left arrow does just the opposite, removing any action selected in the right

window from the toolbar.  The up and down pointing arrows change the position of

an action selected in the right window which changes the position of its button

in the toolbar.</para> </listitem>
</varlistentry>



<!--
<varlistentry>
<term>
<menuchoice><guimenu>>Settings</guimenu><guimenuitem>Configure
Highlighting</guimenuitem></menuchoice></term>
<listitem><para>Opens a dialog box allowing configuration of the syntax
highlighting.  The dialog is described in <xref
linkend="pref-highlighting"/>.</para></listitem>
</varlistentry>  -->

<!--<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F6</keycap></keycombo>
</shortcut>
<guimenu>Settings</guimenu>
<guimenuitem>Show Icon Border</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
Toggle the display of a border on the left of the editing window, where
bookmarks are displayed next to the line they apply to.
</para>
</listitem>
</varlistentry>//-->

<!--<varlistentry>
<term id="vertical-selection">
<menuchoice>
<shortcut>
<keycombo action="simul"><keycap>F4</keycap></keycombo>
</shortcut>
<guimenu>Settings</guimenu>
<guimenuitem>Vertical Selection</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
This is used to turn on or off the vertical selection feature.  Vertical
selection allows text to be selected by column as well as by row.  In other
words with this feature the user is able to select text contained in only
particular contiguous columns and rows.  In affect the user can select a
rectangular area of text anywhere in the document.
</para>
</listitem>
</varlistentry>  //-->

<!--<varlistentry>
<term id="set-highlight">
<menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Highlight Mode</guisubmenu>
</menuchoice>
</term>
<listitem>
<para>
This allows the user to choose the style of color highlighting which the
editor uses to display the text. The styles are selected by programming
language. The font/color information is not stored with the document.
</para>
</listitem>
</varlistentry>  //-->

<!--<varlistentry>
<term><anchor id="end-of-line"/>
<menuchoice>
<guimenu>Settings</guimenu><guisubmenu>End of
Line</guisubmenu></menuchoice></term>
<listitem>
<para>This opens a sub-menu from which the user can select the type of
<quote>end of
line</quote> code for &kwrite; to use, <abbrev>i.e.</abbrev>, the accepted
standard
used by &UNIX;, &Mac; or MSDOS/&Windows; systems.</para>
</listitem>
</varlistentry>  //-->

</variablelist>
</sect1>

<sect1 id="help">
<title>The <guimenu>Help</guimenu> Menu</title>

&help.menu.documentation;

</sect1>
</chapter>

<chapter id="pref-dialog">
<title>Configure &kwrite;</title>

<para>
Selecting <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
Editor...</guimenuitem></menuchoice> from the menu brings up the
<guilabel>Configure Editor</guilabel> dialog box.  This dialog can be
used to alter a number of different settings.  The settings available
for change vary according to which category the user chooses from a
vertical list on the left side of the dialog.  By means of three buttons
along the bottom of the box the user can control the process.
</para>

<para>
They may invoke the <guilabel>Help</guilabel> system, accept the
current settings and close the dialog by means of the
<guibutton>OK</guibutton> button, or <guibutton>Cancel</guibutton> the
process. The categories <guilabel>Colors</guilabel>,
<guilabel>Fonts</guilabel> <guilabel>Indent</guilabel>,
<guilabel>Select</guilabel>, <guilabel>Edit</guilabel>,
<guilabel>Spelling</guilabel> and <guilabel>Highlighting</guilabel> are
detailed below.
</para>

<sect1 id="appearance">
<title>Appearance</title>

<variablelist>
<varlistentry>
<term><guilabel>Word Wrap</guilabel></term>
<listitem>
<variablelist>
<varlistentry id="appearance-settings">
<term><guilabel>Dynamic word wrap</guilabel></term>
<listitem><para>If this option is checked, the text lines
will be wrapped at the view border on the screen.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Dynamic word wrap indicators</guilabel></term>
<listitem><para>Choose when the Dynamic word wrap indicators
should be displayed.
</para></listitem></varlistentry>
<varlistentry>
<term><guilabel>Vertically align dynamically wrapped lines
to indentation depth:
</guilabel></term>
<listitem><para>Enables the start of dynamically wrapped
lines to be aligned  vertically to the indentation level of the first
line.  This can help to make code and markup more
readable.</para><para>Additionally, this allows you to
set a maximum width of the screen, as a percentage,
after which dynamically wrapped lines will no longer be vertically aligned.
For example, at 50%, lines whose indentation levels are deeper than 50% of the
width of the screen will not have vertical alignment applied to subsequent
wrapped lines.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Code Folding</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Show folding markers (if available)
</guilabel></term>
<listitem><para>If this option is checked, the current view will display marks
for code folding, if code folding is available.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Borders</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Show icon border
</guilabel></term>
<listitem><para>If this is checked, you will see an icon border on the left
hand side. The icon border shows bookmark signs for instance.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show line numbers
</guilabel></term>
<listitem><para>If this is checked, you will see line numbers on the left
hand side.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show scrollbar marks
</guilabel></term>
<listitem><para>If this option is checked the current view
will show marks on the vertical scrollbar. These marks will
for instance show bookmarks.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Sort Bookmarks Menu
</guilabel></term>
<listitem><para>
<variablelist>
<varlistentry>
<term><guilabel>By position
</guilabel></term>
<listitem><para>The bookmarks will be ordered by the line
numbers they are placed at.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>By creation
</guilabel></term>
<listitem><para>Each new bookmark will be added to the bottom,
independently from where it is placed in the document.</para></listitem>
</varlistentry>
</variablelist>
</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Show identation lines
</guilabel></term>
<listitem><para>If this is checked, the editor wil display
vertical lines to help identifying indent lines.</para></listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="prefcolors">
<title>Fonts &amp; Colors</title>

<para>This section of the dialog lets you configure all fonts and colors in
any color scheme you have, as well creating new schemes or deleting existing
ones. Each scheme has settings for colors, fonts and normal and highlight text
styles.
</para>

<para>&kwrite; will preselect the currently active scheme for you, if you want to
work on a different scheme start by selecting that from the
<guilabel>Schema</guilabel> combobox.</para>

<sect2 id="prefcolors-colors">
<title>Colors</title>

<variablelist>
<varlistentry id="prefcolors-colors-text-background">
<term><guilabel>Text Area Background</guilabel></term>
<listitem>

<variablelist>

<varlistentry id="pref-colors-normal-text">
<term><guilabel>Normal text</guilabel></term>
<listitem><para>This is the default background for the editor area, it will be
the dominant color on the editor area.</para></listitem>
</varlistentry>

<varlistentry id="pref-colors-selected-text">
<term><guilabel>Selected Text</guilabel></term>
<listitem><para>This is the background for selected text. The default is
the global selection color, as set in your &tde; color preferences.
</para></listitem>
</varlistentry>

<varlistentry id="pref-colors-current-line">
<term><guilabel>Current Line</guilabel></term>
<listitem><para>Set the color for the current line. Setting this a bit different
from the Normal text background helps to keep focus on the current line.
</para></listitem>
</varlistentry>

<varlistentry id="pref-colors-marks">
<term><guilabel>Bookmark</guilabel></term>
<listitem><para>This combo lets you set overlay colors for various mark types.
The color is mixed into the background color of a marked line, so that a line
with more marks or a marked line that is current has a background that is a mix
of more colors. The mark colors are also used if you enable display of scrollbar
marks.</para></listitem>
</varlistentry>

</variablelist>
</listitem>
</varlistentry>

<varlistentry id="prefcolors-colors-other-elements">
<term><guilabel>Other Elements</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Left Border Background</guilabel></term>
<listitem><para>This color is used for the marks, line numbers and folding
marker borders in the left side of the editor view when they are displayed.
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Line Numbers</guilabel></term>
<listitem><para>This color is used to draw the line numbers on the left side of
the view when displayed.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Bracket Highlight</guilabel></term>
<listitem><para>This color is used to draw the background of matching brackets.
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Word Wrap Markers</guilabel></term>
<listitem><para>This color is used to draw a pattern to the left of dynamically
wrapped lines when those are aligned vertically, as well as for the static word
wrap marker.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Tab Markers</guilabel></term>
<listitem><para>This color is used to draw white space indicators when enabled.
</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

</variablelist>
</sect2>

<sect2 id="prefcolors-fonts">
<title>Fonts</title>
<para>
Here you can choose the font for the schema.  You can choose from
any font available on your system, and set a default size. A sample text
displays at the bottom of the dialog, so you can see the effect of your choices.
</para>
</sect2>

<sect2 id="prefcolors-normal-text-styles">
<title>Normal Text Styles</title>
<para>The normal text styles are inherited by the highlight text styles,
allowing the editor to present text in a very consistent way, for example comment
text is using the same style in allmost all of the text formats that kate can
highlight.</para>
<para>The name in the list of styles is using the style configured for
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
context menu.</para>
</sect2>

<sect2 id="prefcolors-highlighting-text-styles">
<title>Highlighting Text Styles</title>
<para>Here you can edit the text styles used by a specific highlight definition.
The editor preselects the highlight used by your current document. To work on a
different highlight, select one in the <guilabel>Highlight</guilabel> combobox
above the style list.
</para>
<para>The name in the list of styles is using the style configured for
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
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
by groups in the style list. For example most highlights import the Alert
highlight, and many source code formats imports the Doxygen highlight. Editing
colors in those groups only affects the styles when used in the edited highlight
format.
</para>
</sect2>

</sect1>

<sect1 id="pref-cursor-selection">
<title>Cursor &amp; Selection</title>

<variablelist>

<varlistentry>
<term><guilabel>Text Cursor Movement</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Smart home</guilabel></term>
<listitem>
<para>When selected, pressing the home key will cause the cursor to
skip white space and go to the start of a line's text.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Wrap cursor</guilabel></term>
<listitem>
<para>When on, moving the insertion cursor using the <emphasis
role="bold">Left</emphasis> and <emphasis role="bold">Right</emphasis> keys will
go on to previous/next line at beginning/end of the line, similar to most
editors.</para><para>When off, the insertion cursor cannot be moved left of the
line start, but it can be moved off the line end, which can be very handy for
programmers. When this option is chosen, moving the cursor with the arrow keys
off the end of a line (to the right) causes it to jump down to the beginning of
the next line. Likewise when the cursor is moved past the beginning of a line
(to the left) it jumps up to the end of the preceding line. When this option is
not selected, moving the cursor right past the end of a line merely causes it to
continue horizontally in the same line and trying to move it left past the
beginning does nothing.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Page Up/Page Down moves cursor</guilabel></term>
<listitem>
<para>This option changes the behavior of the cursor when the user presses
the <keycap>Page Up</keycap> or <keycap>Page Down</keycap> key. If unselected
the text cursor will maintain its relative position within the visible text in
&kwrite; as new text becomes visible as a result of the operation.  So if the
cursor is in the middle of the visible text when the operation occurs it will
remain there (except when one reaches the beginning or end.)  With this option
selected, the first key press will cause the cursor to move to either the top or
bottom of the visible text as a new page of text is displayed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Autocenter cursor (lines):</guilabel></term>
<listitem>
<para>Sets the number of lines to maintain visible above and below the cursor
when possible.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Selection Mode</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Normal</guilabel></term>
<listitem>
<para>Selections will be overwritten by typed text and will be lost on
cursor movement.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Persistent</guilabel></term>
<listitem>
<para>Selections will stay even after cursor movement and typing.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

</variablelist>
</sect1>

<sect1 id="pref-edit">
<title>Editing</title>
<variablelist>

<varlistentry>
<term><guilabel>Tabulators</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Insert spaces instead of tabulators</guilabel></term>
<listitem>
<para>When this is enabled the editor will insert a calculated number of spaces
according to the position in the text and the <option>tab-width</option> setting
when you press the <keycap>TAB</keycap> key.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show tabulators</guilabel></term>
<listitem>
<para>When this is enabled &kwrite; will display a small dot as a visual
representation of tabulator characters.</para>
<note><para>This also causes dots to be drawn to indicate trailing white space.
This will be fixed in a future version of &kwrite;</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term id="pref-tab-width">Tab Width</term> <listitem><para>If the
<link  linkend="pref-word-wrap"><guilabel>Replace Tabs By
Spaces</guilabel></link>
option is selected this entry determines the number of
spaces with which the editor will automatically replace
tabs.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term id="pref-word-wrap"><guilabel>Static Word Wrap</guilabel></term>
<listitem><para>
Word wrap is a feature that causes the editor to automatically start a new line
of text and move (wrap) the cursor to the beginning of that new line.  &kwrite;
will automatically start a new line of text when  the current line reaches the
length specified by the <link linkend="pref-wrap-words-at">Wrap Words
At:</link> option.</para>
<variablelist>
<varlistentry>
<term><guilabel>Enable static word wrap</guilabel></term>
<listitem>
<para>Turns static word wrap on or off.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Show static word wrap markers
(if applicable)</guilabel></term>
<listitem>
<para>If this option is checked, a vertical line will be drawn at the word wrap
column as defined in the <menuchoice> <guimenu>Settings</guimenu>
<guimenuitem>Configure Editor...</guimenuitem></menuchoice> in the Editing tab.
Please note that the word wrap marker is only drawn if you use a fixed pitch
font.</para>
</listitem>
</varlistentry>
<varlistentry>
<term id="pref-wrap-words-at"><guilabel>Wrap words at:</guilabel></term>
<listitem>
<para>If the <link linkend="pref-word-wrap">Word Wrap</link> option is selected
this entry  determines the length (in characters) at which the editor will
automatically start a new line.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Remove Trailing Spaces</guilabel></term>
<listitem><para>&kwrite; will automatically eliminate extra spaces
at the ends of lines of text.</para></listitem> </varlistentry>

<varlistentry>
<term><guilabel>Auto Brackets</guilabel></term> <listitem><para>When
the user types a left bracket ([, (, or {) &kwrite; automatically enters the
right bracket (}, ), or ]) to the right of the cursor.</para></listitem>
</varlistentry>

<varlistentry> <term>Maximum <link linkend="undo">undo</link> steps:</term>
<listitem><para>Here the user may specify the number of steps &kwrite; will
retain in memory for purposes of undoing entries and actions. This means that
the higher the number of steps set the more memory &kwrite; will use for this.
Setting  this entry to 10 would mean that the user would be be able reverse the
last ten operations, <abbrev>i.e.</abbrev> click the <guibutton>undo</guibutton>
button 10 times and obtain results.</para></listitem> </varlistentry>

<varlistentry> <term>Smart search text from:</term>
<listitem><para>This determines where &kwrite; will get the search
text from (this will be automatically entered into the Find Text
dialog):
<itemizedlist>
<listitem><para><emphasis role="bold">Nowhere:</emphasis> Don't guess the search
text.</para></listitem>
<listitem><para><emphasis role="bold">Selection Only:</emphasis> Use
    the current text selection, if available.</para></listitem>
<listitem><para><emphasis role="bold">Selection, then Current Word:</emphasis>
Use the current selection if available, otherwise use the current word.
</para></listitem>
<listitem><para><emphasis role="bold">Current Word
Only:</emphasis> Use the word that    the cursor is currently resting on, if
available.</para></listitem>
<listitem><para><emphasis role="bold">Current Word, then Selection:</emphasis>
Use the current word if    available, otherwise use the current selection.
</para></listitem>
</itemizedlist>
Note that, in all the above modes, if a
search string has not been or cannot be determined, then the Find Text Dialog
will fall back to the last search text.
</para></listitem>
</varlistentry>
<!--<varlistentry>
<term id="pref-replace-tabs-by-spaces"><guilabel>Replace Tabs By
Spaces</guilabel></term> <listitem><para>&kwrite; will replace any tabs  with
the number of spaces indicated in the <link  linkend="pref-tab-width">Tab
Width:</link> entry.</para></listitem>  </varlistentry>

<varlistentry> <term><guilabel>Show Tabs</guilabel></term>
<listitem><para>The editor will display a symbol to indicate
the presence
of a tab in the text.</para></listitem>
</varlistentry>  -->
</variablelist>
</sect1>

<sect1 id="pref-indent">
<title>Indentation</title>
<variablelist>
<varlistentry>
<term><guilabel>Automatic indentation</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>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
<userinput>Normal</userinput>here, and use filetype configurations to set other
indentation modes for text formats like C/C++ code or &XML;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Insert leading Doxygen "*" when typing</guilabel></term>
<listitem>
<para>Automatically insert a leading "*" while typing within a doxygen
style comment. This setting is only enabled when applicable.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Indentation with Spaces</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Use spaces instead of tabs to indent</guilabel></term>
<listitem>
<para>This  replaces tabs with the number of spaces set in <guilabel>Number of
spaces:</guilabel> below.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Emacs style mixed mode</guilabel></term>
<listitem>
<para>Use a mix of tabs and space characters for indentation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Number of spaces:</guilabel></term>
<listitem>
<para>Set the number of spaces you want to use for indentation when you
check <guilabel>Use spaces instead of tabs to indent</guilabel>
above.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Keep Indent Profile</guilabel></term>
<listitem><para>When this is enabled, the editor will not unindent lines in a
selection further when the line with the least indentation becomes unindented.
If you sometimes unindent blocks of indented code, this may be helpful.
</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Keep Extra Spaces</guilabel></term>
<listitem><para>Indentations of more than the selected number of spaces
will not be shortened.</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Keys to use</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Tab key indents</guilabel></term>
<listitem>
<para>This  allows the <keycombo
action="simul"><keycap>tab</keycap></keycombo> key to be used to indent.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Backspace key indent</guilabel></term>
<listitem>
<para>This allows the <keycombo
action="simul"><keycap>backspace</keycap></keycombo> key to be used to
indent.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Tab Key Mode if Nothing Selected</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Insert indent characters</guilabel></term>
<listitem>
<para>This allows the <keycombo
action="simul"><keycap>Tab</keycap></keycombo> key insert indent
characters.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Insert tab character</guilabel></term>
<listitem>
<para>This allows the <keycombo
action="simul"><keycap>Tab</keycap></keycombo> key insert a tab.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Indent current line</guilabel></term>
<listitem>
<para>This allows the <keycombo
action="simul"><keycap>Tab</keycap></keycombo> key indent the current
line.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<!--<varlistentry>
<term><guilabel>Auto Indent</guilabel></term> <listitem><para>This causes
new lines to begin with the same indentation level as the previous
line.</para></listitem>
</varlistentry>  -->
</variablelist>
</sect1>

<sect1 id="pref-open-save">
<title>Open &amp; Save</title>

<variablelist>

<varlistentry>
<term><guilabel>File Format</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Encoding:</guilabel></term>
<listitem>
<para>This sets the default character encoding for your files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>End of line:</guilabel></term>
<listitem>
<para>Choose your prefered end of line mode for your active
document. You have the choice between &UNIX;, DOS/&Windows; or Macintosh.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Automatic end of line detection</guilabel></term>
<listitem>
<para>Check this if you want the editor to autodetect the end of line
type. The first found end of line type will be used for the whole file.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Memory Usage</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Maximum loaded blocks per file:</guilabel></term>
<listitem>
<para>The editor will load given number of blocks (of around 2048 lines) of
text into memory;  if the filesize is bigger than this the other blocks
are swapped to disk and loaded transparently as-needed.</para>
<para>This can cause little delays while navigating in the document; a
larger block count increases the editing speed at the cost of memory.
</para><para>For normal usage, just choose the highest possible block count:
limit it only if you have problems with the memory usage.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Automatic Cleanups on Load/Save</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<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>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Folder Config File</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>Search depth for config file:</guilabel></term>
<listitem>
<para>The editor will search the given number of folder levels upwards
for &kwrite; config file and load the settings line from it.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Backup on Save</guilabel></term>
<listitem><para>Backing up on save will cause &kwrite; to copy the disk file to
&lt;prefix&gt;&lt;filename&gt;&lt;suffix&gt;' before saving changes.
The suffix defaults to <emphasis role="bold">~</emphasis> and prefix is empty by
default.</para>
<variablelist>
<varlistentry>
<term><guilabel>Local files</guilabel></term>
<listitem>
<para>Check this if you want backups of local files when
saving.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Remote files</guilabel></term>
<listitem>
<para>Check this if you want backups of remote files when saving.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Prefix</guilabel></term>
<listitem>
<para>Enter the prefix to prepend to the backup file names.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Suffix</guilabel></term>
<listitem>
<para>Enter the suffix to add to the backup file names.</para>
</listitem>
</varlistentry>

</variablelist>
</listitem>
</varlistentry>

</variablelist>
</sect1>

<sect1 id="pref-highlighting">
<title>Highlighting</title>
<para>This group of options is used to customize the highlighting styles for
each programming language type. Any changes you made in other areas of this
dialog apply only to this type.</para>

<variablelist>
<varlistentry>
<term><guilabel>Highlight:</guilabel></term>
<listitem><para>This is used to choose the language type to
configure.</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Informations</guilabel></term>
<listitem>
<para>
View the properties of the chosen language highlighting rules:
author name and license.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Properties</guilabel></term>
<listitem>
<variablelist>
<varlistentry>
<term><guilabel>File extensions:</guilabel></term>
<listitem><para>This is the list of file extensions used to determine which
files to highlight using the current syntax highlight mode.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>MIME types:</guilabel></term>
<listitem><para>Clicking the wizard button will display a dialog with a list of
all available mime types to choose from.</para><para>The <emphasis
role="bold">File Extensions</emphasis> entry will automatically be edited as
well.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Priority:</guilabel></term>
<listitem><para>Set the priority of the highlight rule.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>

<varlistentry>
<term><guibutton>Download...</guibutton></term>
<listitem>
<para>
Click this button to download new or updated syntax highlight descriptions
from the &kate; website.
</para>
</listitem>
</varlistentry>

</variablelist>
<!-- obsolete annma 24 December 2005
<para>The <guilabel>Configure
Highlighting</guilabel> dialog consists of
two pages, <guilabel>Defaults</guilabel> and <guilabel>Highlighting
Modes</guilabel>. The user can select which page to view by
clicking on the appropriate tab at the top of the dialog</para>

<para>Items available on the <guilabel>Defaults</guilabel> page are as
follows:</para>

<variablelist>
<varlistentry>
<term><guilabel>Default Item Styles</guilabel></term>
<listitem>
<para>
The user can configure the default appearance for
particular items. This would allow a programmer to more easily identify
different items (types of entries) in their code.
</para>

<variablelist>
<varlistentry>
<term><guilabel>Item</guilabel></term>
<listitem><para>This drop down box offers a variety of items that the user
might want to highlight.  They include <guilabel>Normal</guilabel> for
text does not fit in any of the other categories, <guilabel>Comment</guilabel>,
<guilabel>String</guilabel>, <guilabel>Keyword</guilabel> and many more.  Not
all of these entries will need to be configured for every language and so may be
selected as needed.  The options in the rest of this section apply
to the entry selected in this box.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Normal</guilabel></term>
<listitem><para>This allows the user to choose the
item's normal (unselected) color.  This is done by means
of a color selection dialog box, a further explanation of which
may be found in the <link linkend="prefcolors">Colors</link> section of <link
linkend="pref-dialog">Configure &kwrite;</link>.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Bold</guilabel></term>
<listitem><para>This option determines whether or
not the item should be displayed in bold text.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Italic</guilabel></term>
<listitem><para>This option determines whether or
not the item should be displayed in italic text.</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Selected</guilabel></term>
<listitem><para>This allows the user to choose the
item's color when selected.  This is done by means of a
color selection dialog box, a further explanation of which
may be found in the <link linkend="prefcolors">Colors</link> section of <link
linkend="pref-dialog">Configure &kwrite;</link>.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>

<para>Items on the <guilabel>Highlight Modes</guilabel> tab allow the
user to define more specific highlighting depending on the language
style.</para>

<para>One need not set every available option, items not configured
specifically will use the default configuration specified on the
previous <guilabel>Defaults</guilabel> tab.</para>

<variablelist>
<varlistentry>
<term><guilabel>Config Select</guilabel></term>
<listitem><para>This group of options is used to customize the
highlighting styles for each programming language type.  Any changes you
made in other areas of this dialog apply only to this
type.</para>

<variablelist>
<varlistentry>
<term><guilabel>Highlight</guilabel></term>
<listitem><para>This is used to choose the language
type to  configure</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Item</guilabel></term>
<listitem><para>This is to choose the syntax item to
configure.  Remember this  only configures
<emphasis>this</emphasis> item for
<emphasis>this</emphasis>
language.</para></listitem>
</varlistentry>
</variablelist>

<para>As an example, if the user wished to configure the
appearance of <quote>comments</quote> while writing C++, she or he
could choose C++ in the <guilabel>Highlight</guilabel> drop down box, and then
choose Comment in the <guilabel>Item</guilabel> drop down box. To have
<quote>comments</quote> look the same across all languages, the user would need
to configure this in the <guilabel>Defaults</guilabel> page of this dialog box
while leaving <quote>comments</quote> unconfigured within the more
specific <guilabel>Highlight Modes</guilabel> page.</para>
</listitem> </varlistentry>

<varlistentry>
<term><guilabel>Item Style</guilabel></term>
<listitem><para>Here the user can configure the general
appearance of the above
selected item.  Checking the
<guilabel>Default</guilabel> check box causes the
default style as configured on the previous tab to be set, or
the appearance can be configured directly.  The available
options are the same as on the
<guilabel>Defaults</guilabel> tab:
<guilabel>Normal</guilabel>,
<guilabel>Selected</guilabel>, <guilabel>Bold</guilabel>
and <guilabel>Italic</guilabel>.</para></listitem>
</varlistentry>

<varlistentry>
<term><guilabel>Highlight Auto Select</guilabel></term>
<listitem><para>&kwrite; can apply syntax highlighting
automatically, depending on the file extension or mime-type of the opened file.
The defaults are fairly comprehensive, but users that regularly edit files with
non-standard extensions can add them here.  Wildcards are allowed in the
<guilabel>File Extensions</guilabel> text box.  For example, the
default entry for the C++ language is
<userinput>*.cpp;*.cc;*.C;*.h</userinput>. Opening a file called
<filename>foo.h</filename> would automatically apply the
C++ style to it.
</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Item Font</guilabel></term>
<listitem><para>Here the user can choose the font for the
selected item.</para>
<para>The default style can be applied by checking the
<guilabel>Default</guilabel> check box or the user can
choose a specific font
<guilabel>Family</guilabel>, <guilabel>Size</guilabel>
and <guilabel>Charset</guilabel>.  The available options are
the same as those on the <guilabel>Defaults</guilabel> tab.</para></listitem>
</varlistentry>
</variablelist>-->
</sect1>

<sect1 id="pref-filetypes">
<title>Filetypes</title>
<para>This page allows you to override the default configuration for documents
of specified mimetypes. When the editor loads a document, it will try if it
matches the file masks or mimetypes for one of the defined filetypes, and if so
apply the variables defined. If more filetypes match, the one with the highest
priority will be used.
</para>
<variablelist>
<varlistentry>
<term><guilabel>Filetype:</guilabel></term>
<listitem><para>The filetype with the highest priority is the one displayed in
the first drop down box. If more filetypes were found, they are
also listed.</para>
<variablelist>
<varlistentry>
<term><guilabel>New</guilabel></term>
<listitem><para>This is used to create a new filetype. After
you click on this button, the fields below get empty and you
can fill the properties you want for the new filetype.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Delete</guilabel></term>
<listitem><para>To remove an existing filetype, select it from the drop down
box and press the Delete button.</para></listitem>
</varlistentry>
</variablelist>
</listitem> </varlistentry>

<varlistentry>
<term><guilabel>Properties of current filetype</guilabel></term>
<listitem><para>The filetype with the highest priority is the one displayed in
the first drop down box. If more filetypes were found, they are also
listed.</para>
<variablelist>
<varlistentry>
<term><guilabel>Name:</guilabel></term>
<listitem><para>The name of the filetype will be the text of the corresponding
menu item. This name is displayed in the
<menuchoice><guimenu>Tools</guimenu><guimenuitem>Filetypes</guimenuitem>
</menuchoice ></para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Section:</guilabel></term>
<listitem><para>The section name is used to organize the file types in
menus. This is also used in the
<menuchoice><guimenu>Tools</guimenu><guimenuitem>Filetypes</guimenuitem>
</menuchoice> menu.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Variables:</guilabel></term>
<listitem><para>This string allows you to configure &kwrite;'s settings for the
files selected by this mimetype using &kwrite; variables. You can set almost any
configuration option, such as highlight, indent-mode, encoding,
etc.</para><para>For a full list of known variables, see the
manual.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>File extensions:</guilabel></term>
<listitem><para>The wildcards mask allows you to select files by filename. A
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>

</variablelist>
</sect1>

<sect1 id="pref-shortcuts">
<title>Shortcuts</title>
<para>You can change here the shortcut keys configuration. Select an
action and click on <guilabel>Custom</guilabel> if you want a different shortcut
for this action.</para>
<para>The search line alllows you to look for a specific action and see
its associated shortcut.</para>
</sect1>

<sect1 id="pref-plugins">
<title>Plugins</title>
<para>This tab lists all available plugins and you can check those you
want to use. Once a plugin is checked, the
<guibutton>Configure</guibutton> button is enabled and you can click it
in order to configure the highlighted plugin.</para>
</sect1>
</chapter>

<chapter id="credits">
<title>Credits and Licenses</title>

<para>&kwrite; Copyright 2001 by the &kate; team.</para>

<para>
Based on the original &kwrite;, which was Copyright 2000 by Jochen Wilhelmy
<email>digisnap@cs.tu-berlin.de</email>
</para>

<para>Contributions:</para>

<itemizedlist>
<listitem>
<para>&Christoph.Cullmann; &Christoph.Cullmann.mail;</para>
</listitem>

<listitem>
<para>Michael Bartl <email>michael.bartl1@chello.at</email></para>
</listitem>

<listitem>
<para>Phlip <email>phlip_cpp@my-deja.com</email></para>
</listitem>

<listitem>
<para>&Anders.Lund; &Anders.Lund.mail;</para>
</listitem>

<listitem>
<para>Matt Newell <email>newellm@proaxis.com</email></para>
</listitem>

<listitem>
<para>&Joseph.Wenninger; &Joseph.Wenninger.mail;</para>
</listitem>

<listitem>
<para>Jochen Wilhely <email>digisnap@cs.tu-berlin.de</email></para>
</listitem>

<listitem>
<para>&Michael.Koch; &Michael.Koch.mail;</para>
</listitem>

<listitem>
<para>&Christian.Gebauer; &Christian.Gebauer.mail;</para>
</listitem>

<listitem>
<para>&Simon.Hausmann; &Simon.Hausmann.mail;</para>
</listitem>

<listitem>
<para>Glen Parker <email>glenebob@nwlink.com</email></para>
</listitem>

<listitem>
<para>Scott Manson <email>sdmanson@altel.net</email></para>
</listitem>

<listitem>
<para>&John.Firebaugh; &John.Firebaugh.mail;</para>
</listitem>
</itemizedlist>

<para>
Original documentation by &Thad.McGinnis; &Thad.McGinnis.mail;
</para>

<para>
Updated  by &Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; and
&Anders.Lund; &Anders.Lund.mail;
</para>

<para>
This version of the &kwrite; Handbook is based on the original by
&Cristian.Tibirna; &Cristian.Tibirna.mail;
</para>

<para>
Converted to docbook/proofreading by &Lauri.Watts; &Lauri.Watts.mail;
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;
&underGPL;
</chapter>

&documentation.index;
</book>