Doc simplification

Francois Gouget fgouget at
Wed Oct 8 08:51:59 CDT 2003

In the spirit of keeping our documentation simple, maintainable, to the
point and interesting, I have removed part of the 'The Wine DocBook
System' section. That section already describes in quite a bit of detail
how SGML documents are formed and I think that is all that documentation
contributors really need.

We don't need to describe how DSSSL, XSLT, xemacs, db2html or jade work.
More information about these belongs to these tools/systems
documentation, not into a Wine guide.


 * documentation/documentation.sgml

   Remove irrelevant (and incomplete) documentation in 'The Wine DocBook
System' section.

Index: documentation/documentation.sgml
RCS file: /home/cvs/wine/documentation/documentation.sgml,v
retrieving revision 1.14
diff -u -r1.14 documentation.sgml
--- documentation/documentation.sgml	24 Sep 2003 05:11:51 -0000	1.14
+++ documentation/documentation.sgml	8 Oct 2003 12:19:33 -0000
@@ -927,8 +929,8 @@
             It also declares which attributes can be used with which
             tags.  The SGML processing system can use the DTD to make
             sure the document is laid out properly before attempting
-            to process it.  SGML-aware text editors like <link
-            linkend="emacs-psgml">Emacs</link> can also use the DTD to
+            to process it.  SGML-aware text editors like
+            Emacs can also use the DTD to
             guide you while you write, offering you choices about
             which tags you can add in different places in the
             document, and beeping at you when you try to add a tag
@@ -1674,63 +1676,16 @@
-        <!--sect3>
-          <title>Multiple SGML files</title>
-          <para>
-            How to split an SGML document into multiple files...
-          </para>
-        </sect3-->

       <sect2 id="sgml-environment">
-        <title>The SGML Environment</title>
+        <title>Editing SGML Documents</title>

           You can write SGML/DocBook documents in any text editor you
-          might find (although as we'll find in <xref
-          linkend="emacs-psgml">, some editors are more friendly for
-          this task than others).  However, if you want to convert
-          those documents into a more friendly form for reading, such
-          as HTML, PostScript, or PDF, you will need a working SGML
-          environment.  This section attempts to lay out the various
-          SGML rendering systems, and how they are set up on the
-          popular Linux distributions.
-        </para>
-        <!--sect3>
-          <title>DSSSL Environment</title>
-          <para>
-            Explain tools and methodologies..
-          </para>
-        </sect3-->
-        <!--sect3>
-          <title>XSLT Environment</title>
-          <para>
-            Explain tools and methodologies...
-          </para>
-        </sect3-->
-      </sect2>
-      <sect2 id="emacs-psgml">
-        <title>PSGML Mode in Emacs</title>
-        <para>
-          Although you can write SGML documentation in any simple text
-          editor, some editors provide extra support for entering SGML
-          tags, and for verifying that the SGML you create is valid.
-          SGML has been around for a long time, and many commercial
-          editors exist for it; however, until recently open source
-          SGML editors have been scarce.
+          might find although some editors are more friendly for
+          this task than others.
-        <!--note>
-          <title>FIXME</title>
-          <para>
-            List the available commercial and open source SGML
-            editors.
-          </para>
-        </note-->
           The most commonly used open source SGML editor is Emacs,
           with the PSGML <firstterm>mode</firstterm>, or extension.
@@ -1739,46 +1694,9 @@
           shortcuts for creating SGML, as well as automatic
           formatting, validity checking, and the ability to create
           your own macros to simplify complex, repetitive actions.
-          We'll touch briefly on each of these points.
-        </para>
-        <para>
-          The first thing you need is a working installation of Emacs
-          (or XEmacs), with the PSGML package.  Most Linux
-          distributions provide both as easy-to-install packages.
-        </para>
-        <para>
-          Next, you'll need a working SGML environment.  See <xref
-          linkend="sgml-environment"> for more info on setting that
-          up.

-      <!--sect2 id="docbook-build">
-        <title>The DocBook Build System</title>
-        <sect3 id="docbook-infrastructure">
-          <title>Basic Infrastructure</title>
-          <para>
-            FIXME: How the build/make system works (makefiles, db2html,
-            jade, stylesheets).
-          </para>
-        </sect3>
-        <sect3 id="docbook-tweaking">
-          <title>Tweaking the DSSSL stylesheets</title>
-          <para>
-            FIXME: Things you can tweak, and how to do it (examples from
-            default.dsl and print.dsl).
-          </para>
-        </sect3>
-        <sect3 id="docbook-generating">
-          <title>Generating docs for Wine web sites</title>
-          <para>
-            FIXME: Explain make, rsync, etc.
-          </para>
-        </sect3>
-      </sect2-->

Francois Gouget         fgouget at
In theory, theory and practice are the same, but in practice they're different.

More information about the wine-patches mailing list