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
|
<HTML
><HEAD
><TITLE
>Installation</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.45"><LINK
REL="HOME"
TITLE="DocBook"
HREF="docbook.html"><LINK
REL="UP"
TITLE="Appendixes"
HREF="part3.html"><LINK
REL="PREVIOUS"
TITLE="Appendixes"
HREF="part3.html"><LINK
REL="NEXT"
TITLE="DocBook and XML"
HREF="appb.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="dbtdg.css"></HEAD
><BODY
CLASS="APPENDIX"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>DocBook: The Definitive Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="part3.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="appb.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="APPENDIX"
><H1
><A
NAME="APP-INSTALL"
>Appendix A. Installation</A
></H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
>A.1. <A
HREF="appa.html#S-INSTALLDTD"
>Installing the DocBook DTD</A
></DT
><DT
>A.2. <A
HREF="appa.html#S-INSTALLJADE"
>Installing Jade</A
></DT
><DT
>A.3. <A
HREF="appa.html#XINSTMDS"
>Installing the ModularDocBook Stylesheets</A
></DT
></DL
></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="S-INSTALLDTD"
>A.1. Installing the DocBook DTD</A
></H1
><P
><A
NAME="DOCBOOKINSTALLAPPA"
></A
>
This appendix describes how to install the DocBook DTD on your system
so that popular command-line tools like <SPAN
CLASS="APPLICATION"
>SP</SPAN
> can
use it. If you are installing DocBook for use with a commercial application,
consult the documentation for your application as well.</P
><P
>This appendix describes the installation of DocBook V3.1. If you are using
another distribution, the process should be about the same, but there
may be minor differences. DocBook V3.1 is backward compatible with DocBook
V3.0, and is the recommended distribution at the time of this writing.</P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN148159"
>A.1.1. Unpacking the DocBook V3.1 Distribution</A
></H2
><P
><A
NAME="AEN148162"
></A
>
DocBook is distributed on the <A
HREF="http://www.oasis-open.org/docbook/"
TARGET="_top"
>DocBook web
site</A
>. You will also find a copy of the distribution on
the <A
HREF="appe.html"
>CD-ROM</A
>.</P
><P
><A
NAME="AEN148168"
></A
>
The distribution consists of 14 files:</P
><DIV
CLASS="INFORMALTABLE"
><P
></P
><TABLE
BORDER="0"
CLASS="CALSTABLE"
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>31chg.txt</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>Describes the changes in DocBook
V3.1 from the preceding version (3.0)</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>40issues.txt</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>Summarizes backwards-incompatible
changes planned for DocBook V4.0</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>50issues.txt</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>Summarizes backwards-incompatible
changes planned for DocBook V5.0</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>cals-tbl.dtd</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>The CALS Table Model DTD</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>ChangeLog</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>A GNU-style ChangeLog
summarizing the individual edits made on each file in the distribution
since V3.0.</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>dbcent.mod</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>The character entity module</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>dbgenent.mod</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>The general entity module</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>dbhier.mod</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>The document hierarchy module</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>dbnotn.mod</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>The notations module</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>dbpool.mod</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>The information pool module</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>docbook.cat</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>A sample OASIS catalog
for DocBook</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>docbook.dcl</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>An SGML Declaration suitable
for DocBook</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>docbook.dtd</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>The DocBook DTD</TD
></TR
><TR
><TD
WIDTH="1"
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="FILENAME"
>readme.txt</TT
></TD
><TD
WIDTH="4"
ALIGN="LEFT"
VALIGN="TOP"
>The DocBook V3.1 <SPAN
CLASS="QUOTE"
>"readme"</SPAN
> file</TD
></TR
></TABLE
><P
></P
></DIV
><P
>Unpack the distribution into a directory on your system. The exact location
is irrelevant. On UNIX systems it's common to put it somewhere under <TT
CLASS="FILENAME"
>/usr/local</TT
> or <TT
CLASS="FILENAME"
>/share</TT
> (for example, <TT
CLASS="FILENAME"
>/usr/local/sgml/docbook</TT
> or <TT
CLASS="FILENAME"
>/share/sgml/docbook</TT
>).
On a PC, perhaps <TT
CLASS="FILENAME"
>c:\sgml\docbook</TT
>.</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN148239"
>A.1.2. Getting the ISO Entity Sets</A
></H2
><P
><A
NAME="AEN148242"
></A
>
<A
NAME="AEN148245"
></A
>
<A
NAME="AEN148249"
></A
>
<A
NAME="AEN148253"
></A
>
DocBook refers to a number of standard entity sets that
are not distributed with DocBook. (They aren't distributed with
DocBook because they aren't maintained by the DocBook
TC. They're maintained by ISO.) If you've installed other SGML
DTDs or tools, they may already be on your system.</P
><P
>If you are missing some of them, they are available from
Robin Cover's pages at OASIS: <A
HREF="http://www.oasis-open.org/cover/ISOEnts.zip"
TARGET="_top"
>http://www.oasis-open.org/cover/ISOEnts.zip</A
>.<A
NAME="AEN148258"
HREF="#FTN.AEN148258"
>[1]</A
> See <A
HREF="http://www.oasis-open.org/cover/topics.html#entities"
TARGET="_top"
>http://www.oasis-open.org/cover/topics.html#entities</A
>
for more information.</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DBCATALOG"
>A.1.3. The DocBook Catalog</A
></H2
><P
><A
NAME="AEN148265"
></A
>
<A
NAME="AEN148269"
></A
>
DocBook uses public identifiers to refer to its
constituent parts. In some sense, DocBook <I
CLASS="EMPHASIS"
>is</I
>
DocBook because it has the formal public
identifier <SPAN
CLASS="QUOTE"
>"<TT
CLASS="LITERAL"
>-//OASIS//DTD DocBook V3.1//EN</TT
>"</SPAN
>.
In order for tools on your system to
find your locally installed copy of DocBook, you must map these
public identifiers into system identifiers, i.e., filenames, on
your system. For a complete discussion of catalog files,
see <A
HREF="ch02.html#S-PID-SID-CATALOGS"
>Section 2.3</A
>.</P
><P
><A
NAME="AEN148277"
></A
>
The DocBook distribution includes a sample catalog, <TT
CLASS="FILENAME"
>docbook.cat</TT
>, which provides a mapping for all of the public identifiers referenced
by DocBook. This mapping won't work <SPAN
CLASS="QUOTE"
>"out of the box"</SPAN
> for two
reasons: first, your tools won't be able to find it, and second, the mappings
for the ISO entity sets probably don't point to the right place on your system.</P
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN148282"
>A.1.3.1. Finding the Catalog</A
></H3
><P
>If you've already got some other SGML DTDs installed, you probably already
have a catalog file. In this case, the easiest thing to do is append
the DocBook catalog entries to the end of your existing catalog and then change
them to point to the files on your system.</P
><P
>If DocBook is the first DTD that you're installing, make a
copy of <TT
CLASS="FILENAME"
>docbook.cat</TT
> and call it
<TT
CLASS="FILENAME"
>catalog</TT
>. Put this file in a higher-level
directory and edit the relative pathnames that it contains to point to
the actual locations of the files on your system. For example, if you installed DocBook
in <TT
CLASS="FILENAME"
>/share/sgml/docbk30/</TT
>, put the
<TT
CLASS="FILENAME"
>catalog</TT
> in <TT
CLASS="FILENAME"
>/share/sgml/</TT
>.</P
><P
><A
NAME="AEN148292"
></A
>
<A
NAME="AEN148295"
></A
>
In order for applications to find your catalog file(s), you may have
to change the application preferences or set an environment variable. For <SPAN
CLASS="APPLICATION"
>SP</SPAN
> and <SPAN
CLASS="APPLICATION"
>Jade</SPAN
>, set the environment
variable <TT
CLASS="ENVAR"
>SGML_CATALOG_FILES</TT
> to the delimited list of catalog
filenames. On my system, this looks like:</P
><PRE
CLASS="SCREEN"
>SGML_CATALOG_FILES=./catalog;n:/share/sgml/catalog;n:/adept80/doctypes/catalog.jade;j:/jade/catalog</PRE
><P
>(On a UNIX machine, use colons instead of semicolons to delimit the
filenames.)</P
><P
>If you don't wish to set the environment variable, you can explicitly
pass the name of each catalog to the <SPAN
CLASS="APPLICATION"
>SP</SPAN
> application
with the <TT
CLASS="OPTION"
>-c</TT
> option, like this:</P
><PRE
CLASS="SCREEN"
>nsgmls -c ./catalog -c n:/share/sgml/catalog <TT
CLASS="REPLACEABLE"
><I
>-c othercatalogs</I
></TT
> ...</PRE
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN148307"
>A.1.3.2. Fixing the Catalog</A
></H3
><P
><A
NAME="AEN148310"
></A
>
The basic format of each entry in the DocBook catalog is:</P
><PRE
CLASS="SCREEN"
>PUBLIC "some public id" "some filename"</PRE
><P
>What you have to do is change each of the <SPAN
CLASS="QUOTE"
>"some filenames"</SPAN
>
to point to the actual name of the file on your system.</P
><DIV
CLASS="NOTE"
><P
></P
><TABLE
CLASS="NOTE"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="figures/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
><A
NAME="AEN148318"
></A
>
Filenames should be supplied using absolute filenames,
or paths relative to the location of
the <I
CLASS="EMPHASIS"
>catalog</I
> file.</P
></TD
></TR
></TABLE
></DIV
><P
>To continue with the example above, let's say that you've got:</P
><P
></P
><UL
><LI
><P
>DocBook in <TT
CLASS="FILENAME"
>/share/sgml/docbk30/</TT
>,</P
></LI
><LI
><P
>The ISO entities in <TT
CLASS="FILENAME"
>/share/sgml/entities/8879/</TT
>,
and</P
></LI
><LI
><P
>Your catalog in <TT
CLASS="FILENAME"
>/share/sgml/catalog</TT
></P
></LI
></UL
><P
>Then you would change the catalog entry for the DTD to be:</P
><PRE
CLASS="SCREEN"
>PUBLIC "-//OASIS//DTD DocBook V3.1//EN" "docbk30/docbook.dtd"</PRE
><P
>You would change the catalog entry for the general technical character entities to:</P
><PRE
CLASS="SCREEN"
>PUBLIC "ISO 8879:1986//ENTITIES General Technical//EN" "entities/8879/iso-tech.gml"</PRE
><P
>And similarly for the other public identifiers used by DocBook. In each
case, the filename specified for the public identifier should be the name
of the file on your system, specified as an absolute filename, or
relative to the location of the <TT
CLASS="FILENAME"
>catalog</TT
>
in which it occurs.</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN148339"
>A.1.3.3. Mapping System Identifiers for XML</A
></H3
><P
><A
NAME="AEN148342"
></A
>
<A
NAME="AEN148346"
></A
>
Since XML documents are required to have system identifiers, but are not
required to have public identifiers, it's likely that some of the documents
you want to process will only have system identifiers.</P
><P
>It turns out that you can still take advantage of the catalog in this case.
The <TT
CLASS="LITERAL"
>SYSTEM</TT
> directive allows you to map the system
identifier used in the document to the actual location on your system.</P
><P
>Suppose that you work with a colleague who uses the system identifier
<SPAN
CLASS="QUOTE"
>"file:///c:/sgml/db3xml/db3xml.dtd"</SPAN
> to identify the XML version
of DocBook on her system. On your system, you want to map that to
<SPAN
CLASS="QUOTE"
>"/share/sgml/db3xml/db3xml.dtd"</SPAN
>. The following entry in
your catalog will do the trick:</P
><PRE
CLASS="SCREEN"
>SYSTEM "http://docbook.org/docbook/xml/1.4/db3xml.dtd" "/share/sgml/db3xml/db3xml.dtd"</PRE
><P
>Unfortunately, this technique only works with applications that read and
understand catalog files.</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN148357"
>A.1.4. Testing Your Installation</A
></H2
><P
><A
NAME="AEN148360"
></A
>
<A
NAME="AEN148364"
></A
>
<A
NAME="AEN148367"
></A
>
The best way to test your installation is with a simple command-line
parser like <I
CLASS="COMMAND"
>nsgmls</I
> from <SPAN
CLASS="APPLICATION"
>SP</SPAN
>.
Create a small test document, like this:</P
><PRE
CLASS="SCREEN"
><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<chapter><title>Test Chapter</title>
<para>
This is a test document.
</para>
</chapter></PRE
><P
>and run the following command:</P
><PRE
CLASS="SCREEN"
>nsgmls -sv test.sgm</PRE
><P
><A
NAME="AEN148376"
></A
>
<A
NAME="AEN148379"
></A
>
If the <I
CLASS="COMMAND"
>nsgmls</I
> command produces errors, review your
catalog and resolve the errors. You can ignore warnings about <TT
CLASS="LITERAL"
>DTDDECL</TT
> being unsupported. It is unsupported, and there's no way to disable
the warning message. Note, however, that this may also affect which SGML declaration
gets used. When in doubt, pass the correct declaration explicitly and see
if that corrects any problems. (To parse <TT
CLASS="FILENAME"
>test.sgm</TT
> with
the declaration <TT
CLASS="FILENAME"
>docbook.dcl</TT
> explicitly, run <I
CLASS="COMMAND"
>nsgmls -sv docbook.dcl test.sgm</I
>.)</P
><P
>For some suggestions about how to work around these problems in <SPAN
CLASS="APPLICATION"
>SP</SPAN
> and <SPAN
CLASS="APPLICATION"
>Jade</SPAN
>, see the next section,
<A
HREF="appa.html#S-INSTALLJADE"
>Section A.2</A
>.</P
></DIV
></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="S-INSTALLJADE"
>A.2. Installing Jade</A
></H1
><P
><A
NAME="AEN148394"
></A
>
For simplicity, the instructions assume that you are working with
Jade on a Microsoft Windows machine. These instructions should be just as
useful if you are working on another platform, except for the normal cross-platform
idiosyncracies (path and filename separator characters, use of drive letters,
etc.).</P
><P
>Download and unpack the <A
HREF="http://www.jclark.com/jade/"
TARGET="_top"
>Jade</A
> distribution. Binary distributions are available for some platforms,
which makes installation a simple matter of unpacking the distribution. Or
you can build Jade from the source (consult the documentation that comes with
Jade for more detail about building it from source).</P
><P
>You may wish to add the directory where you installed Jade to your <TT
CLASS="ENVAR"
>PATH</TT
>. If not, make sure that you use the fully qualified name of the
executable when you run the commands below.</P
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN148401"
>A.2.1. Setting Up the Catalog</A
></H2
><P
><A
NAME="AEN148404"
></A
>
First, the catalog needs to be set up as described in
<A
HREF="appa.html#DBCATALOG"
>Section A.1.3</A
>
in order for Jade to be able to parse your DocBook documents. In addition,
Jade comes with its own <TT
CLASS="FILENAME"
>catalog</TT
> file that you must add
to the <TT
CLASS="ENVAR"
>SGML_CATALOG_FILES</TT
> environment variable or otherwise
make available to Jade.</P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="AEN148410"
>A.2.2. Testing Jade</A
></H2
><P
><A
NAME="AEN148413"
></A
>
Download <A
HREF="http://nwalsh.com/docbook/dsssl/doc/testdata/jtest.sgm"
TARGET="_top"
><TT
CLASS="FILENAME"
>jtest.sgm</TT
></A
> and <A
HREF="http://nwalsh.com/docbook/dsssl/doc/testdata/jtest.dsl"
TARGET="_top"
><TT
CLASS="FILENAME"
>jtest.dsl</TT
></A
>. (Or get them off the CD-ROM in
FIXME.) These are self-contained
test documents. Test Jade by running:</P
><PRE
CLASS="SCREEN"
>jade -t rtf -d jtest.dsl jtest.sgm</PRE
><P
>This command should silently produce <A
HREF="http://nwalsh.com/docbook/dsssl/doc/testdata/jtest.rtf"
TARGET="_top"
>jtest.rtf</A
>. If you encounter warnings or errors here, Jade is not installed
correctly. One possible culprit is your catalog setup. See <A
HREF="ch04.html#JADEMULTDECL"
>Section 4.5</A
>.</P
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN148424"
>A.2.2.1. DTDDECL Warnings</A
></H3
><P
><A
NAME="AEN148427"
></A
>
One annoying shortcoming in Jade is that it does not support the <TT
CLASS="LITERAL"
>DTDDECL</TT
> catalog directive and it complains loudly if it encounters
one. In Jade, it's almost always possible to work around the problems that <TT
CLASS="LITERAL"
>DTDDECL</TT
> would solve, so you can generally ignore the warnings.</P
><P
>If you also use applications that do understand <TT
CLASS="LITERAL"
>DTDDECL</TT
>,
and find the warnings too distracting to bear, setup alternate catalogs
for <SPAN
CLASS="APPLICATION"
>SP</SPAN
> applications, <TT
CLASS="FILENAME"
>catalog.jade</TT
>,
that are identical to your normal catalogs but do not contain any <TT
CLASS="LITERAL"
>DTDDECL</TT
> entries. You can then avoid the warnings by putting <TT
CLASS="FILENAME"
>catalog.jade</TT
> in your <TT
CLASS="ENVAR"
>SGML_CATALOG_FILES</TT
> path, instead of <TT
CLASS="FILENAME"
>catalog</TT
>.</P
></DIV
></DIV
></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="XINSTMDS"
>A.3. Installing the ModularDocBook Stylesheets</A
></H1
><P
><A
NAME="AEN148443"
></A
>
<A
NAME="AEN148446"
></A
>
<A
NAME="AEN148450"
></A
>
<A
HREF="http://nwalsh.com/~ndw/"
TARGET="_top"
>Norman Walsh</A
> (one of your
intrepid authors ;-) maintains two DSSSL stylesheets for DocBook, one for
print and one for online (HTML) output. You can obtain both of these stylesheets
from <A
HREF="http://nwalsh.com/docbook/dsssl/"
TARGET="_top"
>http://nwalsh.com/docbook/dsssl/</A
>. (A recent version is also on
the CD-ROM.)</P
><DIV
CLASS="PROCEDURE"
><OL
TYPE="1"
><LI
><P
>If you have not already done so, download and install the DocBook
DTD as described in <A
HREF="appa.html#S-INSTALLDTD"
>Section A.1</A
>.</P
></LI
><LI
><P
>Likewise, if Jade is not installed on your system, download
and install it as described in <A
HREF="appa.html#S-INSTALLJADE"
>Section A.2</A
>.</P
></LI
><LI
><P
>Download and unpack the <A
HREF="http://nwalsh.com/docbook/dsssl/"
TARGET="_top"
>stylesheet distribution</A
>.</P
></LI
><LI
><P
><A
NAME="AEN148468"
></A
>
<A
NAME="AEN148471"
></A
>
Test the installation by processing <TT
CLASS="FILENAME"
>test.sgm</TT
>
(from the previous section) with Jade:</P
><PRE
CLASS="SCREEN"
>jade -t rtf -d d:\where-you-unpacked-the-stylesheets\docbook\print\docbook.dsl test.sgm</PRE
><P
>This command should silently produce <A
HREF="http://nwalsh.com/docbook/dsssl/doc/testdata/test.rtf"
TARGET="_top"
><TT
CLASS="FILENAME"
>test.rtf</TT
></A
>. If not, and the preceding test succeeded, something
has gone wrong--<A
HREF="http://nwalsh.com/~ndw/contact.html"
TARGET="_top"
>contact
the maintainer</A
>.</P
><P
>To test the HTML stylesheet, run:</P
><PRE
CLASS="SCREEN"
>jade -t sgml -d d:\where-you-unpacked-the-stylesheets\docbook\html\docbook.dsl test.sgm</PRE
><P
>This command should silently produce <A
HREF="http://nwalsh.com/docbook/dsssl/doc/testdata/c01.htm"
TARGET="_top"
><TT
CLASS="FILENAME"
>c01.htm</TT
></A
>. If not, and the preceding test succeeded, something
has gone wrong--<A
HREF="http://nwalsh.com/~ndw/contact.html"
TARGET="_top"
>contact
the maintainer</A
>.<A
NAME="AEN148487"
></A
>></P
></LI
></OL
></DIV
></DIV
></DIV
><H3
CLASS="FOOTNOTES"
>Notes</H3
><TABLE
BORDER="0"
CLASS="FOOTNOTES"
WIDTH="100%"
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="5%"
><A
NAME="FTN.AEN148258"
HREF="appa.html#AEN148258"
>[1]</A
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="95%"
><P
>The names of the entity files in this distribution do not
exactly match the names of the files used in the catalog file
distributed with DocBook (<TT
CLASS="FILENAME"
>docbook.cat</TT
>). Make sure your
catalog file points to the right files.</P
></TD
></TR
></TABLE
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="part3.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="docbook.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="appb.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Appendixes</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="part3.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>DocBook and <SPAN
CLASS="ACRONYM"
>XML</SPAN
></TD
></TR
></TABLE
></DIV
><P
><A
HREF="ln41.html"
>Copyright</A
> © 1999 O'Reilly & Associates, Inc. All rights reserved.</P
></BODY
></HTML
>
|