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
|
<chapter id="reading-the-dtd">
<title>Understanding, Using, and Maintaining DocBook</title>
<para>This chapter describes how to understand and use the files that make
up the DocBook distribution. Parts of this discussion are relatively technical.
If you are unfamiliar with reading and understanding DTD constructs, you may
need to refer to other SGML resources for help.</para>
<sect1>
<title>Quick Start</title>
<para>To use DocBook <quote>out of the box,</quote> do the following:<orderedlist>
<listitem><para>Point your application to a valid series of mappings between
the formal public identifiers used in DocBook and the system files corresponding
to the DocBook modules. (You can use the <filename>docbook.cat</filename>
catalog file, provided with the DocBook distribution, for this purpose; you
may need to edit this file to make it point to accurate file locations on
your system.)</para>
</listitem><listitem><para>Use a <literal>DOCTYPE</literal> declaration in
your SGML documents as follows, providing your top-level element name as the
document type name:<programlisting><!DOCTYPE <replaceable>element-name
</replaceable> PUBLIC "-//Davenport//DTD DocBook V2.4.1//EN">
<<replaceable>element-name</replaceable>>
⋮
</<replaceable>element-name</replaceable>></programlisting></para>
<para>For example (assuming no need for an internal declaration subset):<programlisting>
<!DOCTYPE book PUBLIC "-//Davenport//DTD DocBook V2.4.1//EN">
<book>
⋮
</book></programlisting></para>
</listitem></orderedlist></para>
<para>Before validating or processing any documents, you may need to prepare
or compile DocBook in some fashion for use with your software.</para>
</sect1>
<sect1 id="interchg-checklist">
<title>Interchanging DocBook Documents</title>
<para>Simply using DocBook or a subset of it is not enough to ensure successful
interchange. If you send someone your DocBook files, you must also tell the
recipient about the markup your documents use and any of your additional markup
conventions and processing expectations that impose constraints on processing.
</para>
<para>Delivered DocBook documents should be accompanied by a filled-out interchange
questionnaire. Because each situation is unique, you may need to supply additional
information (such as layout specifications) in order to deliver a complete
package.</para>
<bridgehead>DocBook and SGML Usage</bridgehead>
<orderedlist><listitem><para>What version of the DTD are you using?</para>
</listitem><listitem><para>Did you use any markup features of the DTD that
have been flagged as obsolescent (to be removed at the next major version
of DocBook)? If so, which ones?</para>
</listitem><listitem><para>Did you extend DocBook in any way, inside or outside
the provided customization mechanisms? How? All extensions must be negotiated
with the recipient.</para>
</listitem><listitem><para>Did you remove markup from DocBook to create a
subset? If you used a subset of DocBook, supply the subset you used. (Note
that even the removal of references to ISO entity sets creates a subset.)
</para>
</listitem><listitem><para>Did you use the supplied SGML declaration or another
one? If you used another one, provide it.</para>
</listitem><listitem><para>Did you use the supplied catalog or another one,
or none at all? If you used a catalog other than the supplied one, provide
it.</para>
</listitem><listitem><para>If your documents bear no document type declaration,
and you parsed them with a document declaration (with or without an internal
subset), supply it.</para>
</listitem><listitem><para>Did you add <literal>NOTATION</literal> declarations?
If so, what are they? List all data content notations used in your documents.
</para>
</listitem><listitem><para>Did you use the <literal>SUBDOC</literal> feature?
If so, how did you manage the name spaces of their IDs, if you did manage
them at all?</para>
</listitem><listitem><para>Did you use character sets other than ISO 8859-1
(Latin 1)? If so, which ones? How did you use them?</para>
</listitem><listitem><para>Did you declare and use character entities and
other general entities besides the ISO entity sets? If so, supply the entity
declarations and the desired appearance for the additional character entities.
</para>
</listitem><listitem><para>Are your document files normalized to include all
markup explicitly?</para>
</listitem><listitem><para>Are you supplying a document fragment? If so, have
you provided any necessary auxiliary information (such as metainformation)
for the fragment? Are there any attribute values that haven't been specified
that are expected to inherit from a parent that isn't present?</para>
</listitem></orderedlist>
<bridgehead>Processing Requirements and Markup Interpretation</bridgehead>
<orderedlist continuation="continues"><listitem><para>What formatting do you
require your interchange partner to do in the fashion you did? For example,
where and how must text be generated in order for the documents to make sense?
</para>
</listitem><listitem><para>Supply your style sheet and information regarding
its format and version.</para>
</listitem><listitem><para>How did you create tables of contents, lists of
titles, and indices? Are they stored in DocBook form? If so, did you generate
them (and according to what rules) or create them by hand?</para>
</listitem><listitem><para>If you used the Lang common attribute, why and
to what effect?</para>
</listitem><listitem><para>If you used the Remap common attribute, why and
to what effect?</para>
</listitem><listitem><para>If you used the Role common attribute, why and
to what effect?</para>
</listitem><listitem><para>If you used the effectivity attributes, which did
you use, why, and to what effect?</para>
</listitem><listitem><para>What values did you give to the Label attribute
and how are they to be interpreted for rendering?</para>
</listitem><listitem><para>What values did you give to the Mark and Override
attributes for lists and how are they to be interpreted for rendering?</para>
</listitem><listitem><para>Did you use the Renderas attribute on sections
and/or BridgeHeads?</para>
</listitem><listitem><para>Supply all keyword values you used for attributes
whose declared values are not enumerated tokens, along with the expected processing
for the occurrence of each keyword.</para>
</listitem><listitem><para>Did you use markup to control width, size, and/or
positioning settings (such as <quote>fold-out</quote> or <quote>centered</quote>)
for graphics, linespecific regions, and tables? If so, how?</para>
</listitem><listitem><para>For rendering of Sidebars, must these appear in
the flow of the text where they appear in your files, or may they float?</para>
</listitem><listitem><para>For Graphic and InlineGraphic, what method(s) did
you use for providing graphic data: element content, Fileref attribute, or
Entityref attribute?</para>
</listitem><listitem><para>How did you specify column widths in tables? Did
you use vertical spans? Did you use horizontal spans?</para>
</listitem><listitem><para>If you used the Type attribute on the link elements,
why and to what effect?</para>
</listitem><listitem><para>Did you use the Subject attribute on GlossDef?
If so, did you use a thesaurus of terms? If so, what is it?</para>
</listitem><listitem><para>If you used the Class attribute on RefMiscInfo,
why and to what effect?</para>
</listitem><listitem><para>If you used ULink and provided URLs that are queries,
what back-end processing is required to resolve those queries?</para>
</listitem><listitem><para>Did you use any processing instructions? Were they
in entities? What copyfitting have you already done, and for what outputs?
</para>
</listitem></orderedlist>
<bridgehead>Miscellaneous</bridgehead>
<orderedlist continuation="continues"><listitem><para>Have you checked your
files for viruses?</para>
</listitem><listitem><para>If you used BridgeHead, have you joined a recovery
support group?</para>
</listitem></orderedlist>
</sect1>
<sect1 id="upgrading">
<title>Using New Releases of DocBook</title>
<para>For each new version of DocBook, you can expect that the version numbers
mentioned in all the DocBook files and their formal public identifiers will
be updated. At a minimum, these changes will require you to change any public
identifiers used in your documents and variant DTDs. (Note that <filename>
dbgenent.mod</filename> does not mention a version number since it is expected
to be edited by users.)</para>
<para>When DocBook is revised, you will need to assess whether you want to
use any new features in the revised version and whether (for major revisions)
any backwards-incompatible changes will require you to transform your existing
documents to stay in conformance to the new version.</para>
<para>In addition, if you have created a variant DTD by means of a customization
layer (see
<!-- <xref linkend="dbgmaint"> -->
the <citetitle>Customizer's Guide</citetitle>), you
will need to assess whether your
changes are still valid. For example, you may have created an extension by
adding a special synopsis element, which has now been added to the original
DTD so that other companies can use it too. In this case, you would probably
need to discard the customization to avoid parsing errors. For another example,
DocBook may have added some list elements in the new version that you would
prefer to remove from your variant, which would require a new customization.
</para>
</sect1>
<sect1 id="specific-tools">
<title>Using DocBook with Specific Tools</title>
<para>Following are some notes on using DocBook with SGML-aware software applications.
</para>
<sect2>
<title>DTD Validation Warnings</title>
<para>The content model of the Entry element uses nonrecommended mixed content.
Most parsers (for example, <literal>nsgmls</literal> and Mark-It) report a
warning for this content model, but the model is valid.</para>
</sect2>
<sect2>
<title>ADEPT•Editor and Document•Architect</title>
<para>You may need to reduce the capacities in the DocBook SGML declaration
in order to compile DocBook under Document•Architect for use with ADEPT•Editor.
The following capacities should be sufficient for most documents:<programlisting>
TOTALCAP 500000
ATTCAP 350000
ATTCHCAP 350000
AVGRPCAP 350000
ELEMCAP 350000
ENTCAP 350000
ENTCHCAP 350000
GRPCAP 350000
IDCAP 350000
IDREFCAP 350000</programlisting></para>
<para>If you put IDs on all your elements, you may need to increase <literal>
IDCAP</literal>.</para>
</sect2>
<sect2>
<title>Normalizing Documents with <command>nsgmls</command></title>
<comment>TBS: Description of how to normalize documents if you have turned
OMITTAG on.</comment></sect2>
<sect2>
<title>RulesBuilder</title>
<para>RulesBuilder issues a warning about the Set element being defined but
not referenced. Set is properly not referenced in any other content models
because it is the topmost element. This warning may be due to the fact that
the top-level driver file contains no <literal>ELEMENT</literal> declarations.
</para>
</sect2>
</sect1>
<sect1 id="architecture">
<title>DocBook Architecture</title>
<para>The architecture of the DocBook DTD is modular and parameterized so
that people who read and use DocBook and who interchange DocBook documents
can more easily do the following:<itemizedlist><listitem><para>Customize DocBook
in appropriate ways</para>
</listitem><listitem><para>Maintain variant DTDs over time with as high a
degree of fidelity to the original as possible</para>
</listitem><listitem><para>Determine exactly what is different between the
original and a variant</para>
</listitem></itemizedlist></para>
<para>Even if you intend to use DocBook in its original form, you need to
understand how all the files go together. <xref linkend="mod-fig"> shows stacked
boxes that represent the interdependencies of all the files that make up the
distributed DocBook V2.4 application, as well as the files that can be supplied
to create a <quote>customization layer</quote> on top of the DTD. Upper modules
depend on lower ones.</para>
<figure id="mod-fig">
<title>DocBook Modules and Files</title>
<graphic entityref="modules"></graphic>
</figure>
<para><xref linkend="call-fig"> shows the <quote>call tree</quote> (entity
referencing structure) of the DTD modules, with the order of references shown
left to right. Modules related exclusively to customization are shown with
dashed lines; these need not be supplied if you are not customizing DocBook,
and may not even need to be supplied for most simple customizations.</para>
<figure id="call-fig">
<title>Entity Referencing Structure</title>
<graphic entityref="calltree"></graphic>
</figure>
<para>The contents and function of the files that make up the DocBook application
are as follows. For V2.4.1 of DocBook, the formal public identifiers of the
DocBook modules should use the version string <quote>V2.4.1</quote>.<variablelist>
<varlistentry><term><filename>docbook.dcl</filename></term>
<listitem>
<para>This file contains an SGML declaration developed for DocBook, which
depends on certain SGML declaration characteristics being set. You may need
to change this declaration to suit your particular documents and processing
applications; if so, it is a good idea to document what you've changed using
comments.</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>docbook.dtd</filename></term>
<listitem>
<para>This driver file declares data content notations and declares and references
the two main modules and the ISO standard entity sets. The driver file can
be thought of as <quote>the DocBook DTD.</quote> If you reference the driver
file, declare it with the formal public identifier <literal>"-//Davenport//DTD
DocBook <replaceable>version</replaceable>//EN"</literal>.</para>
<para>Note that the driver file declares and references the nineteen ISO entity
sets that appear in an annex to ISO 8879. It is assumed that your environment
has these entity set files available. (The DocBook catalog data file (<filename>
docbook.cat</filename>) has entries for these entity sets.) If you do not
have these files, you can get them from the Davenport archive.</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>dbhier.mod</filename></term>
<listitem>
<para>This module contains the declarations related to the document hierarchical
structure of DocBook documents: sets, books, reference entries, sections,
articles, and so on. It is stored in a separate module in order to ease the
process of reusing the information pool with a completely different document
hierarchy. If you reference this module directly, declare it with the formal
public identifier <literal>"-//Davenport//ELEMENTS DocBook Document Hierarchy <replaceable>
version</replaceable>//EN"</literal>.</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>dbpool.mod</filename></term>
<listitem>
<para>This module contains the declarations related to the information pool
of DocBook documents, such as paragraphs, command names, and index terms.
Here is where most of the parameter entities for element classes (such as <quote>
lists</quote>) and mixtures (such as the <quote>component mixture</quote>)
are set up, as well as the entities for common attributes. It is stored in
a separate module in order to ease the process of reusing the information
pool with a completely different document hierarchy. If you reference this
module directly, declare it with the formal public identifier <literal>"-//Davenport//ELEMENTS
DocBook Information Pool <replaceable>version</replaceable>//EN"</literal>.
</para>
<para>This module has dependencies on <filename>calstbl.mod</filename> and
also has a few unavoidable dependencies on <filename>docbook.mod</filename>
(which <xref linkend="mod-fig"> doesn't reflect). See the comments in the <filename>
dbpool.mod</filename> file for more information.</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>calstbl.mod</filename></term>
<listitem>
<para>This module contains the CALS-based table model that DocBook uses. It
is referenced directly by the information pool module, which parameterizes
it by redefining various entities. If you reference this module directly,
declare it with the formal public identifier <literal>"-//Davenport//ELEMENTS
CALS-Based DocBook Table Model <replaceable>version</replaceable>//EN"</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>dbgenent.mod</filename></term>
<listitem>
<para>This file contains the declarations for any general entities (such as
entities for special characters and boilerplate text) needed in your environment.
The entity for this file is referenced in the DocBook driver file so that
you can take advantage of it without having to do anything special to the
original parts of the DTD, but the file provided as part of the distribution
is empty except for an explanatory SGML comment. Its formal public identifier
is <literal>"-//Davenport//ELEMENTS DocBook Additional General Entities//EN".
</literal></para>
<para>You can edit this file as necessary to add general entity declarations,
or you can use the file as provided if you need no additional general entities.
Note that you do not need to edit this file if you want to use only the ISO
entity sets already referenced in the driver file. If you do edit the file,
be sure not to overwrite it with the original file contents when you unpack
new versions of DocBook.</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>rdbhier.mod</filename>, <filename>rdbhier2.mod
</filename>, <filename>rdbpool.mod</filename>, <filename>rdbmods.mod</filename></term>
<listitem>
<para>These are the suggested names for the files that contain any customizations
(entity redeclarations) that require the referencing of entities declared
earlier in the DTD. You must declare these files as entities in your customization
layer. If you declare these entities as <literal>PUBLIC</literal> entities,
you will need to add the appropriate entries to the DocBook catalog data file
(<filename>docbook.cat</filename>) or to another catalog file that you use.
</para>
<para>These files exist only if you create them and declare their associated
entities as part of a customization effort, and their contents will be unique
to your customization. Note that many simple customizations do <emphasis>
not</emphasis> require these files to be created.</para>
</listitem>
</varlistentry>
<varlistentry><term><filename>docbook.cat</filename></term>
<listitem>
<para>This is a collection of catalog data in SGML Open TR9401 format, providing
default filename locations as the <quote>storage object identifiers</quote>
corresponding to the formal public identifiers by which DocBook modules should
be identified. This file is provided as a convenience; you may need to incorporate
this data into an existing catalog file or change the entries into a different
format for use by your applications, and may need to change the storage object
identifiers depending on the names, locations, and storage platforms of the
DocBook files in your environement.</para>
</listitem>
</varlistentry>
</variablelist></para>
</sect1>
<sect1>
<title>DocBook Entities</title>
<para>DocBook relies heavily on <firstterm>internal parameter entities</firstterm>
(substitution-string mechanisms that work somewhat like programming macros)
to achieve consistency, ease maintenance, and encourage appropriate customization.
Unfortunately, the density of entity references can make it difficult to read
the actual element and attribute declarations. The major entities used inside
these declarations are described briefly here.</para>
<para>There are two special kinds of entities that are used to group elements: <firstterm>
classes</firstterm> and <firstterm>mixtures</firstterm>. Class entities are
used to group elements that are very similar, such as <quote>all the list
elements.</quote> Mixture entities are used to group whole element classes
(and sometimes individual elements as well) that are all supposed to be allowed
in a particular set of contexts. Classes and mixtures are described in more
detail below.</para>
<sect2>
<title>Patterns of Entity Naming and Usage</title>
<para><xref linkend="pattern-ex"> shows a synopsis of the kinds of parameter
entities that are used in the definition of most elements in DocBook.</para>
<example id="pattern-ex">
<title>Parameter Entity Synopsis</title>
<programlisting><!ENTITY % <replaceable>element</replaceable>.content.module "INCLUDE"> <lineannotation>
aggregate module entity</lineannotation>
<!ENTITY % <replaceable>element</replaceable>.module "INCLUDE"> <lineannotation>
simple module entity</lineannotation>
<!ENTITY % <replaceable>subelement</replaceable>.module "INCLUDE"> <lineannotation>
simple module entity</lineannotation>
⋮
<!ENTITY % <replaceable>class1</replaceable>.class "<replaceable>elem1
</replaceable>|<replaceable>elem2</replaceable>"> <lineannotation>
class entity</lineannotation>
<!ENTITY % <replaceable>class2</replaceable>.class "<replaceable>elem3
</replaceable>|<replaceable>elem4</replaceable>"> <lineannotation>
class entity</lineannotation>
⋮
<!ENTITY % <replaceable>mixture1</replaceable>.mix "%<replaceable>class1
</replaceable>.class;|%<replaceable>class2</replaceable>.class;" <lineannotation>
mixture entity</lineannotation>
<!ENTITY % <replaceable>mixture2</replaceable>.mix "%<replaceable>class1
</replaceable>.class;"> <lineannotation>mixture entity</lineannotation>
⋮
<![ %<replaceable>element</replaceable>.content.module; [ <lineannotation>
aggregate module entity reference</lineannotation>
<![ %<replaceable>element</replaceable>.module' [ <lineannotation>
simple module entity reference</lineannotation>
<!ENTITY % local.<replaceable>element</replaceable>.attrib ""> <lineannotation>
local attribute entity</lineannotation>
<!ELEMENT <replaceable>element</replaceable> - - (<replaceable>subelement
</replaceable>, (%<replaceable>mixture1</replaceable>.mix;)+)>
<!ATTLIST <replaceable>element</replaceable>
%common.attrib; <lineannotation>common attribute entity reference
</lineannotation>
%local.<replaceable>element</replaceable>.attrib; <lineannotation>
local attribute entity reference</lineannotation>
>
<!--end of <replaceable>element</replaceable>.module-->]]>
<![ %<replaceable>subelement</replaceable>.module' [ <lineannotation>
simple module entity reference</lineannotation>
<!ENTITY % local.<replaceable>subelement</replaceable>.attrib ""> <lineannotation>
local attribute entity</lineannotation>
<!ELEMENT <replaceable>subelement</replaceable> - - ((%<replaceable>mixture2
</replaceable>.mix;)+)> <lineannotation>content with mixture entity reference
</lineannotation>
<!ATTLIST <replaceable>subelement</replaceable>
%common.attrib; <lineannotation>common attribute entity reference
</lineannotation>
%local.<replaceable>subelement</replaceable>.attrib; <lineannotation>
local attribute entity reference</lineannotation>
>
<!--end of <replaceable>subelement</replaceable>.module-->]]>
<!--end of <replaceable>element</replaceable>.content.module-->]]>
</programlisting>
</example>
</sect2>
<sect2>
<title>Previous and Current Parameter Entities</title>
<para><xref linkend="equiv"> shows the equivalences between the parameter
entities in V2.2.1 and the versions starting with V2.3, in approximately the
order that the original entities appear in DocBook V2.2.1. If you are new
to reading DocBook, you don't need to read this table. (Note that many new
entities have been added; these don't appear in the table.)</para>
<table frame="all" id="equiv">
<title>Parameter Entity Equivalences</title>
<tgroup cols="3" colsep="1" rowsep="1">
<colspec colwidth="139*">
<colspec colwidth="135*">
<colspec colwidth="182*">
<thead>
<row><entry align="left" valign="top"><emphasis role="strong">Original Entity
</emphasis></entry><entry align="left" valign="top"><emphasis role="strong">
New Entity</emphasis></entry><entry align="left" valign="top"><emphasis role="strong">
Comments</emphasis></entry></row>
</thead>
<tbody>
<row>
<entry align="left" valign="top">notationtypes</entry>
<entry align="left" valign="top">notation.class</entry>
</row>
<row>
<entry align="left" valign="top">commonatts</entry>
<entry align="left" valign="top">common.attrib</entry>
</row>
<row>
<entry align="left" valign="top">yesorno</entry>
<entry align="left" valign="top">yesorno.attvals</entry>
</row>
<row>
<entry align="left" valign="top">yes</entry>
<entry align="left" valign="top">yes.attval</entry>
</row>
<row>
<entry align="left" valign="top">no</entry>
<entry align="left" valign="top">no.attval</entry>
</row>
<row>
<entry align="left" valign="top">appendix.gp</entry>
<entry align="left" valign="top">appendix.class</entry>
</row>
<row>
<entry align="left" valign="top">book.gp</entry>
<entry align="left" valign="top">book.class</entry>
</row>
<row>
<entry align="left" valign="top">chapter.gp</entry>
<entry align="left" valign="top">chapter.class</entry>
</row>
<row>
<entry align="left" valign="top">index.gp</entry>
<entry align="left" valign="top">index.class</entry>
</row>
<row>
<entry align="left" valign="top">bookcontent.gp</entry>
<entry align="left" valign="top">partcontent.mix</entry>
</row>
<row>
<entry align="left" valign="top">ndxterm.gp</entry>
<entry align="left" valign="top">ndxterm.class</entry>
</row>
<row>
<entry align="left" valign="top">xref.gp</entry>
<entry align="left" valign="top">xref.char.class</entry>
</row>
<row>
<entry align="left" valign="top">links.gp</entry>
<entry align="left" valign="top">link.char.class</entry>
</row>
<row>
<entry align="left" valign="top">basechar.gp</entry>
<entry align="left" valign="top">base.char.class</entry>
<entry align="left" valign="top">No #PCDATA directly in entity</entry>
</row>
<row>
<entry align="left" valign="top">phrase.gp</entry>
<entry align="left" valign="top">Removed in V2.4</entry>
<entry align="left" valign="top">In V2.3, was phrase.char.mix (other.char.class
+ base.char.class + link.char.class)</entry>
</row>
<row>
<entry align="left" valign="top">bookinfo.content.gp</entry>
<entry align="left" valign="top">setinfo.char.mix</entry>
<entry align="left" valign="top">Now contains ModeSpec; omission was an oversight
</entry>
</row>
<row>
<entry align="left" valign="top">docinfo.content.gp</entry>
<entry align="left" valign="top">docinfo.char.class</entry>
</row>
<row>
<entry align="left" valign="top">words.gp</entry>
<entry align="left" valign="top">word.char.class</entry>
</row>
<row>
<entry align="left" valign="top">computerterms.gp</entry>
<entry align="left" valign="top">cptr.char.class</entry>
</row>
<row>
<entry align="left" valign="top">cptrphrase.gp</entry>
<entry align="left" valign="top">cptr.char.mix (cptr.char.class + other.char.class
+ base.char.class + link.char.class)</entry>
</row>
<row>
<entry align="left" valign="top">inlinechar.gp</entry>
<entry align="left" valign="top">Removed in V2.4; see para.char.mix</entry>
<entry align="left" valign="top">In V2.3, was inline.char.mix</entry>
</row>
<row>
<entry align="left" valign="top">eqncontent.gp</entry>
<entry align="left" valign="top">equation.content</entry>
<entry align="left" valign="top">No more local.equations</entry>
</row>
<row>
<entry align="left" valign="top">tblcontent.gp</entry>
<entry align="left" valign="top">table.content</entry>
<entry align="left" valign="top">No more local.tables</entry>
</row>
<row>
<entry align="left" valign="top">list.gp</entry>
<entry align="left" valign="top">list.class</entry>
</row>
<row>
<entry align="left" valign="top">admonition.gp</entry>
<entry align="left" valign="top">admon.class</entry>
</row>
<row>
<entry align="left" valign="top">code.example.gp</entry>
<entry align="left" valign="top">linespecific.class</entry>
</row>
<row>
<entry align="left" valign="top">synop.gp</entry>
<entry align="left" valign="top">synop.class</entry>
</row>
<row>
<entry align="left" valign="top">object.gp</entry>
<entry align="left" valign="top">(informal.class + linespecific.class + synop.class)
</entry>
<entry align="left" valign="top">No single replacement entity</entry>
</row>
<row>
<entry align="left" valign="top">para.gp</entry>
<entry align="left" valign="top">para.class</entry>
</row>
<row>
<entry align="left" valign="top">formalobject.gp</entry>
<entry align="left" valign="top">formal.class</entry>
</row>
<row>
<entry align="left" valign="top">component.gp</entry>
<entry align="left" valign="top">component.mix, divcomponent.mix, refcomponent.mix
(genobj.class + descobj.class + admon.class + formal.class + list.class +
informal.class + linespecific.class + synop.class + para.class + compound.class)
</entry>
</row>
<row>
<entry align="left" valign="top">refclass.gp</entry>
<entry align="left" valign="top">refclass.char.mix</entry>
</row>
<row>
<entry align="left" valign="top">nav.gp</entry>
<entry align="left" valign="top">nav.class</entry>
</row>
<row>
<entry align="left" valign="top">inlineobj.gp</entry>
<entry align="left" valign="top">para.char.mix (inline.char.mix + inlineobj.char.class
+ synop.class)</entry>
</row>
<row>
<entry align="left" valign="top">sect1.gp</entry>
<entry align="left" valign="top">bookcomponent. content</entry>
<entry align="left" valign="top">In V2.3, was sect1.content</entry>
</row>
<row>
<entry align="left" valign="top">ubiq.gp</entry>
<entry align="left" valign="top">ubiq.mix</entry>
</row>
<row>
<entry align="left" valign="top">primsee</entry>
<entry align="left" valign="top">(none)</entry>
</row>
<row>
<entry align="left" valign="top">secsee</entry>
<entry align="left" valign="top">(none)</entry>
</row>
<row>
<entry align="left" valign="top">argchcatt</entry>
<entry align="left" valign="top">(none)</entry>
</row>
<row>
<entry align="left" valign="top">grpchcatt</entry>
<entry align="left" valign="top">(none)</entry>
</row>
<row>
<entry align="left" valign="top">repatt</entry>
<entry align="left" valign="top">(none)</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2>
<title>Marked Section Entities</title>
<para>All of DocBook's element and attribute declaration pairs are surrounded
by marked sections (regions that work somewhat like programming <quote><literal>
ifdef</literal>s</quote>) whose status keywords are stored in entities. Some
marked sections surround groups of related elements. In reading the DTD, you
can simply ignore all the lines that look as follows:<programlisting><![ %<replaceable>
name</replaceable>.content.module; [
<![ %<replaceable>name</replaceable>.module; [
⋮
<!--end of <replaceable>name</replaceable>.module-->]]>
<!--end of <replaceable>name</replaceable>.content.module-->]]></programlisting></para>
</sect2>
<sect2>
<title>Class (<literal><replaceable>xxx</replaceable>.class</literal>) Entities
</title>
<para>Class entities are used to build mixture entities and, in some cases,
are used directly in element and attribute declarations in various capacities. <xref
linkend="class-ents"> lists all the class entities and their contents in alphabetical
order.</para>
<table frame="all" id="class-ents">
<title>Class Entities and Contents</title>
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colwidth="139*">
<colspec colwidth="317*">
<thead>
<row><entry align="left" valign="top"><emphasis role="strong">Class Entity
</emphasis></entry><entry align="left" valign="top"><emphasis role="strong">
Contents</emphasis></entry></row>
</thead>
<tbody>
<row>
<entry align="left" valign="top">admon.class</entry>
<entry align="left" valign="top">Caution, Important, Note, Tip, Warning</entry>
</row>
<row>
<entry align="left" valign="top">appendix.class</entry>
<entry align="left" valign="top">Appendix</entry>
</row>
<row>
<entry align="left" valign="top">article.class</entry>
<entry align="left" valign="top">Article</entry>
</row>
<row>
<entry align="left" valign="top">base.char.class</entry>
<entry align="left" valign="top">Anchor</entry>
</row>
<row>
<entry align="left" valign="top">book.class</entry>
<entry align="left" valign="top">Book</entry>
</row>
<row>
<entry align="left" valign="top">chapter.class</entry>
<entry align="left" valign="top">Chapter</entry>
</row>
<row>
<entry align="left" valign="top">compound.class</entry>
<entry align="left" valign="top">MsgSet, Procedure, Sidebar</entry>
</row>
<row>
<entry align="left" valign="top">cptr.char.class</entry>
<entry align="left" valign="top">Action, Application, ClassName, Command,
ComputerOutput, Database, Email, ErrorName, ErrorType, Filename, Function,
GUIButton, GUIIcon, GUILabel, GUIMenu, GUIMenuItem, GUISubmenu, Hardware,
Interface, InterfaceDefinition, KeyCap, KeyCode, KeyCombo, KeySym, Literal,
Markup, MediaLabel, MenuChoice, MouseButton, MsgText, Option, Optional, Parameter,
Property, Replaceable, ReturnValue, SGMLTag, StructField, StructName, Symbol,
SystemItem, Token, Type, UserInput</entry>
</row>
<row>
<entry align="left" valign="top">descobj.class</entry>
<entry align="left" valign="top">Abstract, AuthorBlurb, Epigraph</entry>
</row>
<row>
<entry align="left" valign="top">docinfo.char.class</entry>
<entry align="left" valign="top">Author, AuthorInitials, CorpAuthor, ModeSpec,
OtherCredit, ProductName, ProductNumber, RevHistory</entry>
</row>
<row>
<entry align="left" valign="top">formal.class</entry>
<entry align="left" valign="top">Equation, Example, Figure, Table</entry>
</row>
<row>
<entry align="left" valign="top">genobj.class</entry>
<entry align="left" valign="top">Anchor, BridgeHead, Comment, Highlights</entry>
</row>
<row>
<entry align="left" valign="top">index.class</entry>
<entry align="left" valign="top">Index, SetIndex</entry>
</row>
<row>
<entry align="left" valign="top">informal.class</entry>
<entry align="left" valign="top">Address, BlockQuote, Graphic, GraphicCO,
InformalEquation, InformalExample, InformalTable</entry>
</row>
<row>
<entry align="left" valign="top">inlineobj.char.class</entry>
<entry align="left" valign="top">InlineGraphic, InlineEquation</entry>
</row>
<row>
<entry align="left" valign="top">linespecific.class</entry>
<entry align="left" valign="top">LiteralLayout, ProgramListing, ProgramListingCO,
Screen, ScreenCO, ScreenShot</entry>
</row>
<row>
<entry align="left" valign="top">link.char.class</entry>
<entry align="left" valign="top">Link, OLink, ULink</entry>
</row>
<row>
<entry align="left" valign="top">list.class</entry>
<entry align="left" valign="top">CalloutList, GlossList, ItemizedList, OrderedList,
SegmentedList, SimpleList, VariableList</entry>
</row>
<row>
<entry align="left" valign="top">nav.class</entry>
<entry align="left" valign="top">ToC, LoT, Index, Glossary, Bibliography</entry>
</row>
<row>
<entry align="left" valign="top">ndxterm.class</entry>
<entry align="left" valign="top">IndexTerm</entry>
</row>
<row>
<entry align="left" valign="top">notation.class</entry>
<entry align="left" valign="top">BMP, CGM-CHAR, CGM-BINARY, CGM-CLEAR, DITROFF,
DVI, EPS, EQN, FAX, GIF, IGES, PCX, PIC, PS, TBL, TEX, TIFF, WMF, WPG, linespecific
(this is the only class entity that contains not element names, but non-SGML
notation names)</entry>
</row>
<row>
<entry align="left" valign="top">other.char.class</entry>
<entry align="left" valign="top">Comment, Subscript, Superscript</entry>
</row>
<row>
<entry align="left" valign="top">para.class</entry>
<entry align="left" valign="top">FormalPara, Para, SimPara</entry>
</row>
<row>
<entry align="left" valign="top">refentry.class</entry>
<entry align="left" valign="top">RefEntry</entry>
</row>
<row>
<entry align="left" valign="top">synop.class</entry>
<entry align="left" valign="top">Synopsis, CmdSynopsis, FuncSynopsis</entry>
</row>
<row>
<entry align="left" valign="top">word.char.class</entry>
<entry align="left" valign="top">Abbrev, Acronym, Citation, CiteTitle, CiteRefEntry,
Emphasis, FirstTerm, ForeignPhrase, GlossTerm, Footnote, Phrase, Quote, Trademark,
WordAsWord</entry>
</row>
<row>
<entry align="left" valign="top">xref.char.class</entry>
<entry align="left" valign="top">FootnoteRef, XRef</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2>
<title>Mixture (<literal><replaceable>xxx</replaceable>.mix</literal>) Entities
</title>
<para>Mixture entities combine various class entities and individual elements
for use in repeatable-OR content model groups.</para>
<para><xref linkend="obj-mix-ents"> shows the pattern of class entities used
to build the object-level mixture entities that are used directly in content
models. An <quote>X</quote> means that all elements in the indicated class
are allowed.</para>
<table frame="all" id="obj-mix-ents">
<title>Object-Level (<literal><replaceable>xxx</replaceable>.mix</literal>)
Mixture Entities and Contents</title>
<tgroup cols="11" colsep="1" rowsep="1">
<colspec colname="col1" colwidth="114*">
<colspec colwidth="31*">
<colspec colwidth="35*">
<colspec colwidth="31*">
<colspec colwidth="29*">
<colspec colwidth="37*">
<colspec colwidth="29*">
<colspec colwidth="38*">
<colspec colwidth="44*">
<colspec colwidth="31*">
<colspec colname="col11" colwidth="37*">
<spanspec nameend="col11" namest="col1" spanname="1to11">
<thead>
<row><entry align="right" valign="top"></entry><entry align="center" valign="top">
list</entry><entry align="center" valign="top">adm</entry><entry align="center"
valign="top">line</entry><entry align="center" valign="top">syn</entry><entry
align="center" valign="top">para</entry><entry align="center" valign="top">
inf</entry><entry align="center" valign="top">form</entry><entry align="center"
valign="top">cmpd</entry><entry align="center" valign="top">gen</entry><entry
align="center" valign="top">desc</entry></row>
</thead>
<tbody>
<row>
<entry align="right" valign="top">admon.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">a</entry>
<entry align="center" valign="top">b</entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">component.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
</row>
<row>
<entry align="right" valign="top">divcomponent. mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
</row>
<row>
<entry align="right" valign="top">example.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">figure.mix</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">footnote.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">glossdef.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">c</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">highlights.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">indexdiv. component.mix</entry>
<entry align="center" valign="top">d</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">e</entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">legalnotice.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">f</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">para.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">refcomponent. mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
</row>
<row>
<entry align="right" valign="top">sidebar.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">g</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">tabentry.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">h</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="left" spanname="1to11" valign="top"><literallayout>a: Procedure
and Sidebar only.
b: Anchor, BridgeHead, and Comment only.
c: Comment only.
d: ItemizedList, OrderedList, VariableList, and SimpleList only.
e: Anchor and Comment only.
f: BlockQuote only.
g: Procedure only.
h: Graphic only.</literallayout></entry>
</row>
<row>
<entry align="left" spanname="1to11" valign="top"><literallayout>lst: list.class
adm: admon.class
line: linespecific.class
syn: synop.class
para: para.class
inf: informal.class
form: form.class
cmpd: compound.class
gen: genobj.class
desc: descobj.class</literallayout></entry>
</row>
</tbody>
</tgroup>
</table>
<para><xref linkend="inl-mix-ents"> shows the pattern of class entities used
to build the inline-level mixture entities that are used directly in content
models. An <quote>X</quote> means that all elements in the indicated class
are allowed.</para>
<table frame="all" id="inl-mix-ents">
<title>Inline-Level (<literal><replaceable>xxx</replaceable>.char.mix</literal>)
Mixture Entities and Contents</title>
<tgroup cols="10" colsep="1" rowsep="1">
<colspec colname="col1" colwidth="125*">
<colspec colwidth="34*">
<colspec colwidth="36*">
<colspec colwidth="38*">
<colspec colwidth="35*">
<colspec colwidth="42*">
<colspec colwidth="37*">
<colspec colwidth="38*">
<colspec colwidth="36*">
<colspec colname="col10" colwidth="35*">
<spanspec nameend="col10" namest="col1" spanname="1to10">
<thead>
<row><entry align="right" valign="top"></entry><entry align="center" valign="top">
#P</entry><entry align="center" valign="top">X</entry><entry align="center"
valign="top">W</entry><entry align="center" valign="top">L</entry><entry align="center"
valign="top">C</entry><entry align="center" valign="top">B</entry><entry align="center"
valign="top">D</entry><entry align="center" valign="top">O</entry><entry align="center"
valign="top">I</entry></row>
</thead>
<tbody>
<row>
<entry align="right" valign="top">cptr.char.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">a</entry>
</row>
<row>
<entry align="right" valign="top">docinfo.char.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">c</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">b</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">a</entry>
</row>
<row>
<entry align="right" valign="top">ndxterm.char.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">a</entry>
</row>
<row>
<entry align="right" valign="top">para.char.mix (also contains synop.class)
</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
</row>
<row>
<entry align="right" valign="top">refinline.char.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">refname.char.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
</row>
<row>
<entry align="right" valign="top">smallcptr.char.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">b</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">a</entry>
</row>
<row>
<entry align="right" valign="top">title.char.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">X</entry>
</row>
<row>
<entry align="right" valign="top">word.char.mix</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">c</entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top"></entry>
<entry align="center" valign="top">X</entry>
<entry align="center" valign="top">a</entry>
</row>
<row>
<entry align="left" spanname="1to10" valign="top"><literallayout>a: InlineGraphic
only.
b: Replaceable only.
c: Emphasis and Trademark only.</literallayout></entry>
</row>
<row>
<entry align="left" spanname="1to10" valign="top"><literallayout>#P: #PCDATA
X: xref.char.class
W: word.char.class
L: link.char.class
C: cptr.char.class
B: base.char.class
D: docinfo.char.class
O: other.char.class
I: inlineobj.char.class</literallayout></entry>
</row>
</tbody>
</tgroup>
</table>
<para>A few miscellaneous mixtures are also defined:<itemizedlist><listitem>
<para>The mixture ubiq.mix contains ndxterm.class and BeginPage.</para>
</listitem><listitem><para>The mixture person.ident.mix contains Honorific,
FirstName, Surname, Lineage, OtherName, Affiliation, AuthorBlurb, and Contrib.
</para>
</listitem><listitem><para>The mixture partcontent.mix contains appendix.class,
chapter.class, nav.class, Preface, refentry.class, and Reference.</para>
</listitem><listitem><para>The mixture setinfo.char.mix contains <literal>
#PCDATA</literal>, docinfo.char.class, Title, Copyright, CorpName, Date, Editor,
Edition, InvPartNumber, ISBN, LegalNotice, OrgName, PrintHistory, Publisher,
PubsNumber, ReleaseInfo, SubTitle, and VolumeNum.</para>
</listitem></itemizedlist></para>
</sect2>
<sect2>
<title>Content Model Fragment (<literal><replaceable>xxx</replaceable>.content
</literal>) Entities</title>
<para><xref linkend="frag-ents"> alphabetically lists the entities containing
non-mixture fragments of content models, the contexts in which they are typically
used, and their contents.</para>
<table frame="all" id="frag-ents">
<title>Content Model Fragment Entities, Contexts, and Contents</title>
<tgroup cols="3" colsep="1" rowsep="1">
<colspec colwidth="183*">
<colspec colwidth="137*">
<colspec colwidth="136*">
<thead>
<row><entry align="left" valign="top"><emphasis role="strong">Entity</emphasis></entry>
<entry align="left" valign="top"><emphasis role="strong">Contexts</emphasis></entry>
<entry align="left" valign="top"><emphasis role="strong">Contents</emphasis></entry>
</row>
</thead>
<tbody>
<row>
<entry align="left" valign="top">bookcomponent.content</entry>
<entry align="left" valign="top">Chapter-level elements, PartIntro, and Article
</entry>
<entry align="left" valign="top">A divcomponent mixture followed by either
Sect1s, RefEntries, or SimpleSects</entry>
</row>
<row>
<entry align="left" valign="top">bookcomponent.title.content</entry>
<entry align="left" valign="top">Chapter-level divisions, ToC, LoT, Part,
Reference, Bibliography, Glossary, Index, SetIndex</entry>
<entry align="left" valign="top">An optional DocInfo, followed by Title, followed
optionally by TitleAbbrev</entry>
</row>
<row>
<entry align="left" valign="top">div.title.content</entry>
<entry align="left" valign="top">Set, Book, PartIntro, DocInfo, SeriesInfo,
ArtHeader</entry>
<entry align="left" valign="top">Title followed optionally by TitleAbbrev
</entry>
</row>
<row>
<entry align="left" valign="top">equation.content</entry>
<entry align="left" valign="top">Equation, InformalEquation</entry>
<entry align="left" valign="top">One or more Graphics</entry>
</row>
<row>
<entry align="left" valign="top">formalobject.title.content</entry>
<entry align="left" valign="top">Formal objects, Procedure, Sidebar, SegmentedList,
VariableList</entry>
<entry align="left" valign="top">Title followed optionally by TitleAbbrev
</entry>
</row>
<row>
<entry align="left" valign="top">inlineequation.content</entry>
<entry align="left" valign="top">InlineEquation</entry>
<entry align="left" valign="top">One or more Graphics</entry>
</row>
<row>
<entry align="left" valign="top">programlisting.content</entry>
<entry align="left" valign="top">ProgramListing</entry>
<entry align="left" valign="top">A mixture of CO, LineAnnotation and inline.char.mix
</entry>
</row>
<row>
<entry align="left" valign="top">refsect.title.content</entry>
<entry align="left" valign="top">Reference entry sections</entry>
<entry align="left" valign="top">Title followed optionally by TitleAbbrev
</entry>
</row>
<row>
<entry align="left" valign="top">screen.content</entry>
<entry align="left" valign="top">Screen</entry>
<entry align="left" valign="top">A mixture of CO, LineAnnotation and inline.char.mix
</entry>
</row>
<row>
<entry align="left" valign="top">sect.title.content</entry>
<entry align="left" valign="top">Sections</entry>
<entry align="left" valign="top">Title followed optionally by TitleAbbrev
</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2>
<title>Attribute (<literal><replaceable>xxx</replaceable>.attrib</literal>)
Entities</title>
<para><xref linkend="attrib-list"> lists the entities that define individual
attributes and groupings of attributes.</para>
<para>Attribute placeholder entities with the naming pattern <literal>local.<replaceable>
xxx</replaceable>.attrib</literal> are defined in every <literal>ELEMENT</literal>/<literal>
ATTLIST</literal> pair's marked section. You can ignore these entity declarations.
</para>
<table frame="all" id="attrib-list">
<title>Attribute Entities</title>
<tgroup cols="4" colsep="1" rowsep="1">
<colspec colwidth="135*">
<colspec colwidth="120*">
<colspec colwidth="97*">
<colspec colwidth="104*">
<thead>
<row><entry align="left" valign="top"><emphasis role="strong">Entity</emphasis></entry>
<entry align="left" valign="top"><emphasis role="strong">Attribute name(s)
</emphasis></entry><entry align="left" valign="top"><emphasis role="strong">
Declared value</emphasis></entry><entry align="left" valign="top"><emphasis
role="strong">Default value</emphasis></entry></row>
</thead>
<tbody>
<row>
<entry align="left" valign="top">arch.attrib</entry>
<entry align="left" valign="top">Arch</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">common.attrib</entry>
<entry align="left" valign="top">id.attrib, lang.attrib, remap.attrib, role.attrib,
xreflabel.attrib, revisionflag.attrib, effectivity.attrib</entry>
</row>
<row>
<entry align="left" valign="top">effectivity.attrib</entry>
<entry align="left" valign="top">arch.attrib, os.attrib, revision.attrib,
userlevel.attrib, vendor.attrib</entry>
</row>
<row>
<entry align="left" valign="top">graphics.attrib</entry>
<entry align="left" valign="top">All attributes related to specifying graphics
</entry>
</row>
<row>
<entry align="left" valign="top">id.attrib</entry>
<entry align="left" valign="top">Id</entry>
<entry align="left" valign="top">ID</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">idreq.attrib</entry>
<entry align="left" valign="top">Id</entry>
<entry align="left" valign="top">ID</entry>
<entry align="left" valign="top">#REQUIRED</entry>
</row>
<row>
<entry align="left" valign="top">idreq.common.attrib</entry>
<entry align="left" valign="top">idreq.attrib, lang.attrib, remap.attrib,
role.attrib, xreflabel.attrib</entry>
</row>
<row>
<entry align="left" valign="top">label.attrib</entry>
<entry align="left" valign="top">Label</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">lang.attrib</entry>
<entry align="left" valign="top">Lang</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">linespecific.attrib</entry>
<entry align="left" valign="top">Format</entry>
<entry align="left" valign="top">NOTATION linespecific</entry>
<entry align="left" valign="top">linespecific</entry>
</row>
<row>
<entry align="left" valign="top">linkend.attrib</entry>
<entry align="left" valign="top">Linkend</entry>
<entry align="left" valign="top">IDREF</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">linkendreq.attrib</entry>
<entry align="left" valign="top">Linkend</entry>
<entry align="left" valign="top">IDREF</entry>
<entry align="left" valign="top">#REQUIRED</entry>
</row>
<row>
<entry align="left" valign="top">linkends.attrib</entry>
<entry align="left" valign="top">Linkends</entry>
<entry align="left" valign="top">IDREFS</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">linkendsreq.attrib</entry>
<entry align="left" valign="top">Linkends</entry>
<entry align="left" valign="top">IDREF</entry>
<entry align="left" valign="top">#REQUIRED</entry>
</row>
<row>
<entry align="left" valign="top">mark.attrib</entry>
<entry align="left" valign="top">Mark</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">moreinfo.attrib</entry>
<entry align="left" valign="top">MoreInfo</entry>
<entry align="left" valign="top">(RefEntry| None)</entry>
<entry align="left" valign="top">None</entry>
</row>
<row>
<entry align="left" valign="top">os.attrib</entry>
<entry align="left" valign="top">OS</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">pagenum.attrib</entry>
<entry align="left" valign="top">PageNum</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">remap.attrib</entry>
<entry align="left" valign="top">Remap</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">revision.attrib</entry>
<entry align="left" valign="top">Revision</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">revisionflag.attrib</entry>
<entry align="left" valign="top">RevisionFlag</entry>
<entry align="left" valign="top">(Changed |Added |Deleted)</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">role.attrib</entry>
<entry align="left" valign="top">Role</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">userlevel.attrib</entry>
<entry align="left" valign="top">UserLevel</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">vendor.attrib</entry>
<entry align="left" valign="top">Vendor</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
<row>
<entry align="left" valign="top">xreflabel.attrib</entry>
<entry align="left" valign="top">XRefLabel</entry>
<entry align="left" valign="top">CDATA</entry>
<entry align="left" valign="top">#IMPLIED</entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
</sect1>
</chapter>
|