List:Commits« Previous MessageNext Message »
From:plavin Date:August 24 2007 9:39pm
Subject:svn commit - mysqldoc@docsrva: r7542 - trunk/userguide
View as plain text  
Author: plavin
Date: 2007-08-24 23:39:43 +0200 (Fri, 24 Aug 2007)
New Revision: 7542

Log:
Reorganize, add notes about audience and nature of the book


Modified:
   trunk/userguide/excel-mysql.xml
   trunk/userguide/introduction.xml
   trunk/userguide/userguide.xml


Modified: trunk/userguide/excel-mysql.xml
===================================================================
--- trunk/userguide/excel-mysql.xml	2007-08-24 15:25:06 UTC (rev 7541)
+++ trunk/userguide/excel-mysql.xml	2007-08-24 21:39:43 UTC (rev 7542)
Changed blocks: 2, Lines Added: 2, Lines Deleted: 2; 1250 bytes

@@ -357,7 +357,7 @@
       spreadsheet in tab-separated format, a Google spreadsheet for
       example, then simply save the file as a CSV file. Tab-separated
       text files are the easiest to import into MySQL but importing a
-      CSV file is almost as simple. Before saving the file review the
+      CSV file is almost as simple. Before saving the file, review the
       contents first and ensure that no commas appear anywhere in the
       data. A stray comma can cause data corruption or complete failure
       when importing data in CSV format.

@@ -1260,7 +1260,7 @@
     <title>Updating a MySQL Database from a Spreadsheet</title>
 
     <para>
-      Migrating spreadsheet data to a MYSQL database can be a relatively
+      Migrating spreadsheet data to a MySQL database can be a relatively
       simple task especially when using Query Browser. However,
       migrating users to that database can be much more difficult. You
       may find that you continue to receive database updates in the form


Modified: trunk/userguide/introduction.xml
===================================================================
--- trunk/userguide/introduction.xml	2007-08-24 15:25:06 UTC (rev 7541)
+++ trunk/userguide/introduction.xml	2007-08-24 21:39:43 UTC (rev 7542)
Changed blocks: 3, Lines Added: 49, Lines Deleted: 7; 2868 bytes

@@ -1,6 +1,10 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[ 
+<!ENTITY % all.entities SYSTEM "all-entities.ent">
+%all.entities;
+]>
 <chapter id="introduction">
 
   <title>Introduction</title>

@@ -15,7 +19,9 @@
       [SH] The following was sent in by community member Vangelis
       Katsikaros on the mysqldoc list. Even if we might not want to use
       his text we should have a short introduction to the client/server
-      principle. intoduction to the client/server architecture MySQL
+      principle. 
+      
+      intoduction to the client/server architecture MySQL
       follows the client/server architecture and as a consequence, MySQL
       consists of two parts: the server and the client(s). They
       communicate over a well-defined interface but let's not describe

@@ -109,22 +115,58 @@
   
   <section>
     
-    <title>About This Book</title>
+    <title>About This Book</title>   
     
+    
     <section>
       
-      <title>Target Audience</title>
+      <title>This is Not the Manual</title>
       
-      <para></para>
+      <para>
+        On the MySQL documentation web page (<xref linkend="&base-url-docs;"/>)
+        you'll find the various versions of the MySQL manual. 
+        At the time of writing there are three different 
+        versions of the manual each one running to about 2,000 pages in PDF
+        format. These manuals are meant to be the definitive reference 
+        books for each specific manual. You should be able to find the answer for 
+        any question you have about any version of MySQL. 
+      </para>
       
+      <para>
+        This is 
+        can be difficult to see the forest for the trees.
+      </para>
+      
+      <para>
+        where necessary point to the manual
+      </para>
+      
+      <para>
+        specific notes about features or usage when introduced etc won't
+        be here
+      </para>
+      
+      <para>
+        for the sake of simplicity only deals with version 5.0 
+      </para>
+      
     </section>
     
     <section>
       
-      <title>This is Not the Manual</title>
+      <title>Target Audience</title>
       
-      <para></para>
+      <para>
+        users new to databases in general and users new to 
+        MySQL
+      </para>
       
+      <para>
+        regardless of operating system many users are unfamiilar with
+        working from the command line
+        will make no assumptions in this respect
+      </para>
+      
     </section>
     
   </section>


Modified: trunk/userguide/userguide.xml
===================================================================
--- trunk/userguide/userguide.xml	2007-08-24 15:25:06 UTC (rev 7541)
+++ trunk/userguide/userguide.xml	2007-08-24 21:39:43 UTC (rev 7542)
Changed blocks: 4, Lines Added: 15, Lines Deleted: 17; 1959 bytes

@@ -47,22 +47,20 @@
     <title>Getting Started</title>
 
     <xi:include href="installing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-
-
-<!--start basic admin-->
-
-    <xi:include href="basic-administration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
     
-<!--end basic admin-->
-    
     <!--start client tools-->
     
     <xi:include href="mysql-client-programs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
     
     <!--end client tools-->
     
+    <!--start basic admin-->
+    
+    <xi:include href="basic-administration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    
+    <!--end basic admin-->
+    
     <xi:include href="mysql-server-programs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-
     
   </part>
 

@@ -84,7 +82,7 @@
 
         <title>Working From the Command Line</title>
 
-        <para><remark>[PL] Move client programs here?</remark></para>
+        <para><remark>[PL] Not a repeat of the MySQL Client section.</remark></para>
 
       </section>
 

@@ -433,7 +431,7 @@
 
       <section>
 
-        <title>The Options File</title>
+        <title>The Options File Revisited</title>
 
         <para></para>
 

@@ -612,22 +610,22 @@
 
     <appendix>
 
-      <title>Other GUI Tools</title>
+      <title>Other MySQL Utilities</title>
 
       <para></para>
 
     </appendix>
 
+    <xi:include href="excel-mysql.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    
     <appendix>
-
-      <title>Other MySQL Utilities</title>
-
+      
+      <title>Migrating an Access Database to MySQL</title>
+      
       <para></para>
-
+      
     </appendix>
 
-    <xi:include href="excel-mysql.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-
     <appendix>
 
       <title>Using PHP Data Objects (PDO) With MySQL</title>


Thread
svn commit - mysqldoc@docsrva: r7542 - trunk/userguideplavin24 Aug