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
|
<?xml version="1.0" encoding="UTF-8" ?>
<chapter id="extending-quanta-3-2">
<chapterinfo>
<title>Extending &quantaplus;</title>
<authorgroup>
<author>
<firstname>Christopher</firstname>
<surname>Hornbaker</surname>
<affiliation>
<address><email>chrishornbaker@earthlink.net</email></address>
</affiliation>
</author>
<author>
<firstname>András</firstname>
<surname>Mantia</surname>
<affiliation>
<address><email>amantia@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</chapterinfo>
<title>Extending &quantaplus;</title>
<para>
This chapter describes how to customize &quantaplus; to your particular
needs and how you can help &quantaplus; become better.
</para>
<!--<sect1 id="kommander-3-2">
<title>Using Kommander With &quantaplus;</title>
<para>
Kommander, by Marc Britton.
</para>
</sect1> -->
<sect1 id="dtep-intro-3-2">
<title>Document Type Editing Package (&DTEP;)</title>
<para>
Document Type Editing Packages (&DTEP;s) are used in &quantaplus; to add
support for markup, scripting languages, and &CSS;. They allow
&quantaplus; to provide features like auto-completion and node trees.
Their simplicity and flexibility are what make &quantaplus; a fast,
developer friendly &IDE; for web developers. They are what make &quantaplus;
an easy-to-use, productive environment.
</para>
<para>
&DTEP;s come in two flavors, Family 1, which are markups, and Family 2,
which are scripting and &CSS;. &DTEP;s are made up of two parts, the Tag
Folder and the Toolbars. Tag Folders are composed of two types of files,
the &descriptionrc; and TagXML files, which carry the extension .tag.
Toolbars are the handy, icon-oriented tabs of buttons (above the editing
window) which place text into a document faster than the user can type.
</para>
<para>
&DTEP;s can be created manually (see below), <link linkend="download-resources">downloaded</link> or automatically created from an existing DTD. See <xref linkend="converting-dtd" /> for details about the conversion.
</para>
<para>
This document describes how to make TagXML files, the &descriptionrc;, and
toolbars. In short, a &DTEP;.
</para>
<para>
TagXML files (.tag) define both the attributes specific to a tag and the
layout and contents of the properties dialog &quantaplus; shows for the tag.
The &descriptionrc; file provides rules and information on the &DTEP;
itself. Toolbars provide a quick means for adding tags into a document
without worry of mis-spellings and such.
</para>
<sect2 id="dtep-packaging-3-2">
<title>Packaging</title>
<para>
Tag Folders are just that, folders. They are composed only of the
&descriptionrc; and TagXML files. Tag Folders carry the name of the mark-up
language and version, if applicable. (For example, html-4.01-strict)
</para>
</sect2>
<sect2 id="tagxml-3-2">
<title>TagXML</title>
<para>
The table below lists the elements defined in TagXML and declares whether
they are required or not. While not all are required, it is recommended
that you use as many as you can so that other users can have a better
experience and more information to work with.
</para>
<informaltable>
<tgroup cols="3">
<thead>
<row>
<entry>Element</entry>
<entry>Default Usage</entry>
<entry>Case Usage</entry>
</row>
</thead>
<tbody>
<row>
<entry>TAGS</entry>
<entry>required</entry>
<entry>always</entry>
</row>
<row>
<entry>tag</entry>
<entry>required</entry>
<entry>always</entry>
</row>
<row>
<entry>label</entry>
<entry>optional</entry>
<entry>required to create a properties dialog</entry>
</row>
<row>
<entry>attr</entry>
<entry>optional</entry>
<entry>required to define an attribute</entry>
</row>
<row>
<entry>tooltip</entry>
<entry>optional</entry>
<entry>required to have the properties dialog display a tooltip</entry>
</row>
<row>
<entry>whatsthis</entry>
<entry>optional</entry>
<entry>required to have the properties dialog display a <quote>What's This
</quote></entry>
</row>
<row>
<entry>list</entry>
<entry>optional</entry>
<entry>required when an attr is of the type <quote>list</quote></entry>
</row>
<row>
<entry>item</entry>
<entry>optional</entry>
<entry>required when <list> is used</entry>
</row>
<row>
<entry>textlocation</entry>
<entry>optional</entry>
<entry>always</entry>
</row>
<row>
<entry>location</entry>
<entry>optional</entry>
<entry>required when label is used</entry>
</row>
<row>
<entry>text</entry>
<entry>optional</entry>
<entry>required when label is used</entry>
</row>
<row>
<entry>children</entry>
<entry>optional</entry>
<entry>list of tags that can appear within the tag being defined</entry>
</row>
<row>
<entry>child</entry>
<entry>required</entry>
<entry>a children entry</entry>
</row>
<row>
<entry>stoppingtags</entry>
<entry>optional</entry>
<entry>list of tags that tell another tag to end</entry>
</row>
<row>
<entry>stoppingtag</entry>
<entry>required</entry>
<entry>a stoppingtags entry</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<sect3 id="dtep-element-descriptions-3-2">
<title>TagXML Element Descriptions</title>
<para>
The following sections will describe, in detail, each element. Everything
from where they can go to what goes in them is layed out in an
easy-to-follow manner.
</para>
<sect4 id="TAGS-3-2">
<title>TAGS</title>
<para>
This is the root element of a TagXML document. It may appear in a document
only once. It can contain the definition of multiple tags. This is an
element-only type element.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry>
<entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry><emphasis>NONE</emphasis></entry>
<entry>tag</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="tag-3-2">
<title>tag</title>
<para>
Wrapper for tag being defined. This is an element-only type element.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry>
<entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>TAGS</entry>
<entry>label, attr, stoppingtags</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<informaltable>
<tgroup cols="6">
<thead>
<row>
<entry>Attribute</entry><entry>Type</entry><entry>Values</entry>
<entry>Default</entry><entry>Use</entry><entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>name</entry><entry>string</entry><entry></entry><entry></entry>
<entry>required</entry><entry>Specifies the name of the tag being defined.</entry>
</row>
<row>
<entry>single</entry><entry>boolean</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>Specifies whether or not the tag requires a
closing tag </(tagname)>.</entry>
</row>
<row>
<entry>type</entry><entry>string</entry><entry></entry><entry>xmltag</entry>
<entry>optional</entry><entry>Specifies the type of tag being defined.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>xmltag</entry><entry></entry>
<entry></entry><entry>Type of tag is XML-based. (Family 1 only.)</entry>
</row>
<row>
<entry></entry><entry></entry><entry>entity</entry><entry></entry>
<entry></entry><entry>The tag describes an entity. (Family 1 only.)</entry>
</row>
<row>
<entry></entry><entry></entry><entry>property</entry><entry></entry>
<entry></entry><entry>Type of tag is &CSS; related. (Family 2 only.)</entry>
</row>
<row>
<entry></entry><entry></entry><entry>function</entry><entry></entry>
<entry></entry><entry>Type of tag is a script function. When used,
<attr> becomes arguments of the function. (Family 2 only.)</entry>
</row>
<row>
<entry></entry><entry></entry><entry>class</entry><entry></entry>
<entry></entry><entry>Type of tag is a script class. (Family 2 only.)</entry>
</row>
<row>
<entry></entry><entry></entry><entry>method</entry><entry></entry>
<entry></entry><entry>Type of tag is a class method. (Family 2 only.)</entry>
</row>
<row>
<entry>returnType</entry><entry>string</entry><entry></entry><entry>void
</entry>
<entry>optional</entry><entry>Specifies the return type of tag being
defined. (Family 2 only.)</entry>
</row>
<row>
<entry></entry><entry></entry><entry>void</entry><entry></entry>
<entry></entry><entry>Type of tag returns void.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>int</entry><entry></entry>
<entry></entry><entry>Type of tag returns int.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>float</entry><entry></entry>
<entry></entry><entry>Type of tag returns float.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>long</entry><entry></entry>
<entry></entry><entry>Type of tag returns long.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>string</entry><entry></entry>
<entry></entry><entry>Type of tag returns string.</entry>
</row>
<row>
<entry>version</entry><entry>string</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>Specifies the version of the language for which this tag is valid</entry>
</row>
<row>
<entry>extends</entry><entry>string</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>Valid only if the type of the tag is "class". The name of the base class for this class. (Family 2 only.)</entry>
</row>
<row>
<entry>class</entry><entry>string</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>Valid only if the type is "method". Specifies the name of the class to where this method belongs. (Family 2 only.)</entry>
</row>
<row>
<entry>common</entry><entry>boolean</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>if "yes", the tag specifies a common attribute group and the attributes inside this tag can be attached to any other tag. (Family 1 only.)</entry>
</row>
<row>
<entry>comment</entry><entry>string</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>the comment string appears near the tag name in the completion box</entry>
</row></tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="label-3-2">
<title>label</title>
<para>
Place a label in the dialog. The text is specified by the <text> tag.
This is an element-only type element.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry>
<entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>tag</entry>
<entry>text, location</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="attr-3-2">
<title>attr</title>
<para>
Defines an attribute of the tag. This element occurs once for each
attribute. It defines the name and type of attribute. It also contains
additional tags that specify how this attribute should be displayed, et cetera.
This is an element-only type element.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry>
<entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>tag</entry>
<entry>location, list, tooltip, whatsthis, textlocation</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<informaltable>
<tgroup cols="6">
<thead>
<row>
<entry>Attribute</entry><entry>Type</entry><entry>Values</entry>
<entry>Default</entry><entry>Use</entry><entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>name</entry><entry>string</entry><entry></entry><entry></entry>
<entry>required</entry><entry>Specifies the name of the attribute being
defined.</entry>
</row>
<row>
<entry>type</entry><entry>string</entry><entry></entry><entry>input</entry>
<entry>required</entry><entry>Specifies the type of the attribute being
defined.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>input</entry><entry></entry>
<entry></entry><entry>Field supports free text entries (text field).</entry>
</row>
<row>
<entry></entry><entry></entry><entry>check</entry><entry></entry>
<entry></entry><entry>Field value is boolean (check box).</entry>
</row>
<row>
<entry></entry><entry></entry><entry>color</entry><entry></entry>
<entry></entry><entry>Field value is a color.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>url</entry><entry></entry>
<entry></entry><entry>Field value is a &URL;. (Local file to refer to.)</entry>
</row>
<row>
<entry></entry><entry></entry><entry>list</entry><entry></entry>
<entry></entry><entry>Field value is an item from a specified list.</entry>
</row>
<row>
<entry>status</entry><entry>string</entry><entry></entry><entry>optional</entry>
<entry>required</entry><entry>Specifies whether or not the argument is
required. (Family 2 only.)</entry>
</row>
<row>
<entry></entry><entry></entry><entry>optional</entry><entry></entry>
<entry></entry><entry>Argument is optional.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>required</entry><entry></entry>
<entry></entry><entry>Argument is required.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>implied</entry><entry></entry>
<entry></entry><entry>Argument is implied.</entry>
</row>
<row>
<entry>source</entry><entry>string</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>Specifies the sources used to fill the entry for the attribute in the tag editor dialog and the attribute tree</entry>
</row>
<row>
<entry></entry><entry></entry><entry>selection</entry><entry></entry>
<entry></entry><entry>The selected text is used as source</entry>
</row>
<row>
<entry></entry><entry></entry><entry>dcop</entry><entry></entry>
<entry></entry><entry>The result of a dcop method is used as source</entry>
</row>
<row>
<entry>interface</entry><entry>string</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>Requires source="dcop". The dcop interface from inside &quantaplus; used to get the source data.</entry>
</row>
<row>
<entry>method</entry><entry>string</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>Requires source="dcop" and an interface name. The dcop method name from inside &quantaplus; used to get the source data.</entry>
</row>
<row>
<entry>arguments</entry><entry>string</entry><entry></entry><entry></entry>
<entry>optional</entry><entry>Requires source="dcop", an interface and a method name. The arguments passed to the method. It can be empty or "%tagname%", meaning the current tags name.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="tooltip-3-2">
<title>tooltip</title>
<para>
Defines the tooltip for a field in the dialog. This element is text-only.
</para>
<note>
<para>
Currently only plain text is supported (you cannot use any markup).
</para>
</note>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry>
<entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>attr</entry>
<entry><emphasis>NONE</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="whatsthis-3-2">
<title>whatsthis</title>
<para>
Defines the 'What's This' help for a field in the dialog. This element is
text-only.
</para>
<note>
<para>
Currently only plain text is supported (you cannot use any markup).
</para>
</note>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry>
<entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>attr</entry>
<entry><emphasis>NONE</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="list-3-2">
<title>list</title>
<para>
A container tag that groups together the items in a list. It may appear
only once for each attribute description. This is an element-only type
element.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry>
<entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>attr</entry>
<entry>item</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="item-3-2">
<title>item</title>
<para>
Defines an item in a list. This element is text-only.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry>
<entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>list</entry>
<entry><emphasis>NONE</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="textlocation-3-2">
<title>textlocation</title>
<para>
Specifies the position of a tag's attribute text within a dialog. This tag
can only occur once for each attribute in the dialog (&ie; one for each
<attr> tag). This element is empty.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry>
<entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>attr</entry>
<entry><emphasis>NONE</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<informaltable>
<tgroup cols="4">
<thead>
<row>
<entry>Attribute</entry><entry>Type</entry>
<entry>Use</entry><entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>row</entry><entry>nonNegativeInteger</entry>
<entry>required</entry><entry>Specifies the row in the dialog layout of a
field or label.</entry>
</row>
<row>
<entry>col</entry><entry>nonNegativeInteger</entry>
<entry>required</entry><entry>Specifies the column in the dialog layout of
a field or label.</entry>
</row>
<row>
<entry>rowspan</entry><entry>nonNegativeInteger</entry>
<entry>optional</entry><entry>Specifies the number of rows a field should
span.</entry>
</row>
<row>
<entry>colspan</entry><entry>nonNegativeInteger</entry>
<entry>optional</entry><entry>Specifies the number of columns a field
should span.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="location-3-2">
<title>location</title>
<para>
Specifies the position and size of a field in the dialog. This tag should
occur once for each field in the dialog (&ie; one for each <attr> and
<label> tag). This element is empty.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry><entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>label, attr</entry><entry><emphasis>NONE</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<informaltable>
<tgroup cols="4">
<thead>
<row>
<entry>Attribute</entry><entry>Type</entry>
<entry>Use</entry><entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>row</entry><entry>nonNegativeInteger</entry>
<entry>required</entry><entry>Specifies the row in the dialog layout of a
field or label.</entry>
</row>
<row>
<entry>col</entry><entry>nonNegativeInteger</entry>
<entry>required</entry><entry>Specifies the column in the dialog layout of
a field or label.</entry>
</row>
<row>
<entry>rowspan</entry><entry>nonNegativeInteger</entry>
<entry>optional</entry><entry>Specifies the number of rows a field should
span.</entry>
</row>
<row>
<entry>colspan</entry><entry>nonNegativeInteger</entry>
<entry>optional</entry><entry>Specifies the number of columns a field
should span.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="text-3-2">
<title>text</title>
<para>
Define the text for a label or check box. This element is text-only.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry><entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>label, attr</entry><entry><emphasis>NONE</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="children-3-2">
<title>children</title>
<para>
Defines a list of elements that can appear within the tag being specified.
This element is an element-only type element.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry><entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>tag</entry><entry>child</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="child-3-2">
<title>child</title>
<para>
Defines a child tag. This element is empty.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry><entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>children</entry><entry><emphasis>NONE</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<informaltable>
<tgroup cols="4">
<thead>
<row>
<entry>Attribute</entry><entry>Type</entry><entry>Values</entry>
<entry>Use</entry><entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>name</entry><entry>string</entry><entry></entry>
<entry>required</entry><entry>Specifies a tag that can appear within the a
certain tag.</entry>
</row>
<row>
<entry>usage</entry><entry>string</entry><entry></entry>
<entry>optional</entry><entry>Specifies the relation with the parent.</entry>
</row>
<row>
<entry></entry><entry></entry><entry>required</entry>
<entry></entry><entry>The parent must have at least one child with this name.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="stoppingtags-3-2">
<title>stoppingtags</title>
<para>
Defines a list of elements that force a tag to end. This element is an
element-only type element.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry><entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>tag</entry><entry>stoppingtag</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
<sect4 id="stoppingtag-3-2">
<title>stoppingtag</title>
<para>
Defines a stopping tag. This element is empty.
</para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Parent(s)</entry><entry>Children</entry>
</row>
</thead>
<tbody>
<row>
<entry>stoppingtags</entry><entry><emphasis>NONE</emphasis></entry>
</row>
</tbody>
</tgroup>
</informaltable>
<informaltable>
<tgroup cols="4">
<thead>
<row>
<entry>Attribute</entry><entry>Type</entry>
<entry>Use</entry><entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>name</entry><entry>string</entry>
<entry>required</entry><entry>Specifies which tags force the ending of
another tag.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect4>
</sect3>
<sect3 id="tagxml-usage-3-2">
<title>TagXML Usage</title>
<para>
All TagXML files must begin with the &XML; declaration: <?xml
version="1.0" encoding="UTF-8"?> and must be properly nested and closed.
</para>
<important>
<para>
White space does not adversely affect anything, but watch out for & and
< characters. These should likely be replaced with an &amp; and
&lt;, respectively, in elements such as <tooltip>, <whatsthis>,
and <text>. Not doing so will not cause a crash, but you will have
chunks of your work disappear if you do not.
</para>
</important>
</sect3>
<sect3 id="tagxml-validation-3-2">
<title>TagXML Validation</title>
<para>
To validate your TagXML files, simply click the <quote>Tools</quote>
pop-up dialog at the top of &quantaplus; and select <quote>Validate
TagXML.</quote> A dialog will present itself and you need only to follow
the simple directions.
</para>
<note>
<para>
This feature is currently not present. Currently validation occurs when
the TagXML files are loaded into &quantaplus;.
</para>
</note>
</sect3>
<sect3 id="tagxml-examples-3-2">
<title>TagXML Examples</title>
<sect4 id="family-one-3-2">
<title>Family 1</title>
<para>
The following will show you a valid Family 1 TagXML file. This file
happens to describe &W3C; &XML; Schema's <schema> element. The file name
for this TagXML file would be schema.tag. Simple, eh?
</para>
<informalexample>
<literallayout>
<markup>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE TAGS>
<TAGS>
<tag name="schema">
<label>
<text>id</text>
<location col="0" row="0"/>
</label>
<attr name="id" type="input">
<tooltip>A unique ID for the element.</tooltip>
<whatsthis>A unique ID for the element.</whatsthis>
<location col="1" row="0"/>
</attr>
<label>
<text>version</text>
<location col="0" row="1"/>
</label>
<attr name="version" type="input">
<tooltip>Version of the schema.</tooltip>
<whatsthis>Version of the schema.</whatsthis>
<location col="1" row="1"/>
</attr>
<label>
<text>targetNamespace</text>
<location col="0" row="2"/>
</label>
<attr name="targetNamespace" type="input">
<tooltip>&URI; reference of the namespace of this schema.</tooltip>
<whatsthis>&URI; reference of the namespace of this schema.</whatsthis>
<location col="1" row="2"/>
</attr>
<label>
<text>xmlns</text>
<location col="0" row="3"/>
</label>
<attr name="xmlns" type="input">
<tooltip>&URI; reference for one or more namespaces for use in this schema.
If no prefix is used, then components of that namespace may be used unqualified.</tooltip>
<whatsthis>&URI; reference for one or more namespaces for use in this schema.
If no prefix is used, then components of that namespace may be used unqualified.</whatsthis>
<location col="1" row="3"/>
</attr>
<label>
<text>attributeFormDefault</text>
<location col="0" row="4"/>
</label>
<attr name="attributeFormDefault" type="list">
<items>
<item>qualified</item>
<item>unqualified</item>
</items>
<tooltip>Default form for all attributes within this schema.</tooltip>
<whatsthis>Default form for all attributes within this schema.</whatsthis>
<location col="1" row="4"/>
</attr>
<label>
<text>elementFormDefault</text>
<location col="0" row="5"/>
</label>
<attr name="elementFormDefault" type="list">
<items>
<item>qualified</item>
<item>unqualified</item>
</items>
<tooltip>Default form for all elements within this schema.</tooltip>
<whatsthis>Default form for all elements within this schema.</whatsthis>
<location col="1" row="5"/>
</attr>
<label>
<text>blockDefault</text>
<location col="0" row="6"/>
</label>
<attr name="blockDefault" type="input">
<location col="1" row="6"/>
</attr>
<label>
<text>finalDefault</text>
<location col="0" row="7"/>
</label>
<attr name="finalDefault" type="input">
<location col="1" row="7"/>
</attr>
</tag>
</TAGS>
</markup>
</literallayout>
</informalexample>
</sect4>
<sect4 id="family-two-3-2">
<title>Family 2</title>
<para>
The following will show you a valid Family 2 TagXML file. This file
happens to describe &PHP;'s overload function. The file name for this
TagXML file would be overload.tag.
</para>
<informalexample>
<literallayout>
<markup>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE tags>
<tags>
<tag name="overload" type="function" returnType="void">
<attr name="class_name" type="string" status="optional"/>
</tag>
</tags>
</markup>
</literallayout>
</informalexample>
</sect4>
</sect3>
</sect2>
<sect2 id="descriptionrc-3-2">
<title>&descriptionrc;</title>
<para>
The &descriptionrc; file is, also, quite simple and there is an editor for it accessible from <menuchoice><guimenu>DTD</guimenu><guimenuitem>Edit DTD Settings</guimenuitem></menuchoice>. This will edit the &descriptionrc; for a &DTEP; you can select from a list. In order to
edit the &descriptionrc; for a newly created &DTEP; you should create a simple &descriptionrc; with the following entries:
</para>
<para>
<informalexample>
<literallayout>
<markup>
[General]
Version = Use 1 for &quantaplus; version <=3.1.2 and 2 for any version greater.
Name = DTD definition string. (-//&W3C;//DTD HTML 4.01 Transitional//EN)
NickName = The beautified name of the DTD. (HTML 4.01 Transitional). If not defined, Name is
used as NickName.
</markup>
</literallayout>
</informalexample>
</para>
<para>Once you have created it at put aside of the tag files, load the newly created &DTEP; with <menuchoice><guimenu>DTD</guimenu><guimenuitem>Load DTD Package (DTEP)</guimenuitem></menuchoice> and after it is loaded you can proceed with editing the settings of the &DTEP;. Check the tooltips and the whatsthis text of the entries in the editor dialog to understand the meaning of each entry. Alternatively you can read the <filename>quanta/data/dtep/dtd-description.txt</filename> from the source tarball containing a description about the format.
</para>
</sect2>
</sect1>
<sect1 id="user-actions">
<title>User Defined Actions</title>
<para>
Actions are very common in every application. You meed them often when you use any application. Clicking on a toolbar icon, selecting a menu item or using a shortcut usually executes an action. In &quantaplus; actions are taken to the next level. Instead of hardcoded actions (that are created by the application
programmer at the source code level) it is possible for the ordinary user to create and modify actions and by this way adding
new functionality to &quantaplus;. These are the user defined actions, and many of the standard &quantaplus; actions are user defined (and user modifiable) actions as well.
</para>
<para>There are three types of user definable actions:
<itemizedlist>
<listitem><para><link linkend="text-actions">Text actions</link></para></listitem>
<listitem><para><link linkend="tag-actions">Tag actions</link></para></listitem>
<listitem><para><link linkend="script-actions">Script actions</link></para></listitem>
</itemizedlist>
</para>
<sect2 id="creating-actions">
<title>Creating actions</title>
<para>
You can create an action by going to
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Actions</guimenuitem>
</menuchoice>
. Click on <guibutton>New Action</guibutton> and you will face a similar dialog:
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img7.png" format="PNG" />
</imageobject>
</mediaobject>
<variablelist>
<varlistentry>
<term><guilabel>Type</guilabel></term>
<listitem><para>Specifies the action's type (<link linkend="text-actions">Text</link>, <link linkend="tag-actions">Tag</link>, <link linkend="script-actions">Script</link>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Text</guilabel></term>
<listitem><para>The user visible name of the action.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>The button near the <guilabel>Text</guilabel> label</term>
<listitem><para>The icon assigned to this action. Click on it in order to change the current icon.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Tool tip</guilabel></term>
<listitem><para>Short description of what the action does.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Shortcut</guilabel></term>
<listitem><para>The shortcut assigned to this action. Click on <guilabel>Custom</guilabel> or the button near <guilabel>Custom</guilabel> to assign a shortcut; click on <guilabel>None</guilabel> to remove the currently assigned shortcut.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Container toolbars</guilabel></term>
<listitem><para>The user defined toolbars where this action appears. See <xref linkend="creating-toolbars-3-2"/>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Detailed Settings</guilabel></term>
<listitem><para>Specific settings for the different type of actions. See below.
</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect2>
<sect2 id="text-actions">
<title>Text actions</title>
<para>
<mediaobject><imageobject>
<imagedata fileref="text-action.png" format="PNG" />
</imageobject></mediaobject>
The simplest actions. You can enter some text in the <guilabel>Detailed Settings</guilabel> area and whenever the action is executed this text will be inserted in your document
at the current cursor position. See the below example.
</para>
</sect2>
<sect2 id="tag-actions">
<title>Tag actions</title>
<para>
Useful to insert XML tags, but of course you can use them for other purposes as well.
<mediaobject><imageobject>
<imagedata fileref="tag-actions.png" format="PNG" />
</imageobject></mediaobject>
<variablelist>
<varlistentry>
<term><guilabel><tag></guilabel></term>
<listitem><para>The name of the tag.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel></tag></guilabel></term>
<listitem><para>If checked when the action is executed this text will be inserted as a closing tag. If there is a selected area in the document before you execute the action, the <tag> will be inserted before the selected area and the </tag> after.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Run "Edit tag" dialog if available</guilabel></term>
<listitem><para>If checked and there is a tagXML file for this tag, a tag editing dialog will be shown prior of inserting the tag inside the document, so you can fine-tune the tag attributes.</para></listitem>
</varlistentry>
</variablelist>
The <tag> and </tag> will be inserted as you've typed there. The <, > or the / sign won't be automatically appended.
</para>
</sect2>
<sect2 id="script-actions">
<title>Script actions</title>
<para>
<mediaobject><imageobject>
<imagedata fileref="script-action.png" format="PNG" />
</imageobject></mediaobject>
The most powerful action type. With the help of this action you
can run external applications (usually scripts, but it's
not limited to scripts), which can alter your document or use your document (or part of your document) as input. Examples from &quantaplus; itself are the <guibutton>Quick Start</guibutton> dialog, the various <guilabel>View In...</guilabel> actions for the (X)HTML DTEPs.
</para>
<para>
First you have to enter the name of your script with the interpreter as well. Example:
<command>sh /home/myHome/myScript.sh</command>.
</para>
<para>
Although you can use full paths, the recommended way is to use the <command>%scriptdir</command> variable in the command line, like <command>sh %scriptdir/myScript.sh</command>. This way &quantaplus; will try to locate your script in the following places:
<itemizedlist>
<listitem><para>global script folder: <filename><envar>$TDEDIR</envar>/share/apps/quanta/scripts</filename></para></listitem>
<listitem><para>local script folder: <filename><envar>$TDEHOME</envar>/share/apps/quanta/scripts</filename></para></listitem>
<listitem><para>your path: <envar>$PATH</envar></para></listitem>
</itemizedlist>
There are other special variables that you can use in the command line:
<itemizedlist>
<listitem><para><command>%f</command>: will be replaced with the URL of the current document. In case of local documents, file:/ will be stripped from the document.</para></listitem>
<listitem><para><command>%input</command>: will be replaced with the selected input. See below.</para></listitem>
<listitem><para><command>%projectbase</command>: will be replaced with the URL of the current project. It is empty if no project is loaded.</para></listitem>
<listitem><para><command>%pid</command>: will be replaced with the PID of the running &quantaplus; process. If &quantaplus; is running in unique mode, the "unique " text will be prepended to the PID number. Useful when you use DCOP to control &quantaplus; from the external script.</para></listitem>
<listitem><para><command>%userarguments</command>: useful in case of events. This entry will be replaced by the event properties in the following order: <variablelist>
<varlistentry>
<term>First argument</term>
<listitem><para>The unique id of the script</para></listitem>
</varlistentry>
<varlistentry>
<term>Second argument</term>
<listitem><para>the event name</para></listitem>
</varlistentry>
<varlistentry>
<term>Third argument</term>
<listitem><para>the parameters for the event, usually the file name of the current document or the path to the project file.</para></listitem>
</varlistentry>
</variablelist>
</para></listitem>
</itemizedlist>
</para>
<para>
Aside of the above methods the script can receive input from &quantaplus; on the standard input. In the <guilabel>Input</guilabel> combobox you can select what to send to the standard input. Choices are:
<itemizedlist>
<listitem><para><guilabel>None</guilabel>: nothing is sent to the script.</para></listitem>
<listitem><para><guilabel>Current document</guilabel>: the whole document is sent to the script.</para></listitem>
<listitem><para><guilabel>Selected text</guilabel>: the selected area of the document is sent to the script. Using the <command>%input</command> variable usually makes sense only when using this setting.</para></listitem>
</itemizedlist>
</para>
<para>
Similar to the <guilabel>Input</guilabel> you can catch the output of the executed application. There are two kind of outputs:
<itemizedlist>
<listitem><para>normal output, printed to the standard output;</para>
</listitem>
<listitem><para>error messages, printed to the standard error.</para>
</listitem>
</itemizedlist>
You can specify what should happen with the text printed to the standard output. This can be done by modifying the value of the <guilabel>Output</guilabel> combobox:
<itemizedlist>
<listitem><para><guilabel>None</guilabel>: the output of the application is ignored.</para></listitem>
<listitem><para><guilabel>Insert in cursor position</guilabel>: the output will be inserted in the current document and the cursor position.</para></listitem>
<listitem><para><guilabel>Replace selection</guilabel>: the selected area of the document will be replaced with the output.</para></listitem>
<listitem><para><guilabel>Replace selection</guilabel>: the selected area of the document will be replaced with the output.</para></listitem>
<listitem><para><guilabel>Create a new document</guilabel>: a new document will be created and will contain all the output of the script.</para></listitem>
<listitem><para><guilabel>Replace current document</guilabel>: the entire document will be replaced with the output.</para></listitem>
<listitem><para><guilabel>Message window</guilabel>: the output will appear in the <guilabel>Messages</guilabel> toolview.</para></listitem>
</itemizedlist>
</para>
<para>The choices for the standard error output (<guilabel>Error</guilabel>) are the same as for the normal output.</para>
</sect2>
</sect1>
<sect1 id="creating-toolbars-3-2">
<title>Creating Toolbars</title>
<para>
The following will show you how to create toolbars for a &DTEP;. Toolbars
are graphical elements that are assigned to actions. Actions, in
&quantaplus;, are the basis for nearly all the extensions that
&quantaplus; has and will acquire in the future. The same mechanism that
defines an action in &quantaplus; also enables auto-completion and tag
dialogs. With actions, the limit of what you can do is virtually
limitless. For means of an example, we will use <ulink
url="http://tidy.sf.net">&HTML; tidy</ulink> on our web pages.
</para>
<sect2 id="from-scratch-to-complete-3-2">
<title>From Scratch to Complete</title>
<para>
To begin, you will need to create a user toolbar. Select
<menuchoice>
<guimenu>Toolbars</guimenu>
<guimenuitem>Add User Toolbar</guimenuitem>
</menuchoice>.
</para>
<para>
If there are many tags for the markup language, it is recommended that you
split up the tags into logical groups. You will need to create a new user
toolbar for each group. In this case, there are not many, so we will be
making one toolbar and naming it with the name of the markup.
</para>
<para>
Once all your toolbars are created, you must add and configure the
actions. To do this, select
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Actions</guimenuitem>
</menuchoice>
<emphasis>
</emphasis>.
</para>
<para>
The parts of this window are pretty straight forward. Press the
<guibutton>New action</guibutton> button at the bottom of the window to
enter the editing mode.
</para>
<para>
Fill in all of the necessary fields and add the tag to the appropriate
toolbar(s).
</para>
<para>
Complete the rest and, if the tag has attributes and you always plan to
use them, check the <guilabel>Run "Edit tag" dialog if available
</guilabel> box so that you will be prompted every time the action is used.
</para>
<para>
You should now have something much like the following.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img7.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
Press the <guibutton>Apply</guibutton> button and you will see the action
added to the toolbar(s) you have selected.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img8.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
Egad! That's an awful icon. How will yourself and others remember that
icon goes with that action? Let's replace it before trouble arises.
</para>
<para>
To create an icon that more accurately describes that action, we will be
using &kiconedit;. Select it from the &kmenu;, <menuchoice>
<guisubmenu>Graphics</guisubmenu>
<guisubmenu>More Programs</guisubmenu>
</menuchoice> (or where ever your distribution placed it).
</para>
<para>
&kiconedit; defaults to the size 32x32 pixels, but we need 22x22. To
change this, select
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Resize</guimenuitem>
</menuchoice>.
</para>
<para>
Keep in mind that you are creating an icon that will assist in helping not
only yourself to remember which action does what, but also other users of
the &DTEP;.
</para>
<para>
Since the tag I am creating the icon for is called <quote>start,</quote>
I have decided to create a <quote>Start sign.</quote> Using the color green
(green often interpreted as <quote>go,</quote> <quote>start,</quote> or
<quote>proceed</quote>) will, or, at least, should, convey a message
to the user that clicking this action will place the <start> tag in the
current document.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img15.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
Now that I am finished with the creation of the icon, I will save it.
</para>
<para>
Once you are done with creating the icon(s), you must associate the icon
with the action. To do this, open
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Actions</guimenuitem>
</menuchoice> again (in &quantaplus;) and select the action you made
the icon for. Beside the <guilabel>Text</guilabel> field, you will see a
button, click it.
</para>
<para>
Select <guilabel>Other Icons</guilabel> and then click the <guibutton>
Browse</guibutton> button.
</para>
<para>
Goto the folder in which you saved the icon, select the icon, and click
<guibutton>OK</guibutton>.
</para>
<para>
Press the <guibutton>Apply</guibutton> button and either continue to do the
same with the other tags, if any, or click <guibutton>OK</guibutton> to
finish.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img18.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
Let us say you would like to add some common &quantaplus; functions to your
toolbar or maybe you think the toolbar would be better off organized in a
different manner with some separators to group the actions. Open the
<guilabel>Configure Toolbars</guilabel> dialog by going
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars</guimenuitem>
</menuchoice>. Make sure your toolbar is selected.
</para>
<para>
I will be choosing the separator (top of the left column) for my toolbar.
Once you have selected the item you wish to add to your toolbar, press the
right arrow button. This will add it to your toolbar.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img21.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
I think I would like a quick way to access the <guilabel>Konqueror
Preview</guilabel>. I will select it and add it to the toolbar.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img22.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
Note how the separator helps in grouping. Someone new to my toolbar might
have thought that the &konqueror; button was like or the opposite of the
start button.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img23.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
Apply your changes and, when you are done, press <guibutton>OK</guibutton>
to finish.
</para>
<para>
Ah, look at the fantastic new toolbar! Much more handy now.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img24.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
Remember to test your toolbar, by clicking all the buttons, so that you
know the output is correct.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="dtep_doc_img25.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
Now to save the toolbar, we will select
<menuchoice>
<guimenu>Toolbars</guimenu>
<guisubmenu>Save Toolbars</guisubmenu>
<guimenuitem>Save as Local Toolbar</guimenuitem>
</menuchoice>.
</para>
<para>
Save it to the correct folder. Since NeXML does not exist, I will just
have it to the top-level folder, but your toolbar(s) should be saved to
the correct folder. Make sure to adjust your &descriptionrc; to have it
load your toolbar(s) when a new file of that type is created.
</para>
</sect2>
</sect1>
<sect1 id="creating-quanta-docs-3-2">
<sect1info>
<title>Creating Your Own Documentation</title>
<authorgroup>
<author>
<firstname>Robert</firstname>
<surname>Nickel</surname>
<affiliation>
<address><email>robert@artnickel.com</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
</sect1info>
<title>Creating Your Own Documentation</title>
<para>
Probably the most notable additions to &quantaplus; for the general user
will be the addition of documentation for the markup or scripting language
that you like best. To that end, this chapter will explain how I create
the &PHP; documentation tree for my personal use.
</para>
<para>
Before starting on creating your own documentation, you may wish to check
out the <ulink url="http://quanta.sf.net/main1.php?contfile=resource">
&quantaplus; repository</ulink> to see if someone else has already done
this set.
</para>
<para>
There are two parts to this process. First, you must obtain the existing
documentation for the markup/scripting/&etc; language that you are after.
Second, you have to create the <filename>docrc</filename> file. The first
is up to you, the second is what we will cover here.
</para>
<para>
The general form of the docrc file is as follows:
</para>
<informalexample>
<literallayout>
#KDE Config File
[Tree]
Doc dir=<replaceable>path, relative to this file, of the documentation html files</replaceable> ⪚ php42/
#top level elements
Top Element=<replaceable>Your description for these documentation</replaceable> ⪚ &PHP; 4.2 documentation
Section 1=Section1.html
Section 2=#Sec2.1,#Sec2.2,#Sec2.3
Sec2.1=Sec2.1.html
Sec2.2=Sec2.2.html
Sec2.3=Sec2.3.html
...
[Context]
ContextList=func1,func2,tag1,tag2,tag3
func1=func1.html
func2=func2.html
tag1=tag1.html
tag2=tag2.html
tag3=tag3.html
</literallayout>
</informalexample>
<para>
The <filename>docrc</filename> is broken down into two sections: Tree and
Context.
</para>
<para>
The Tree section defines the presentation aspect of the documentation in
the documentation tab. For example, you will see that in the &PHP;
documentation you have something akin to this:
</para>
<mediaobject>
<imageobject>
<imagedata fileref="doc-view1.png" format="PNG" />
</imageobject>
</mediaobject>
<para>
Relating this to the above, my &PHP; <filename>docrc</filename> looks like
this:
</para>
<informalexample>
<literallayout>
#KDE Config File
[Tree]
Doc dir=php42/
#top level elements
Top Element=PHP 4.2 documentation
PHP 4.2 documentation=Table of Contents,#Getting Started,#Language Reference
Table of Contents=index.html
Getting Started=Introduction, ...
Introduction=introduction.html
...
Language Reference=Basic syntax, ...
Basic syntax=language.basic-syntax.html
...
</literallayout>
</informalexample>
<para>
Notice the <literal>#</literal> in front of <quote>Getting Started</quote>
and <quote>Language Reference</quote>. This indicates that these are sub
containers in the tree and have content of their own. I do not believe that
there is a set limit to the depth here (other than that driven by sanity)
— use your judgment.
</para>
<para>
For the Table of Contents, you will notice that it is referenced directly to
a file (and consequently shows up at the bottom of the tree view —
folders first!).
</para>
<important>
<para>
Spaces do not adversely affect anything, but watch out for & and <
characters. These should likely be replaced by &amp; and &lt;
respectively in all of the &XML; based &quantaplus; resource files.
</para>
</important>
<para>
The Context section is the section of the docrc file that is used to
facilitate context sensitive help. For example, you are writing a &PHP;
script and you would like to see the documentation for the
<function>mysql_fetch_array</function> function. You simply highlight the
function and then press <keycombo action="simul">&Ctrl;<keycap>H</keycap>
</keycombo> for context help. The documentation on
<function>mysql_fetch_array</function> will immediately display. There are
only two entry types here: the ContextList and the file association lines.
</para>
<variablelist>
<varlistentry>
<term>ContextList</term>
<listitem>
<para>
Really simple, this is just a comma separated list of the context items
you wish to have available (for &PHP;, these are the functions for &PHP;).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>File association lines</term>
<listitem>
<para>
These are of the form context item=html doc page. ⪚
acos=function.acos.html
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
A pared down version of my <filename>docrc</filename> Context section is
as follows:
</para>
<informalexample>
<literallayout>
#Keywords for context help
[Context]
ContextList=abs,acos,acosh,addcslashes,addslashes,...
abs=function.abs.html
acos=function.acos.html
acosh=function.acosh.html
addcslashes=function.addcslashes.html
addslashes=function.addslashes.html
...
</literallayout>
</informalexample>
<para>
Now you can just save your <filename>docrc</filename> file, save it in
<filename class="directory">$<envar>HOME</envar>/.trinity/share/apps/quanta/doc</filename>
or <filename
class="directory">$<envar>TDEDIR</envar>/share/apps/quanta/doc</filename>
for local or global use respectively. Then create a folder (the one
specified in your <filename>docrc</filename> file) in the same folder
as your <filename>docrc</filename> file and copy your &HTML; pages in
there.
</para>
<para>
You will need to restart &quantaplus; to see your documentation.
</para>
<para>
Once you are sure that they are good and worth sharing, send the <filename>
docrc</filename> file along with a description of any pertinent
information on what documentation you used to the
<ulink url="http://quanta.sf.net/main1.php?contfile=resource">&quantaplus;
repository</ulink> for use by the &quantaplus; community. You will not get
rich, but you will feel great knowing that you contributed to the best web
development platform around.
</para>
</sect1>
<sect1 id="sharing-resources">
<title>Sharing Resources</title>
<para>With &quantaplus; you are not alone. It is possible to share the various resources (DTEP packages, toolbars with actions, scripts, templates) with others. There are two ways to do it:
</para>
<variablelist>
<varlistentry>
<term>Sending in Email</term>
<listitem><para>The resources can be sent in email to your friends, partners or to whomever you want. You will see the <guilabel>Send in Email</guilabel> menu entries in various places, like <menuchoice><guimenu>DTD</guimenu><guimenuitem>Send DTD Package (DTEP) in Email</guimenuitem></menuchoice>, <menuchoice><guimenu>Toolbars</guimenu><guimenuitem>Send Toolbar in Email</guimenuitem></menuchoice>, in the context menu of the files and folders in the <guilabel>Templates</guilabel> and <guilabel>Scripts</guilabel> tree.
</para></listitem>
</varlistentry>
<varlistentry>
<term>Uploading to the main server</term>
<listitem><para>The resources can be uploaded to our main repository, from where all other &quantaplus; users can download them. The submissions are reviewed and made available only if our team considers correct and useful will be published. In order to make a valid submission it is suggested to sign the resources, thus you need a GPG/PGP key. This information is used to verify the origin of the resources both by our team and by the downloaders.</para>
<para>About getting the resources from the main server see <xref linkend="download-resources" />.</para>
<para>When uploading you will be asked to enter the passphrase for your secret GPG key (the passphrase will not be stored), or in the case of having more secret keys, you will be able to pick up the one you want to use. In the <guilabel>Share Hot New Stuff</guilabel> dialog fill the input fields (the <guilabel>Preview URL</guilabel> may remain empty) and start the upload by clicking <guilabel>OK</guilabel>.</para>
<para>
The upload can be initiated from
<menuchoice><guimenu>DTD</guimenu><guimenuitem>Upload DTD Package (DTEP)</guimenuitem></menuchoice>, <menuchoice><guimenu>Toolbars</guimenu><guimenuitem>Upload Toolbar</guimenuitem></menuchoice>, in the context menu of the files and folders in the <guilabel>Templates</guilabel> and <guilabel>Scripts</guilabel> tree.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="download-resources">
<title>Getting Resources</title>
<para>It is possible to upgrade your &quantaplus; without getting a new version, by getting new resources like DTEP packages, toolbars with actions, templates, scripts and documentation. One possibility is that you got the resources in email or have downloaded from a web server, in which cases you usually need to manually install them. In lucky case you also got an install script when you have downloaded the resources. But &quantaplus; has a dedicated server holding resources that were either not included in the main distribution because of their sizes or infrequent usage, or they were contributed later by users, and these resources are automatically installed. Do download such resources use the various <guilabel>Download</guilabel> menu entries. You can find them at <menuchoice><guimenu>DTD</guimenu><guimenuitem>Download DTD Package (DTEP)</guimenuitem></menuchoice>, <menuchoice><guimenu>Toolbars</guimenu><guimenuitem>Download Toolbar</guimenuitem></menuchoice>, in the context menu of an empty area or toplevel item in the <guilabel>Templates</guilabel>, <guilabel>Scripts</guilabel> and <guilabel>Documentation</guilabel> trees.
</para>
<para>
After a resource was downloaded, but before it is installed, &quantaplus; verifies if the resource is valid, by checking the integrity and the signature. In case of problems it warns you and you can decide if you want to continue or not. Please read the warning dialogs carefully. In the case when the integrity is correct and the resource is correctly signed, you will still get an information dialog, so you can see who created the resource.
</para>
<para>
<caution><para>Be sure that you install resources, especially toolbars and scripts, only from trusted sources!</para></caution>
</para>
</sect1>
<sect1 id="converting-dtd">
<title>Converting a DTD to a &DTEP;</title>
<para>It is possible to work on XML languages currently not supported by &quantaplus; by creating a DTEP package. But the creation can be time consuming, as you may need to write hundreds of tag files in <link linkend="tagxml-3-2">tagXML</link> format. Of course, there is a nicer way to go, by converting the DTD automatically into a DTEP package.
</para>
<para>The conversion can be started from the <menuchoice><guimenu>DTD</guimenu><guimenuitem>Load & Convert DTD</guimenuitem></menuchoice> menu. Select the <filename>.dtd</filename> file which defines the DTD you want to use, and after that you will see the following dialog:
<mediaobject>
<imageobject>
<imagedata fileref="dtd-conversion.png" format="PNG" />
</imageobject>
</mediaobject>
</para>
<para>The entries are:</para>
<itemizedlist>
<listitem><para><guilabel>Target directory name:</guilabel>the newly created &DTEP; will go under this name to the <filename><envar>$TDEHOME</envar>/share/apps/quanta/dtep</filename> folder.
</para>
</listitem>
<listitem><para><guilabel>Name:</guilabel>the name (definition string) of the DTD</para></listitem>
<listitem><para><guilabel>Nickname:</guilabel> the user visible name of the &DTEP;</para></listitem>
<listitem><para><guilabel>!DOCTYPE definition line:</guilabel>
the string that should appear in the !DOCTYPE tag, like
HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"</para></listitem>
<listitem><para><guilabel>DTD URL:</guilabel> the URL pointing to the DTD file</para></listitem>
<listitem><para><guilabel>Default extension:</guilabel> the extension usually used for files that were written in this DTD</para></listitem>
<listitem><para><guilabel>Case-sensitive tags and attributes:</guilabel> self explaining, usually true for XML language variants</para></listitem>
<listitem><para><guilabel>Fine-tune the DTEP after conversion:</guilabel> if checked, after the conversion is done, &quantaplus; will bring up the &descriptionrc; editor, so you can fine tune the newly created &DTEP;. It is recommended to leave this options checked.</para></listitem>
</itemizedlist>
</sect1>
</chapter>
|