+ url="http://www.ctan.org">
CTAN site.
+
+
+
JadeTeX does not at the time of
+ writing come with much of an installation guide, but there is a
+ makefile which shows what is needed. It
+ also includes a directory cooked, wherein
+ you'll find some of the macro packages it needs, but not all, and
+ not complete -- at least last we looked.
+
+
+ Before building the jadetex.fmt format file,
+ you'll probably want to edit the jadetex.ltx
+ file, to change the configuration of
+
Babel to suit your locality. The line
+ to change looks something like
+\RequirePackage[german,french,english]{babel}[1997/01/23]
+
+ and you should obviously list only the languages you actually need,
+ and have configured
Babel for.
- When using
emacs/psgml, a comfortable way of working with
- these separate files of book parts is to insert a proper DOCTYPE
- declaration while you're editing them. If you are working on this source, for instance,
- it's an appendix chapter, so you would specify the document as an "appendix" instance of
- a DocBook document by making the first line look like this:
-
- !doctype appendix PUBLIC "-//Davenport//DTD DocBook V3.0//EN"
-
-
- This means that anything and everything that reads
SGML will get it
- right, and I can verify the document with "nsgmls -s docguide.sgml".
+ It is quite likely that when you use
+
PostgreSQL documentation sources, that
+
TeX will stop during the second run,
+ and tell you that its capacity has been exceeded. This is, as
+ far as we can tell, because of the way
+
JadeTeX generates cross referencing
+ information.
TeX can, of course, be
+ compiled with larger data structure sizes. The details of this
+ will vary according to your installation.
+
-
Building Documentation
+
Building <span class="marked">The </span>Documentation
- GNU
make is used to build documentation
- from the DocBook sources. There are a few environment definitions
- which may need to be set or modified for your installation.
- The Makefile looks for
- doc/../src/Makefile and (implicitly) for
- doc/../src/Makefile.custom to obtain
- environment information. On my system, the
- src/Makefile.custom looks like
-
-# Makefile.custom
-# Thomas Lockhart 1998-03-01
-
-POSTGRESDIR= /opt/postgres/current
-CFLAGS+= -m486
-YFLAGS+= -v
-
-# documentation
-
-HSTYLE= /home/lockhart/SGML/db143.d/docbook/html
-PSTYLE= /home/lockhart/SGML/db143.d/docbook/print
-
-
- where HSTYLE and PSTYLE determine the path to
- and hardcopy (print) stylesheets, respectively. These stylesheet
- file names are for Norm Walsh's
-
Modular Style Sheets; if other
- stylesheets are used then one can define HDSL and PDSL as the full path
- and file name for the stylesheet, as is done above for HSTYLE and PSTYLE.
- On many systems, these stylesheets will be found in packages installed in
- /usr/lib/sgml/,
- /usr/share/lib/sgml/,
- or
- /usr/local/lib/sgml/.
+ Before you can build the documentation you need to run the
+ configure script as you would when building
+ the programs themselves. Check the output near the end of the run,
+ it should look something like this:
+
+
+checking for onsgmls... onsgmls
+checking for openjade... openjade
+checking for DocBook V3.1... yes
+checking for DocBook stylesheets... /usr/lib/sgml/stylesheets/nwalsh-modular
+checking for sgmlspl... sgmlspl
+
+
+ If neither onsgmls nor
+ nsgmls were found then you will not see the
+ remaining 4 lines. nsgmls is part of the Jade
+ package. If DocBook V3.1
was not found then you did
+ not install the DocBook DTD kit in a place where jade can find it,
+ or you have not set up the catalog files correctly. See the
+ installation hints above. The DocBook stylesheets are looked for
+ in a number of relatively standard places, but if you have them
+ some other place then you should set the environment variable
+ DOCBOOKSTYLE to the location and rerun
+ configure afterwards.
-
HTML documentation packages can be generated
- from the
SGML source by typing
-% cd doc/src
-% make tutorial.tar.gz
-% make user.tar.gz
-% make admin.tar.gz
-% make programmer.tar.gz
-% make postgres.tar.gz
-% make install
-
-
+ Once you have everything set up, change to the directory
+ doc/src/sgml and run one of the following
+ commands: (Remember to use GNU make.)
+
+
+ To build the
HTML version of the
+ Administrator's Guide:
+
+
doc/src/sgml$ gmake admin.html+
+
+
- These packages can be installed from the main documentation directory
- by typing
-% cd doc
-% make install
-
-
+
+ For the RTF version of the same:
+
+
doc/src/sgml$ gmake admin.rtf+
+
+
+
+
+ To get a
DVI version via
+
+
doc/src/sgml$ gmake admin.dvi+
+
+
+
+
+ And Postscript from the
DVI:
+
+
doc/src/sgml$ gmake admin.ps+
+
+
+ The official Postscript format documentation is generated
+ differently. See below.
+
+
+
+
+
+ The other books can be built with analogous commands by replacing
+ admin with one of developer,
+ programmer, tutorial, or
+ user. Using postgres builds
+ an integrated version of all 5 books, which is practical since the
+ browser interface makes it easy to move around all of the
+ documentation by just clicking.
+
+
+
+
HTML
+
+ When building
HTML documentation in
+ doc/src/sgml, some of the resulting files
+ will possibly (or quite certainly) have conflicting names between
+ books. Therefore the files are not in that directory in the
+ regular distribution. Instead, the files belonging to each book
+ are stored in a tar archive that is unpacked at installation time.
+ To create a set of
HTML documentation packages
+ use the commands
+cd doc/src
+gmake tutorial.tar.gz
+gmake user.tar.gz
+gmake admin.tar.gz
+gmake programmer.tar.gz
+gmake postgres.tar.gz
+gmake install
+
+ In the distribution, these archives live in the
+ doc directory and are installed by default
+ with gmake install.
+
+
Manpages
We use the
docbook2man utility to
REFENTRY pages to *roff output suitable for man
- pages. At the time of writing, the utility required patching to
- successfully run on the
Postgres markup,
- and we added a small amount of new functionality to allow setting
- the man page section in the output file name.
-
-
-
docbook2man is written in perl, and
- requires the CPAN package SGMLSpm to run. Also,
- it requires
nsgmls to be available,
- which is included in the
jade- distribution. After installing these packages, then simply run
-
-$ cd doc/src
-$ make man
-
-
+ pages. The man pages are also distributed as a tar archive,
+ similar to the
HTML version. To create the man page package, use the commands
+cd doc/src
+gmake man
+
which will result in a tar file being generated in the
doc/src directory.
-
docbook2man Installation Procedure
-
-
- Install the
docbook2man package,
- available at
-
http://shell.ipoline.com/~elmert/comp/docbook2X/-
-
-
-
- Install the SGMLSpm perl module, available from CPAN mirrors.
-
-
-
-
- Install
nsgmls if not already
- available from your
jade installation.
-
-
-
+ The man build leaves a lot of confusing output, and special care
+ must be taken to produce quality results. There is still room for
+ improvement in this area.
+
-
Hardcopy Generation<span class="marked"> for v7.0</span>
+
Hardcopy Generation
The hardcopy Postscript documentation is generated by converting the
-
-
Toolsets
-
- We have documented experience with three installation methods for the
- various tools that are needed to process the documentation. One is
- installation from
RPMs on
-
Linux, the second is installation from
- FreeBSD port, and the last is a general installation
- from original distributions of the individual tools. These will be
- described below.
-
-
- There may be some other packaged distributions for
- these tools. Please report package status to the docs mailing list and
- we will include that information here.
-
-
-
-
<productname>Linux</productname> <acronym>RPM</acronym> Installation
-
- The simplest installation for a RedHat-compatible Linux system
- uses the
RPM set developed by Mark Galassi at
- Cygnus. It should also be possible to install from sources, as
- described in a subsequent section.
-
-
-
Installing RPMs
-
-
- and related packages.
-
-
-
-
- Install Norm Walsh's latest style sheets. Depending on the age
- of the RPMs, the latest style sheets may be substantially
- improved from those contained in the
RPMs.
-
-
-
-
- Update your src/Makefile.custom to include
- HSTYLE and PSTYLE definitions pointing to the style sheets.
-
-
-
-
-
-
-
FreeBSD Installation
-
- There is a full set of ports of the
- documentation tools available on FreeBSD. In fact, postgresql.org,
- on which documentation is automatically updated every evening, is
- a FreeBSD machine.
-
-
-
Installing FreeBSD Ports
-
-
- To build the documentation on FreeBSD a number of ports will need to
- be installed.
-% cd /usr/ports/devel/gmake && make install
-% cd /usr/ports/textproc/docproj && make install
-% cd /usr/ports/textproc/docbook && make install
-% cd /usr/ports/textproc/dsssl-docbook-modular && make install
-
-
-
-
-
- Set environment variables
- toolset.
-
-
- This was not required for the FreeBSD machine at
- postgresql.org, so you may not have to do this.
-
-
-
-export SMGL_ROOT=/usr/local/share/sgml
-SGML_CATALOG_FILES=/usr/local/share/sgml/jade/catalog
-SGML_CATALOG_FILES=/usr/local/share/sgml/html/catalog:$SGML_CATALOG_FILES
-SGML_CATALOG_FILES=/usr/local/share/sgml/iso8879/catalog:$SGML_CATALOG_FILES
-SGML_CATALOG_FILES=/usr/local/share/sgml/transpec/catalog:$SGML_CATALOG_FILES
-SGML_CATALOG_FILES=/usr/local/share/sgml/docbook/catalog:$SGML_CATALOG_FILES
-export SGML_CATALOG_FILES
-
-
- (this is sh/bash syntax; adjust accordingly for csh/tcsh).
-
-
-
-
- Make needs some special arguments, or these need to be added to your
- Makefile.custom:
-HSTYLE=/usr/local/share/sgml/docbook/dsssl/modular/html/
-PSTYLE=/usr/local/share/sgml/docbook/dsssl/modular/print/
-
-
- Of course you'll need to use gmake rather than just plain 'make' to build.
-
-
-
-
-
-
-
Debian Installation
-
- There is a full set of packages of the
- documentation tools available for Debian.
-
-
-
Installing Debian Packages
-
-
- Install jade, docbook, and unzip:
-
-apt-get install jade
-apt-get install docbook
-apt-get install docbook-stylesheets
-
-
-
-
-
- Install the latest style sheets.
-
-
-
-
- Verify that
unzip is installed, or
- install the package:
-
-apt-get install unzip
-
-
-
-
-
- Grab the latest stylesheet zipballs from
-
http://www.nwalsh.com/docbook/dsssl- and unzip it somewhere (possibly /usr/share).
-
-
-
-
-
-
- Edit src/Makefile.custom to add appropriate HSTYLE and PSTYLE
- definitions:
-
-HSTYLE= /usr/share/docbook/html
-PSTYLE= /usr/share/docbook/print
-
-
-
-
-
-
-
-
Manual Installation of Tools
-
- This is a brief run-through of the process of obtaining and
- installing the software you'll need to edit DocBook source with Emacs
- and process it with Norman Walsh's DSSSL style sheets to create
-
-
- The easiest way to obtain the SGML and DocBook tools may be to get
-
sgmltools requires the GNU version of
-
m4. To confirm that you have the
- correct version of m4 available, try
-
-gnum4 --version
-
-
+
+
Documentation Authoring
- If you install GNU m4, install it with the name gnum4 and
-
sgmltools will find it.
- After the install, you will
- and Norm Walsh's
DocBook- style sheets. The instructions below are for installing these tools
- separately.
+ not suffer from an oversupply of open-source authoring tools. The
+ most common toolset is the
+ editor with appropriate editing mode. On some systems
+ (e.g., RedHat Linux) these tools are provided in a typical full
+ installation.
- 3>
-
<span class="marked">Prerequisites</span>
+ 2>
+
<span class="marked">Emacs/PSGML</span>
- What you need:
-
-
-
- A working installation of GCC 2.7.2
-
-
-
- A working installation of Emacs 19.19 or later
-
-
-
- An unzip program for Unix to unpack things
-
-
-
+
PSGML is the most common and most
+ powerful mode for editing
SGML documents.
+ When properly configured, it will allow you to use
+
Emacs to insert tags and check markup
+ consistancy. You could use it for
HTML as
+ well. Check the
+ url="http://www.lysator.liu.se/projects/about_psgml.html">PSGML
+ web site for downloads, installation instructions, and
+ detailed documentation.
- What you must fetch:
-
-
-
- (version 1.1 in file jade1_1.zip was
- current at the time of writing)
-
-
-
-
-
-
-
Norman Walsh's Modular Stylesheets- (version 1.19 was originally used to produce these documents)
-
-
-
-
Lennart Staflin's PSGML- (version 1.0.1 in psgml-1.0.1.tar.gz was
- available at the time of writing)
-
-
-
+ There is one important thing to note with
+
PSGML: its author assumed that your
+ main
SGML DTD directory
+ would be /usr/local/lib/sgml. If, as in the
+ examples in this chapter, you use
+ /usr/local/share/sgml, you have to
+ compensate for this, either by setting
+ SGML_CATALOG_FILES environment variable, or you
+ can customize your
PSGML installation
+ (its manual tells you how).
- Important URLs:
-
-
-
-
-
-
-
-
-
-
The Modular Stylesheets web page-
-
-
-
-
-
- Pepper's Whirlwind Guide
-
-
-
- Robin Cover's database of
SGML- software
-
-
-
-
-
-
-
-
Installing Jade
-
-
Installing Jade
-
-
- Read the installation instructions at the above listed
- URL.
-
-
-
-
- Unzip the distribution kit in a suitable place. The command to do
- this will be something like
-unzip -aU jade1_1.zip
-
-
-
-
-
-
Jade is not built using
-
GNU autoconf, so you'll need to edit a
- Makefile yourself. Since James Clark has been
- good enough to prepare his kit for it, it is a good idea to make a
- build directory (named for your machine architecture, perhaps) under
- the main directory of the
Jade- distribution, copy the file Makefile from the
- main directory into it, edit it there, and then run
- make there.
-
-
- However, the Makefile does need to be
- edited. There is a file called Makefile.jade in
- the main directory, which is intended to be used with make -f
- Makefile.jade when building
Jade- (as opposed to just
SP,
- that
Jade is built upon). We suggest that
- you don't do that, though, since there is more that you need to change
- than what is in Makefile.jade, so you'd have to
- edit one of them anyway.
-
-
- Go through the Makefile, reading James'
- instructions and editing as needed. There are various variables that
- need to be set. Here is a collected summary of the most important
- ones, with typical values:
-prefix = /usr/local
-XDEFINES = -DSGML_CATALOG_FILES_DEFAULT=\"/usr/local/share/sgml/catalog\"
-XLIBS = -lm
-RANLIB = ranlib
-srcdir = ..
-XLIBDIRS = grove spgrove style
-XPROGDIRS = jade
-
- Note the specification of where to find the default catalog of
-
SGML support files -- you may want to change that
- to something more suitable for your own installation. If your system
- doesn't need the above settings for the math library and the
- ranlib command, leave them as they are in the
- Makefile.
-
-
-
-
- Type make to build Jade and the various
-
-
-
- Once the software is built, make install will
- do the obvious.
-
-
-
-
-
-
-
Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit
-
-
Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit
-
-
- You'll want to place the files that make up the
- directory you built
Jade to expect them in,
- which, if you followed our suggestion above, is
- /usr/local/share/sgml/. In addition to the
- actual
DocBook files, you'll need to have a
- catalog file in place, for the mapping of
- document type specifications and external entity references to actual
- files in that directory. You'll also want the
ISO- character set mappings, and probably one or more versions of
-
-
- One way to install the various
DTD and
- support files and set up the catalog file, is to
- collect them all into the above mentioned directory, use a single file
- named CATALOG to describe them all, and then
- create the file catalog as a catalog pointer to
- the former, by giving it the single line of content:
-CATALOG /usr/local/share/sgml/CATALOG
-
-
-
-
-
- The CATALOG file should then contain three types
- of lines. The first is the (optional)
SGML- declaration, thus:
-SGMLDECL docbook.dcl
-
- Next, the various references to
DTD and entity
- files must be resolved. For the
DocBook- files, these lines look like this:
-PUBLIC "-//Davenport//DTD DocBook V3.0//EN" docbook.dtd
-PUBLIC "-//USA-DOD//DTD Table Model 951010//EN" cals-tbl.dtd
-PUBLIC "-//Davenport//ELEMENTS DocBook Information Pool V3.0//EN" dbpool.mod
-PUBLIC "-//Davenport//ELEMENTS DocBook Document Hierarchy V3.0//EN" dbhier.mod
-PUBLIC "-//Davenport//ENTITIES DocBook Additional General Entities V3.0//EN" dbgenent.mod
-
-
-
-
-
- Of course, a file containing these comes with the
-
DocBook kit. Note that the last item on
- each of these lines is a file name, given here without a path. You
- can put the files in subdirectories of your main
-
SGML directory if you like, of course, and modify
- the reference in the CATALOG file.
-
DocBook also references the
-
ISO character set entities, so you need to fetch
- and install these (they are available from several sources, and are
- easily found by way of the URLs listed above), along with catalog
- entries for all of them, such as:
-PUBLIC "ISO 8879-1986//ENTITIES Added Latin 1//EN" ISO/ISOlat1
-
- Note how the file name here contains a directory name, showing that
- we've placed the
ISO entity files in a subdirectory
- named ISO. Again, proper catalog entries should
- accompany the entity kit you fetch.
-
-
-
-
-
-
-
-
Installing Norman Walsh's <acronym>DSSSL</acronym> Style Sheets
-
-
Installing Norman Walsh's <acronym>DSSSL</acronym> Style Sheets
-
-
- Read the installation instructions at the above listed
- URL.
-
-
-
-
- To install Norman's style sheets, simply unzip the distribution
- kit in a suitable place. A good place to dot this would be
- /usr/local/share, which places the kit in a
- directory tree under /usr/local/share/docbook.
- The command will be something like
-unzip -aU db119.zip
-
-
-
-
-
- One way to test the installation is to build the
-
HTML and
RTF forms of the
-
PostgreSQL User's Guide.
-
-
-
-
-
- To build the
HTML files,
- directory, doc/src/sgml, and say
-jade -t sgml -d /usr/local/share/docbook/html/docbook.dsl -D ../graphics postgres.sgml
-
-
-
- book1.htm is the top level node of the output..
-
-
-
-
- To generate the
RTF output, ready for importing
- into your favorite word processing system and printing, type:
-jade -t rtf -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml
-
-
-
-
-
-
-
-
-
-
-
-
Installing <productname>PSGML</productname>
-
-
Installing <productname>PSGML</productname>
-
-
- Read the installation instructions at the above listed
- URL.
-
-
-
-
- Unpack the distribution file, run configure, make and make
- install to put the byte-compiled files and info library in place.
-
-
-
-
- Then add the following lines to your
- /usr/local/share/emacs/site-lisp/site-start.el
- file to make
Emacs properly load
-(setq load-path
- (cons "/usr/local/share/emacs/site-lisp/psgml" load-path))
-(autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t)
-
-
-
-
-
- If you want to use
PSGML when editing
-
HTML too, also add this:
-(setq auto-mode-alist
- (cons '("\\.s?html?\\'" . sgml-mode) auto-mode-alist))
-
-
-
-
-
- There is one important thing to note with
-
PSGML: its author assumed that your main
-
SGML DTD directory would be
- /usr/local/lib/sgml. If, as in the examples in
- this chapter, you use /usr/local/share/sgml, you
- have to compensate for this.
-
-
-
-
- You can set the
- SGML_CATALOG_FILES environment variable.
-
-
-
-
- You can
- customize your
PSGML installation (its
- manual tells you how).
-
-
-
-
- You can even edit the source file
- psgml.el before compiling and installing
-
PSGML, changing the hard-coded paths to
- match your own default.
-
-
+ Put the following in your ~/.emacs
+ environment file (adjusting the path names to be appropriate for
+ your system):
- >
-
+; ********** for SGML mode (psgml)
-
-
+(setq sgml-omittag t)
+(setq sgml-shorttag t)
+(setq sgml-minimize-attributes nil)
+(setq sgml-always-quote-attributes t)
+(setq sgml-indent-step 1)
+(setq sgml-indent-data t)
+(setq sgml-parent-document nil)
+(setq sgml-default-dtd-file "./reference.ced")
+(setq sgml-exposed-tags nil)
+(setq sgml-catalog-files '("/usr/local/share/sgml/catalog"))
+(setq sgml-ecat-files nil)
-
- Installing <productname>JadeTeX</productname></title</span>></div>
<div class="diff add">+(autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t )</div>
<div class="diff add">+<span class="marked"></programlisting</span>></div>
<div class="diff ctx"> </div>
<div class="diff rem">- <para></div>
<div class="diff rem">- If you want to, you can also install</div>
<div class="diff rem">- <productname>JadeTeX</productname> to use</div>
<div class="diff rem">- <productname>TeX</productname> as a formatting backend for</div>
<div class="diff rem">- <productname>Jade</productname>. Note that this is still quite</div>
<div class="diff rem">- unpolished software, and will generate printed output that is inferior</div>
<div class="diff rem">- to what you get from the <acronym>RTF</acronym> backend. Still, it</div>
<div class="diff rem">- works all right, especially for simpler documents that don't use</div>
<div class="diff rem">- tables, and as both <productname>JadeTeX</productname> and the style</div>
<div class="diff rem">- sheets are under continuous improvement, it will certainly get better</div>
<div class="diff rem">- over time.</div>
<div class="diff add">+ and in the same file add an entry for <acronym>SGML</acronym></div>
<div class="diff add">+ into the (existing) definition for</div>
<div class="diff add">+ <varname>auto-mode-alist</varname>:</div>
<div class="diff add">+<programlisting></div>
<div class="diff add">+(setq</div>
<div class="diff add">+ auto-mode-alist</div>
<div class="diff add">+ '(("\\.sgml$" . sgml-mode)</div>
<div class="diff add">+ ))</div>
<div class="diff add">+</programlisting></div>
<div class="diff ctx"> </para></div>
<div class="diff ctx"> </div>
<div class="diff ctx"> <para></div>
<div class="diff rem">- To install and use <productname>JadeTeX</productname>, you will</div>
<div class="diff rem">- need a working installation of <productname>TeX</productname> and</div>
<div class="diff rem">- <productname>LaTeX2e</productname>, including the supported</div>
<div class="diff rem">- <productname>tools</productname> and</div>
<div class="diff rem">- <productname>graphics</productname> packages,</div>
<div class="diff rem">- <productname>Babel</productname>, <productname><acronym>AMS</acronym></div>
<div class="diff rem">- fonts</productname> and <productname>AMS-LaTeX</productname>, the</div>
<div class="diff rem">- <productname><acronym>PSNFSS</acronym></productname> extension and</div>
<div class="diff rem">- companion kit of "the 35 fonts", the <productname>dvips</productname></div>
<div class="diff rem">- program for generating <productname>PostScript</productname>, the</div>
<div class="diff rem">- macro packages <productname>fancyhdr</productname>,</div>
<div class="diff rem">- <productname>hyperref</productname>,</div>
<div class="diff rem">- <productname>minitoc</productname>, <productname>url</productname> and</div>
<div class="diff rem">- <productname>ot2enc</productname>, and of course</div>
<div class="diff rem">- <productname>JadeTeX</productname> itself. All of these can be found</div>
<div class="diff rem">- on your friendly neighborhood <acronym>CTAN</acronym> site.</div>
<div class="diff add">+ Currently, each <acronym>SGML</acronym> source file has the</div>
<div class="diff add">+ following block at the end of the file:</div>
<div class="diff add">+</div>
<div class="diff add">+<programlisting></div>
<div class="diff add">+<!-- Keep this comment at the end of the file</div>
<div class="diff add">+Local variables:</div>
<div class="diff add">+mode: sgml</div>
<div class="diff add">+sgml-omittag:t</div>
<div class="diff add">+sgml-shorttag:t</div>
<div class="diff add">+sgml-minimize-attributes:nil</div>
<div class="diff add">+sgml-always-quote-attributes:t</div>
<div class="diff add">+sgml-indent-step:1</div>
<div class="diff add">+sgml-indent-data:t</div>
<div class="diff add">+sgml-parent-document:nil</div>
<div class="diff add">+sgml-default-dtd-file:"./reference.ced"</div>
<div class="diff add">+sgml-exposed-tags:nil</div>
<div class="diff add">+sgml-local-catalogs:("/usr/lib/sgml/catalog")</div>
<div class="diff add">+sgml-local-ecat-files:nil</div>
<div class="diff add">+End:</div>
<div class="diff add">+--></div>
<div class="diff add">+</programlisting></div>
<div class="diff add">+ This will set up a number of editing mode parameters even if you</div>
<div class="diff add">+ do not set up your <filename>~/.emacs</filename> file, but it is</div>
<div class="diff add">+ a bit unfortunate, since if you followed the installation</div>
<div class="diff add">+ instructions above, then the catalog path will not match your</div>
<div class="diff add">+ location. Hence you might need to turn off local variables:</div>
<div class="diff add">+<programlisting></div>
<div class="diff add">+(setq inhibit-local-variables t)</div>
<div class="diff add">+</programlisting></div>
<div class="diff ctx"> </para></div>
<div class="diff ctx"> </div>
<div class="diff ctx"> <para></div>
<div class="diff rem">- <productname>JadeTeX</productname> does not at the time of</div>
<div class="diff rem">- writing come with much of an installation guide, but there is a</div>
<div class="diff rem">- <filename>makefile</filename> which shows what is needed. It also</div>
<div class="diff rem">- includes a directory <filename>cooked</filename>, wherein you'll find</div>
<div class="diff rem">- some of the macro packages it needs, but not all, and not complete --</div>
<div class="diff rem">- at least last we looked.</div>
<div class="diff add">+ The <productname>PostgreSQL</productname> distribution includes a</div>
<div class="diff add">+ parsed DTD definitions file <filename>reference.ced</filename>.</div>
<div class="diff add">+ You may find that when using PSGML, a comfortable way of working</div>
<div class="diff add">+ with these separate files of book parts is to insert a proper</div>
<div class="diff add">+ <literal>DOCTYPE</literal> declaration while you're editing them.</div>
<div class="diff add">+ If you are working on this source, for instance, it is an</div>
<div class="diff add">+ appendix chapter, so you would specify the document as an</div>
<div class="diff add">+ <quote>appendix</quote> instance of a DocBook document by making</div>
<div class="diff add">+ the first line look like this:</div>
<div class="diff add">+</div>
<div class="diff add">+<programlisting></div>
<div class="diff add">+<!doctype appendix PUBLIC "-//OASIS//DTD DocBook V3.1//EN"></div>
<div class="diff add">+</programlisting></div>
<div class="diff add">+</div>
<div class="diff add">+ This means that anything and everything that reads</div>
<div class="diff add">+ <acronym>SGML</acronym> will get it right, and I can verify the</div>
<div class="diff add">+ document with <command>nsgmls -s docguide.sgml</command>. (But</div>
<div class="diff add">+ you need to take out that line before building the entire</div>
<div class="diff add">+ documentation set.)</div>
<div class="diff ctx"> </para></div>
<div class="diff add">+ </sect2></div>
<div class="diff add">+</div>
<div class="diff add">+ <sect2></div>
<div class="diff add">+ <title>Other Emacs modes
- Before building the jadetex.fmt format
- file, you'll probably want to edit the
- jadetex.ltx file, to change the configuration of
-
Babel to suit your locality. The line to
- change looks something like
-\RequirePackage[german,french,english]{babel}[1997/01/23]
-
- and you should obviously list only the languages you actually need,
- and have configured
Babel for.
+
GNU Emacs ships with a different SGML
+ mode, which is not quite as powerful as
+
PSGML, but it's less confusing and
+ lighter weight. Also, it offers syntax highlighting (font lock),
+ which can be very helpful.
- With
JadeTeX working, you should be
- able to generate and format
TeX output for
- the
PostgreSQL manuals by giving the
- commands (as above, in the doc/src/sgml
- directory)
-jade -t tex -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml
-jadetex postgres.tex
-jadetex postgres.tex
-dvips postgres.dvi
-
-
- Of course, when you do this,
TeX will stop
- during the second run, and tell you that its capacity has been
- exceeded. This is, as far as we can tell, because of the way
-
JadeTeX generates cross referencing
- information.
TeX can, of course, be
- compiled with larger data structure sizes. The details of this will
- vary according to your installation.
+ Norm Walsh offers a major
+ url="http://nwalsh.com/emacs/docbookide/index.html">mode
+ specifically for DocBook which also has font-lock and a
+ number of features to reduce typing.
+
-
-
-
-
-
Alternate Toolsets
-
-
-
-
-
-
projects / postgresql.git / commitdiff