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
|
<?xml version="1.0" encoding="ISO8859-1" standalone="no"?>
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
Redistribution and use in source (SGML DocBook) and 'compiled' forms
(SGML, HTML, PDF, PostScript, RTF and so forth) with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code (SGML DocBook) must retain the above
copyright notice, this list of conditions and the following
disclaimer as the first lines of this file unmodified.
2. Redistributions in compiled form (transformed to other DTDs,
converted to PDF, PostScript, RTF and other formats) must reproduce
the above copyright notice, this list of conditions and the
following disclaimer in the documentation and/or other materials
provided with the distribution.
THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
$FreeBSD$
$FreeBSDde$
basiert auf: r38826
-->
<!--?
o SGML-Kontext sollte besser mit Umgebung uebersetzt werden.
Oliver Fischer
-->
<chapter id="sgml-primer">
<title>Die SGML-Fibel</title>
<para>Die Mehrzahl der Dokumente des FDPs sind in SGML geschrieben.
Ziel dieses Kapitels ist es, genau zu erklären, was
das bedeutet und wie man die SGML-Quellen liest und versteht.
Ebenso werden die in den Quellen genutzten Kniffe erklärt,
auf die man beim Lesen der Dokumente stoßen wird.</para>
<para>Teile dieses Kapitels basieren auf Mark Galassis <quote><ulink
url="http://www.galassi.org/mark/mydocs/docbook-intro/docbook-intro.html">Get
Going With DocBook</ulink></quote>.</para>
<sect1 id="sgml-primer-overview">
<title>Überblick</title>
<para>In den guten alten Zeiten war der Umgang mit
<quote>elektronischem</quote> Text einfach. Man musste
lediglich wissen, welcher Zeichensatz (ASCII, EBCDIC oder ein
anderer) vorlag. Text war einfach Text und sah so aus, wie man
ihn sah. Keine Extras, keine Formatierungen und kein sonstiger
Schnickschnack.</para>
<para>Für viele Zwecke war dies allerdings nicht ausreichend.
Von einem machinenlesbaren Text wird erwartet, dass er auch von
Maschinen gelesen und intelligent weiterverarbeitet werden kann.
Einzelne Stellen sollen hervorgehoben werden, andere sollen in ein
Glossar aufgenommen werden oder auf andere Textstellen
verweisen. Dateinamen wiederum sollen in einer
<quote>schreibmaschinenähnlichen</quote> Schrift auf dem
Bildschirm dargestellt werden, der Ausdruck soll jedoch in
<quote>Schrägschrift</quote> oder in einer beliebigen anderen
Darstellungsform erfolgen.</para>
<para>Anfänglich gab es die Hoffnung, dass die
Künstliche Intelligenz (KI) helfen würde, dieses Ziel
zu erreichen. Computer sollte den Text lesen und dazu in der Lage
sein, selbstständig wichtige Formulierungen, Dateinamen,
Benutzereingaben oder Beispiele zu erkennen. Leider verlief die
Entwicklung in diesem Bereich nicht wie gewünscht und Computer
benötigen nach wie vor etwas Unterstützung, bevor sie
Texte vernünftig verarbeiten können.</para>
<para>Genauer gesagt, man muss ihnen sagen, was was ist. Sehen
wir uns folgende Zeilen an:</para>
<blockquote>
<para>Löschen Sie <filename>/tmp/foo</filename> mittels &man.rm.1;.</para>
<screen>&prompt.user; <userinput>rm /tmp/foo</userinput></screen>
</blockquote>
<para>Es fällt uns leicht, zu erkennen, was ein Dateiname, ein
einzugebender Befehl oder ein Verweis auf eine Hilfeseite ist. Das
kann ein Computer, der einen Text verarbeitet, nicht. Aus diesem
Grund ist es notwendig, Texte mit weiteren Informationen
<quote>auszuzeichnen</quote>.</para>
<para>Der Begriff <quote>Auszeichnung<footnote> <para>Im
angelsächischschen Sprachraum wird von
<quote>markup</quote>
gesprochen.</para></footnote></quote> bedeutet, dass
sich der Wert eines Textes erhöht, aber auch seine Kosten.
Durch Auszeichnungen wird einem Dokument zusätzlicher Text
hinzugefügt, der aber von dem eigentlichen Dokumenteninhalt
auf eine bestimmte Art und Weise unterschieden werden kann, so
dass Programme die Auszeichnung erkennen können und
mittels dieser Informationen während der Verarbeitung in
der Lage sind, Entscheidungen zu treffen. Texteditoren
können diese Auszeichnungselemente vor dem Benutzer
verbergen, um zu vermeiden, dass er durch sie abgelenkt
wird.</para>
<!--<para><quote>Markup</quote> is commonly used to describe <quote>adding
value</quote> or <quote>increasing cost</quote>. The term takes on both
these meanings when applied to text. Markup is additional text included
in the document, distinguished from the document's content in some way,
so that programs that process the document can read the markup and use
it when making decisions about the document. Editors can hide the
markup from the user, so the user is not distracted by it.</para>-->
<para>Die durch die Auszeichnungselemente im Textdokument
zusätzlich abgelegten Informationen erhöhen den Wert
des Dokuments. Allerdings muss diese Arbeit in den meisten
Fällen von einem Menschen getan werden – wären
Maschinen dazu fähig, wären zusätzliche
Auszeichnungselemente unnötig. Der damit verbundene Aufwand
<emphasis>erhöht die Kosten</emphasis>, die durch die
Erstellung des Dokuments entstehen.</para>
<para>Das etwas weiter oben gegebene Beispiel sieht im Quelltext
so aus:</para>
<programlisting><![CDATA[
<para>Löschen Sie <filename>/tmp/foo</filename> mittels &man.rm.1;.</para>
<screen>&prompt.user; <userinput>rm /tmp/foo</userinput></screen>]]></programlisting>
<para>Die Auszeichnungselemente sind deutlich vom eigentlichen
Inhalt zu unterscheiden.</para>
<para>Die Einführung von Auszeichnungselementen setzt voraus,
dass festgelegt wird, welche Bedeutung einzelne Elemente haben
und wie diese interpretiert werden. Sie brauchen daher eine
Auszeichnungssprache, der Sie folgen, wenn Sie eigene
Dokumente verfassen.</para>
<para>Natürlich kann es keine universelle
Auszeichnungssprache geben und eine einzige mag nicht
ausreichend für alle möglichen Anwendungsfälle
sein. Eine Sprache für technische Dokumente wird sich
wahrscheinlich stark von einer für Kochrezepte
unterscheiden. Die universelle Lösung ist eine
Basissprache, mit deren Hilfe weitere Sprachen entwickelt werden
können – eine
<emphasis>Meta-Auszeichungssprache</emphasis> also.</para>
<para>Genau diese Anforderung wird von der Standard Generalized
Markup Language (<abbrev>SGML</abbrev>) erfüllt. Mit ihrer
Hilfe wurden viele andere Auszeichungssprachen wie
beispielsweise HTML und DocBook, welche beide von FDP genutzt
werden, entwickelt.</para>
<para>Die eigentliche Sprachdefinition erfolgt in einer
Dokumenten-Typ-Definition (DTD). Innerhalb dieser DTD werden die
Namen der einzelnen Elemente, deren mögliche Reihenfolge
und Verschachtelung sowie weitere Informationen
festgelegt.</para>
<!-- Der letzte Satz dieses Absatzes muss noch übersetzt werden.
Ich habe keine gute Übersetzung dafür bis jetzt
gefunden. Oliver Fischer -->
<!--<para>Each language definition is more properly called a Document Type
Definition (DTD). The DTD specifies the name of the elements that can
be used, what order they appear in (and whether some markup can be used
inside other markup) and related information. A DTD is sometimes
referred to as an <emphasis>application</emphasis> of SGML.</para>-->
<para id="sgml-primer-validating">Eine DTD ist eine
<emphasis>vollständige</emphasis> Definition aller
möglichen Sprachelemente, ihrer
Reihenfolge<footnote><para>Bei natürlichen Sprachen spricht
man vom Satzbau – demjenigen Konstrukt, das unter
anderem die Position des Subjekts, Objekts und
Prädikats in einem Satz festlegt.</para></footnote>,
optionaler Elemente und so weiter und so weiter. Dank dieser
recht formalen Festlegung ist es möglich,
SGML-<emphasis>Parser</emphasis> zu entwickeln, die sowohl ein
Dokument als auch seine DTD einlesen und anhand dieser DTD
prüfen können, ob das Dokument allen Anforderungen der
DTD entspricht. Dieser Vorgang wird allgemein als
<emphasis>Validierung des Dokuments</emphasis>
bezeichnet.</para>
<note>
<para>Das Validieren eines SGML-Dokuments gegen eine DTD
überprüft lediglich die korrekte Syntax des
Dokuments, dass heißt, ob nur gültige
Auszeichnungselemente verwendet wurden und ihre Reihenfolge
stimmt. Dabei wird <emphasis>nicht</emphasis> geprüft, ob
die Elemente der DTD <emphasis>sinngemäß</emphasis>
verwandt wurden. Sollten beispielsweise alle Dateinamen als
Funktionsnamen ausgezeichnet worden sein, so würde der
Parser keinen Fehler signalisieren. Formaler ausgedrückt:
Der Parser prüft die Syntax, aber nicht die
Semantik.</para>
</note>
<para>Es ist anzunehmen, dass, wenn man selber vor hat
Dokumentation für das FDP zu schreiben, der
größte Teil davon mit Hilfe von HTML oder DocBook
geschrieben werden wird. Aus diesem Grunde wird an dieser Stelle
nicht erklärt, wie eine DTD entwickelt wird.</para>
</sect1>
<sect1 id="sgml-primer-elements">
<title>Von Elementen, Tags und Attributen</title>
<!-- Bei der Übersetzung des ersten Satzes bin ich mir nicht
sicher, ob es einee bessere gibt. Oliver Fischer -->
<para>Alle in SGML geschriebenen DTDs haben bestimmte gemeinsame
Eigenschaften. Das ist nicht verwunderlich, da sich die hinter
SGML stehende Idee unweigerlich bemerkbar macht. <!--?
Kandidat fuer ein Umformulierung. Oliver Fischer --> Zwei der
markantesten Merkmale dieser Idee sind die Begriffe
<emphasis>Inhalt</emphasis> und
<emphasis>Element</emphasis>.</para>
<!--<para>All the DTDs written in SGML share certain characteristics. This is
hardly surprising, as the philosophy behind SGML will inevitably show
through. One of the most obvious manifestations of this philosophy is
that of <emphasis>content</emphasis> and
<emphasis>elements</emphasis>.</para>-->
<!--? Vielleicht sollte man nicht von Elementen sondern von Teilen
sprechen. Oliver Fischer -->
<!--?
Hier muss die endlose Rekursion noch besser zum Ausdruck kommen.
-->
<para>Von einem Dokument, unabhängig, ob es sich um eine
einzelne Webseite oder ein langes Buch handelt, wird angenommen,
dass es einen wie auch immer gearteten Inhalt hat. Dieser
lässt sich selbst wiederum in Teilelemente
aufspalten, die ebenso zerlegbar sind. Durch die Aufnahme von
Auszeichnungselementen in einen Text, werden diese einzelnen
Elemente eindeutig benannt und voneinander abgegrenzt.</para>
<!--<para>Your documentation (whether it is a single web page, or a lengthy
book) is considered to consist of content. This content is then divided
(and further subdivided) into elements. The purpose of adding markup is
to name and identify the boundaries of these elements for further
processing.</para>-->
<!--? Begriff Element erscheint hier ploetzlich. Sollte
besser eingefuehrt werden. Oliver Fischer -->
<para>Nimmt man zum Beispiel ein typisches Buch, so kann man es
auf der obersten Ebene als ein Ganzes, als ein Element
betrachten. Dieses <quote>Buch</quote>-Element enthält nun
Kapitel, die wiederum selbst als Elemente bezeichnet werden
können. Jedes einzelne Kapitel enthält weitere
Elemente. So gibt es beispielsweise Absätze, Zitate und
Fußnoten. Jeder Absatz kann wiederum selbst Elemente
enthalten, die helfen, den Absatzinhalt als direkte Rede oder
als Namen eines der Protagonisten einer Geschichte zu
identifizieren.</para>
<para>Wenn man möchte, kann man sich das als
<quote>Unterteilung</quote><footnote><para>Im
angelsächsichen Sprachraum wird hier von
<quote>chunking</quote> gesprochen.</para></footnote> des
Inhalts vorstellen. Auf der obersten Ebene gibt es ein Element:
das Buch selbst. Schaut man ein wenig tiefer, findet man weitere
Teilelemente: die einzelnen Kapitel. Diese sind wiederum
unterteilt in Absätze, Fußnoten, Namen und so weiter
und so weiter.</para>
<para>Anzumerken ist an dieser Stelle, dass das eben gesagte
ohne weiteres auf jeden Inhaltstyp angewandt werden kann, auch
ohne dass von <acronym>SGML</acronym> die Rede ist. Man
könnte beispielsweise einfach verschiedene Stifte nehmen
und einen Ausdruck dieser Fibel vor sich hinlegen und dann mit
verschiedenen Farben die einzelnen Abschnitte des Buchinhalts
markieren.</para>
<para>Leider gibt es keinen elektronischen Stift, um das zu tun.
Deshalb muss ein anderer Weg gewählt werden, um zu
bestimmen, zu welchem Element die einzelnen Inhalte
gehören. In SGML-basierten Auszeichnungssprachen wie HTML
und DocBook werden dafür so genannte
<emphasis>Tags</emphasis> eingesetzt.</para>
<para>Mit einem solchen Tag wird eindeutig festgelegt, wo ein
bestimmtes Element beginnt und wo es endet. <emphasis>Allerdings
gehört der Tag selber nicht zum Element.</emphasis> Er
legt lediglich die Grenzen des Elements fest. Da jede DTD mit dem Ziel
entwickelt wurde, einen speziellen Inhaltstyp auszuzeichnen,
wird jede DTD verschiedene Elemente kennen, die daher
natürlich auch unterschiedlich benannt sein werden.</para>
<para>Der Starttag für ein imaginäres Element mit dem
Namen <replaceable>elementname</replaceable> ist
<sgmltag><<replaceable>elementname</replaceable>></sgmltag>.
Sein Gegenstück, der schließende Endtag, ist
<sgmltag></<replaceable>elementname</replaceable>></sgmltag>.</para>
<example>
<title>Verwendung eines Elements (Start- und Endtag)</title>
<para>HTML kennt das Element <sgmltag>p</sgmltag>, um
festzulegen, dass ein bestimmter abgegrenzter Bereich
einen Absatz darstellt. Dieses Element hat sowohl einen Start-
als auch einen Endtag.</para>
<programlisting><![CDATA[<p>Das ist ein Absatz. Er beginnt mit Starttag
für das Element 'p' und endet mit dem Endtag für
das Element 'p'.</p>
<p>Das ist ein etwas kürzerer Absatz.</p>]]></programlisting>
</example>
<para>Elemente müssen nicht notwendigerweise einen Endtag
haben. Ebenso ist es nicht notwendig, dass Elemente einen
Inhalt haben. Beispielsweise kann in HTML-Dokumenten mittels
eines speziellen Elements festgelegt werden, dass eine
horizontale Linie an einer bestimmten Stelle erscheinen soll. Da
dieses Element offensichtlich keinen Inhalt hat, wird auch kein
Endtag benötigt.</para>
<example>
<title>Verwendung eines Elements (nur Starttag)</title>
<para>In HTML kann man mit dem Element <sgmltag>hr</sgmltag>
festlegen, dass an einer bestimmten Stelle eine
horizontale Linie angezeigt werden soll. Da dieses Element
keinen Inhalt umschließt, hat es nur einen
Starttag.</para>
<programlisting><![CDATA[<p>Das ist ein Abschnitt.</p>
<hr>
<p>Das ist ein weiterer Absatz. Eine horizontale Linie
trennt ihn vom vorherigen Absatz.</p>]]></programlisting>
</example>
<para>Elemente können andere Elemente enthalten. Im
anfangs erwähnten Buch enthielt das Buch-Element
alle Kapitel-Elemente, die wiederum alle Absatz-Elemente
enthielten und so fort.</para>
<example>
<title>Verschachtelte Elemente: <sgmltag>em</sgmltag></title>
<programlisting><![CDATA[<p>Das ist ein einfacher <em>Abschnitt</em>, in dem
einige <em>Worte</em> <em>hervorgehoben</em> wurden.]]></programlisting>
</example>
<para>Welche Elemente andere Elemente enthalten können und
welche das sind, wird innerhalb der DTD eines Dokuments
festgelegt.</para>
<!--
<para>The DTD will specify the rules detailing which elements can contain
other elements, and exactly what they can contain.</para>
-->
<important>
<para>Viele Leute sind oft verwirrt, wenn es um die richtige
Benutzung der Begriffe Tag und Element geht. Im Ergebnis werden
sie oft so genutzt, als wären sie austauschbar.
Allerdings sind sie das nicht.</para>
<para>Ein Element ist ein konzeptioneller Teil eines Dokuments
und hat einen festgelegten Anfang und ein festgelegtes
Ende. Ein Tag hingegen markiert die Stelle, an der ein Element
beginnt und endet.</para>
<para>Wenn in diesem Dokument vom <quote>Tag <sgmltag>p</sgmltag></quote>
gesprochen wird, ist damit der Text
gemeint, der aus den drei Zeichen <literal><</literal>,
<literal>p</literal> und <literal>></literal> besteht. Wird
hingegen von dem <quote>Element <sgmltag>p</sgmltag></quote>
gesprochen, ist damit das gesamte Element gemeint.</para>
<para>Diese Unterscheidung ist sicherlich subtil. Trotzdem
sollte man sie sich vergegenwärtigen.</para>
</important>
<para>Elemente können selber Attribute haben, die aus einem
Namen und einem Wert bestehen. Die Attribute haben die Aufgabe,
dem Element zusätzliche Informationen hinzuzufügen.
Denkbar sind hier Festlegungen über die Darstellung,
Bezeichner, über die das Element eindeutig identifiziert
werden kann, oder beliebige andere Informationen.</para>
<para>Elementattribute werden in den <emphasis>Starttag</emphasis>
eingefügt und haben die Form
<literal><replaceable>Attributename</replaceable>="<replaceable>Wert</replaceable>"</literal>.</para>
<para>Bei einigen HTML-Versionen kennt das Element
<sgmltag>p</sgmltag> das Attribut <sgmltag>align</sgmltag>, mit
dessen Hilfe die Textausrichtung eines Absatzes bestimmt werden
kann.</para>
<para><literal>align</literal> akzeptiert einen von vier
vorgegebenen Werten: <literal>left</literal>,
<literal>center</literal>, <literal>right</literal> und
<literal>justify</literal>. Ist <literal>align</literal> nicht
angegeben, wird vom Standardwert <literal>left</literal>
ausgegangen.</para>
<example>
<title>Elemente mit Attributen nutzen</title>
<programlisting><![CDATA[<p align="left">Die Verwendung des align-Attributs
für diesen Absatz ist überflüssig, da left
der Standardwert ist.</p>
<p align="center">Dieser Absatz wird hoffentlich mittig dargestellt.</p>]]></programlisting>
</example>
<para>Einige Attribute akzeptieren nur bestimmte Werte, wie
beispielsweise <literal>left</literal> oder
<literal>justify</literal>. Andere akzeptieren jeden beliebigen
Wert. Enthält Attributwert doppelte Anführungszeichen
(<literal>"</literal>), wird der Wert in einfachen
Anführungszeichen eingeschlossen.</para>
<example>
<title>Attribute mit einfachen Anführungszeichen</title>
<programlisting><![CDATA[<p align='right'>Ich stehe rechts!</p>]]></programlisting>
</example>
<para>Manchmal können die Anführungszeichen um den
Attributwert weggelassen werden. Allerdings sind die Regeln,
die festlegen wann dies zulässig ist, sehr spitzfindig.
Am besten schließen Sie Attributwerte
<emphasis>immer</emphasis> in Anführungszeichen ein.</para>
<para>Die Informationen über Attribute, Elemente und Tags
sind in SGML-Katalogen abgelegt und werden von den verschiedenen
Werkzeugen des Dokumentationsprojektes genutzt, um die
geschriebenen Dokumente zu validieren. Die Programme die durch
<filename role="package">textproc/docproj</filename> installiert
werden, bringen ihre eigenen Katalogvarianten mit, zudem pflegt
das FDP seine eigenen Kataloge. Beide Katalogarten müssen
von allen Programmen gefunden werden können.</para>
<sect2>
<title>Was dafür getan werden muss;…</title>
<para>Damit die Beispiele dieser Fibel ausgeführt werden
können, ist es notwendig, dass einige Programme auf
dem Rechner installiert sind und das eine Umgebungsvariable
korrekt gesetzt wird.</para>
<procedure>
<step>
<para>Der erste Schritt ist die Installation des Ports
<filename role="package">textproc/docproj</filename>
über das FreeBSD-Portsystem. <filename
role="package">textproc/docproj</filename> ist ein
<emphasis>Metaport</emphasis>, der alle vom FDP
benötigten Programme und Daten aus dem Netz laden und
installieren sollte.</para>
</step>
<step>
<para>Anschließend muss in den Shellkonfigurationsdateien die
Variable <envar>SGML_CATALOG_FILES</envar>
<footnote><simpara>Sofern man nicht an der deutschen
Dokumentation arbeitet, müssen die
Verzeichnisangaben entsprechend angepasst
werden.</simpara>
</footnote> gesetzt werden.</para>
<example id="sgml-primer-envars">
<title><filename>.profile</filename>, für &man.sh.1; und
&man.bash.1; Benutzer</title>
<programlisting>SGML_ROOT=/usr/local/share/sgml
SGML_CATALOG_FILES=${SGML_ROOT}/jade/catalog
SGML_CATALOG_FILES=${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/doc/share/sgml/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILES
export SGML_CATALOG_FILES</programlisting>
</example>
<!--?
Hier muesste geprueft werden, ob sich die letzten beiden Zeilen
vertragen oder nicht. Gibt es Entitaeten, die in beiden
vorhanden sind, aber unterschiedliche Uebersetzungen haben?
Oliver Fischer
-->
<example>
<title><filename>.cshrc</filename>, für &man.csh.1;- und
&man.tcsh.1;-Benutzer</title>
<programlisting>setenv SGML_ROOT /usr/local/share/sgml
setenv SGML_CATALOG_FILES ${SGML_ROOT}/jade/catalog
setenv SGML_CATALOG_FILES ${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES ${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES ${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES /usr/doc/share/sgml/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES /usr/doc/de_DE.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILES</programlisting>
</example>
<para>Damit die Änderungen wirksam werden, meldet man
sich ab und anschließend wieder an – oder man
führt die obigen Anweisungen direkt in der Shell
aus und setzt so die benötigten Umgebungsvariablen.</para>
</step>
</procedure>
<procedure>
<step>
<para>Nun sollte man eine Datei
<filename>beispiel.sgml</filename> anlegen, die den
folgenden Text enthält:</para>
<programlisting><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Eine Beispieldatei in HTML</title>
</head>
<body>
<p>Das ist ein Absatz mit etwas Text.</p>
<p>Das ist ein Absatz mit anderem Text.</p>
<p align="right">Dieser Absatz wird rechtsbündig
ausgerichtet.</p>
</body>
</html>]]></programlisting>
</step>
<step>
<para>Nachdem die Datei abgespeichert wurde, kann sie
mit Hilfe eines SGML-Parsers validiert werden.</para>
<para>Bestandteil von <filename role="package">textproc/docproj</filename>
ist <command>onsgmls</command> - ein <link
linkend="sgml-primer-validating">validierender Parser</link>.
<command>onsgmls</command> liest ein Dokument entsprechend einer SGML-DTD
ein und gibt anschließend ein Element-Structure-Information-Set
(ESIS) aus. Allerdings ist das an dieser Stelle nicht weiter
wichtig.</para>
<para>Wird <command>onsgmls</command> mit der Option <option>-s</option>
aufgerufen, werden nur Fehlermeldungen ausgegeben. Dadurch
kann leicht geprüft werden, ob ein Dokument gültig
ist oder nicht.</para>
<para>So prüft man mit <command>onsgmls</command>, ob die neuangelegte
Beispieldatei gültig ist:</para>
<screen>&prompt.user; <userinput>onsgmls -s beispiel.sgml</userinput></screen>
<para>Sofern das Beispiel korrekt abgetippt wurde, wird sich
<command>onsgmls</command> ohne jegliche Ausgabe beenden. Das bedeutet,
dass das Dokument erfolgreich validiert werden konnte
und somit gültig ist.</para>
</step>
<step>
<para>Jetzt sollten die Tags <sgmltag>title</sgmltag> und
<sgmltag>/title</sgmltag> aus dem Dokument gelöscht
und das Dokument erneut validiert werden:</para>
<screen>&prompt.user; <userinput>onsgmls -s beispiel.sgml</userinput>
onsgmls:beispiel.sgml:5:4:E: character data is not allowed here
onsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen>
<para>Die Fehlermeldungen, die von <command>onsgmls</command>
ausgegeben werden, sind in durch Doppelpunkte getrennte
Spalten unterteilt.</para>
<informaltable frame="none" pgwide="1">
<tgroup cols="2">
<thead>
<row>
<entry>Spalte</entry>
<entry>Bedeutung</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>Der Name des Programms, das den Fehler
meldet. Hier wird immer <literal>onsgmls</literal>
stehen.</entry>
</row>
<row>
<entry>2</entry>
<entry>Der Name der fehlerhaften Datei.</entry>
</row>
<row>
<entry>3</entry>
<entry>Die Zeilennummer des Fehlers.</entry>
</row>
<row>
<entry>4</entry>
<entry>Die Spaltenummer des Fehlers.</entry>
</row>
<row>
<entry>5</entry>
<entry>Ein einbuchstabiger Code, der über die
Art des Fehlers informiert. <literal>I</literal>
steht für eine informelle Meldung,
<literal>W</literal> für eine Warnung und
<literal>E</literal> für Fehler<footnote>
<para>Nicht immer besteht eine Meldung aus
fünf Spalten. Die Ausgabe von
<command>onsgmls -sv</command> ist
beispielsweise <literal>onsgmls:I: SP version
"1.3"</literal> (natürlich
abhängig von der Version). Wie man sehen
kann, handelt es sich hier um eine informelle
Meldung.</para>
</footnote> und <literal>X</literal> für
einen Querverweis. Bei den oben stehenden Ausgaben
handelt es sich also um Fehlermeldungen.</entry>
</row>
<row>
<entry>6</entry>
<entry>Die Meldung.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>Durch das Weglassen des Tags <sgmltag>title</sgmltag>
sind zwei unterschiedliche Fehler entstanden.</para>
<para>Der erste Fehler besagt, dass Inhalt (in diesem
Falle Zeichen anstatt eines Starttags) an einer Stelle
gefunden wurde, an der der Parser etwas anderes erwartet
hat. Genauer gesagt wurde der Starttag eines Elements
erwartet, das innerhalb von <sgmltag>head</sgmltag>
auftreten kann.</para>
<para>Der zweite Fehler wurde dadurch verursacht, dass
das Element <sgmltag>head</sgmltag> ein
Element <sgmltag>title</sgmltag> enthalten
<emphasis>muss</emphasis> und <command>onsgmls</command>
nicht berücksichtigt, dass dieser Fehler auf dem
vorhergehenden beruht. Es wird lediglich festgestellt,
dass der Endtag von <sgmltag>head</sgmltag> auftritt,
obwohl nicht alle notwendigen Elemente vorhanden sind.</para>
</step>
<step>
<para>Zum Schluß sollte der Tag
<sgmltag>title</sgmltag> wieder in die Beispieldatei
eingefügt werden.</para>
</step>
</procedure>
</sect2>
</sect1>
<sect1 id="sgml-primer-doctype-declaration">
<!--? Oliver Fischer: Man sollte mal feststellen, welche Bezeichung
von w3c.de oder so hier verwendet wird.-->
<title>Die DOCTYPE-Deklaration</title>
<para>Am Anfang jedes Dokuments muss der Name der dem
Dokument zugrundeliegenden DTD angegeben werden. Mit Hilfe
dieser Information können SGML-Parser die verwendete DTD
feststellen und prüfen, ob das Dokument zu ihr konform ist.</para>
<para>Üblicherweise steht diese Information in einer Zeile,
die als DOCTYPE-Deklaration bezeichnet wird.</para>
<para>Eine Deklaration für ein HTML-Dokument, das nach den
Vorgaben der DTD für HTML 4.0 geschrieben wurde, sieht so
aus:</para>
<programlisting><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN">]]></programlisting>
<para>und besteht aus verschiedenen Teilen.</para>
<!--<para>That line contains a number of different components.</para>-->
<!--?
Hier bin ich mir nicht sicher, ob ich genau übersetzt habe oder
das Orginal sprachlich ungenau ist. Man sollte hier mal
in den Standardspezikationen nachschlagen und gegebenenfalls
das Orginal korrigieren.
Oliver Fischer
-->
<variablelist>
<varlistentry>
<term><literal><!</literal></term>
<listitem>
<para>Die Zeichenkette <literal><!</literal> dient hier
als <emphasis>Indikator</emphasis>, dass es sich bei
diesem Ausdruck um eine SGML-Deklaration handelt und diese
Zeile den Dokumententyp festlegt.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>DOCTYPE</literal></term>
<listitem>
<para>Zeigt an, dass dies die SGML-Deklaration für
den Dokumententyp ist.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>html</literal></term>
<listitem>
<para>Nennt das erste <link
linkend="sgml-primer-elements">Element</link>, das im
Dokument auftaucht.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>PUBLIC "-//W3C//DTD HTML 4.0//EN"</literal></term>
<listitem>
<para>Nennt den Formalen Öffentlichen Bezeichner
<footnote>
<simpara>auf Englisch <foreignphrase>Formal Public
Identifier (FPI) </foreignphrase></simpara>
</footnote> der DTD des Dokuments. Diese Information wird
von SGML-Parsern ausgewertet, um die von dem Dokument
referenzierte DTD zu bestimmen.</para>
<para>Das Schlüsselwort <literal>PUBLIC</literal>
gehört nicht zum öffentlichen Bezeichner,
sondern legt fest, wie ein SGML-Parser die DTD finden
kann. Alternative Wege eine DTD zu referenzieren werden
<link linkend="sgml-primer-fpi-alternatives">später
gezeigt</link>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>></literal></term>
<listitem>
<para>Schließt den mit <literal><!</literal> begonnenen
Ausdruck ab.</para>
</listitem>
</varlistentry>
</variablelist>
<sect2>
<title>Formale Öffentliche Bezeichner</title>
<!--? -->
<note>
<para>Dieser Abschnitt braucht nicht unbedingt zu gelesen zu
werden. Dennoch ist es empfehlenswert, da er nützliche
Hintergrundinformationen enthält, die hilfreich sein
können, falls der SGML-Prozessor die genutzte DTD nicht
finden kann.</para>
</note>
<para>Jeder öffentliche Bezeichner muss eine bestimmte Syntax
haben, die wie folgt lautet:</para>
<!-- Oliver Fischer: Ich habe hier Owner mit Besitzer uebersetzt.
Mein Gefühl sagt mir, dass dies nicht 100% richtig ist.
Vielleicht ist Aussteller bessert? -->
<programlisting>"<replaceable>Besitzer</replaceable>//<replaceable>Schlüsselwort</replaceable> <replaceable>Beschreibung</replaceable>//<replaceable>Sprache</replaceable>"</programlisting>
<variablelist>
<varlistentry>
<term><replaceable>Besitzer</replaceable></term>
<listitem>
<para>Nennt den Besitzer des öffentlichen Bezeichners.</para>
<para>Falls diese Zeichenkette mit <quote>ISO</quote>
beginnt, gehört der Bezeichner dem ISO-Kommitee.
Der Bezeichner <literal>"ISO 8879:1986//ENTITIES Greek
Symbols//EN"</literal> nennt <quote>ISO
8879:1986</quote> als den Besitzer des Satzes von
Entitäten für griechische Zeichen. ISO
8879:1986 ist die ISO-Bezeichnung für den
SGML-Standard.</para>
<!--? Die Formulierung gefällt mir nicht. Oliver Fischer -->
<para>Beginnt die Zeichenkette nicht mit
<quote>ISO</quote>, sieht sie entweder so
<literal>-//<replaceable>Besitzer</replaceable></literal>
oder so
<literal>+//<replaceable>Besitzer</replaceable></literal>
aus. Beide Varianten unterscheiden sich also nur durch
das anfängliche <literal>+</literal> bzw.
<literal>-</literal>.</para>
<para>Sofern am Anfang ein <literal>-</literal> steht, ist
der Bezeichner nicht öffentlich registriert, steht
hingegen ein <literal>+</literal> am Anfang, ist er
registriert.</para>
<!--? Vielleicht besser: Wie Namen registeriert werden?
Oliver Fischer -->
<!--? Mit der Übersetzung des letzten Satzes bin ich mir
nicht sicher.... Das muss irgendwie besser ausgedrückt
werden.... -->
<para>Im ISO-Standard ISO 9070:1991 wurde festgelegt, wie
registrierte Namen erzeugt werden können. Unter
anderem können sie von den Bezeichnungen von
ISO-Publikationen, von ISBN-Nummern oder einer
Organisationsbezeichnungen entsprechend ISO 6523
abgeleitet werden. Anträge für neue offiziell
registrierte Bezeichner werden vom ISO-Kommitee an das
American National Standards Institute (ANSI)
weitergeleitet.</para>
<!--?
Eine Zeichenkette kann kein Besitzer sein.
Wie koennte man das besser ausdruecken?
-->
<para>Da das FreeBSD-Projekt seine Bezeichner nicht hat
registrieren lassen, ist der Besitzer
<literal>-//FreeBSD</literal>. Unter anderem kann man
daran auch sehen, dass das W3C sich nicht hat
registrieren lassen.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>Schlüsselwort</replaceable></term>
<listitem>
<para>Es gibt verschiedene Schlüsselwörter mit
denen man die Art der gegebenen Informationen beschreiben
kann. Einige der üblichsten sind
<literal>DTD</literal>, <literal>ELEMENT</literal>,
<literal>ENTITIES</literal> und <literal>TEXT</literal>.
<literal>DTD</literal> wird nur für Dateien mit
DTDs verwandt, <literal>ELEMENT</literal> findet
für Dateien mit Fragmenten von DTDs Verwendung, die
nur Deklarationen für Entitäten und Elemente
enthalten. <literal>TEXT</literal> wird für
SGML-Inhalte (Texte und Tags) verwendet.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>Beschreibung</replaceable></term>
<listitem>
<para>Eine frei wählbare Beschreibung des Inhalts der
referenzierten Datei. Möglich sind hier
Versionsnummern oder ein kurzer und sinnvoller Text, der
innerhalb der SGML-Welt eindeutig ist.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>Sprache</replaceable></term>
<listitem>
<para>Ein ISO-Code aus zwei Buchstaben, der die für
die Datei verwendete Sprache nennt.
<literal>EN</literal> steht hier für Englisch,
<literal>DE</literal> für Deutsch.</para>
</listitem>
</varlistentry>
</variablelist>
<sect3>
<title>Die <filename>catalog</filename>-Dateien</title>
<para>Wenn man die oben beschriebene Syntax für
Bezeichner verwendet und ein Dokument durch einen
SGML-Prozessor schickt, muss dieser die
Möglichkeit haben, den Bezeichner auf eine real
existierende Datei abzubilden, die die benötigte DTD
enthält.</para>
<para>Einer der möglichen Wege hierfür sind
Katalogdateien. Eine solche Datei, die üblicherweise
<filename>catalog</filename> heißt, besteht aus
einzelnen Zeilen, die Bezeichner auf Dateinamen abbilden.
Enthält ein Katalog beispielsweise die Zeile</para>
<programlisting>PUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd"</programlisting>
<para>kann ein SGML-Prozessor darüber feststellen, dass die
benötigte DTD in der Datei <filename>strict.dtd</filename>
im Unterverzeichnis <filename class="directory">4.0</filename>
des Verzeichnisses des Katalogs zu finden ist.</para>
<para>Ein gutes Beispiel für einen Katalog ist
<filename>/usr/local/share/sgml/html/catalog</filename>.
Diese Datei enthält den Katalog für alle HTML
DTDs, die im Zuge der Installation von <filename
role="package">textproc/docproj</filename> installiert
wurden.</para>
</sect3>
<sect3>
<title>Die Variable <envar>SGML_CATALOG_FILES</envar></title>
<para>Natürlich muss einem SGML-Prozessor noch
mitgeteilt werden können, wo er seine Kataloge finden
kann. Viele Programme bieten hierfür
Kommandozeilenoptionen an, über die man einen oder
mehrere Kataloge angeben kann.</para>
<para>Zusätzlich besteht noch die Möglichkeit mit
der Umgebungsvariablen <envar>SGML_CATALOG_FILES</envar> auf
SGML-Kataloge zu verweisen. Die Einträge von
<envar>SGML_CATALOG_FILES</envar> müssen aus den
vollständigen Pfadnamen der Kataloge, jeweils durch
Komma getrennt, bestehen.</para>
<!--? Stimmt die Formulierung? Oliver Fischer -->
<para>Üblicherweise werden die folgenden Kataloge über
<envar>SGML_CATALOG_FILES</envar> für
die Arbeit an den Dokumenten des FDPs eingebunden:</para>
<itemizedlist>
<listitem>
<para><filename>/usr/local/share/sgml/docbook/4.1/catalog</filename></para>
</listitem>
<listitem>
<para><filename>/usr/local/share/sgml/html/catalog</filename></para>
</listitem>
<listitem>
<para><filename>/usr/local/share/sgml/iso8879/catalog</filename></para>
</listitem>
<listitem>
<para><filename>/usr/local/share/sgml/jade/catalog</filename></para>
</listitem>
</itemizedlist>
<para>Allerdings sollte das
<link linkend="sgml-primer-envars">schon geschehen
sein</link>.</para>
</sect3>
</sect2>
<sect2 id="sgml-primer-fpi-alternatives">
<title>Alternativen zu Formalen Öffentlichen Bezeichnern</title>
<para>Anstatt mit einem Bezeichner die zum Dokument
gehörende DTD zu referenzieren, kann auch explizit auf
die Datei der DTD verwiesen werden.</para>
<para>Die Syntax des DOCTYPE-Deklaration ist in diesem Falle
anders:</para>
<!--<para>The syntax for this is slightly different:</para>-->
<programlisting><![CDATA[<!DOCTYPE html SYSTEM "/pfad/zur/dokumenten.dtd">]]></programlisting>
<para>Das Schlüsselwort <literal>SYSTEM</literal> legt
fest, dass ein SGML-Prozessor die DTD auf
<quote>systemspezifische</quote> Art und Weise bestimmen soll.
Meistens, aber nicht immer, wird so auf eine Datei im
Dateisystem verwiesen.</para>
<para>Allerdings sollte man öffentliche Bezeichner aus
Gründen der Portabilität bevorzugen, da man so
nicht eine Kopie der DTD mit dem Dokument selber verteilen
muss, beziehungsweise da man, wenn man mit
<literal>SYSTEM</literal> arbeitet, nicht davon ausgehen kann,
dass die benötigte DTD auf anderen Systemen genau
unter dem gleichen Pfad verfügbar ist.</para>
</sect2>
</sect1>
<sect1 id="sgml-primer-sgml-escape">
<title>Die Rückkehr zu SGML</title>
<para>An einer früheren Stelle wurde erwähnt, dass
man SGML nur benötigt, falls man selbst eine DTD entwickeln
möchte. Genaugenommen ist das nicht 100%ig richtig. Einige
Teile der SGML-Syntax können auch in normalen Dokumenten
verwendet werden, falls dies gewünscht oder notwendig
ist.</para>
<para>In diesem Falle muss dafür Sorge getragen werden,
dass ein SGML-Prozessor feststellen kann, dass ein
bestimmter Abschnitt des Inhalts SGML ist, das er verarbeiteten
muss.</para>
<para>Solche SGML-Abschnitte werden mittels
<literal><! ... ></literal> in Dokumenten
besonders gekennzeichnet. Alles, was sich zwischen diesen
Begrenzungen befindet, ist SGML, wie es auch in DTDs gefunden
werden kann.</para>
<para>Demnach ist die <link
linkend="sgml-primer-doctype-declaration">DOCTYPE-Deklaration</link>
ein gutes Beispiel für SGML, das in Dokumenten verwendet
werden muss…</para>
</sect1>
<sect1 id="sgml-primer-comments">
<title>Kommentare</title>
<para>Kommentare sind SGML-Konstrukte, die normalerweise nur
in DTDs gültig sind. Dennoch ist es, wie in
<xref linkend="sgml-primer-sgml-escape"/> gezeigt,
möglich Fragmente mit SGML-Syntax in Dokumenten zu
verwenden.</para>
<para>Zum Abgrenzen von SGML-Kommentaren wird ein doppelter
Bindestrich <quote><literal>--</literal></quote> verwendet. Mit
seinem ersten Auftreten öffnet er einen Kommentar, mit
seinem zweiten schließt er ihn wieder.</para>
<example>
<title>Beispiele für Kommentare in SGML</title>
<programlisting><!-- Testkommentar --></programlisting>
<programlisting><![CDATA[
<!-- Text innerhalb eines Kommentars -->
<!-- Ein anderer Kommentar -->
<!-- So können mehrzeilige Kommentare
genutzt werden -->
<!-- Eine andere Möglichkeit für --
-- mehrzeilige Kommentare. -->]]></programlisting>
</example>
<!--? Noch zu uebersetzen. Oliver Fischer -->
<![%output.print;[
<important>
<title>Es sind zwei Bindestriche</title>
<para>Es gibt ein Problem mit den PostScript- oder
PDF-Versionen dieses Dokuments. Das obige Beispiel
zeigt vielleicht nur einen Bindestrich (<literal>-</literal>)
hinter <literal><!</literal> und vor
<literal>></literal>.</para>
<para>Es <emphasis>müssen</emphasis> zwei Bindestriche
und <emphasis>nicht</emphasis> nur einer benutzt werden.
Die PostScript- und PDF-Versionen haben vielleicht
beide Bindestriche zu einem längeren Strich, dem
<emphasis>em-dash</emphasis>, zusammengefasst.</para>
<para>Die HTML-, nur-Text und RTF-Versionen dieses Dokuments
sind nicht von diesem Problem betroffen.</para>
</important>
]]>
<para>Hat man früher schon Erfahrungen mit HTML gesammelt,
wird man vielleicht andere Regeln für den Gebrauch von
Kommentaren kennengelernt haben. Beispielsweise wird oft
angenommen, dass Kommentare mit <literal><!--</literal>
begonnen und nur mit <literal>--></literal> beendet
werden.</para>
<para>Dies ist <emphasis>nicht</emphasis> der Fall. Viele
Webbrowser haben fehlerhafte HTML-Parser, die dies akzeptieren.
Die SGML-Parser, die vom FDP verwendet werden, halten sich
strenger an die SGML-Spezifikation und verwerfen Dokumente mit
solchen Fehlern.</para>
<example>
<title>Fehlerhafte SGML-Kommentare</title>
<programlisting><![CDATA[
<!-- Innerhalb eines Kommentars --
DIES IST NICHT TEIL EINES KOMMENTARS
-- Wieder innerhalb eines Kommentars -->]]></programlisting>
<para>SGML-Parser würden die mittlere Zeile wie folgt
interpretieren:</para>
<!--<para>The SGML parser will treat this as though it were actually;</para>-->
<programlisting><!DIES IST NICHT TEIL EINES KOMMENTARS></programlisting>
<para>Da es sich hierbei nicht um gültiges SGML handelt, kann
diese Zeile zur verwirrenden Fehlermeldungen führen.</para>
<programlisting><![CDATA[<!--------------- Eine wirklich schlechte Idee --------------->]]></programlisting>
<para>Wie das Beispiel zeigt, sollten solche Kommentare
tunlichst vermieden werden.</para>
<!--<para>As the example suggests, <emphasis>do not</emphasis> write
comments like that.</para>-->
<programlisting><![CDATA[<!--===================================================-->]]></programlisting>
<para>Ein solcher Kommentar ist (ein wenig) besser, kann aber
jemanden, der mit SGML noch nicht so vertraut ist,
verwirren.</para>
</example>
<sect2>
<title>Fingerübungen…</title>
<procedure>
<step>
<para>Zur Übung können Sie einige Kommentare in
die Datei <filename>beispiel.sgml</filename> einfügen
und überprüfen, ob die Datei nun noch erfolgreich
von <command>onsgmls</command> validiert werden kann.</para>
</step>
<step>
<para>Zu Testzwecken sollten Sie
auch noch ein paar fehlerhafte Kommentare hinzufügen
und sich die resultierenden Fehlermeldungen von
<command>onsgmls</command> ansehen.</para>
</step>
</procedure>
</sect2>
</sect1>
<sect1 id="sgml-primer-entities">
<title>Entitäten</title>
<para>Entitäten stellen einen Mechanismus dar, mit dem
einzelnen Dokumententeilen ein Name zugewiesen werden kann.
Findet ein SGML-Parser während des Parsens eine
Entität, ersetzt er diese durch den ihr zugewiesenen
Inhalt.</para>
<para>Dadurch steht eine einfache Möglichkeit zur
Verfügung, mit der variabler Inhalt in SGML-Dokumenten
eingebunden werden kann. Zusätzlich sind Entitäten der
einzige Weg, über den eine Datei in eine andere Datei mit
SGML-Mitteln eingebunden werden kann.</para>
<para>Es werden zwei Arten von Entitäten unterschieden:
<emphasis>Allgemeine Entitäten</emphasis> und
<emphasis>Parameterentitäten</emphasis>.</para>
<sect2 id="sgml-primer-general-entities">
<title>Allgemeine Entitäten</title>
<para>Allgemeine Entitäten können nur in
Dokumenten benutzt werden. Sie können zwar im
SGML-Kontext definiert aber dort nicht benutzt
werden. Vergleichen Sie dies mit
Im <link linkend="sgml-primer-parameter-entities">Parameterentitäten</link>.</para>
<para>Jede allgemeine Entität hat einen Namen, über
den sie angesprochen werden kann, um den von ihr
referenzierten Inhalt in ein Dokument einzubinden. Dafür
muss an der betreffenden Stelle der Namen der
Entität per
<literal>&<replaceable>entitaetenname</replaceable>;</literal>
einfügt werden. Eine Entität
<literal>current.version</literal> könnte beispielsweise
durch die aktuelle Versionsnummer eines Programms ersetzt
werden. Man könnte also schreiben:</para>
<!--?
Der vorhergehende Satz ist nicht 100% sinngemaeß uebersetzt.
Klingt zudem doof.
Oliver Fischer
-->
<!--<para>Each general entity has a name. When you want to reference a
general entity (and therefore include whatever text it represents in
your document), you write
<literal>&<replaceable>entity-name</replaceable>;</literal>. For
example, suppose you had an entity called
<literal>current.version</literal> which expanded to the current
version number of your product. You could write;</para>-->
<programlisting><![CDATA[<para>Die aktuelle Version des
Programms ist ¤t.version;.</para>]]></programlisting>
<para>Wenn sich die Versionsnummer ändert, muss
nur die Entität angepasst und anschließend
das Dokument neu erzeugt werden.</para>
<para>Eine weitere Einsatzmöglichkeit für Allgemeine
Entitäten ist das Einbinden von Zeichen, die auf andere
Weise nicht in ein SGML-Dokument eingefügt werden
könnten. Ein Beispiel für solche Zeichen sind
<literal><</literal> und <literal>&</literal>, die
normalerweise nicht direkt in
SGML-Dokumenten erlaubt sind. Stößt ein SGML-Parser
bei seiner Arbeit auf das Symbol <literal><</literal>,
nimmt er an, dass der Anfang eines Start- oder Endtags
gefunden wurde. Bei einem <literal>&</literal> wird er
annehmen, den Anfang einer Entität gefunden zu haben.</para>
<para>Wenn eines der beiden Zeichen benötigt wird, werden
daher die allgemeinen Entitäten <literal>&lt;</literal>
und <literal>&amp;</literal> verwendet.</para>
<para>Allgemeine Entitäten können nur in einem
SGML-Kontext definiert werden. Üblich ist es, dies direkt
nach der DOCTYPE-Deklaration zu tun:</para>
<example>
<title>Allgemeine Entitäten festlegen</title>
<programlisting><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY current.version "3.0-RELEASE">
<!ENTITY last.version "2.2.7-RELEASE">
]>]]></programlisting>
<para>Wichtig ist an dieser Stelle, dass die
DOCTYPE-Deklaration durch eine eckige Klammer am Ende der
ersten Zeile erweitert wurde. Die beiden Entitäten
selber werden in den folgenden zwei Zeilen definiert, bevor
in der letzten Zeile die eckige Klammer und die
DOCTYPE-Deklaration wieder geschlossen werden.</para>
<!--?
UEbersetzung mit dem Orginal vergleichen und nach einer
besseren UEbersetzung suchen.
-->
<para>Die eckigen Klammern sind notwendig um festzulegen, dass
man die über DOCTYPE genannte DTD erweitern möchte.</para>
</example>
</sect2>
<sect2 id="sgml-primer-parameter-entities">
<title>Parameterentitäten</title>
<para>Genau wie <link
linkend="sgml-primer-general-entities">Allgemeine
Entitäten</link> werden Parameterentitäten
eingesetzt um wiederverwendbare Inhaltsteile mit Namen zu
versehen. Im Gegensatz zu Allgemeinen Entitäten
können sie aber nur innerhalb eines <link
linkend="sgml-primer-sgml-escape">SGML-Kontextes</link>
genutzt werden.</para>
<para>Die Definition von Parameterentitäten erfolgt
ähnlich zu der Allgemeiner Entitäten. Sie werden
lediglich mit
<literal>%<replaceable>entitaetenname</replaceable>;</literal>
anstelle von
<literal>&<replaceable>entitaetenname</replaceable>;</literal>
referenziert<footnote>
<para>Es wird das Prozentzeichen anstelle des
kaufmännischen Unds verwendet.</para>
</footnote>. Wichtig ist, dass das
<literal>%</literal>-Zeichen zwischen
<literal>ENTITY</literal> und dem Entitätennamen ein Teil
der Definition ist.</para>
<example>
<title>Parameterentitäten festlegen</title>
<programlisting><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % param.etwas "etwas">
<!ENTITY % param.text "Text">
<!ENTITY % param.neu "%param.etwas mehr %param.text">
<!-- %param.neu ist jetzt "etwas mehr Text" -->
]>]]></programlisting>
</example>
<!--? Noch nicht übersetzt. Oliver Fischer -->
<!--<para>This may not seem particularly useful. It will be.</para>-->
</sect2>
<sect2>
<title>Fingerübungen…</title>
<procedure>
<step>
<para>Fügen Sie in <filename>beispiel.sgml</filename>
eine Allgemeine Entität ein.</para>
<programlisting><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" [
<!ENTITY version "1.1">
]>
<html>
<head>
<title>Eine HTML-Beispieldatei</title>
</head>
<body>
<p>Das ist ein Absatz mit etwas Text.</p>
<p>Das ist ein Absatz mit anderem Text.</p>
<p align="right">Dieser Absatz wird rechtsbündig
ausgerichtet.</p>
<p>Die aktuelle Version ist: &version;</p>
</body>
</html>]]></programlisting>
</step>
<step>
<para>Validieren Sie diese Datei mit
<command>onsgmls</command></para>
</step>
<step>
<para>Öffnen Sie nun <filename>beispiel.sgml</filename>
mit Ihrem Webbrowser. Es kann notwendig sein, dass
Sie die Datei vorher in <filename>beispiel.html</filename>
umbenennen müssen, damit die Datei auch als
HTML-Dokument erkannt wird.</para>
<para>Nur wenn Sie einen sehr modernen Browser haben, werden
Sie sehen können, dass
<literal>&version;</literal> durch die Versionsnummer
ersetzt wurde. Leider haben die meisten Webbrowser
sehr einfache SGML-Parser, die nicht richtig mit SGML
umgehen können<footnote>
<para>Eigentlich ist das eine Schande. Man stelle sich
vor, welche Probleme und Hacks, wie beispielsweise
Server Side Includes, man an dieser Stelle hätte
vermeiden können.</para>
</footnote>.</para>
</step>
<step>
<para>Die Lösung hierfür ist, das Dokument zu
<emphasis>normalisieren</emphasis>. Zu diesem Zweck liest
ein Normer <!--? Sehr freie Übersetzung. Oliver -->
das Dokument ein und gibt anschließend semantisch
gleichwertiges SGML wieder aus, dass auf verschiedene
Arten transformiert worden sein kann. Eine dieser
möglichen Transformationen ist das Ersetzen der
Referenzen auf Entitäten mit dem von ihnen
präsentierten Inhalt.</para>
<para>Versuchen Sie, die Beispieldatei mittels
<command>osgmlnorm</command> zu normalisieren:</para>
<screen>&prompt.user; <userinput>osgmlnorm beispiel.sgml > beispiel.html</userinput></screen>
<para>Anschließend sollten Sie eine normalisierte
Version, dass heißt eine, bei der die
Entitäten gegen ihren Inhalt ersetzt wurden, in der
Datei <filename>beispiel.html</filename> finden. Diese
Datei können Sie sich nun mit Ihrem Browser
ansehen.</para>
</step>
<step>
<para>Wenn Sie sich die Ausgaben von <command>osgmlnorm</command>
ansehen, werden Sie feststellen, dass
die DOCTYPE-Deklaration am Anfang der Datei nicht mehr
enthalten ist. Möchten Sie die Deklaration behalten,
muss <command>osgmlnorm</command> mit der Option
<option>-d</option> aufrufen werden:</para>
<screen>&prompt.user; <userinput>osgmlnorm -d beispiel.sgml > beispiel.html</userinput></screen>
</step>
</procedure>
</sect2>
</sect1>
<sect1 id="sgml-primer-include">
<title>Dateien mit Entitäten einbinden</title>
<!--?
Dieser kleine Absatz klingt ziemlich hölzern.
Oliver Fischer
-->
<para>Sowohl <link
linkend="sgml-primer-general-entities">Allgemeine</link> als
auch <link
linkend="sgml-primer-parameter-entities">Parameterentitäten</link>
sind nützliche Helfer, wenn es darum geht, eine Datei in
eine andere einzubinden.</para>
<sect2 id="sgml-primer-include-using-gen-entities">
<title>Dateien mit Allgemeinen Entitäten einbinden</title>
<para>Angenommen man hat ein Buch geschrieben, dessen Inhalt
auf mehrere Dateien aufgeteilt und mittels SGML
ausgezeichnet. Jedes Kapitel wurde dazu in einer eigenen Datei
(<filename>kapitel1.sgml</filename>,
<filename>kapitel2.sgml</filename> usw.) abgelegt und
über eine Datei <filename>buch.sgml</filename> sollen
alle physischen Dateien wieder mit der Hilfe von
Entitäten zu einem logischen Dokument
zusammengeführt werden.</para>
<para>Damit der Inhalt der Dateien mit Entitäten
eingebunden werden kann, muss die Deklaration der
Entitäten das Schlüsselwort
<literal>SYSTEM</literal> enthalten. SGML-Parser werden so
angewiesen, den Inhalt der referenzierten Datei als Wert
für die jeweilige Entität zu nehmen.</para>
<example>
<title>Dateien mit Allgemeinen Entitäten einbinden</title>
<programlisting><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY kapitel.1 SYSTEM "kapitel1.sgml">
<!ENTITY kapitel.2 SYSTEM "kapitel2.sgml">
<!ENTITY kapitel.3 SYSTEM "kapitel3.sgml">
<!-- Und so weiter... -->
]>
<html>
<!-- Jetzt werden die Kapitel über die Entitäten eingebunden -->
&kapitel.1;
&kapitel.2;
&kapitel.3;
</html>]]></programlisting>
</example>
<warning>
<para>Wenn man Allgemeine Entitäten benutzt, um andere
Dateien einzubinden, dürfen diese Dateien
(<filename>kapitel1.sgml</filename>,
<filename>kapitel2.sgml</filename>, ...)
<emphasis>keine</emphasis> eigene DOCTYPE-Deklaration
haben.</para>
</warning>
</sect2>
<sect2>
<title>Dateien mit Parameterentitäten einbinden</title>
<para>Wie bereits festgestellt, können
Parameterentitäten nur innerhalb eines SGML-Kontexts
genutzt werden. Warum möchte man aber Dateien innerhalb
eines SGML-Kontexts einbinden? Der Vorteil liegt in der
Möglichkeit, die Deklaration von Entitäten in eine
andere Datei auslagern zu können, wodurch diese leichter
wiederverwendbar sind.</para>
<para>Angenommen das Buch aus dem vorherigen Kapitel besteht aus
sehr vielen Kapiteln und diese sollen auch in einem anderen
Buch, aber in einer anderen Reihenfolge, verwendet werden.
Eine Möglichkeit wäre es, die dafür notwendigen
Entitäten am Anfang jedes Buches einzeln festzulegen
– was allerdings mit der Zeit unhandlich und
fehlerträchtig wird.</para>
<para>Alternativ bietet sich dazu an, die Deklarationen in eine
separate Datei auszulagern und deren Inhalt anschließend
in beide Bücher über Parameterentitäten
einzubinden.</para>
<example>
<title>Dateien mit Parameterentitäten einbinden</title>
<para>Zuerst werden die Entitäten in einer separaten
Datei namens <filename>kapitel.ent</filename> deklariert.
<filename>kapitel.ent</filename> enthält für
dieses Beispiel die folgenden Zeilen:</para>
<programlisting><![CDATA[<!ENTITY kapitel.1 SYSTEM "kapitel1.sgml">
<!ENTITY kapitel.2 SYSTEM "kapitel2.sgml">
<!ENTITY kapitel.3 SYSTEM "kapitel3.sgml">]]></programlisting>
<para>Im zweiten Schritt fügt man in beide Bücher
eine Parameterentität ein, die den Inhalt von
<filename>kapitel.ent</filename> referenziert, und lädt
über diese dann die Deklarationen. Anschließend
können die so geladenen Entitäten wie gewohnt
genutzt werden.</para>
<programlisting><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!-- Definieren einer Parameterentität um die Allgemeinen Entitäten für -->
<!-- die Kapitel laden zu können -->
<!ENTITY % kapitel SYSTEM "kapitel.ent">
<!-- Nun wird der Inhalt der referenzierten Datei geladen -->
%kapitel;
]>
<html>
&kapitel.1;
&kapitel.2;
&kapitel.3;
</html>]]></programlisting>
</example>
</sect2>
<sect2>
<title>Fingerübungen…</title>
<sect3>
<title>Binden Sie Dateien über Allgemeine Entitäten ein</title>
<procedure>
<step>
<para>Legen Sie drei Dateien (<filename>absatz1.sgml</filename>,
<filename>absatz2.sgml</filename> und <filename>absatz3.sgml</filename>)
mit jeweils einer Zeile wie
<!-- <para>Create three files, <filename>para1.sgml</filename>,
<filename>para2.sgml</filename>, and
<filename>para3.sgml</filename>.</para>-->
<!--<para>Put content similar to the following in each file;</para>-->
<programlisting><![CDATA[<p>Erster Absatz.</p>]]></programlisting>
an.</para>
</step>
<step>
<para>Ändern Sie <filename>beispiel.sgml</filename> so
ab, dass sie wie folgt aussieht:</para>
<programlisting><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY version "1.1">
<!ENTITY absatz1 SYSTEM "absatz1.sgml">
<!ENTITY absatz2 SYSTEM "absatz2.sgml">
<!ENTITY absatz3 SYSTEM "absatz3.sgml">
]>
<html>
<head>
<title>Eine HTML-Beispieldatei</title>
</head>
<body>
<p>Die aktuelle Version dieses Dokuments ist &version;</p>
&absatz1;
&absatz2;
&absatz3;
</body>
</html>]]></programlisting>
</step>
<step>
<para>Erzeugen Sie nun die Datei
<filename>beispiel.html</filename>, indem Sie
<filename>beispiel.sgml</filename> normalisieren:</para>
<screen>&prompt.user; <userinput>osgmlnorm -d beispiel.sgml > beispiel.html</userinput></screen>
</step>
<step>
<para>Öffnen Sie <filename>beispiel.html</filename>
nun mit einem Webbrowser und vergewissern Sie sich,
dass der Inhalt der Dateien
<filename>absatz<replaceable>N</replaceable>.sgml</filename>
in <filename>beispiel.html</filename> übernommen
wurde.</para>
</step>
</procedure>
</sect3>
<sect3>
<title>Binden Sie Dateien mit Parameterentitäten ein</title>
<note>
<para>Hierfür müssen Sie die vorherige Fingerübung gemacht haben.</para>
</note>
<procedure>
<step>
<para>Ändern Sie <filename>beispiel.sgml</filename> so
ab, dass es wie folgt aussieht:</para>
<programlisting><![CDATA[<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % entitaeten SYSTEM "entitaeten.sgml"> %entitaeten;
]>
<html>
<head>
<title>Eine HTML-Beispieldatei</title>
</head>
<body>
<p>Die aktuelle Version dieses Dokuments ist &version;</p>
&absatz1;
&absatz2;
&absatz3;
</body>
</html>]]></programlisting>
</step>
<step>
<para>Legen Sie eine weitere Datei <filename>entitaeten.sgml</filename> an,
die folgenden Inhalt hat:</para>
<programlisting><![CDATA[<!ENTITY version "1.1">
<!ENTITY absatz1 SYSTEM "absatz1.sgml">
<!ENTITY absatz2 SYSTEM "absatz2.sgml">
<!ENTITY absatz3 SYSTEM "absatz3.sgml">]]></programlisting>
</step>
<step>
<para>Erzeugen Sie die Datei
<filename>beispiel.html</filename>, indem Sie
<filename>beispiel.sgml</filename> normalisieren:</para>
<screen>&prompt.user; <userinput>osgmlnorm -d beispiel.sgml > beispiel.html</userinput></screen>
</step>
<step>
<para>Öffnen Sie <filename>beispiel.html</filename>
nun mit einem Webbrowser und vergewissern Sie sich,
dass der Inhalt der Dateien
<filename>absatz<replaceable>N</replaceable>.sgml</filename>
in <filename>beispiel.html</filename> übernommen
wurde.</para>
</step>
</procedure>
</sect3>
</sect2>
</sect1>
<sect1 id="sgml-primer-marked-sections">
<title>Markierte Bereiche</title>
<para>SGML erlaubt es, dass bestimmte Dokumentabschnitte
während der Verarbeitung besonders behandelt werden sollen.
Diese Abschnitte werden als <quote>markierte Bereiche</quote>
<footnote><para>auf Englisch <foreignphrase>marked
sections</foreignphrase>
</para></footnote>
bezeichnet.</para>
<example>
<title>Aufbau eines markierten Bereiches</title>
<programlisting><![ <replaceable>SCHLÜSSELWORT</replaceable> [
Inhalt des markierten Bereiches
]]></programlisting>
</example>
<para>Da es sich bei markierten Bereichen um SGML-Konstrukte
handelt, werden sie mit <literal><!</literal> eingeleitet.
Der eigentliche Anfang des markierten Bereiches wird von der
folgenden eckigen Klammer bestimmt. Das darauf folgende
<replaceable>SCHLÜSSELWORT</replaceable> legt fest, wie der
<quote>markierte Inhalt</quote> durch einen SGML-Prozessor
während der Verarbeitung behandelt werden soll. Der
<quote>markierte</quote> Inhalt selbst beginnt erst nach der
zweiten eckigen Klammer und erstreckt sich bis zu den zwei
schließenden eckigen Klammern am Ende des Bereiches. Mit
Hilfe des <literal>></literal> Zeichens wird der mit
<literal><!</literal> begonnene SGML-Kontext wieder
verlassen.</para>
<sect2>
<title>Schlüsselworte für markierte Bereiche</title>
<sect3>
<title><literal>CDATA</literal> und <literal>RCDATA</literal></title>
<para>Die Schlüsselworte <literal>CDATA</literal> und
<literal>RCDATA</literal> bestimmen das
<emphasis>Inhaltsmodell</emphasis> für markierte
Bereiche. Dadurch ist es möglich, vom Standardmodell
abzuweichen.</para>
<para>Ein SGML-Prozessor muss während der
Verarbeitung eines Dokuments zu jedem Zeitpunkt wissen,
welches <emphasis>Inhaltsmodell</emphasis> gerade anzuwenden
ist.</para>
<para>Was ist ein Inhaltsmodell? Kurz gesagt beschreibt das
Inhaltsmodell, welche Art von Inhalt der Parser zu erwarten
und wie er damit umzugehen hat.</para>
<para>Bei <literal>CDATA</literal> und
<literal>RCDATA</literal> handelt es sich wahrscheinlich um
die nützlichsten Inhaltsmodelle. <!--? Die richtige
Uebersetzung ist Buchstabendaten. Oliver Fischer -->
<literal>CDATA</literal> steht für
Zeichendaten<footnote>
<para>auf Englisch <foreignphrase>character
data</foreignphrase></para></footnote>. Trifft ein
Parser auf dieses Inhaltsmodell, wird er annehmen, dass
sich im zugehörigen Dokumentenbereich nur
<quote>gewöhnliche</quote> Zeichen befinden. Das
bedeutet, dass <literal><</literal> und
<literal>&</literal> ihre besondere Bedeutung
verlieren und als einfache Zeichen behandelt werden.</para>
<para><literal>RCDATA</literal> steht für
Entitätenreferenzen und Zeichendaten<footnote><para>auf
Englisch
<foreignphrase>Entity references and character
data</foreignphrase></para></footnote>. Für einen
Bereich mit diesem Inhaltsmodell, wird ein Parser davon
ausgehen, dass er sowohl Zeichen als auch
Enitätenreferenzen finden kann. <literal><</literal>
verliert hier zwar auch seine besondere Bedeutung, doch
<literal>&</literal> wird weiterhin als Anfang einer
Entität interpretiert.</para>
<para>Nützlich ist das <literal>CDATA</literal>-Modell
vor allem dann, wenn es darum geht Texte eins-zu-eins zu
übernehmen, in denen <literal><</literal> und
<literal>&</literal> gehäuft
auftreten. Zwar kann man solche Texte überarbeiten und
jedes <literal><</literal> durch ein
<literal>&lt;</literal> und jedes
<literal>&</literal> durch ein <literal>&amp;</literal>
ersetzen, doch es wird in den meisten Fällen
einfacher sein, für den betreffenden Text
<literal>CDATA</literal> als Inhaltsmodell festzulegen. Ein
SGML-Parser wird dann, sobald er auf
<literal><</literal> oder <literal>&</literal> trifft,
diese als Zeichen in einem Text betrachten.</para>
<note>
<para>Bei der Verwendung von <literal>CDATA</literal> und
<literal>RCDATA</literal> als Inhaltsmodell für
SGML-Beispiele, wie sie in diesem Dokument enthalten sind,
muss bedacht werden, dass der Inhalt eines
<literal>CDATA</literal>-Bereiches nicht validiert wird.
dass das SGML in diesen Bereichen gültig ist,
muss auf andere Weise sichergestellt werden. Denkbar ist
beispielsweise, es in einem separaten Dokument zu
erstellen, dort zu prüfen und erst dann in das
eigentliche Dokument einzufügen.</para>
</note>
<!-- The nesting of CDATA within the next example is disgusting -->
<example>
<title>CDATA als Inhaltsmodell für markierte Bereiche</title>
<programlisting><para>Das ist ein Beispiel, wie man einen Text,
der viele <literal>&lt;</literal>- und <literal>&amp;</literal>-
Entitäten enthält, in ein Dokument einbinden kann.
Das Beispiel selbst, das sich innerhalb des markierten Bereiches befindet,
ist ein HTML-Fragment. Der diesen Text umschließende Tag, beginnend mit
mit <sgmltag>para</sgmltag> und endend mit <sgmltag>/para</sgmltag>, stammt aus der DocBook DTD.</para>
<programlisting>
<![RCDATA[ <![CDATA[
<p>Dieses Beispiel demonstriert die Verwendung von HTML-Elementen.
Da spitze Klammern so oft vorkommen, ist es einfacher, das
gesamte Beispiel als CDATA Abschnitt auszuweisen, als die
entsprechenden Entitäten zu nutzen.</p>
<ul>
<li>Das ist ein Listenelement.</li>
<li>Das ist ein zweites Listenelement.</li>
<li>Das ist ein drittes Listenelement.</li>
</ul>
<p>Und das hier, das ist das Ende des Beispiels.</p>]]>
]]>
</programlisting></programlisting>
<para>Liest man die Quellen dieser Fibel, wird man
feststellen, dass diese Technik durchgängig
angewandt wurde.</para>
</example>
</sect3>
<sect3>
<title><literal>INCLUDE</literal> und
<literal>IGNORE</literal></title>
<para>Das Schlüsselwort <literal>INCLUDE</literal> legt
fest, dass der Inhalt des betreffenden Abschnittes
mitverarbeitet wird. Demgegenüber bestimmt
<literal>IGNORE</literal>, dass er ignoriert wird,
dass heißt, dass er bei der Verarbeitung
übergangen wird und in der Ausgabe nicht enthalten
ist.</para>
<example>
<title>Anwendung von <literal>INCLUDE</literal> und
<literal>IGNORE</literal> in markierten
Abschnitten</title>
<programlisting><![ INCLUDE [
Dieser Text wird verarbeitet und eingebunden.
]]>
<![ IGNORE [
Dieser Text wird weder verarbeitet noch eingebunden.
]]></programlisting>
</example>
<para>Für sich alleine ist <literal>IGNORE</literal> als
Anweisung nicht besonders nützlich, da ein Bereich, der
von der Verarbeitung ausgenommen sein soll, auch
auskommentiert werden kann.</para>
<para>Kombiniert man <literal>IGNORE</literal> hingegen mit
<link
linkend="sgml-primer-parameter-entities">Parameterentitäten</link>,
steht so ein Weg zur Verfügung, um dessen Anwendung
besser steuern zu können. Zwar können
Parameterentitäten nur in einem SGML-Kontext einsetzt
werden, da aber markierte Bereiche ebenfalls SGML-Konstrukte
sind, ist diese Einschränkung irrelevant.</para>
<para>Soll beispielsweise ein und dasselbe Dokument in zwei
unterschiedlichen Varianten produziert werden, einer
gedruckten und einer digitalen, und soll nur die digitale
zusätzliche Informationen enthalten, kann dies mit
einem Trick erreicht werden.</para>
<para>Man definiert eine Parameterentität, der man als
Wert die Zeichenkette <literal>INCLUDE</literal> zuweist und
deklariert den betreffenden Bereich, der nur in der
digitalen Variante erscheinen soll, als markierten Abschnitt
und setzt als Schlüsselwort die zuvor definierte
Parameterentität ein.</para>
<para>Soll anstelle der digitalen die gedruckte Variante
produziert werden, muss lediglich der Entität
<literal>IGNORE</literal> als Wert zugewiesen und das
Ursprungsdokument erneut durch den SGML-Prozessor geschickt
werden.</para>
<example>
<title>Kontrolle von markierten Bereichen über
Parameterentitäten</title>
<programlisting><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % digitale.kopie "INCLUDE">
]]>
...
<![ %digitale.kopie [
Dieser Satz sollte nur in der digitalen Version enthalten sein.
]]> </programlisting>
<para>Bei der Produktion der gedruckten Variante muss
der Wert der Entität geändert werden.</para>
<programlisting><!ENTITY % digitale.kopie "IGNORE"></programlisting>
<para>Bei der Verarbeitung wird als Schlüsselwort in
beiden Fällen der von
<literal>%digitale.kopie</literal> repräsentierte
Wert verwendet. Im ersten Fall wird der Inhalt des
markierten Bereichs mitverarbeitet, im zweiten Fall
nicht.</para>
</example>
</sect3>
</sect2>
<sect2>
<title>Fingerübung…</title>
<procedure>
<step>
<para>Legen Sie eine neue Datei
<filename>abschnitt.sgml</filename> an, die folgenden
Inhalt hat:</para>
<programlisting><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % text.ausgabe "INCLUDE">
]>
<html>
<head>
<title>Ein Beispiel mit markierten Abschnitten</title>
</head>
<body>
<p>Dieser Absatz <![CDATA[beinhaltet viele <
Zeichen (< < < < <). Weshalb es einfacher ist,
ihn als CDATA Bereich auszuweisen. ]]></p>
<![ IGNORE [
<p>Dieser Absatz wird NICHT in der Ausgabe enthalten sein.</p>
]]>
<![ <![CDATA[%text.ausgabe]]> [
<p>Dieser Absatz wird in Abhängigkeit von <literal>%text.ausgabe</literal>
mitausgegeben.</p>
]]>
</body>
</html></programlisting>
</step>
<step>
<para>Normalisieren Sie den Inhalt dieser Datei mit Hilfe
von <command>osgmlnorm</command> und sehen Sie sich das
Ergebnis an. Achten Sie dabei darauf, welche Absätze
enthalten beziehungsweise nicht enthalten sind und was aus
den <literal>CDATA</literal>-Bereichen geworden ist.</para>
</step>
<step>
<para>Ändern Sie die Definition von
<literal>text.ausgabe</literal> so, dass es den
Wert <literal>IGNORE</literal> zugewiesen bekommt.
Verarbeiten Sie dann die Datei erneut mit
<command>osgmlnorm</command> und vergleichen die Ausgabe mit
der vom ersten <command>osgmlnorm</command> Lauf.</para>
</step>
</procedure>
</sect2>
</sect1>
<sect1 id="sgml-primer-conclusion">
<title>Schlußbemerkung</title>
<para>Aus Platzgründen, und um der Verständlichkeit
Willen, wurden viele Gesichtspunkte nicht in aller Tiefe
beziehungsweise gar nicht besprochen. Trotzdem sollte in den
bisherigen Kapiteln genügend Wissen über SGML
vermittelt worden sein, um den Aufbau der Dokumentation des FDPs
zu verstehen.</para>
</sect1>
</chapter>
|