From c0abd59f1bb4660b1810214b965479fa1608220c Mon Sep 17 00:00:00 2001 From: Francois Gouget Date: Wed, 8 Oct 2003 19:08:46 +0000 Subject: [PATCH] Remove irrelevant (and incomplete) documentation in 'The Wine DocBook System' section. --- documentation/documentation.sgml | 116 +++++-------------------------- 1 file changed, 17 insertions(+), 99 deletions(-) diff --git a/documentation/documentation.sgml b/documentation/documentation.sgml index a1122d6ef6c..ac1f59eebc9 100644 --- a/documentation/documentation.sgml +++ b/documentation/documentation.sgml @@ -2,7 +2,7 @@ Documenting Wine - This chapter describes how you can help improve Wines documentation. + This chapter describes how you can help improve Wine's documentation. @@ -19,7 +19,7 @@ a successful experience in installing, setting up and using software. Because Wine is a complicated, evolving entity, providing quality up to date documentation is vital to encourage more people to persevere with using and contributing to the project. - The following sections describe in detail how to go about adding to or updating Wines + The following sections describe in detail how to go about adding to or updating Wine's existing documentation. @@ -60,8 +60,10 @@ - The Wine Packagers Guide. This book contains information for - anyone who will be distributing Wine to end users in a prepackaged format. + The Wine Packager's Guide. This book contains + information for anyone who will be distributing Wine to end users + in a prepackaged format. It is also the exception to the rule as + it has intentionally been kept in text format. @@ -139,7 +141,7 @@ Additional notes such as interaction with other parts of the system, differences - between Wines implementation and Win32s, errors in MSDN documentation, + between Wine's implementation and Win32s, errors in MSDN documentation, undocumented cases and bugs that Wine corrects or is compatible with. @@ -571,7 +573,7 @@ BOOL WINAPI PathRelativePathToA( - An easier way is to use Wines build system. To create man pages for a given + An easier way is to use Wine's build system. To create man pages for a given dll, just type make man from within the dlls directory or type make manpages in the root directory of the Wine source tree. You can then check that a man page was generated for your function, @@ -621,8 +623,8 @@ BOOL WINAPI PathRelativePathToA( The simple answer to that is that SGML allows you to create multiple formats of a given document from a single - source. Currently it is used to create HTML, PDF and PS - (PostScript) versions of the Wine books. + source. Currently it is used to create HTML, PDF, PS + (PostScript) and Text versions of the Wine books. @@ -746,7 +748,7 @@ BOOL WINAPI PathRelativePathToA( SGML on Debian - This is not a definitive listing yet, but it seems + This is not a definitive list yet, but it seems you might need the following packages: @@ -927,15 +929,15 @@ BOOL WINAPI PathRelativePathToA( example, it doesn't make sense to put a book element inside a para paragraph element -- only - the reverse. + the reverse makes sense. The DTD thus defines the legal structure of the document. 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 Emacs 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 @@ BOOL WINAPI PathRelativePathToA( - - - The SGML Environment + Editing SGML Documents You can write SGML/DocBook documents in any text editor you - might find (although as we'll find in , 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. + might find although some editors are more friendly for + this task than others. - - - - - - - - - PSGML Mode in Emacs - - 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. - - The most commonly used open source SGML editor is Emacs, with the PSGML mode, or extension. @@ -1739,46 +1694,9 @@ BOOL WINAPI PathRelativePathToA( 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. - - - 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. - - - Next, you'll need a working SGML environment. See for more info on setting that - up. -