cvs: /phpdoc howto.sgml

cslawi Wed Oct 20 19:02:43 1999 EDT Modified files: /phpdoc howto.sgml Log: Normalized. Index: phpdoc/howto.sgml diff -u phpdoc/howto.sgml:1.1 phpdoc/howto.sgml:1.2 --- phpdoc/howto.sgml:1.1 Sun Jun 6 14:50:25 1999 +++ phpdoc/howto.sgml Wed Oct 20 19:02:43 1999 @@ -37,19 +37,19 @@ Although it is possible to use a simple text editor such as vi or notepad to write the SGML, it is recommended to use an SGML editor that helps you along and makes sure your document is proper SGML - conforming to the used document type definition (DTD). + conforming to the used document type definition (DTD).</simpara> <para> A very good (and free) SGML editor is Emacs+PSGML. Emacs is ported to Windows 95/NT. A few pointers: <itemizedlist> <listitem><simpara> - <ulink url="&url.emacs-src;">GNU Emacs Source</ulink> + <ulink url="&url.emacs-src;">GNU Emacs Source</ulink></simpara></listitem> <listitem><simpara> - <ulink url="&url.emacs-nt">GNU Emacs for Windows NT/95</ulink> + <ulink url="&url.emacs-nt">GNU Emacs for Windows NT/95</ulink></simpara></listitem> <listitem><simpara> - <ulink url="&url.psgml;">PSGML 1.0.1 (SGML mode for Emacs)</ulink> - </itemizedlist> + <ulink url="&url.psgml;">PSGML 1.0.1 (SGML mode for Emacs)</ulink></simpara></listitem> + </itemizedlist></para> <para> You have to add this to your <filename>~/.emacs</filename> file to @@ -62,40 +62,37 @@ where <replaceable>PREFIX</replaceable> is the base installation directory where you installed PSGML (typically - <filename class=directory>/usr/local</filename>). + <filename class="directory">/usr/local</filename>).</para> <para> For Windows users without <abbrev>NTFS</abbrev>, the <filename>.emacs</filename> file is called <filename>_emacs</filename>, and resides in the directory given - by the <envar>HOME</envar> environment variable or <filename - class=directory>C:/</filename>. + by the <envar>HOME</envar> environment variable or <filename class="directory">C:/</filename>.</para> <para> <emphasis> If you have information about SGML editors, please send it to - the current maintainer, <ulink - url="&howto.maintainer;">&howto.maintainer;</ulink>. - </emphasis> + the current maintainer, <ulink url="&howto.maintainer;">&howto.maintainer;</ulink>. + </emphasis></para> </sect2> <sect2> <title>SGML Conversion Tools</title> <para> - The PHP3 documentation is written in <ulink - url="&url.docbook;">DocBook</ulink>, which is a widely recognized - SGML DTD for writing technical documentation. + The PHP3 documentation is written in <ulink url="&url.docbook;">DocBook</ulink>, which is a widely recognized + SGML DTD for writing technical documentation.</para> <para> The formatting is done using <ulink url="&url.jade;">Jade</ulink> and <ulink url="&url.dbstyle;">The Modular DocBook Stylesheets</ulink>. Pointers: <itemizedlist> - <listitem><para><ulink url="&url.jade;">Jade</ulink> + <listitem><para><ulink url="&url.jade;">Jade</ulink></para></listitem> <listitem><para><ulink url="&url.dbstyle;">The Modular DocBook - Stylesheets</ulink> - </itemizedlist> + Stylesheets</ulink></para></listitem> + </itemizedlist></para> </sect2> </sect1> @@ -110,7 +107,7 @@ <listitem><simpara> The main file for the documentation. It is supposed to be only "glue" between the other parts, containing only part titles and - entity references to chapters. + entity references to chapters.</simpara></listitem> </varlistentry> <varlistentry id="file-chapters.ent"> @@ -123,7 +120,7 @@ form <sgmltag>reference.<replaceable>name</replaceable></sgmltag>, and appendices have names of the form - <sgmltag>appendix.<replaceable>name</replaceable></sgmltag>. + <sgmltag>appendix.<replaceable>name</replaceable></sgmltag>.</simpara></listitem> </varlistentry> </variablelist> @@ -150,7 +147,7 @@ (or at least very few) layout-specific tags like HTML is full of. The idea with DocBook is to tell as much as you can about the information while writing it, so that software can do more things - with it. + with it.</simpara> <para> Although there are few 1:1 mappings between HTML and DocBook tags, here is a little list that should at least make life easier @@ -179,19 +176,19 @@ </row> </tbody> </tgroup> - </table> + </table></para></sect2> <sect2> <title>DocBook reference</title> <para> General information and documentation for DocBook can be found at - <ulink url="&url.docbook-ref;">&url.docbook-ref;</ulink>. + <ulink url="&url.docbook-ref;">&url.docbook-ref;</ulink>.</para> <para> Element-by-element DTD reference: - <ulink url="&url.docbook-dtdref;">&url.docbook-dtdref;</ulink>. + <ulink url="&url.docbook-dtdref;">&url.docbook-dtdref;</ulink>.</para> <para> Get Going With DocBook, Notes for Hackers: - <ulink url="&url.docbook-intro;">&url.docbook-intro;</ulink>. + <ulink url="&url.docbook-intro;">&url.docbook-intro;</ulink>.</para> <para> </para> </sect2>