diff --git a/documentation/authors.ent b/documentation/authors.ent index 0ef71a57885..2e2330df7a1 100644 --- a/documentation/authors.ent +++ b/documentation/authors.ent @@ -43,6 +43,9 @@ + + + diff --git a/documentation/documentation.sgml b/documentation/documentation.sgml index c34436851b0..b87304136bc 100644 --- a/documentation/documentation.sgml +++ b/documentation/documentation.sgml @@ -86,6 +86,9 @@ SEE ALSO Written by &name-john-sheets; &email-john-sheets; + + Modified by &name-tony-lambregts; &email-tony-lambregts; Nov. 2002 + Writing Documentation with DocBook @@ -98,7 +101,123 @@ SEE ALSO DocBook markup looks very similar to HTML markup, although the names of the markup tags differ. + + Getting Started + + Why SGML? + + The simple answer to that is that SGML allows you + to create multiple formats of a given document from a single + source. Currently sgml is used to create html, pdf and PS + formats of the Users Guide, Developers Guide, Winelib Users + Guide Packagers Guide and FAQ. + + + + What do I need? + + You need the sgml tools. There are various places where you + can get them. The most generic way of geting them form source. + + + + + Quick instructions + + These are the generic steps to get output from sgml. + + + + + + + Go to http://www.sgmltools.org + + + + Download all of the sgmltools packages + + + + Install them all and build them (./configure; make; make install) + + + + Switch to your toplevel wine directory + + + + Run ./configure (or make distclean && ./configure) + + + + Switch to the documentation directory + + + + run make_winehq + + + + View wine-doc/index.html in your favorite browser + + + + + + + + Getting SGML for various distributions + + Most Linux distributions have everything you need already + bundled up in package form. Unfortunately, each + distribution seems to handle its SGML environment + differently, installing it into different paths, and + naming its packages according to its own whims. + + + + SGML on Redhat + + The following packages seems to be sufficient for RedHat 7.1. You + will want to be careful about the order in which you install the + rpms. + + sgml-common-*.rpm + openjade-*.rpm + perl-SGMLSpm-*.rpm + docbook-dtd*.rpm + docbook-style-dsssl-*.rpm + tetex-*.rpm + jadetex-*.rpm + docbook-utils-*.rpm + + You can also use ghostscript to view the ps format output and + Adobe Acrobat 4 to view the pdf file. + + + + + SGML on Debian + + Fix me + + List package names and install locations... + + + + + + SGML on Other Distributions + + Fix me + + List package names and install locations... + + + + Terminology @@ -1006,47 +1125,6 @@ SEE ALSO - - SGML on Redhat - - Most Linux distributions have everything you need already - bundled up in package form. Unfortunately, each - distribution seems to handle its SGML environment - differently, installing it into different paths, and - naming its packages according to its own whims. - - - The following packages seems to be sufficient for RedHat 7.1. You - will want to be careful about the order in which you install the - rpms. - - sgml-common-*.rpm - openjade-*.rpm - perl-SGMLSpm-*.rpm - docbook-dtd*.rpm - docbook-style-dsssl-*.rpm - tetex-*.rpm - jadetex-*.rpm - docbook-utils-*.rpm - - You can also use ghostscript to view the ps format output and - Adobe Acrobat 4 to view the pdf file. - - - - - SGML on Debian - - List package names and install locations... - - - - - SGML on Other Distributions - - List package names and install locations... - -