[Scummvm-cvs-logs] CVS: docs/docbook manual.html,1.1.1.1,1.2 manual.pdf,1.1.1.1,1.2 manual.txt,1.1.1.1,1.2 manual.xml,1.2,1.3

[Max Horn]

Update of /cvsroot/scummvm/docs/docbook
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv31497

Modified Files:
	manual.html manual.pdf manual.txt manual.xml 
Log Message:
Fixed the look of the credits table in the PDF version; added some stub XML for future use

Index: manual.html
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.html,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- manual.html	3 Dec 2004 22:52:49 -0000	1.1.1.1
+++ manual.html	4 Dec 2004 14:44:00 -0000	1.2
@@ -47,44 +47,49 @@
 <dt>2.2.4. <a href="#AEN72">WinCE / PocketPC</a></dt>
 <dt>2.2.5. <a href="#AEN75">PalmOS</a></dt>
 <dt>2.2.6. <a href="#AEN78">Dreamcast</a></dt></dl></dd>
-<dt>2.3. <a href="#AEN81">First steps</a></dt></dl></dd>
-<dt>3. <a href="#AEN84">Running and using ScummVM</a></dt>
+<dt>2.3. <a href="#AEN81">First steps</a></dt>
 <dd>
 <dl>
-<dt>3.1. <a href="#AEN86">The launcher</a></dt>
-<dt>3.2. <a href="#AEN89">Command line options</a></dt>
-<dt>3.3. <a href="#AEN107">Hot Keys</a></dt>
-<dt>3.4. <a href="#AEN110">Saving and loading</a></dt>
-<dt>3.5. <a href="#AEN113">Using Macintosh games</a></dt>
-<dt>3.6. <a href="#AEN116">Multi-CD Games</a></dt></dl></dd>
-<dt>4. <a href="#AEN119">Configuration</a></dt>
+<dt>2.3.1. <a href="#AEN85">Unix-like, Windows, Mac OS X</a></dt>
+<dt>2.3.2. <a href="#AEN88">WinCE / PocketPC</a></dt>
+<dt>2.3.3. <a href="#AEN91">Dreamcast</a></dt></dl></dd></dl></dd>
+<dt>3. <a href="#AEN94">Running and using ScummVM</a></dt>
 <dd>
 <dl>
-<dt>4.1. <a href="#AEN121">Using the launcher</a></dt>
-<dt>4.2. <a href="#AEN124">All config file switches in
+<dt>3.1. <a href="#AEN96">The launcher</a></dt>
+<dt>3.2. <a href="#AEN99">Command line options</a></dt>
+<dt>3.3. <a href="#AEN117">Hot Keys</a></dt>
+<dt>3.4. <a href="#AEN120">Saving and loading</a></dt>
+<dt>3.5. <a href="#AEN123">Using Macintosh games</a></dt>
+<dt>3.6. <a href="#AEN126">Multi-CD Games</a></dt></dl></dd>
+<dt>4. <a href="#AEN129">Configuration</a></dt>
+<dd>
+<dl>
+<dt>4.1. <a href="#AEN131">Using the launcher</a></dt>
+<dt>4.2. <a href="#AEN134">All config file switches in
 detail</a></dt>
-<dt>4.3. <a href="#AEN127">Graphics Filters</a></dt>
-<dt>4.4. <a href="#AEN130">Music and Sound</a></dt></dl></dd>
+<dt>4.3. <a href="#AEN137">Graphics Filters</a></dt>
+<dt>4.4. <a href="#AEN140">Music and Sound</a></dt></dl></dd>
 <dt>A. <a href="#sec.supported-games">Supported Games</a></dt>
 <dd>
 <dl>
-<dt>A.1. <a href="#AEN136">LucasArts Games</a></dt>
-<dt>A.2. <a href="#AEN139">Humongous Games</a></dt>
-<dt>A.3. <a href="#AEN142">Adventure Soft Games</a></dt>
-<dt>A.4. <a href="#AEN145">Revolution Games</a></dt>
-<dt>A.5. <a href="#AEN148">Interactive Binary Illusions
+<dt>A.1. <a href="#AEN146">LucasArts Games</a></dt>
+<dt>A.2. <a href="#AEN149">Humongous Games</a></dt>
+<dt>A.3. <a href="#AEN152">Adventure Soft Games</a></dt>
+<dt>A.4. <a href="#AEN155">Revolution Games</a></dt>
+<dt>A.5. <a href="#AEN158">Interactive Binary Illusions
 Games</a></dt>
-<dt>A.6. <a href="#AEN151">Other Games</a></dt></dl></dd>
-<dt>B. <a href="#AEN154">Tools</a></dt>
+<dt>A.6. <a href="#AEN161">Other Games</a></dt></dl></dd>
+<dt>B. <a href="#AEN164">Tools</a></dt>
 <dd>
 <dl>
-<dt>B.1. <a href="#AEN157">compress_san</a></dt>
-<dt>B.2. <a href="#AEN160">extract</a></dt>
-<dt>B.3. <a href="#AEN163">simon2mp3</a></dt>
-<dt>B.4. <a href="#AEN166">sword2mp3</a></dt></dl></dd>
-<dt>C. <a href="#AEN169">Credits</a></dt>
-<dt><a href="#AEN340">Glossary</a></dt>
-<dt><a href="#AEN351">Index</a></dt></dl></div>
+<dt>B.1. <a href="#AEN167">compress_san</a></dt>
+<dt>B.2. <a href="#AEN170">extract</a></dt>
+<dt>B.3. <a href="#AEN173">simon2mp3</a></dt>
+<dt>B.4. <a href="#AEN176">sword2mp3</a></dt></dl></dd>
+<dt>C. <a href="#AEN179">Credits</a></dt>
+<dt><a href="#AEN350">Glossary</a></dt>
+<dt><a href="#AEN373">Index</a></dt></dl></div>
 <div class="chapter">
 <hr>
 <h1><a name="AEN7"></a>Chapter 1. Introduction</h1>
@@ -212,18 +217,35 @@
 <hr>
 <h2 class="section"><a name="AEN81">2.3. First steps</a></h2>
 <p>TODO: (basic setup; how to add a game using the launcher and the
-play it, getting a first game to run)</p></div></div>
+play it, getting a first game to run).</p>
+<p>Note: We use the default launcher GUI on many systems, but some
+have their own custom launcher, so we'll want to have a separate
+section with different screen shots for those.</p>
+<div class="section">
+<hr>
+<h3 class="section"><a name="AEN85">2.3.1. Unix-like, Windows, Mac
+OS X</a></h3>
+<p>TODO</p></div>
+<div class="section">
+<hr>
+<h3 class="section"><a name="AEN88">2.3.2. WinCE /
+PocketPC</a></h3>
+<p>TODO</p></div>
+<div class="section">
+<hr>
+<h3 class="section"><a name="AEN91">2.3.3. Dreamcast</a></h3>
+<p>TODO</p></div></div></div>
 <div class="chapter">
 <hr>
-<h1><a name="AEN84"></a>Chapter 3. Running and using ScummVM</h1>
+<h1><a name="AEN94"></a>Chapter 3. Running and using ScummVM</h1>
 <div class="section">
-<h2 class="section"><a name="AEN86">3.1. The launcher</a></h2>
+<h2 class="section"><a name="AEN96">3.1. The launcher</a></h2>
 <p>TODO: Explain the launcher and how to use it (even though I hope
 that it's pretty much straightforward); including
 screenshots?</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN89">3.2. Command line
+<h2 class="section"><a name="AEN99">3.2. Command line
 options</a></h2>
 <p>TODO</p>
 <p><b class="command">scummvm</b> [<tt class=
@@ -239,46 +261,46 @@
 <p>Display a brief help text and exit.</p></dd></dl></div></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN107">3.3. Hot Keys</a></h2>
+<h2 class="section"><a name="AEN117">3.3. Hot Keys</a></h2>
 <p>TODO: This also has to cover platform specific
 details...</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN110">3.4. Saving and
+<h2 class="section"><a name="AEN120">3.4. Saving and
 loading</a></h2>
 <p>TODO: Where savegames are stored; autosaves; how to save/load in
 the various games (i.e. F5 in SCUMM games); including screenshots,
 maybe?</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN113">3.5. Using Macintosh
+<h2 class="section"><a name="AEN123">3.5. Using Macintosh
 games</a></h2>
 <p>TODO: How to access the HFS disks from a non-mac; maybe point to
 rescumm, although this shouldn't be necessary anymore
 now.</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN116">3.6. Multi-CD Games</a></h2>
+<h2 class="section"><a name="AEN126">3.6. Multi-CD Games</a></h2>
 <p>TODO</p></div></div>
 <div class="chapter">
 <hr>
-<h1><a name="AEN119"></a>Chapter 4. Configuration</h1>
+<h1><a name="AEN129"></a>Chapter 4. Configuration</h1>
 <div class="section">
-<h2 class="section"><a name="AEN121">4.1. Using the
+<h2 class="section"><a name="AEN131">4.1. Using the
 launcher</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN124">4.2. All config file switches
+<h2 class="section"><a name="AEN134">4.2. All config file switches
 in detail</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN127">4.3. Graphics Filters</a></h2>
+<h2 class="section"><a name="AEN137">4.3. Graphics Filters</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN130">4.4. Music and Sound</a></h2>
+<h2 class="section"><a name="AEN140">4.4. Music and Sound</a></h2>
 <p>TODO</p></div></div>
 <div class="appendix">
 <hr>
@@ -289,64 +311,64 @@
 supported precisely, where to get cutscene packs etc.</p>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN136">A.1. LucasArts Games</a></h2>
+<h2 class="section"><a name="AEN146">A.1. LucasArts Games</a></h2>
 <p>TODO: Add a list of all LEC SCUMM games here, with note
-regarding which variants we (don't support), pointers to special
+regarding which variants we (don't) support, pointers to special
 problems (how to deal with the mac versions if you are on a PC, for
 example), etc.</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN139">A.2. Humongous Games</a></h2>
+<h2 class="section"><a name="AEN149">A.2. Humongous Games</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN142">A.3. Adventure Soft
+<h2 class="section"><a name="AEN152">A.3. Adventure Soft
 Games</a></h2>
 <p>TODO: Simon 1, Simon 2 (and their many variants)</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN145">A.4. Revolution Games</a></h2>
+<h2 class="section"><a name="AEN155">A.4. Revolution Games</a></h2>
 <p>TODO: BASS, BS1, BS2</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN148">A.5. Interactive Binary
+<h2 class="section"><a name="AEN158">A.5. Interactive Binary
 Illusions Games</a></h2>
 <p>TODO: FOTAQ</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN151">A.6. Other Games</a></h2>
+<h2 class="section"><a name="AEN161">A.6. Other Games</a></h2>
 <p>TODO: Tell people here regarding support for additional games
 (FAQ); maybe point at FreeSCI, Dosbox, others</p></div></div>
 <div class="appendix">
 <hr>
-<h1><a name="AEN154"></a>Appendix B. Tools</h1>
+<h1><a name="AEN164"></a>Appendix B. Tools</h1>
 <p>TODO: Explain sword2mp3, simon2mp3, extract, compress_san, etc.
 ; rescumm shouldn't have to be explained anymore; not sure if
 descumm should be explained here, it seems more fit for the dev
 guide, but that's probably debatable...</p>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN157">B.1. compress_san</a></h2>
+<h2 class="section"><a name="AEN167">B.1. compress_san</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN160">B.2. extract</a></h2>
+<h2 class="section"><a name="AEN170">B.2. extract</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN163">B.3. simon2mp3</a></h2>
+<h2 class="section"><a name="AEN173">B.3. simon2mp3</a></h2>
 <p>TODO</p></div>
 <div class="section">
 <hr>
-<h2 class="section"><a name="AEN166">B.4. sword2mp3</a></h2>
+<h2 class="section"><a name="AEN176">B.4. sword2mp3</a></h2>
 <p>TODO</p></div></div>
 <div class="appendix">
 <hr>
-<h1><a name="AEN169"></a>Appendix C. Credits</h1>
-<div class="informaltable"><a name="AEN171"></a>
-<table border="0" frame="void" rules="all" class="CALSTABLE">
-<col width="1*" title="start">
-<col width="1*" title="name">
+<h1><a name="AEN179"></a>Appendix C. Credits</h1>
+<div class="informaltable"><a name="AEN181"></a>
+<table border="0" frame="void" rules="none" class="CALSTABLE">
+<col width="19" title="start">
+<col width="151" title="name">
 <col width="1*" title="job">
 <tbody>
 <tr>
@@ -572,7 +594,7 @@
 reimplement that it is today. Feel free to drop us a line and tell
 us what you think, guys!</p></div>
 <div class="GLOSSARY">
-<h1><a name="AEN340"></a>Glossary</h1>
+<h1><a name="AEN350"></a>Glossary</h1>
 <p>TODO: (explaining abbreviations etc.). Like SCUMM, FOTAQ, COMI,
 FOA, ITE, ...</p>
 <dl>
@@ -580,13 +602,22 @@
 <dd>
 <p>Curse of Monkey Island, one of the SCUMM games supported by
 ScummVM</p></dd>
+<dt><b>FM-TOWNS</b></dt>
+<dd>
+<p>TODO</p></dd>
 <dt><b>FOTAQ</b></dt>
 <dd>
 <p>Flight of the Amazon Queen, one of the games supported by
-ScummVM</p></dd></dl></div>
+ScummVM</p></dd>
+<dt><b>Launcher</b></dt>
+<dd>
+<p>TODO</p></dd>
+<dt><b>MT-32</b></dt>
+<dd>
+<p>TODO</p></dd></dl></div>
 <div class="index">
 <hr>
-<h1><a name="AEN351"></a>Index</h1>
+<h1><a name="AEN373"></a>Index</h1>
 <p>TODO: Note that docbook can be used to automate the generation
 of an index!</p></div></div>
 </body>

Index: manual.pdf
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.pdf,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- manual.pdf	3 Dec 2004 22:52:52 -0000	1.1.1.1
+++ manual.pdf	4 Dec 2004 14:44:00 -0000	1.2
@@ -120,213 +120,249 @@
 (2.3. First steps)
 endobj
 81 0 obj
-<< /S /GoTo /D (5.0) >>
+<< /S /GoTo /D (4.8.9.2) >>
 endobj
 84 0 obj
-(Chapter 3. Running and using ScummVM)
+(2.3.1. Unixlike, Windows, Mac OS X)
 endobj
 85 0 obj
[...4445 lines suppressed...]
+0000109879 00000 n 
+0000109957 00000 n 
+0000115072 00000 n 
+0000118357 00000 n 
+0000118396 00000 n 
+0000118434 00000 n 
+0000118661 00000 n 
 trailer
 <<
-/Size 517
-/Root 515 0 R
-/Info 516 0 R
+/Size 559
+/Root 557 0 R
+/Info 558 0 R
 >>
 startxref
-114104
+118816
 %%EOF

Index: manual.txt
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.txt,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -d -r1.1.1.1 -r1.2
--- manual.txt	3 Dec 2004 22:52:53 -0000	1.1.1.1
+++ manual.txt	4 Dec 2004 14:44:00 -0000	1.2
@@ -42,6 +42,12 @@
 
                 2.3. First steps
 
+                             2.3.1. Unix-like, Windows, Mac OS X
+
+                             2.3.2. WinCE / PocketPC
+
+                             2.3.3. Dreamcast
+
    3. Running and using ScummVM
 
                 3.1. The launcher
@@ -238,7 +244,29 @@
 2.3. First steps
 
    TODO: (basic setup; how to add a game using the launcher and the play it,
-   getting a first game to run)
+   getting a first game to run).
+
+   Note: We use the default launcher GUI on many systems, but some have their
+   own custom launcher, so we'll want to have a separate section with
+   different screen shots for those.
+
+     ----------------------------------------------------------------------
+
+  2.3.1. Unix-like, Windows, Mac OS X
+
+   TODO
+
+     ----------------------------------------------------------------------
+
+  2.3.2. WinCE / PocketPC
+
+   TODO
+
+     ----------------------------------------------------------------------
+
+  2.3.3. Dreamcast
+
+   TODO
 
      ----------------------------------------------------------------------
 
@@ -330,7 +358,7 @@
 A.1. LucasArts Games
 
    TODO: Add a list of all LEC SCUMM games here, with note regarding which
-   variants we (don't support), pointers to special problems (how to deal
+   variants we (don't) support, pointers to special problems (how to deal
    with the mac versions if you are on a PC, for example), etc.
 
      ----------------------------------------------------------------------
@@ -484,10 +512,22 @@
            Curse of Monkey Island, one of the SCUMM games supported by
            ScummVM
 
+   FM-TOWNS
+
+           TODO
+
    FOTAQ
 
            Flight of the Amazon Queen, one of the games supported by ScummVM
 
+   Launcher
+
+           TODO
+
+   MT-32
+
+           TODO
+
      ----------------------------------------------------------------------
 
                                      Index

Index: manual.xml
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- manual.xml	3 Dec 2004 23:32:58 -0000	1.2
+++ manual.xml	4 Dec 2004 14:44:00 -0000	1.3
@@ -152,8 +152,54 @@
       <title>First steps</title>
       <para>TODO:
       (basic setup; how to add a game using the launcher and the play
-      it, getting a first game to run)
+      it, getting a first game to run).
       </para>
+      <para>Note: We use the default launcher GUI on many systems, but
+      some have their own custom launcher, so we'll want to have a separate
+      section with different screen shots for those.
+      </para>
+
+	<!-- This is an example of how you add pictures: -->
+	<!--
+	<mediaobject>
+		<imageobject>
+			<imagedata fileref="figures/eiffeltower.eps" format="EPS"/>
+		</imageobject>
+		<imageobject>
+			<imagedata fileref="figures/eiffeltower.png" format="PNG"/>
+		</imageobject>
+		<textobject>
+			<phrase>The Eiffel Tower</phrase>
+		</textobject>
+		<caption>
+			<para>Designed by Gustave Eiffel in 1889, The Eiffel Tower is one of the
+			most widely recognized buildings in the world.
+			</para>
+		</caption>
+	</mediaobject>
+	-->
+	<!-- Specifically, for a screenshot, you can wrap the mediaobject like this: -->
+	<!--
+	<screenshot>
+	<screeninfo>640x480x256</screeninfo>
+	<mediaobject>...</mediaobject>
+	</screenshot>
+	-->
+
+		  <section>
+        <title>Unix-like, Windows, Mac OS X</title>
+        <para>TODO</para>
+      </section>
+
+      <section>
+        <title>WinCE / PocketPC</title>
+        <para>TODO</para>
+      </section>
+
+      <section>
+        <title>Dreamcast</title>
+        <para>TODO</para>
+      </section>
     </section>
 
   </chapter>
@@ -259,7 +305,7 @@
     <section>
       <title>LucasArts Games</title>
       <para>TODO: Add a list of all LEC SCUMM games here,
-      with note regarding which variants we (don't support),
+      with note regarding which variants we (don't) support,
       pointers to special problems (how to deal with the mac versions
       if you are on a PC, for example), etc.</para>
     </section>
@@ -329,9 +375,9 @@
     <title>Credits</title>
 
 <informaltable frame='none'>
-<tgroup cols='3' align='left' colsep='1' rowsep='1'>
-<colspec colname='start'/>
-<colspec colname='name'/>
+<tgroup cols='3' align='left' colsep='0' rowsep='0'>
+<colspec colname='start' colwidth="0.5cm"/>
+<colspec colname='name' colwidth="4cm"/>
 <colspec colname='job'/>
 <tbody>
 <row><entry namest="start" nameend="job"><emphasis role="bold">The ScummVM team:</emphasis></entry></row>
@@ -436,9 +482,24 @@
     </glossentry>
 
     <glossentry>
+      <glossterm>FM-TOWNS</glossterm>
+      <glossdef><para>TODO</para></glossdef>
+    </glossentry>
+
+    <glossentry>
       <glossterm>FOTAQ</glossterm>
       <glossdef><para>Flight of the Amazon Queen, one of the games supported by ScummVM</para></glossdef>
     </glossentry>
+
+    <glossentry>
+      <glossterm>Launcher</glossterm>
+      <glossdef><para>TODO</para></glossdef>
+    </glossentry>
+
+    <glossentry>
+      <glossterm>MT-32</glossterm>
+      <glossdef><para>TODO</para></glossdef>
+    </glossentry>
   </glossary>
 
   <index>