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
|
<?xml version="1.0" encoding="utf-8"?>
<?xml-model href="http://docbook.org/xml/5.0/rng/dbits.rng" schematypens="http://relaxng.org/ns/structure/1.0"?>
<!--
(Do not remove this comment block.)
Maintained by the MATE Documentation Project
http://wiki.mate-desktop.org/dev-doc:doc-team-guide
Template version: 2.0 beta
Template last modified Jan 30, 2002
-->
<?db.chunk.max_depth 2?>
<article xmlns="http://docbook.org/ns/docbook"
xmlns:db="http://docbook.org/ns/docbook"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0" xml:id="index" xml:lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
<info>
<title>Pluma Manual</title>
<copyright its:translate="no">
<year>2015-2020</year>
<holder>MATE Documentation Project</holder>
</copyright>
<copyright its:translate="no">
<year>2007</year>
<holder>GNOME Documentation Project</holder>
</copyright>
<copyright its:translate="no">
<year>2002</year>
<year>2003</year>
<year>2004</year>
<holder>Sun Microsystems</holder>
</copyright>
<copyright its:translate="no">
<year>2000</year>
<holder>Eric Baudais</holder>
</copyright>
<publisher>
<publishername>MATE Documentation Project</publishername>
</publisher>
<publisher>
<publishername>GNOME Documentation Project</publishername>
</publisher>
<xi:include href="legal.xml"/>
<authorgroup its:translate="no">
<author>
<orgname its:translate="yes">MATE Documentation Project</orgname>
<affiliation>
<orgname its:translate="yes">MATE Desktop</orgname>
</affiliation>
</author>
<author>
<personname>
<firstname>Joachim</firstname>
<surname>Noreiko</surname>
</personname>
</author>
<author>
<orgname its:translate="yes">GNOME Documentation Project</orgname>
<affiliation>
<orgname its:translate="yes">GNOME</orgname>
</affiliation>
</author>
<author>
<personname>
<firstname>Hal</firstname>
<surname>Canary</surname>
</personname>
<contrib its:translate="yes">Added the Shortcut Keys Table</contrib>
</author>
<author>
<orgname its:translate="yes">Sun Java Desktop System Documentation Team</orgname>
<affiliation>
<orgname its:translate="yes">Sun Microsystems</orgname>
</affiliation>
<email>gdocteam@sun.com</email>
</author>
<author>
<personname>
<firstname>Eric</firstname>
<surname>Baudais</surname>
</personname>
<affiliation>
<orgname its:translate="yes">GNOME Documentation Project</orgname>
</affiliation>
<email>baudais@okstate.edu</email>
</author>
<othercredit role="other">
<personname>
<firstname>Baris</firstname>
<surname>Cicek</surname>
</personname>
<contrib its:translate="yes">Provided information from earlier revisions of the pluma application.</contrib>
</othercredit>
<othercredit role="other">
<personname>
<firstname>George</firstname>
<surname>Ajit</surname>
</personname>
<contrib its:translate="yes">Provided information about plugins.</contrib>
</othercredit>
</authorgroup>
<!-- According to GNU FDL, revision history is mandatory if you are
modifying/reusing someone else's document. If not, you can omit it. -->
<revhistory its:translate="no">
<!-- Remember to remove the &manrevision; entity from the revision
entries other than the current revision. -->
<revision>
<revnumber>1.0</revnumber>
<date>2000</date>
<revdescription>
<para role="author" its:translate="no">Eric Baudais <email>baudais@okstate.edu</email></para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.0</revnumber>
<date its:translate="yes">March 2002</date>
<revdescription>
<para role="author" its:translate="yes">Sun GNOME Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.1</revnumber>
<date its:translate="yes">June 2002</date>
<revdescription>
<para role="author" its:translate="yes">Sun GNOME Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.2</revnumber>
<date its:translate="yes">August 2002</date>
<revdescription>
<para role="author" its:translate="yes">Sun GNOME Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.3</revnumber>
<date its:translate="yes">September 2002</date>
<revdescription>
<para role="author" its:translate="yes">Sun GNOME Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.4</revnumber>
<date its:translate="yes">January 2003</date>
<revdescription>
<para role="author" its:translate="yes">Sun GNOME Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.5</revnumber>
<date its:translate="yes">March 2003</date>
<revdescription>
<para role="author" its:translate="yes">Sun GNOME Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.6</revnumber>
<date its:translate="yes">September 2003</date>
<revdescription>
<para role="author" its:translate="yes">Sun GNOME Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.7</revnumber>
<date its:translate="yes">March 2004</date>
<revdescription>
<para role="author" its:translate="yes">Sun GNOME Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.8</revnumber>
<date its:translate="yes">July 2015</date>
<revdescription>
<para role="author" its:translate="yes">Sun Java Desktop System Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>2.9</revnumber>
<date its:translate="yes">July 2006</date>
<revdescription>
<para role="author" its:translate="yes">GNOME Documentation Team</para>
<para role="publisher" its:translate="yes">GNOME Documentation Project</para>
</revdescription>
</revision>
<revision>
<revnumber>3.0</revnumber>
<date its:translate="yes">July 2015</date>
<revdescription>
<para role="author" its:translate="yes">MATE Documentation Team</para>
<para role="publisher" its:translate="yes">MATE Documentation Project</para>
</revdescription>
</revision>
</revhistory>
<releaseinfo>This manual describes version 1.10 of pluma.</releaseinfo>
</info>
<indexterm>
<primary>pluma</primary>
</indexterm>
<indexterm>
<primary>text editor</primary>
</indexterm>
<!-- ============= Document Body ========================================= -->
<!-- ============= Introduction ========================================== -->
<section xml:id="pluma-intro">
<info>
<title>Introduction</title>
</info>
<!-- removed ids, here as anchors to prevent possible breakage -->
<anchor xml:id="pluma-customize-toolbar"/>
<para>The <application>pluma</application> application enables you to create and edit text files.</para>
<para>The aim of <application>pluma</application> is to be a simple and easy to use text editor. More powerful features can be enabled with different <firstterm>plugins</firstterm>, allowing a variety of tasks related to text-editing.</para>
</section>
<!-- ============= Getting Started ======================================= -->
<section xml:id="pluma-getting-started">
<info>
<title>Getting Started</title>
</info>
<!-- ============= To Start pluma ==================================== -->
<section xml:id="pluma-to-start">
<info>
<title>Starting pluma</title>
</info>
<para>You can start <application>pluma</application> in the following ways:</para>
<variablelist>
<varlistentry>
<term>
<guimenu>Applications</guimenu> menu</term>
<listitem>
<para>Choose <menuchoice> <guisubmenu>Accessories</guisubmenu> <guimenuitem>Pluma Text Editor</guimenuitem> </menuchoice>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Command line</term>
<listitem>
<para>Execute the following command: <command>pluma</command></para>
</listitem>
</varlistentry>
</variablelist>
<para>By default, when you open a text document in the file manager, pluma will start, and display the document.</para>
</section>
<section xml:id="pluma-when-you-start">
<info>
<title>The pluma Window</title>
</info>
<para>When you start <application>pluma</application>, the following window is displayed:</para>
<figure xml:id="pluma-window" its:translate="no">
<info>
<title its:translate="yes">pluma Window</title>
</info>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/pluma_window.png" format="PNG"/>
</imageobject>
<textobject>
<phrase its:translate="yes">Shows pluma main window.</phrase>
</textobject>
</mediaobject>
</screenshot>
</figure>
<para>The <application>pluma</application> window contains the following elements:</para>
<variablelist>
<varlistentry>
<term>Menubar</term>
<listitem>
<para>The menus on the menubar contain all the commands you need to work with files in <application>pluma</application>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Toolbar</term>
<listitem>
<para>The toolbar contains a subset of the commands that you can access from the menubar.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Display area</term>
<listitem>
<para>The display area contains the text of the file that you are editing.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Statusbar</term>
<listitem>
<para>The statusbar displays information about current <application>pluma</application> activity and contextual information about the menu items. The statusbar also displays the following information:</para>
<itemizedlist>
<listitem>
<para>Cursor position: the line number and column number where the cursor is located.</para>
</listitem>
<listitem>
<para>Edit mode: If the editor is in insert mode, the statusbar contains the text <guilabel>INS</guilabel>. If the editor is in overwrite mode, the statusbar contains the text <guilabel>OVR</guilabel>. Press the <keycap>Insert</keycap> key to change edit mode.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term>Side Pane</term>
<listitem>
<para>The side pane displays a list of open documents, and other information depending on which plugins are enabled.</para>
<para>By default, the side pane is not shown. To show it, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Side Pane</guimenuitem> </menuchoice>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Bottom Pane</term>
<listitem>
<para>The bottom pane is used by programming tools such as the <application>Python Console</application> plugin to display output.</para>
<para>By default, the bottom pane is not shown. To show it, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Bottom Pane</guimenuitem> </menuchoice>.</para>
</listitem>
</varlistentry>
</variablelist>
<para>When you right-click in the <application>pluma</application> window, the application displays a popup menu. The popup menu contains the most common text editing commands.</para>
<para>Like other MATE applications, actions in <application>pluma</application> can be performed in several ways: with the menu, with the toolbar, or with shortcut keys. Shortcuts keys common to all applications are listed in the <link xlink:href="help:mate-user-guide/shortcuts-apps">User Guide</link>.</para>
</section>
<!-- ============= To Open Multiple Files from the Command Line ====== -->
<section xml:id="pluma-run-from-cmd-line">
<info>
<title>Running pluma from a Command Line</title>
</info>
<para>You can run <application>pluma</application> from a command line and open a single file or multiple files. To open multiple files from a command line, type the following command, then press <keycap>Return</keycap>:</para>
<para>
<command>pluma <replaceable>file1.txt file2.txt file3.txt</replaceable></command>
</para>
<para>Alternatively, you can specify a URI instead of a filename.</para>
<para>Refer to the <link xlink:href="man:pluma"> <citerefentry> <refentrytitle>pluma</refentrytitle> <manvolnum>1</manvolnum> </citerefentry> </link> man page for more information on how to run <application>pluma</application> from a command line.</para>
</section>
</section>
<!-- ================ Usage ============================================== -->
<section xml:id="pluma-usage">
<info>
<title>Working with Files</title>
</info>
<!-- ============= To Create a New File ============================== -->
<section xml:id="pluma-create-new-file">
<info>
<title>Creating a New Document</title>
</info>
<para>To create a new document, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>New</guimenuitem> </menuchoice>. The application displays a new blank document in the <application>pluma</application> window.</para>
</section>
<!-- ============= To Open a File ==================================== -->
<section xml:id="pluma-open-file">
<info>
<title>Opening a File</title>
</info>
<para>To open a file, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Open</guimenuitem> </menuchoice> to display the <guilabel>Open File</guilabel> dialog. Select the file that you want to open, then click <guibutton>Open</guibutton>. The file is displayed in the <application>pluma</application> window.</para>
<para>The application records the paths and filenames of the five most recent files that you edited and displays the files as menu items on the <menuchoice> <guimenu>File</guimenu> </menuchoice> menu. You can also click on the <inlinemediaobject its:translate="no">
<imageobject>
<imagedata fileref="figures/pluma_recent_files_menu_icon.png" format="PNG"/>
</imageobject>
<textobject>
<phrase its:translate="yes">Shows Recent Files menu icon.</phrase>
</textobject>
</inlinemediaobject> icon on the toolbar to display the list of recent files.</para>
<note>
<para>You can open multiple files in <application>pluma</application>. The application adds a tab for each open file to the window. For more on this see <xref linkend="pluma-tabs"/>.</para>
</note>
<tip>
<para>You can type the file location on <guilabel>Open File</guilabel> dialog. To switch between location entry and breadcrumbs, press <keycombo><keycap>Ctrl</keycap><keycap>l</keycap></keycombo>, <keycap>.</keycap>, <keycap>~</keycap> or <keycap>/</keycap>.</para>
</tip>
</section>
<!-- ============= To Save a File ==================================== -->
<section xml:id="pluma-save-file">
<info>
<title>Saving a File</title>
</info>
<para>You can save files in the following ways:</para>
<itemizedlist>
<listitem>
<para>To save changes to an existing file, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Save</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>To save a new file or to save an existing file under a new filename, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Save As</guimenuitem> </menuchoice>. Enter a name for the file in the <guilabel>Save As</guilabel> dialog, then click <guibutton>Save</guibutton>.</para>
</listitem>
<listitem>
<para>To save all the files that are currently open in <application>pluma</application>, choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Save All</guimenuitem> </menuchoice>.</para>
</listitem>
</itemizedlist>
<para>To close all the files that are currently open in <application>pluma</application>, choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Close All</guimenuitem> </menuchoice>.</para>
</section>
<!-- ============= Working with tabs ================================= -->
<section xml:id="pluma-tabs">
<info>
<title>Working With Tabs</title>
</info>
<para>When more than one file is open, <application>pluma</application> shows a <firstterm>tab</firstterm> for each document above the display area. To switch to another document, click on its tab.</para>
<para>To move a document to another <application> pluma</application> window, drag the tab corresponding to the file to the window you want to move it to.</para>
<para>To move a document to a new <application> pluma</application> window, either drag its tab to the desktop, or choose <menuchoice> <guimenu>Documents</guimenu> <guimenuitem>Move to New Window</guimenuitem> </menuchoice>.</para>
</section>
</section>
<section xml:id="working-with-text">
<info>
<title>Working with Text</title>
</info>
<!-- ============= To Edit Text ====================================== -->
<section xml:id="pluma-edit-text">
<info>
<title>Editing Text</title>
</info>
<para>You can edit the text of a file in the following ways:</para>
<itemizedlist>
<listitem>
<para>Type new text from the keyboard. The blinking <firstterm>insertion cursor</firstterm> marks the point where new text appears. To change this, use the arrow keys on the keyboard or click with the mouse.</para>
</listitem>
<listitem>
<para>To copy the selected text to the clipboard, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Copy</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>To delete the selected text from the file and move the selected text to the clipboard, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Cut</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>To permanently delete the selected text from the file, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Delete</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>To insert the contents of the clipboard at the cursor position, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Paste</guimenuitem> </menuchoice>. You must cut or copy text before you can paste text into the file, either from pluma or another application.</para>
</listitem>
<listitem>
<para>To select all the text in a file, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Select All</guimenuitem> </menuchoice>.</para>
</listitem>
</itemizedlist>
</section>
<!-- ============== To Undo or Redo Edits ============================ -->
<section xml:id="pluma-undo-redo-edits">
<info>
<title>Undoing and Redoing Changes</title>
</info>
<para>To undo a change you have made, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Undo</guimenuitem> </menuchoice>. To reverse this action, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Redo</guimenuitem> </menuchoice>.</para>
</section>
</section>
<section xml:id="pluma-find">
<info>
<title>Finding and Replacing</title>
</info>
<para>In <application>pluma</application>, there are two ways of searching for text. You can use the <guilabel>Find</guilabel> dialog to search for a specific piece of text, or <guilabel>Incremental Search</guilabel> to highlight matching text as you type it.</para>
<!-- ============= To Find Text ================================ -->
<section xml:id="pluma-find-text">
<info>
<title>Finding Text</title>
</info>
<para>To search a file for a string of text, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice>
<guimenu>Search</guimenu>
<guimenuitem>Find</guimenuitem>
</menuchoice> to display the <guilabel>Find</guilabel> dialog.</para>
</listitem>
<listitem>
<para>Type the string that you want to find in the <guilabel>Search for</guilabel> field. You can include special characters such as a new line or tab: see <xref linkend="pluma-find-escapes"/>.</para>
</listitem>
<listitem>
<para>Click <guibutton>Find</guibutton> to search the file for the first occurrence of the string after your current cursor position. If <application>pluma</application> finds the string, the application selects first occurrence of the string. Other occurrences of the string are highlighted.</para>
</listitem>
<listitem>
<para>To find the next occurrence of the string, click <guibutton>Find</guibutton> or choose <menuchoice>
<guimenu>Search</guimenu>
<guimenuitem>Find Next</guimenuitem>
</menuchoice>. To find the previous occurrence of the text, choose <menuchoice>
<guimenu>Search</guimenu>
<guimenuitem>Find Previous</guimenuitem>
</menuchoice>.</para>
</listitem>
</orderedlist>
<para>After you have closed the <guilabel>Find</guilabel> dialog, you can still move the selection to other occurrences of the text by choosing <menuchoice>
<guimenu>Search</guimenu>
<guimenuitem>Find Next</guimenuitem>
</menuchoice> and <menuchoice>
<guimenu>Search</guimenu>
<guimenuitem>Find Previous</guimenuitem>
</menuchoice>.</para>
<para>To remove the highlighting from the text, choose <menuchoice>
<guimenu>Search</guimenu>
<guimenuitem>Clear Highlight</guimenuitem>
</menuchoice>.</para>
<para>Refer to the <link xlink:href="man:pcrepattern"> <citerefentry> <refentrytitle>pcrepattern</refentrytitle> <manvolnum>3</manvolnum> </citerefentry> </link> for more information about the syntax and the semantics of the regular expressions supported on <guilabel>Find</guilabel> dialog.</para>
</section>
<section xml:id="pluma-find-incremental">
<info>
<title>Incremental Search</title>
</info>
<para>Incremental search highlights matching text in the document as you type it letter by letter. (This is similar to the search feature in several web browsers.)</para>
<para>To start an incremental search, choose <menuchoice>
<guimenu>Search</guimenu>
<guimenuitem>Incremental Search</guimenuitem>
</menuchoice>. The search box appears at the top of the display area. </para>
<para>Begin typing, and text that matches will be highlighted in the document. The first instance after the cursor position is also selected.</para>
<para>To advance the selection to the next match while keeping the incremental search box open, press <keycombo>
<keycap>Ctrl</keycap>
<keycap>G</keycap>
</keycombo>. Press <keycombo>
<keycap>Ctrl</keycap>
<keycap>Shift</keycap>
<keycap>G</keycap>
</keycombo> to go back to the previous match.</para>
<tip>
<para>You can also use the up and down arrow keys or the mouse wheel to move the selection between matches.</para>
</tip>
</section>
<!-- ============= To Find and Replace Text ========================== -->
<section xml:id="pluma-find-replace-text">
<info>
<title>Replacing Text</title>
</info>
<para>To search a file for a string, and replace the string with an alternative string, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice>
<guimenu>Search</guimenu>
<guimenuitem>Replace</guimenuitem>
</menuchoice> to display the <guilabel>Replace</guilabel> dialog.</para>
</listitem>
<listitem>
<para>Type the string that you want to find, in the <guilabel>Search for</guilabel> field. You can include special characters such as a new line or tab: see <xref linkend="pluma-find-escapes"/>.</para>
</listitem>
<listitem>
<para>Type the string that you want to use to replace the string that you find, in the <guilabel>Replace with</guilabel> field.</para>
</listitem>
</orderedlist>
<para>To examine each occurrence of the string before replacing it, click <guibutton>Find</guibutton>. If <application>pluma</application> finds the string, the application selects the string. Click <guibutton>Replace</guibutton> to replace the selected occurrence of the string. To find the next occurrence of the string, click <guibutton>Find</guibutton> again.</para>
<para>To replace all occurrences of the string throughout the document, click <guibutton>Replace All</guibutton>.</para>
</section>
<!-- ============= Find and Replace Options ============================ -->
<section xml:id="pluma-find-options">
<info>
<title>Find and Replace Options</title>
</info>
<para>The <guilabel>Find</guilabel> dialog and the <guilabel>Replace</guilabel> dialog both have the following options:</para>
<itemizedlist>
<listitem>
<para>Select the <guilabel>Match case</guilabel> option to only find occurrences of the string that match the case of the text that you type. For example, with <guilabel>Match case</guilabel> selected, "TEXT" will not match "text".</para>
</listitem>
<listitem>
<para>Select the <guilabel>Match entire word only</guilabel> option to only find occurrences of the string that match the entire words of the text that you type. For example, with <guilabel>Match entire word only</guilabel> selected, "text" will not match "texture". <!-- translators, please make up your own example ;) --></para>
</listitem>
<listitem>
<para>Select the <guilabel>Search backwards</guilabel> option to search backwards towards the beginning of the document. </para>
</listitem>
<listitem>
<para>Select the <guilabel>Wrap around</guilabel> option to search to one end of the document and then continue the search from the other end of the file. </para>
</listitem>
</itemizedlist>
</section>
<!-- ============= Special Characters ============================ -->
<section xml:id="pluma-find-escapes">
<info>
<title>Special Characters</title>
</info>
<para>You can include the following escape sequences in the text to find or replace to represent special characters:</para>
<variablelist>
<varlistentry>
<term>
<literal>\n</literal>
</term>
<listitem>
<para>Specifies a new line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>\t</literal>
</term>
<listitem>
<para>Specifies a tab character.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>\r</literal>
</term>
<listitem>
<para>Specifies a carriage return.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<literal>\\</literal>
</term>
<listitem>
<para>The backslash character itself must be escaped if it is being searched for.
For example, if you are looking for the "<literal>\n</literal>" literal, you will
have to type "\\n" in the <guilabel>Search for</guilabel> field. Or if you are
looking for a sequence of backslashes, you will have to double the number of
searched backslashes.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- ============= To Position the Cursor on a Specific Line ========= -->
<section xml:id="pluma-goto-line">
<info>
<title>Positioning the Cursor on a Specific Line</title>
</info>
<para>To position the cursor on a specific line in the current file, choose <menuchoice> <guimenu>Search</guimenu> <guimenuitem>Go to Line</guimenuitem> </menuchoice>. The line number box appears at the top of the display area.</para>
<para>Begin typing the number of the line that you want to move the cursor to and the document will scroll to the specified line.</para>
<para>To dismiss the box and move the cursor to the specified line, press <keycap>Return</keycap>.</para>
</section>
</section>
<section xml:id="pluma-printing">
<info>
<title>Printing</title>
</info>
<!-- ============= To Set the Page Options =========================== -->
<section xml:id="pluma-page-setup">
<info>
<title>Setting the Page Options</title>
</info>
<para>To set the page options, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Page Setup</guimenuitem> </menuchoice> to display the <guilabel>Page Setup</guilabel> dialog.</para>
<para>The <guilabel>Page Setup</guilabel> dialog enables you to specify the following print options:</para>
<section xml:id="pluma-page-setup-general">
<info>
<title>General Tabbed Section</title>
</info>
<variablelist>
<varlistentry>
<term>
<guilabel>Print syntax highlighting</guilabel>
</term>
<listitem>
<para>Select this option to print syntax highlighting. For more information about syntax highlighting, see <xref linkend="pluma-set-highlightmode"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Print page headers</guilabel>
</term>
<listitem>
<para>Select this option to include a header on each page that you print. You cannot configure the header. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Line Numbers</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Print line numbers</guilabel> option to include line numbers when you print a file.</para>
<para>Use the <guilabel>Number every ... lines </guilabel> spin box to specify how often to print the line numbers, for example every 5 lines, every 10 lines, and so on.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Text Wrapping</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Enable text wrapping</guilabel> option to wrap text onto the next line, at a character level, when you print a file. The application counts wrapped lines as one line for line numbering purposes.</para>
<para>Select the <guilabel>Do not split words over two lines</guilabel> option to wrap text onto the next line, at a word level, when you print a file.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="pluma-page-setup-fonts">
<info>
<title>Fonts</title>
</info>
<variablelist>
<varlistentry>
<term>
<guilabel>Body</guilabel>
</term>
<listitem>
<para>Click on this button to select the font used to print the body text of a file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Line numbers</guilabel>
</term>
<listitem>
<para>Click on this button to select the font used to print line numbers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Headers and footers</guilabel>
</term>
<listitem>
<para>Click on this button to select the font to use to print the headers and footers in a file. </para>
</listitem>
</varlistentry>
</variablelist>
<para>To reset the fonts to the default fonts for printing a file from <application>pluma</application>, click <guibutton>Restore Default Fonts</guibutton>.</para>
</section>
</section>
<!-- ============= To Print a File ============================ -->
<section xml:id="pluma-print-file">
<info>
<title>Printing a Document</title>
</info>
<para>You can use <application>pluma</application> to perform the following print operations:</para>
<itemizedlist>
<listitem>
<para>Print a document to a printer. </para>
</listitem>
<listitem>
<para>Print the output of the print command to a file.</para>
</listitem>
</itemizedlist>
<para>If you print to a file, <application>pluma</application> sends the output of the file to a pre-press format file. The most common pre-press formats are PostScript and Portable Document Format (PDF).</para>
<para>To preview the pages that you want to print, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print Preview</guimenuitem> </menuchoice>.</para>
<para>To print the current file to a printer or a file, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Print</guimenuitem> </menuchoice> to display the <guilabel>Print</guilabel> dialog.</para>
<para>The <guilabel>Print</guilabel> dialog enables you to specify the following print options:</para>
<section xml:id="print-dialog-job">
<info>
<title>Job Tabbed Section</title>
</info>
<variablelist>
<varlistentry>
<term>
<guilabel>Print range</guilabel>
</term>
<listitem>
<para>Select one of the following options to determine how many pages to print:</para>
<itemizedlist>
<listitem>
<para>
<guilabel>All</guilabel>
</para>
<para>Select this option to print all the pages in the file.</para>
</listitem>
<listitem>
<para>
<guilabel>Lines</guilabel>
</para>
<para>Select this option to print the specified lines only. Use the <guilabel>From</guilabel> and <guilabel>To</guilabel> spin boxes to specify the line range.</para>
</listitem>
<listitem>
<para>
<guilabel>Selection</guilabel>
</para>
<para>Select this option to print the selected text only. This option is only available if you select text.</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Copies</guilabel>
</term>
<listitem>
<para>Use the <guilabel>Number of copies</guilabel> spin box to specify the number of copies of the file that you want to print.</para>
<para>If you print multiple copies of the file, select the <guilabel>Collate</guilabel> option to collate the printed copies.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="print-dialog-printer">
<info>
<title>Printer Tabbed Section</title>
</info>
<variablelist>
<varlistentry>
<term>
<guilabel>Printer</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the printer to which you want to print the file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Settings</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the printer settings.</para>
<para>To configure the printer, click <guibutton>Configure</guibutton>. For example, you can enable or disable duplex printing, or schedule delayed printing, if this functionality is supported by the printer.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Location</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select one of the following print destinations:</para>
<variablelist>
<varlistentry>
<term>
<guilabel>CUPS</guilabel>
</term>
<listitem>
<para>Print the file to a CUPS printer.</para>
<note>
<para>If the selected printer is a CUPS printer, <guilabel>CUPS</guilabel> is the only entry in this drop-down list.</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>lpr</guilabel>
</term>
<listitem>
<para>Print the file to a printer.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>File</guilabel>
</term>
<listitem>
<para>Print the file to a PostScript file.</para>
<para>Click <guibutton>Save As</guibutton> to display a dialog where you specify the name and location of the PostScript file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Custom</guilabel>
</term>
<listitem>
<para>Use the specified command to print the file.</para>
<para>Type the name of the command in the text box. Include all command-line arguments.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>State</guilabel>
</term>
<listitem>
<para>This functionality is not supported in this version of pluma.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Type</guilabel>
</term>
<listitem>
<para>This functionality is not supported in this version of pluma.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Comment</guilabel>
</term>
<listitem>
<para>This functionality is not supported in this version of pluma.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="print-dialog-paper">
<info>
<title>Paper Tabbed Section</title>
</info>
<variablelist>
<varlistentry>
<term>
<guilabel>Paper size</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the size of the paper to which you want to print the file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Width</guilabel>
</term>
<listitem>
<para>Use this spin box to specify the width of the paper. Use the adjacent drop-down list to change the measurement unit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Height</guilabel>
</term>
<listitem>
<para>Use this spin box to specify the height of the paper.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Feed orientation</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the orientation of the paper in the printer.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Page orientation</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the page orientation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Layout</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the page layout. A preview of each layout that you select is displayed in the <guilabel>Preview</guilabel> area.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Paper tray</guilabel>
</term>
<listitem>
<para>Use this drop-down list to select the paper tray.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
</section>
<section xml:id="pluma-programming-features">
<info>
<title>Programming Features</title>
</info>
<para>Several of <application>pluma</application>'s features for programming are provided with plugins. For example, the Tag List plugin provides a list of commonly-used tags for different markup languages: see <xref linkend="pluma-tag-list-plugin"/>.</para>
<!-- ============= Syntax Highlighting ============================== -->
<section xml:id="pluma-set-highlightmode">
<info>
<title>Syntax Highlighting</title>
</info>
<para>Syntax highlighting makes source code easier to read by showing different parts of the text in different colors.</para>
<para><application>pluma</application> chooses an appropriate syntax highlighting mode based on a document's type. To override the syntax highlighting mode, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Highlight Mode</guimenuitem> </menuchoice>, then choose one of the following menu items:</para>
<variablelist>
<varlistentry>
<term>
<guimenuitem>Normal</guimenuitem>
</term>
<listitem>
<para>Do not display any syntax highlighting.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guisubmenu>Sources</guisubmenu>
</term>
<listitem>
<para>Display syntax highlighting to edit source code. Use the <guisubmenu>Sources</guisubmenu> submenu to select the source code type.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guisubmenu>Markup</guisubmenu>
</term>
<listitem>
<para>Display syntax highlighting to edit markup code. Use the <guisubmenu>Markup</guisubmenu> submenu to select the markup code type.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guisubmenu>Scripts</guisubmenu>
</term>
<listitem>
<para>Display syntax highlighting to edit script code. Use the <guisubmenu>Scripts</guisubmenu> submenu to select the script code type.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guisubmenu>Others</guisubmenu>
</term>
<listitem>
<para>Display syntax highlighting to edit other types of code. Use the <guisubmenu>Others</guisubmenu> submenu to select the code type.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- ============= To Pipe the Output of a Command to a File ========= -->
<section xml:id="pluma-pipe-output">
<info>
<title>Piping the Output of a Command to a File</title>
</info>
<para>You can use <application>pluma</application> to pipe the output of a command to a text file. For example, to pipe the output of an <command>ls</command> command to a text file, type <command>ls | pluma</command>, then press <keycap>Return</keycap>.</para>
<para>The output of the <command>ls</command> command is displayed in a new text file in the <application>pluma</application> window.</para>
<para>Alternatively, you can use the <application>External tools</application> plugin to pipe command output to the current file. <!-- fixme: xref needed! --></para>
</section>
</section>
<!-- ================ Shortcut Keys ====================================== -->
<section xml:id="pluma-shortcutkeys">
<info>
<title>Shortcut Keys</title>
</info>
<para>Use shortcut keys to perform common tasks more quickly than with the mouse and menus. The following tables list all of <application>pluma</application>'s shortcut keys.</para>
<para>For more on shortcut keys, see the <link xlink:href="help:mate-user-guide/keyboard-skills">Desktop User Guide</link>.</para>
<!-- ============= Tabs ======================== -->
<bridgehead>Tabs</bridgehead>
<para>Shortcuts for tabs:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para>
</entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para>
</entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry>
<para>Ctrl + Alt + PageUp</para>
</entry>
<entry>
<para>Switches to the next tab to the left.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Alt + PageDown</para>
</entry>
<entry>
<para>Switches to the next tab to the right.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + W</para>
</entry>
<entry>
<para>Close tab.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Shift + L</para>
</entry>
<entry>
<para>Save all tabs.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Shift + W</para>
</entry>
<entry>
<para>Close all tabs. </para>
</entry>
</row>
<row valign="top">
<entry>
<para>Alt + n</para>
</entry>
<entry>
<para>Jump to nth tab.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- ============= Files ======================== -->
<bridgehead>Files</bridgehead>
<para>Shortcuts for working with files:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para>
</entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para>
</entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry>
<para>Ctrl + N</para>
</entry>
<entry>
<para>Create a new document.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + O</para>
</entry>
<entry>
<para>Open a document.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + S</para>
</entry>
<entry>
<para>Save the current document to disk.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Shift + S</para>
</entry>
<entry>
<para>Save the current document with a new filename.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + P</para>
</entry>
<entry>
<para>Print the current document.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Shift + P</para>
</entry>
<entry>
<para>Print preview.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + W</para>
</entry>
<entry>
<para>Close the current document.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Q</para>
</entry>
<entry>
<para>Quit Pluma.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- ============= Edit ======================= -->
<bridgehead>Edit</bridgehead>
<para>Shortcuts for editing documents:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para>
</entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para>
</entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry>
<para>Ctrl + Z</para>
</entry>
<entry>
<para>Undo the last action.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Shift + Z</para>
</entry>
<entry>
<para>Redo the last undone action .</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + X</para>
</entry>
<entry>
<para>Cut the selected text or region and place it on the clipboard.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + C</para>
</entry>
<entry>
<para>Copy the selected text or region onto the clipboard.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + V</para>
</entry>
<entry>
<para>Paste the contents of the clipboard.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + A</para>
</entry>
<entry>
<para>Select all.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + D</para>
</entry>
<entry>
<para>Delete current line.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + U</para>
</entry>
<entry>
<para>Change case to uppercase.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + L</para>
</entry>
<entry>
<para>Change case to lowercase.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Alt + U</para>
</entry>
<entry>
<para>Toggle case of each character.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Alt + L</para>
</entry>
<entry>
<para>Capitalize each word.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Alt + Up</para>
</entry>
<entry>
<para>Move the selected line up one line.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Alt + Down</para>
</entry>
<entry>
<para>Move the selected line down one line.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Tab</para>
</entry>
<entry>
<para>Increase indent of the selected lines.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Shift + Tab</para>
</entry>
<entry>
<para>Decrease indent of the selected lines.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- ============= View ======================= -->
<bridgehead>View</bridgehead>
<para>Shortcuts for the current view:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para>
</entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para>
</entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry>
<para>Ctrl + Y</para>
</entry>
<entry>
<para>Show/hide line numbers.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- ============= Panes ======================= -->
<bridgehead>Panes</bridgehead>
<para>Shortcuts for showing and hiding panes:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para>
</entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para>
</entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry>
<para>F9</para>
</entry>
<entry>
<para>Show/hide the side pane.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + F9</para>
</entry>
<entry>
<para>Show/hide the bottom pane.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- ============= Search ======================= -->
<bridgehead>Search</bridgehead>
<para>Shortcuts for searching:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para>
</entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para>
</entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry>
<para>Ctrl + F</para>
</entry>
<entry>
<para>Find a string.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + G</para>
</entry>
<entry>
<para>Find the next instance of the string.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Shift + G</para>
</entry>
<entry>
<para>Find the previous instance of the string.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + K</para>
</entry>
<entry>
<para>Interactive search.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + H</para>
</entry>
<entry>
<para>Search and replace.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Shift + K</para>
</entry>
<entry>
<para>Clear highlight.</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + I</para>
</entry>
<entry>
<para>Goto line.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- ============= Tools ======================= -->
<bridgehead>Tools</bridgehead>
<para>Shortcuts for tools:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para>
</entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para>
</entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry>
<para>Shift + F7</para>
</entry>
<entry>
<para>Check spelling (with plugin).</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Alt + F12</para>
</entry>
<entry>
<para>Remove trailing spaces (with plugin).</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + T</para>
</entry>
<entry>
<para>Indent (with plugin).</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Shift + T</para>
</entry>
<entry>
<para>Remove Indent (with plugin).</para>
</entry>
</row>
<row valign="top">
<entry>
<para>F8</para>
</entry>
<entry>
<para>Run "make" in current directory (with plugin).</para>
</entry>
</row>
<row valign="top">
<entry>
<para>Ctrl + Shift + D</para>
</entry>
<entry>
<para>Directory listing (with plugin).</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<!-- ============= Help ======================= -->
<bridgehead>Help</bridgehead>
<para>Shortcuts for help:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="50*"/>
<colspec colname="COLSPEC1" colwidth="50*"/>
<thead>
<row valign="top">
<entry colname="COLSPEC0">
<para>Shortcut Key</para>
</entry>
<entry colname="COLSPEC1" align="left">
<para>Command</para>
</entry>
</row>
</thead>
<tbody>
<row valign="top">
<entry>
<para>F1</para>
</entry>
<entry>
<para>Open <application>pluma</application>'s user manual.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<!-- ============= Preferences ============================= -->
<section xml:id="pluma-prefs">
<info>
<title>Preferences</title>
</info>
<para>To configure <application>pluma</application>, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>. The <guilabel>Preferences</guilabel> dialog contains the following categories:</para>
<itemizedlist>
<listitem>
<para>
<xref linkend="pluma-prefs-view"/>
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-prefs-editor"/>
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-prefs-fontsandcolors"/>
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-prefs-plugins"/>
</para>
</listitem>
</itemizedlist>
<section xml:id="pluma-prefs-view">
<info>
<title>View Preferences</title>
</info>
<variablelist>
<varlistentry>
<term>
<guilabel>Text Wrapping</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Enable text wrapping</guilabel> option to have long lines of text flow into paragraphs instead of running off the edge of the text window. This avoids having to scroll horizontally</para>
<para>Select the <guilabel>Do not split words over two lines</guilabel> option to have the text wrapping option preserve whole words when flowing text to the next line. This makes text easier to read.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Line Numbers</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Display line numbers</guilabel> option to display line numbers on the left side of the <application>pluma</application> window. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Current Line</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Highlight current line</guilabel> option to highlight the line where the cursor is placed. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Right Margin</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Display right margin</guilabel> option to display a vertical line that indicates the right margin. </para>
<para>Use the <guilabel>Right margin at column</guilabel> spin box to specify the location of the vertical line. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Bracket Matching</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Highlight matching bracket</guilabel> option to highlight the corresponding bracket when the cursor is positioned on a bracket character. </para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="pluma-prefs-editor">
<info>
<title>Editor Preferences</title>
</info>
<variablelist>
<varlistentry>
<term>
<guilabel>Tabs</guilabel>
</term>
<listitem>
<para>Use the <guilabel>Tab width</guilabel> spin box to specify the width of the space that <application> pluma</application> inserts when you press the <keycap>Tab</keycap> key. </para>
<para>Select the <guilabel>Insert spaces instead of tabs</guilabel> option to specify that <application> pluma</application> inserts spaces instead of a tab character when you press the <keycap>Tab</keycap> key. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Auto Indentation</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Enable auto indentation</guilabel> option to specify that the next line starts at the indentation level of the current line. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>File Saving</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Create a backup copy of files before saving</guilabel> option to create a backup copy of a file each time you save the file. The backup copy of the file contains a ~ at the end of the filename.</para>
<para>Select the <guilabel>Autosave files every ... minutes</guilabel> option to automatically save the current file at regular intervals. Use the spin box to specify how often you want to save the file.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="pluma-prefs-fontsandcolors">
<info>
<title>Font & Colors Preferences</title>
</info>
<variablelist>
<varlistentry>
<term>
<guilabel>Font</guilabel>
</term>
<listitem>
<para>Select the <guilabel>Use default theme font</guilabel> option to use the default system font for the text in the <application>pluma</application> text window. </para>
<para>The <guilabel>Editor font</guilabel> field displays the font that <application>pluma</application> uses to display text. Click on the button to specify the font type, style, and size to use for text. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Color Scheme</guilabel>
</term>
<listitem>
<para>You can choose a color scheme from the list of color schemes. By default, the following color schemes are installed:</para>
<variablelist>
<varlistentry>
<term>
<guilabel>Classic</guilabel>
</term>
<listitem>
<para>Classic color scheme based on the gvim color scheme.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Cobalt</guilabel>
</term>
<listitem>
<para>Blue based color scheme.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Kate</guilabel>
</term>
<listitem>
<para>Color scheme used in the Kate text editor.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Oblivion</guilabel>
</term>
<listitem>
<para>Dark color scheme using the Tango color palette.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<guilabel>Tango</guilabel>
</term>
<listitem>
<para>Color scheme using the Tango color scheme.</para>
</listitem>
</varlistentry>
</variablelist>
<para>You can add a new color scheme by clicking on <guilabel>Add...</guilabel>, and selecting a color scheme file</para>
<para>You can remove the selected color scheme by clicking on <guilabel>Remove</guilabel></para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="pluma-prefs-plugins">
<info>
<title>Plugins Preferences</title>
</info>
<para>Plugins add extra features to <application>pluma</application>. For more information on plugins and how to use the built-in plugins, see <xref linkend="pluma-plugins-overview"/>.</para>
<!-- ============= To Load pluma Plugins ========================= -->
<section xml:id="pluma-install-plugins">
<info>
<title>Enabling a Plugin</title>
</info>
<para>To enable a <application>pluma</application> plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>Select the <guilabel>Plugins</guilabel> tab.</para>
</listitem>
<listitem>
<para>Select the check box next to the name of the plugin that you want to enable.</para>
</listitem>
<listitem>
<para>Click <guibutton>Close</guibutton> to close the <guilabel>Preferences</guilabel> dialog.</para>
</listitem>
</orderedlist>
</section>
<!-- ============= To Remove pluma Plugins ========================= -->
<section xml:id="pluma-remove-plugins">
<info>
<title>Disabling a Plugin</title>
</info>
<para>A plugin remains enabled when you quit <application>pluma</application>. </para>
<para>To disable a <application>pluma</application> plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>Select the <guilabel>Plugins</guilabel> tab. </para>
</listitem>
<listitem>
<para>Deselect the check box next to the name of the plugin that you want to disable.</para>
</listitem>
<listitem>
<para>Click <guibutton>Close</guibutton> to close the <guilabel>Preferences</guilabel> dialog. </para>
</listitem>
</orderedlist>
</section>
</section>
</section>
<!-- ============= To Use the pluma Plugins ========================= -->
<section xml:id="pluma-plugins">
<info>
<title>Plugins</title>
</info>
<section xml:id="pluma-plugins-overview">
<info>
<title>Working with Plugins</title>
</info>
<para>You can add extra features to <application>pluma</application> by enabling <firstterm>plugins</firstterm>. A plugin is a supplementary program that enhances the functionality of an application. Plugins add new items to the <application>pluma</application> menus for the new features they provide.
</para>
<para>Several plugins come built-in with <application>pluma</application>.</para>
<para>To enable and disable plugins, or see which plugins are currently enabled, use the <xref linkend="pluma-prefs-plugins"/>.</para>
<para>The following plugins come built-in with <application>pluma</application>:</para>
<!-- Not yet documented:
File browser
-->
<itemizedlist>
<listitem>
<para>
<xref linkend="pluma-document-statistics-plugin"/> shows the number of lines, words, and characters in the document.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-external-tools-plugin"/> allows you to execute external commands from <application>pluma</application>.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-file-browser-plugin"/> allows you to browse your files and folders in the side pane.</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-indent-lines-plugin"/> adds or removes indentation from the selected lines.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-insert-date-time-plugin"/> adds the current date and time into a document.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-modelines-plugin"/> allows you to set editing preferences for individual documents, and supports <application>Emacs</application>, <application>Kate</application> and <application>Vim</application>-style modelines.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-python-console-plugin"/> allows you to run commands in the python programming language.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-trailsave-plugin"/> allows you to strip trailing whitespaces in your document after saving.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-snippets-plugin"/> allows you to store frequently-used pieces of text and insert them quickly into a document.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-sort-plugin"/> arranges selected lines of text into alphabetical order.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-spell-checker-plugin"/> corrects the spelling in the selected text, or marks errors automatically in the document.
</para>
</listitem>
<listitem>
<para>
<xref linkend="pluma-tag-list-plugin"/> lets you insert commonly-used tags for HTML and other languages from a list in the side pane.
</para>
</listitem>
</itemizedlist>
<note>
<para>For more information on creating plugins, see <link xlink:href="https://github.com/mate-desktop/pluma/tree/master/plugins"></link>.</para>
</note>
</section>
<section xml:id="pluma-document-statistics-plugin">
<info>
<title>Document Statistics Plugin</title>
</info>
<para>The <application>Document Statistics</application> plugin counts the number of lines, words, characters with spaces, characters without spaces, and bytes in the current file. The plugin displays the results in a <guilabel>Document Statistics</guilabel> dialog. To use the Document Statistics plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Document Statistics</guimenuitem> </menuchoice> to display the <guilabel>Document Statistics</guilabel> dialog. The <guilabel>Document Statistics</guilabel> dialog displays the following information about the file:</para>
<itemizedlist>
<listitem>
<para>Number of lines in the current document.</para>
</listitem>
<listitem>
<para>Number of words in the current document.</para>
</listitem>
<listitem>
<para>Number of characters, including spaces, in the current document.</para>
</listitem>
<listitem>
<para>Number of characters, not including spaces, in the current document.</para>
</listitem>
<listitem>
<para>Number of bytes in the current document.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>You can continue to update the <application>pluma</application> file while the <guilabel>Document Statistics</guilabel> dialog is open. To refresh the contents of the <guilabel>Document Statistics</guilabel> dialog, click <guibutton>Update</guibutton>.</para>
</listitem>
</orderedlist>
</section>
<section xml:id="pluma-external-tools-plugin">
<info>
<title>External Tools Plugin</title>
</info>
<para>The <application>External Tools</application> plugin allows you to execute external commands from <application>pluma</application>. You can pipe some content into a command and exploit its output (for example, <application>sed</application>), or launch a predefined command (for example, <application>make</application>).</para>
<para>Use the <guilabel>External Tools Manager</guilabel> to create and edit commands. To run an external command, choose it from the <guimenu>Tools</guimenu> menu.</para>
<section xml:id="pluma-external-tools-plugin-builtin">
<info>
<title>Built-in Commands</title>
</info>
<para>The following commands are provided with the <application>External Tools</application> plugin:</para>
<variablelist>
<varlistentry>
<term>Build</term>
<listitem>
<para>Runs <application>make</application> in the current document's directory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Directory Listing</term>
<listitem>
<para>Lists the contents of the current document's directory in a new document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Environment Variables</term>
<listitem>
<para>Displays the environment variables list in the bottom pane.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Grep</term>
<listitem>
<para>Searches for a term in all files in the current document directory, using pattern matching. Results are shown in the bottom pane.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Remove Trailing Spaces</term>
<listitem>
<para>Removes all spaces from the end of lines in the document.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="pluma-external-tools-plugin-define">
<info>
<title>Defining a Command</title>
</info>
<para>To add an external command, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>External Tools</guimenuitem> </menuchoice>.</para>
<para>In the <guilabel>External Tools Manager</guilabel> window, click <guibutton>New</guibutton>. You can specify the following details for the new command:</para>
<variablelist>
<varlistentry>
<term>Description</term>
<listitem>
<para>This description is shown in the statusbar when the menu command is chosen.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Accelerator</term>
<listitem>
<para>Enter a keyboard shortcut for the command.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Commands</term>
<listitem>
<para>The actual commands to be run. Several <application>pluma</application> environment variables can be used to pass content to these commands: see <xref linkend="pluma-external-tools-plugin-variables"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Input</term>
<listitem>
<para>The content to give to the commands (as <systemitem>stdin</systemitem>): the entire text of the current document, the current selection, line, or word.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Output</term>
<listitem>
<para>What to do with the output of the commands: display in the bottom pane, put in a new document, or place in the current document, at the end, at the cursor position, or replacing the selection or the entire document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Applicability</term>
<listitem>
<para>Determines which sort of documents can be affected by the command, for example whether saved or not, and local or remote.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section xml:id="pluma-external-tools-plugin-edit">
<info>
<title>Editing and Removing Tools</title>
</info>
<para>To edit a tool, select it in the list and make changes to its properties.</para>
<para>To rename a tool, click it again in the list.</para>
<para>To restore a built-in tool that you have changed, press <guilabel>Revert</guilabel>.</para>
<para>To remove a tool, select it in the list and press <guibutton>Remove</guibutton>. You can not remove built-in tools, only those you have created yourself.</para>
</section>
<section xml:id="pluma-external-tools-plugin-variables">
<info>
<title>Variables</title>
</info>
<para>You can use the following variables in the <guilabel>Commands</guilabel> field of the command definition:</para>
<itemizedlist>
<listitem>
<para>PLUMA_CURRENT_DOCUMENT_URI</para>
</listitem>
<listitem>
<para>PLUMA_CURRENT_DOCUMENT_NAME</para>
</listitem>
<listitem>
<para>PLUMA_CURRENT_DOCUMENT_SCHEME</para>
</listitem>
<listitem>
<para>PLUMA_CURRENT_DOCUMENT_PATH</para>
</listitem>
<listitem>
<para>PLUMA_CURRENT_DOCUMENT_DIR</para>
</listitem>
<listitem>
<para>PLUMA_DOCUMENTS_URI</para>
</listitem>
<listitem>
<para>PLUMA_DOCUMENTS_PATH</para>
</listitem>
</itemizedlist>
</section>
</section>
<section xml:id="pluma-file-browser-plugin">
<info>
<title>File Browser Pane Plugin</title>
</info>
<para>The <application>File Browser Pane</application> Plugin shows your files and folders in the side pane, allowing you to quickly open files.</para>
<para>To view the File Browser, choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Side Pane</guimenuitem> </menuchoice> and then click on the tab showing the File Browser icon at the bottom of the side pane.</para>
<section xml:id="pluma-file-browser-plugin-browsing">
<info>
<title>Browsing your Files</title>
</info>
<para>The File Browser tab initially shows your file manager bookmarks. To browse the contents of any item, double-click it.</para>
<para>To show a parent folder, choose from the drop-down list, or press the up arrow on the File Browser's toolbar.</para>
<para>To show the folder that contains the document you are currently working on, right-click in the file list and choose <guimenuitem>Set root to active document</guimenuitem>.</para>
</section>
<section xml:id="pluma-file-browser-plugin-open">
<info>
<title>Opening a File</title>
</info>
<para>To open a file in <application>pluma</application>, double-click it in the file list.</para>
</section>
<section xml:id="pluma-file-browser-plugin-create">
<info>
<title>Creating Files and Folders</title>
</info>
<para>To create a new, empty text file in the current folder shown in the browser, right-click in the file list and choose <guimenuitem>New File</guimenuitem>.</para>
<para>To create a new folder in the current folder shown in the browser, right-click in the file list and choose <guimenuitem>New Folder</guimenuitem>.</para>
</section>
</section>
<section xml:id="pluma-indent-lines-plugin">
<info>
<title>Indent Lines Plugin</title>
</info>
<para>The <application>Indent Lines</application> plugin adds or removes space from the beginning of lines of text.</para>
<para>To indent or unindent text, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Select the lines that you want to indent. To indent or unindent a single line, place the cursor anywhere on that line.</para>
</listitem>
<listitem>
<itemizedlist>
<listitem>
<para>To indent the text, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Indent</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>To remove the indentation, choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Unindent</guimenuitem> </menuchoice>.</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
<para>The amount of space used, and whether tab character or space characters are used, depends on the <guilabel>Tab Stops</guilabel> settings in the Editor Preferences: see <xref linkend="pluma-prefs-editor"/>.</para>
</section>
<section xml:id="pluma-insert-date-time-plugin">
<info>
<title>Insert Date/Time Plugin</title>
</info>
<para>The <application>Insert Date/Time</application> plugin inserts the current date and time into a document. To use the Insert Date/Time plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert Date and Time</guimenuitem> </menuchoice>. </para>
<para>If you have not configured the Insert Date/Time plugin to automatically insert the date/time without prompting you for the format, <application>pluma</application> displays the <guilabel>Insert Date and Time</guilabel> dialog. Select the appropriate date/time format from the list. Click <guibutton>Insert</guibutton> to close the <guilabel>Insert Date and Time</guilabel> dialog. <application>pluma</application> inserts the date/time at the cursor position in the current file. </para>
<para>If you have configured <application>pluma</application> to use one particular date/time format, the <guilabel>Insert Date and Time</guilabel> dialog is not displayed. The date/time is automatically entered at the cursor position in the current file. </para>
</listitem>
</orderedlist>
<section xml:id="pluma-date-time-configure">
<info>
<title>Configuring the Insert Date/Time Plugin</title>
</info>
<para>To configure the Insert Date/Time plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Preferences</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>Select the <guilabel>Plugins</guilabel> tab.</para>
</listitem>
<listitem>
<para>Select the <guilabel>Insert Date/Time</guilabel> plugin.</para>
</listitem>
<listitem>
<para>Click <guibutton>Configure Plugin</guibutton> to display the <guilabel>Configure insert date/time plugin</guilabel> dialog.</para>
</listitem>
<listitem>
<para>Select one of the options, as follows: </para>
<itemizedlist>
<listitem>
<para>To specify the date/time format each time you insert the date/time, select the <guilabel>Prompt for a format</guilabel> option.</para>
</listitem>
<listitem>
<para>To use the same <application>pluma</application>-provided date/time format each time you insert the date/time, select the <guilabel>Use the selected format</guilabel> option, then select the appropriate format from the list. When you select this option, <application>pluma</application> does not prompt you for the date/time format when you choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert Date and Time</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>To use the same customized date/time format each time you insert the date/time, select the <guilabel>Use custom format</guilabel> option, then enter the appropriate format in the text box. Refer to the <link xlink:href="man:strftime">
<citerefentry>
<refentrytitle>strftime</refentrytitle>
<manvolnum>3</manvolnum>
</citerefentry>
</link> for more information on how to specify a custom format. When you select this option, <application>pluma</application> does not prompt you for the date/time format when you choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Insert Date and Time</guimenuitem> </menuchoice>.
</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>Click <guibutton>OK</guibutton> to close the <guilabel>Configure insert date/time plugin</guilabel> dialog.
</para>
</listitem>
<listitem>
<para>To close the <guilabel>Preferences</guilabel> dialog, click <guibutton>Close</guibutton>.</para>
</listitem>
</orderedlist>
</section>
</section>
<section xml:id="pluma-modelines-plugin">
<info>
<title>Modelines Plugin</title>
</info>
<para>The <application>Modelines</application> plugin allows you to set preferences for individual documents. A <firstterm>modeline</firstterm> is a line of text at the start or end of the document with settings that <application>pluma</application> recognizes.</para>
<para>Preferences set using modelines take precedence over the ones specified in the preference dialog.</para>
<para>You can set the following preferences with modelines:</para>
<itemizedlist>
<listitem>
<para>Tab width</para>
</listitem>
<listitem>
<para>Indent width</para>
</listitem>
<listitem>
<para>Insert spaces instead of tabs</para>
</listitem>
<listitem>
<para>Text Wrapping</para>
</listitem>
<listitem>
<para>Right margin width</para>
</listitem>
</itemizedlist>
<para>The <application>Modelines</application> plugin supports a subset of the options used by other text editors <application>Emacs</application>, <application>Kate</application> and <application>Vim</application>.</para>
<section xml:id="pluma-modelines-plugin-emacs">
<info>
<title>Emacs Modelines</title>
</info>
<para>The first two lines of a document are scanned for <application>Emacs</application> modelines.</para>
<para>The <application>Emacs</application> options for tab-width, indent-offset, indent-tabs-mode and autowrap are supported. For more information, see the <link xlink:href="http://www.delorie.com/gnu/docs/emacs/emacs_486.html">GNU Emacs Manual</link>.</para>
</section>
<section xml:id="pluma-modelines-plugin-kate">
<info>
<title>Kate Modelines</title>
</info>
<para>The first and last ten lines a document are scanned for <application>Kate</application> modelines.</para>
<para>The <application>Kate</application> options for tab-width, indent-width, space-indent, word-wrap and word-wrap-column are supported. For more information, see the <link xlink:href="http://www.kate-editor.org/article/katepart_modelines">Kate website</link>.</para>
</section>
<section xml:id="pluma-modelines-plugin-vim">
<info>
<title>Vim Modelines</title>
</info>
<para>The first and last three lines a document are scanned for <application>Vim</application> modelines.</para>
<para>The <application>Vim</application> options for et, expandtab, ts, tabstop, sw, shiftwidth, wrap, and textwidth are supported. For more information, see the <link xlink:href="http://vimdoc.sourceforge.net/htmldoc/options.html#modeline">Vim website</link>.</para>
</section>
</section>
<section xml:id="pluma-python-console-plugin">
<info>
<title>Python Console Plugin</title>
</info>
<para>The <application>Python Console</application> Plugin allows you to run commands in the python programming language from <application>pluma</application>. Enabling the plugin adds a tab to the bottom pane. This shows recent output and a command prompt field.</para>
<caution>
<para>Commands entered into the python console are not checked before they are run. It is therefore possible to hang <application>pluma</application>, for example by entering an infinite loop.</para>
</caution>
</section>
<section xml:id="pluma-trailsave-plugin">
<info>
<title>Save Without Trailing Spaces Plugin</title>
</info>
<para>The <application>Save Without Trailing Spaces</application> Plugin removes whitespace characters such as space (<command>˽</command>), tab (<command>\t</command>), carriage returns (<command>\r</command>) etc. from the end of a line. To use the Save Without Trailing Spaces plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Enable the plugin as described in <xref linkend="pluma-prefs-plugins"/>.</para>
</listitem>
<listitem>
<para>When your document is ready, save it.</para>
</listitem>
<listitem>
<para>You will see that any trailing whitespaces has been stripped after the document has been saved.</para>
</listitem>
</orderedlist>
</section>
<section xml:id="pluma-snippets-plugin">
<info>
<title>Snippets Plugin</title>
</info>
<para>The <application>Snippets</application> plugin allows you to store frequently-used pieces of text, called <firstterm>snippets</firstterm>, and insert them quickly into a document.</para>
<para>Snippets are specific to the language syntax of the current document. For example, when you are working with an HTML document, you can choose from a list of snippets that are useful for HTML. In addition, some snippets are global, and are available in all documents.</para>
<para>A number of built-in snippets are installed with <application>pluma</application>, which can be modified.</para>
<section xml:id="pluma-snippets-plugin-insert">
<info>
<title>Inserting Snippets</title>
</info>
<para>To insert a snippet into a document, type its <firstterm>tab trigger</firstterm> and press <keycap>Tab</keycap>. A snippet's tab trigger is usually the first few letters of the snippet, or something else that is short and easy to remember.</para>
<para>Alternatively, press <keycombo> <keycap>Ctrl</keycap> <keycap>Space</keycap> </keycombo> to see a list of snippets you can insert.</para>
</section>
<section xml:id="pluma-snippets-plugin-add">
<info>
<title>Adding Snippets</title>
</info>
<para>To create a new snippet, do the following:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Manage Snippets</guimenuitem> </menuchoice>. The <guilabel>Snippets Manager</guilabel> window opens.</para>
</listitem>
<listitem>
<para>The list of snippets is grouped by language. Select the language you want to add a snippet to, or a snippet in that language group. To add a snippet for all languages, choose Global at the top of the list. The syntax of the document you are currently working with is shown by default.</para>
</listitem>
<listitem>
<para>Click <guibutton>New</guibutton>. A new snippet appears in the list.</para>
</listitem>
<listitem>
<para>Enter the following information for the new snippet:</para>
<variablelist>
<varlistentry>
<term>Name</term>
<listitem>
<para>Enter a name for the snippet in the text field within the snippet list. The name of a snippet serves only as a reminder of its purpose. You can change name of a snippet you create by clicking on it in the list.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Snippet text</term>
<listitem>
<para>Enter the text of the snippet in the <guilabel>Edit snippet</guilabel> text box. For special codes you can use, see <xref linkend="pluma-snippets-plugin-syntax"/>.</para>
<tip>
<para>You can switch back to the document window to copy text without closing the <guilabel>Snippets Manager</guilabel> window.</para>
</tip>
</listitem>
</varlistentry>
<varlistentry>
<term>Tab Trigger</term>
<listitem>
<para>Enter the tab trigger for the snippet. This is the text that you type before pressing <keycap>Tab</keycap> to insert the snippet.</para>
<para>The tag must be either a single word comprising only letters, or any single character. The <guilabel>Tab trigger</guilabel> will highlight in red if an invalid tab trigger is entered.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Shortcut key</term>
<listitem>
<para>Type a shortcut key to use for inserting the snippet.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</orderedlist>
</section>
<section xml:id="pluma-snippets-plugin-edit">
<info>
<title>Editing and Removing Snippets</title>
</info>
<para>To edit a snippet, select it in the list and make changes to its text and activation properties.</para>
<para>To rename a snippet, click it again in the list.</para>
<para>To restore a built-in snippet that you have changed, press <guilabel>Revert</guilabel>.</para>
<para>To remove a snippet, select it in the list and press <guibutton>Remove</guibutton>. You can not remove built-in snippets, only those you have created yourself.</para>
</section>
<section xml:id="pluma-snippets-plugin-syntax">
<info>
<title>Snippet Substitutions</title>
</info>
<para>In addition to inserting stored text, a snippet can include customizable text, or mark spaces where you can add text once the snippet is inserted in your document.</para>
<para>You can use the following placeholder codes in snippet text:</para>
<variablelist>
<varlistentry>
<term>Tab placeholders</term>
<listitem>
<para><literal>$<replaceable>n</replaceable></literal> defines a tab placeholder, where <literal>n</literal> is any number from 1 upwards. </para>
<para><literal>${<replaceable>n</replaceable>:<replaceable>default</replaceable>}</literal> defines a tab placeholder with a default value.</para>
<para>A tab placeholder marks a place in the snippet text where you can add extra text after the snippet is inserted.</para>
<para>To use tab placeholders, insert the snippet as normal. The cursor is placed at the first tab placeholder. Type text, and press <keycap>Tab</keycap> to advance to the next tab placeholder. The number in the placeholder code defines the order in which tab advances to each place in the text.</para>
<para>Press <keycombo> <keycap>Shift</keycap> <keycap>Tab</keycap> </keycombo> to return to the previous tab placeholder. Pressing <keycap>Tab</keycap> when there are no more tab placeholders moves the cursor to the end of the snippet text, or to the end placeholder if it exists.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Mirror placeholders</term>
<listitem>
<para>A repeated tab placeholder will mirror the placeholder already defined. This allows you to type in text only once that you want to appear several times in the snippet.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>End placeholder</term>
<listitem>
<para><literal>$0</literal> defines the end placeholder. This allows you to finish working with the snippet with the cursor at a point other than the end of the snippet text.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Environmental variables</term>
<listitem>
<para>Environmental variable such as <literal>$PATH</literal> and <literal>$HOME</literal> are substituted in snippet text. The following variables specific to <application>pluma</application> can also be used:</para>
<variablelist>
<varlistentry>
<term>$PLUMA_SELECTED_TEXT</term>
<listitem>
<para>The currently selected text.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$PLUMA_FILENAME</term>
<listitem>
<para>The full filename of the document, or an empty string if the document isn't saved yet.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$PLUMA_BASENAME</term>
<listitem>
<para>The basename of the filename of the document, or an empty string if the document isn't saved yet.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>$PLUMA_CURRENT_WORD</term>
<listitem>
<para>The word at the cursor's location in the document. When this variable is used, the current word will be replaced by the snippet text.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>Shell placeholders</term>
<listitem>
<para><literal>$(<replaceable>cmd</replaceable>)</literal> is replaced by the result of executing <replaceable>cmd</replaceable> in a shell. </para>
<para><literal>$(<replaceable>n</replaceable>:<replaceable>cmd</replaceable>)</literal> allows you to give this placeholder a reference, where <replaceable>n</replaceable> is any number from 1 upwards. Use <literal>$<replaceable>n</replaceable></literal> to use the output from one shell placeholder as input in another.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Python placeholders</term>
<listitem>
<para><literal>$<<replaceable>cmd</replaceable>></literal> is replaced by the result of evaluating <replaceable>cmd</replaceable> in the python interpreter.</para>
<para><literal>$<<replaceable>a</replaceable>:<replaceable>cmd</replaceable>></literal> specifies another python placeholder as a dependency, where <replaceable>a</replaceable> gives its order in the snippet. This allows you to use python functions defined in another snippet. To specify several dependencies, separate the numbers with commas thus: <literal>$<<replaceable>a</replaceable>,<replaceable>b</replaceable>:<replaceable>cmd</replaceable>></literal></para>
<para>To use a variable in all other python snippets, declare it as <literal>global</literal>.</para>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
<section xml:id="pluma-sort-plugin">
<info>
<title>Sort Plugin</title>
</info>
<para>The <application>Sort</application> plugin arranges selected lines of text into alphabetical order.</para>
<caution>
<para>You cannot undo the Sort operation, so you should save the file before performing the sort. To revert to the saved version of the file after the sort operation, choose <menuchoice> <guimenu>File</guimenu> <guimenuitem>Revert</guimenuitem> </menuchoice>.</para>
</caution>
<para>To use the Sort plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Select the lines of text you want to sort.</para>
</listitem>
<listitem>
<para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Sort</guimenuitem> </menuchoice>. The <guilabel>Sort</guilabel> dialog opens.</para>
</listitem>
<listitem>
<para>Choose the options you want for the sort:</para>
<itemizedlist>
<listitem>
<para>To arrange the text in reverse order, select <guilabel>Reverse order</guilabel>.</para>
</listitem>
<listitem>
<para>To delete duplicate lines, select <guilabel>Remove duplicates</guilabel>.</para>
</listitem>
<listitem>
<para>To ignore case sensitivity, select <guilabel>Ignore case</guilabel>.</para>
</listitem>
<listitem>
<para>To have the sort ignore the characters at the start of the lines, set the first character that should be used for sorting in the <guilabel>Start at column</guilabel> spin box.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>To perform the sort operation, click <guibutton>Sort</guibutton>.</para>
</listitem>
</orderedlist>
</section>
<section xml:id="pluma-spell-checker-plugin">
<info>
<title>Spell Checker Plugin</title>
</info>
<para>The <application>Spell Checker</application> plugin checks the spelling in the selected text. You can configure <application>pluma</application> to check the spelling automatically, or you can check the spelling manually, in the specified language. The language setting, and the autocheck spelling properties, apply per document. To use the Spell checker plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Set Language</guimenuitem> </menuchoice> to display the <guilabel>Set language</guilabel> dialog. Select the appropriate language from the list. Click <guibutton>OK</guibutton> to close the <guilabel>Set language</guilabel> dialog.</para>
</listitem>
<listitem>
<para>To check the spelling automatically, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Autocheck Spelling</guimenuitem> </menuchoice>. To unset the automatic spell check, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Autocheck Spelling</guimenuitem> </menuchoice> again. When automatic spell checking is set, an icon is displayed beside the <guimenuitem>Autocheck Spelling</guimenuitem> menu item. Automatic spell checking is unset by default, each time <application>pluma</application> starts.</para>
<para>Unknown spellings are displayed in a different color, and underlined. Right-click on an unknown spelling, then select <guimenu>Spelling Suggestions</guimenu> from the popup menu:</para>
<itemizedlist>
<listitem>
<para>To replace the unknown spelling with another spelling in the list, select the replacement spelling from the <guimenu>Spelling Suggestions</guimenu> popup menu.</para>
</listitem>
<listitem>
<para>To add the unknown spelling to your personal dictionary, select <menuchoice> <guimenu>Spelling Suggestions</guimenu> <guimenuitem>Add</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>To ignore all occurrences of the unknown spelling, so that they are no longer flagged as unknown but are not added to your personal dictionary, select <menuchoice> <guimenu>Spelling Suggestions</guimenu> <guimenuitem>Ignore All</guimenuitem> </menuchoice>. The unknown word is ignored in the current <application>pluma</application> session only.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>To check the spelling manually, choose <menuchoice> <guimenu>Tools</guimenu> <guimenuitem>Check Spelling</guimenuitem> </menuchoice>.</para>
<para>If there are no spelling errors, an <guilabel>Information</guilabel> dialog displays a message stating that the document does not contain misspelled words. Click <guibutton>OK</guibutton> to close the <guilabel>Information</guilabel> dialog.</para>
<para>If there are spelling errors, the <guilabel>Check Spelling</guilabel> dialog is displayed:</para>
<itemizedlist>
<listitem>
<para>The <guilabel>Misspelled word</guilabel> is displayed at the top of the dialog.</para>
</listitem>
<listitem>
<para>A suggested known spelling is displayed in the <guilabel>Change to</guilabel> text box. You can replace this with another known spelling by selecting a spelling from the <guilabel>Suggestions</guilabel> list, or you can enter text directly into the <guilabel>Change to</guilabel> text box.</para>
</listitem>
<listitem>
<para>To check the spelling of the text in the <guilabel>Change to</guilabel> text box, click <guibutton>Check Word</guibutton>. If this is a known word, the <guilabel>Suggestions</guilabel> list is replaced with the text <literal>(correct spelling)</literal>. If the word is not known, new entries appear in the <guilabel>Suggestions</guilabel> list.</para>
</listitem>
<listitem>
<para>To ignore the current occurrence of the unknown word, click <guibutton>Ignore</guibutton>. To ignore all occurrences of the unknown word, click <guibutton>Ignore All</guibutton>. The unknown word is ignored in the current <application>pluma</application> session only.</para>
</listitem>
<listitem>
<para>To change the current occurrence of the unknown word to the text in the <guilabel>Change to</guilabel> text box, click <guibutton>Change</guibutton>. To change all occurrences of the unknown word to the text in the <guilabel>Change to</guilabel> text box, click <guibutton>Change All</guibutton>.</para>
</listitem>
<listitem>
<para>To add the unknown word to your personal dictionary, click <guibutton>Add word</guibutton>.</para>
</listitem>
<listitem>
<para>To close the <guilabel>Check Spelling</guilabel> dialog, click <guibutton>Close</guibutton>.</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
<section xml:id="pluma-tag-list-plugin">
<info>
<title>Tag List Plugin</title>
</info>
<para>The <application>Tag List</application> plugin allows you to insert common tags from a list in the side pane.</para>
<para>To use the Tag List plugin, perform the following steps:</para>
<orderedlist inheritnum="ignore" continuation="restarts">
<listitem>
<para>Choose <menuchoice> <guimenu>View</guimenu> <guimenuitem>Side Pane</guimenuitem> </menuchoice>.</para>
</listitem>
<listitem>
<para>By default, the side pane shows a tab containing a list of open documents. Click on the tab showing a + icon at the bottom of the side pane to show the tag list tab.</para>
</listitem>
<listitem>
<para>Select the appropriate tag category from the drop-down list. For example, <guilabel>HTML - Tags</guilabel>.</para>
</listitem>
<listitem>
<para>Scroll through the tag list to find the required tag.</para>
</listitem>
<listitem>
<para>To insert a tag at the cursor position in the current file, double-click on the tag in the tag list. You can also insert a tag as follows:</para>
<itemizedlist>
<listitem>
<para>To insert a tag in the current file and change the focus from the side pane to the display area, press <keycap>Return</keycap>.</para>
</listitem>
<listitem>
<para>To insert a tag in the current file and maintain the focus on the <guilabel>Tag list plugin</guilabel> window, press <keycombo> <keycap>Shift</keycap> <keycap>Return</keycap> </keycombo>.</para>
</listitem>
</itemizedlist>
</listitem>
</orderedlist>
</section>
</section>
</article>
|