📄 docguide.sgml
字号:
<step performance="required"> <para> Generate the <acronym>RTF</acronym> input by typing (for example): <programlisting>% cd doc/src/sgml% make tutorial.rtf </programlisting> </para> </step> <step performance="required"> <para> Open a new document in <productname>Applix Words</productname> and then import the <acronym>RTF</acronym> file. </para> </step> <step performance="required"> <para> Print out the existing Table of Contents, to mark up in the following few steps. </para> </step> <step performance="required"> <para> Insert figures into the document. Center each figure on the page using the centering margins button.</para> <para> Not all documents have figures. You can grep the <acronym>SGML</acronym> source files for the string <quote>graphic</quote> to identify those parts of the documentation which may have figures. A few figures are replicated in various parts of the documentation. </para> </step> <step performance="required"> <para> Work through the document, adjusting page breaks and table column widths. </para> </step> <step performance="required"> <para> If a bibliography is present, Applix Words seems to mark all remaining text after the first title as having an underlined attribute. Select all remaining text, turn off underlining using the underlining button, then explicitly underline each document and book title. </para> </step> <step performance="required"> <para> Work through the document, marking up the ToC hardcopy with the actual page number of each ToC entry. </para> </step> <step performance="required"> <para> Replace the right-justified incorrect page numbers in the ToC with correct values. This only takes a few minutes per document. </para> </step> <step performance="required"> <para> Save the document as native Applix Words format to allow easier last minute editing later. </para> </step> <step performance="required"> <para> <quote>Print</quote> the document to a file in Postscript format. </para> </step> <step performance="required"> <para> Compress the Postscript file using <application>gzip</application>. Place the compressed file into the <filename>doc</filename> directory. </para> </step> </procedure> </sect2></sect1><sect1><title>Toolsets</title><para>We have documented experience with two installation methods for thevarious tools that are needed to process the documentation. One isinstallation from <acronym>RPM</acronym>s on<productname>Linux</productname>, the other is a general installationfrom original distributions of the individual tools. Both will bedescribed below.</para><para>We understand that there are some other packaged distributions forthese tools. <productname>FreeBSD</productname> seems to have themavailable. Please report package status to the docs mailing list andwe will include that information here.</para><sect2><title><acronym>RPM</acronym> installation on<productname>Linux</productname></title><para>Install <ulink url="ftp://ftp.cygnus.com/pub/home/rosalia/"><acronym>RPM</acronym>s</ulink> for <productname>Jade</productname>and related packages.</para></sect2><sect2><title>Manual installation of tools</title><para>This is a brief run-through of the process of obtaining andinstalling the software you'll need to edit DocBook source with Emacsand process it with Norman Walsh's DSSSL style sheets to create <acronym>HTML</acronym>and <acronym>RTF</acronym>.</para><para>These instructions do not cover new <application>jade</application>/DocBooksupport in the <ulink url="http://www.sgmltools.org/"><productname>sgml-tools</productname></ulink>package. The authors have not tried this package since it adopted DocBook, but it is almost certainly a good candidate for use.</para><sect3><title>Prerequisites</title><para>What you need:<itemizedlist><listitem><para>A working installation of GCC 2.7.2</para></listitem><listitem><para>A working installation of Emacs 19.19 or later</para></listitem><listitem><para>An unzip program for UNIX to unpack things</para></listitem></itemizedlist></para><para>What you must fetch:<itemizedlist><listitem><para><ulink url="ftp://ftp.jclark.com/pub/jade/">James Clark's <productname>Jade</productname></ulink>(version 1.1 in file <filename>jade1_1.zip</filename> was current at the time of writing)</para></listitem><listitem><para><ulink url="http://www.ora.com/davenport/docbook/current/docbk30.zip"><productname>DocBook</productname> version 3.0</ulink></para></listitem><listitem><para><ulink url="http://nwalsh.com/docbook/dsssl/">Norman Walsh's <productname>Modular Stylesheets</productname></ulink>(version 1.19 was used to produce these documents)</para></listitem><listitem><para><ulink url="ftp://ftp.lysator.liu.se/pub/sgml/">Lennart Staflin's <productname>PSGML</productname></ulink>(version 1.0.1 in <filename>psgml-1.0.1.tar.gz</filename> was available at the time of writing)</para></listitem></itemizedlist></para><para>Important URLs:<itemizedlist><listitem><para><ulink url="http://www.jclark.com/jade/">The <productname>Jade</productname> web page</ulink></para></listitem><listitem><para><ulink url="http://www.ora.com/davenport/">The <productname>DocBook</productname> web page</ulink></para></listitem><listitem><para><ulink url="http://nwalsh.com/docbook/dsssl/">The <productname>Modular Stylesheets</productname> web page</ulink></para></listitem><listitem><para><ulink url="http://www.lysator.liu.se/projects/about_psgml.html">The <productname>PSGML</productname> web page</ulink></para></listitem><listitem><para><ulink url="http://www.infotek.no/sgmltool/guide.htm">Steve Pepper's Whirlwind Guide</ulink></para></listitem><listitem><para><ulink url="http://www.sil.org/sgml/publicSW.html">Robin Cover's database of <acronym>SGML</acronym> software</ulink></para></listitem></itemizedlist></para></sect3><sect3><title>Installing Jade</title><procedure><title>Installing Jade</title><step performance="required"><para>Read the installation instructions at the above listedURL.</para></step><step performance="required"><para>Unzip the distribution kit in a suitable place. The command to dothis will be something like<programlisting>unzip -aU jade1_1.zip</programlisting></para></step><step performance="required"><para><productname>Jade</productname> is not built using<productname>GNU Autoconf</productname>, so you'll need to edit a<filename>Makefile</filename> yourself. Since James Clark has beengood enough to prepare his kit for it, it is a good idea to make abuild directory (named for your machine architecture, perhaps) underthe main directory of the <productname>Jade</productname>distribution, copy the file <filename>Makefile</filename> from themain directory into it, edit it there, and then run<command>make</command> there.</para><para>However, the <filename>Makefile</filename> does need to beedited. There is a file called <filename>Makefile.jade</filename> inthe main directory, which is intended to be used with <command>make -fMakefile.jade</command> when building <productname>Jade</productname>(as opposed to just <productname>SP</productname>, the <acronym>SGML</acronym> parser kitthat <productname>Jade</productname> is built upon). We suggest thatyou don't do that, though, since there is more that you need to changethan what is in <filename>Makefile.jade</filename>, so you'd have toedit one of them anyway.</para><para>Go through the <filename>Makefile</filename>, reading James'instructions and editing as needed. There are various variables thatneed to be set. Here is a collected summary of the most importantones, with typical values:<programlisting>prefix = /usr/localXDEFINES = -DSGML_CATALOG_FILES_DEFAULT=\"/usr/local/share/sgml/catalog\"XLIBS = -lmRANLIB = ranlibsrcdir = ..XLIBDIRS = grove spgrove styleXPROGDIRS = jade</programlisting>Note the specification of where to find the default catalog of<acronym>SGML</acronym> support files -- you may want to change thatto something more suitable for your own installation. If your systemdoesn't need the above settings for the math library and the<command>ranlib</command> command, leave them as they are in the<filename>Makefile</filename>.</para></step><step performance="required"><para>Type <command>make</command> to build Jade and the various<productname>SP</productname> tools.</para></step><step performance="required"><para>Once the software is built, <command>make install</command> willdo the obvious.</para></step></procedure></sect3><sect3><title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title><procedure><title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title><step performance="required"><para>You'll want to place the files that make up the<productname>DocBook</productname> <acronym>DTD</acronym> kit in thedirectory you built <productname>Jade</productname> to expect them in,which, if you followed our suggestion above, is<filename>/usr/local/share/sgml/</filename>. In addition to theactual <productname>DocBook</productname> files, you'll need to have a<filename>catalog</filename> file in place, for the mapping ofdocument type specifications and external entity references to actualfiles in that directory. You'll also want the <a
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -