Author: shinz
Date: 2007-04-19 17:36:55 +0200 (Thu, 19 Apr 2007)
New Revision: 6002
Log:
Reformat
Added:
trunk/mysqldoc-guide/article-entwicklermagazin.odt
Modified:
trunk/mysqldoc-guide/overview.de.xml
trunk/mysqldoc-guide/overview.xml
Property changes on: trunk/mysqldoc-guide/article-entwicklermagazin.odt
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/mysqldoc-guide/article-entwicklermagazin.odt
===================================================================
Changed blocks: 0, Lines Added: 0, Lines Deleted: 0; 331 bytes
Modified: trunk/mysqldoc-guide/overview.de.xml
===================================================================
--- trunk/mysqldoc-guide/overview.de.xml 2007-04-19 14:55:23 UTC (rev 6001)
+++ trunk/mysqldoc-guide/overview.de.xml 2007-04-19 15:36:55 UTC (rev 6002)
Changed blocks: 9, Lines Added: 86, Lines Deleted: 28; 12207 bytes
@@ -163,7 +163,10 @@
</row>
<row>
<entry><filename>xsl.d</filename></entry>
- <entry>Die standardmäßigen DocBook XSL-Stylesheets sowie Erweiterungen und Verbesserungen, die speziell für die MySQL-Dokumentation geschrieben wurden. Die ursprünglichen DocBook XSL-Stylesheets wurden in keiner Weise verändert.</entry>
+ <entry>Die standardmäßigen DocBook XSL-Stylesheets sowie Erweiterungen und
+ Verbesserungen, die speziell für die MySQL-Dokumentation
+ geschrieben wurden. Die ursprünglichen DocBook
+ XSL-Stylesheets wurden in keiner Weise verändert.</entry>
</row>
</tbody>
</tgroup>
@@ -173,11 +176,18 @@
Die sonstigen Verzeichnisse enthalten die Dokumentation selbst,
zumeist im Format DocBook XML, teilweise aber auch in einem
anderen XML-Format, das durch Transformation in DocBook XML
- umgewandelt werden kann. Zusätzlich enthalten diese Verzeichnisse weitere für die Dokumentation benötigte Dateien, beispielsweise Entitätsdefinitionen und Grafikdateien (Diagramme und Bildschirmfotos).
- <remark>I've asked MC about the following sentence.</remark>
- In each case, there is
- typically only one document target in each directory, but each
- document can be translated into any one of the desired formats.
+ umgewandelt werden kann. Zusätzlich enthalten diese Verzeichnisse
+ weitere für die Dokumentation benötigte Dateien, beispielsweise
+ Entitätsdefinitionen und Grafikdateien (Diagramme und
+ Bildschirmfotos).
+
+ <remark>
+ I've asked MC about the following sentence.
+ </remark>
+
+ In each case, there is typically only one document target in each
+ directory, but each document can be translated into any one of the
+ desired formats.
</para>
<table id="mysqldoc-guide-overview-dirent-docs">
@@ -198,10 +208,13 @@
</row>
<row>
<entry><filename>arbitrary</filename></entry>
- <entry>Enthält die Spezifikationen für die <quote>beliebige Dokumentation</quote>, siehe
+ <entry>Enthält die Spezifikationen für die <quote>beliebige
+ Dokumentation</quote>, siehe
+
<!--<xref
- linkend="mysqldoc-guide-tools-arby"/>-->.
- .</entry>
+ linkend="mysqldoc-guide-tools-arby"/>-->
+
+ . .</entry>
</row>
<row>
<entry><filename>common</filename></entry>
@@ -209,7 +222,11 @@
</row>
<row>
<entry><filename>dynamic-docs</filename></entry>
- <entry>Die Quellen für dynamisch erzeugte Informatonen, momentan verwendet für Server-Optionen und -Variablen sowie Operatoren und Funktionen. Diese Dateien werden geparst und für die Verwendung an verschiedenen Stellen der Dokumentation in DocBook XML umgewandelt.</entry>
+ <entry>Die Quellen für dynamisch erzeugte Informatonen, momentan verwendet
+ für Server-Optionen und -Variablen sowie Operatoren und
+ Funktionen. Diese Dateien werden geparst und für die
+ Verwendung an verschiedenen Stellen der Dokumentation in
+ DocBook XML umgewandelt.</entry>
</row>
<row>
<entry><filename>falcon</filename></entry>
@@ -221,11 +238,15 @@
</row>
<row>
<entry><filename>guibook</filename></entry>
- <entry>Das Handbuch, das die Handbücher sämtlicher GUI-Tools zu einem gemensamen Buch zusammenfasst.</entry>
+ <entry>Das Handbuch, das die Handbücher sämtlicher GUI-Tools zu einem
+ gemensamen Buch zusammenfasst.</entry>
</row>
<row>
<entry><filename>illustrations</filename></entry>
- <entry>Quelldateien für Illustrationen in diversen Teilen der Dokumentation. Diese werden erzeit in PNG-Grafikdateien umgewandelt. Dieses Format wird in den DocBook XML-Dateien direkt referenziert.</entry>
+ <entry>Quelldateien für Illustrationen in diversen Teilen der Dokumentation.
+ Diese werden erzeit in PNG-Grafikdateien umgewandelt.
+ Dieses Format wird in den DocBook XML-Dateien direkt
+ referenziert.</entry>
</row>
<row>
<entry><filename>internals</filename></entry>
@@ -249,11 +270,19 @@
</row>
<row>
<entry><filename>refman-<replaceable>#.#</replaceable></filename></entry>
- <entry>Quellen für die MySQL-Referenzhandbücher für MySQL-Versionen <replaceable>#.#</replaceable> (beispielsweise für die Versionen 5.0 und 5.1). Zur Dokumentation in diesem Verzeichnis gehören die für alle MySQL-Versionen gültigen Dateien im Verzeichnis <filename>refman-common</filename>.</entry>
+ <entry>Quellen für die MySQL-Referenzhandbücher für MySQL-Versionen
+ <replaceable>#.#</replaceable> (beispielsweise für die
+ Versionen 5.0 und 5.1). Zur Dokumentation in diesem
+ Verzeichnis gehören die für alle MySQL-Versionen
+ gültigen Dateien im Verzeichnis
+ <filename>refman-common</filename>.</entry>
</row>
<row>
<entry><filename>refman-common</filename></entry>
- <entry>Dokumentation, die allen Referenzhandbüchern gemein ist, beispielsweise die Connectors-Dokumentation, gemeinsame Grafiken oder Kapitel und Anhänge, die in sämtlichen Versionen des Referenzhandbuchs auftauchen.</entry>
+ <entry>Dokumentation, die allen Referenzhandbüchern gemein ist, beispielsweise
+ die Connectors-Dokumentation, gemeinsame Grafiken oder
+ Kapitel und Anhänge, die in sämtlichen Versionen des
+ Referenzhandbuchs auftauchen.</entry>
</row>
<row>
<entry><filename>userguide</filename></entry>
@@ -274,7 +303,13 @@
<title>Erforderliche Software</title>
<para>
- Um Ausgabeformate zu erzeugen oder in sonstiger Weise mit der Dokumentation zu arbeiten, müssen bestimmte Programme und sonstige Dinge vorhanden sein. Sämtliche Programme, die wir verwenden, sind entweder als quelloffene Software oder als Freeware erhältlich. Welche Software genau installiert werden muss, hängt davon ab, welche Aufgaben durchgeführt werden sollen.
+ Um Ausgabeformate zu erzeugen oder in sonstiger Weise mit der
+ Dokumentation zu arbeiten, müssen bestimmte Programme und
+ sonstige Dinge vorhanden sein. Sämtliche Programme, die wir
+ verwenden, sind entweder als quelloffene Software oder als
+ Freeware erhältlich. Welche Software genau installiert werden
+ muss, hängt davon ab, welche Aufgaben durchgeführt werden
+ sollen.
</para>
<para>
@@ -285,21 +320,34 @@
<listitem>
<para>
- <emphasis role="bold">make</emphasis> — das standardmäßige Hilfsprogramm <command>make</command>, das entweder mit dem Betriebssystem mitgeliefert wird (Linux und die meisten Unix-Varianten) oder separat installiert werden muss (unter Windows zum Beispiel mittels Cygwin, <ulink url="http://www.cygwin.com"/>).
+ <emphasis role="bold">make</emphasis> — das
+ standardmäßige Hilfsprogramm <command>make</command>, das
+ entweder mit dem Betriebssystem mitgeliefert wird (Linux und
+ die meisten Unix-Varianten) oder separat installiert werden
+ muss (unter Windows zum Beispiel mittels Cygwin,
+ <ulink url="http://www.cygwin.com"/>).
</para>
</listitem>
<listitem>
<para>
- <emphasis role="bold">XML Tools</emphasis> — das XML-Toolkit von <ulink url="http://xmlsoft.org"/> enthält eine Reihe von Hilfsprogrammen, die für die Arbeit mit DocBook XML erforderlich sind, beispielsweise <command>xmllint</command> und
- <command>xsltproc</command>. Diese Programme werden auch häufig mit dem Betriebssystem (oder mit Cygwin) mitgeliefert.
+ <emphasis role="bold">XML Tools</emphasis> — das
+ XML-Toolkit von <ulink url="http://xmlsoft.org"/> enthält
+ eine Reihe von Hilfsprogrammen, die für die Arbeit mit
+ DocBook XML erforderlich sind, beispielsweise
+ <command>xmllint</command> und <command>xsltproc</command>.
+ Diese Programme werden auch häufig mit dem Betriebssystem
+ (oder mit Cygwin) mitgeliefert.
</para>
</listitem>
<listitem>
<para>
- <emphasis role="bold">Perl</emphasis> — ist für etliche der erweiterten Werkzeuge nötig, die unseren Produktionsprozess unterstützen. Zusätzlich zu Perl selbst werden noch die Bibliothek <literal>Expat</literal> und die Module
- <literal>XML::Parser::PerlSAX</literal>,
+ <emphasis role="bold">Perl</emphasis> — ist für etliche
+ der erweiterten Werkzeuge nötig, die unseren
+ Produktionsprozess unterstützen. Zusätzlich zu Perl selbst
+ werden noch die Bibliothek <literal>Expat</literal> und die
+ Module <literal>XML::Parser::PerlSAX</literal>,
<literal>IO::String</literal> und <literal>IO::File</literal>
benötigt.
</para>
@@ -308,28 +356,38 @@
</itemizedlist>
<para>
- Um PDF-Dateien zu erzeugen, wird eine geeignete Java-Laufzeit-Umgebung benötigt (mindestens Version 1.5) sowie das Apache-Werkzeug <literal>FOP</literal>
- (<ulink url="http://xmlgraphics.apache.org/fop/"/>). Derzeit empfehlen wir die FOP-Version 0.20.5.
+ Um PDF-Dateien zu erzeugen, wird eine geeignete
+ Java-Laufzeit-Umgebung benötigt (mindestens Version 1.5) sowie
+ das Apache-Werkzeug <literal>FOP</literal>
+ (<ulink url="http://xmlgraphics.apache.org/fop/"/>). Derzeit
+ empfehlen wir die FOP-Version 0.20.5.
</para>
<para>
- Unter Unix-ähnlichen Systemen wie Linux und Mac OS X wird FOP in ein beliebiges Verzeichnis installiert. Anschließend setzt man einen Link auf den Befehl <command>fop.sh</command>, den man <command>fop</command> nennt, beispielsweise so:
+ Unter Unix-ähnlichen Systemen wie Linux und Mac OS X wird FOP in
+ ein beliebiges Verzeichnis installiert. Anschließend setzt man
+ einen Link auf den Befehl <command>fop.sh</command>, den man
+ <command>fop</command> nennt, beispielsweise so:
</para>
<programlisting>shell> <userinput>ln -s /usr/local/fop-0.20.5/bin/fop.sh /usr/local/bin/fop</userinput></programlisting>
<para>
- Für große Dateien wie das MySQL-Referenzhandbuch sollte der FOP zur Verfügung stehende Speicher erhöht werden. Das geschieht durch Setzen der Befehlszeilenoption <option>-Xmx##m</option> in der letzten Zeile des Skripts <command>fop.sh</command> oder (unter Windows)
- <command>fop.bat</command>:
+ Für große Dateien wie das MySQL-Referenzhandbuch sollte der FOP
+ zur Verfügung stehende Speicher erhöht werden. Das geschieht
+ durch Setzen der Befehlszeilenoption <option>-Xmx##m</option> in
+ der letzten Zeile des Skripts <command>fop.sh</command> oder
+ (unter Windows) <command>fop.bat</command>:
</para>
<programlisting>shell> <userinput>JAVACMD -Xmx2048m -classpath "$LOCALCLASSPATH" $FOP_OPTS org.apache.fop.apps.Fop "$@"</userinput></programlisting>
<para>
- If you want to build CHM (Compiled HTML) documents then you must
- use Windows and install the HTML Workshop toolkit from Micrsoft
+ Zum Erzeugen von CHM (kompiliertes HTML) wird Windows benötigt.
+ Außerdem muss das Toolkit HTML Workshop von Micrsoft
(<ulink
- url="http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc"/>.
+ url="http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc"/>
+ installiert werden.
</para>
</section>
Modified: trunk/mysqldoc-guide/overview.xml
===================================================================
--- trunk/mysqldoc-guide/overview.xml 2007-04-19 14:55:23 UTC (rev 6001)
+++ trunk/mysqldoc-guide/overview.xml 2007-04-19 15:36:55 UTC (rev 6002)
Changed blocks: 10, Lines Added: 87, Lines Deleted: 19; 8647 bytes
@@ -13,7 +13,14 @@
Somewhere we should mention that the whole documentation system is
based on open source components or free software (MS Help Workshop).
</remark>
-<remark>Generally, you're using the term "translate" quite often to talk about transformations. This can be confusing considering that a lot of our docs stuff is about translations (of human language). I'd suggest to use "transform" for the former. /SH</remark>
+
+ <remark>
+ Generally, you're using the term "translate" quite often to talk
+ about transformations. This can be confusing considering that a lot
+ of our docs stuff is about translations (of human language). I'd
+ suggest to use "transform" for the former. /SH
+ </remark>
+
<para>
MySQL develops all of the documentation internally. This includes
the various version specific reference manuals, the documentation
@@ -116,11 +123,17 @@
<remark>
"In addition ... also ..." sounds redundant /SH
</remark>
+
+
+
<remark>
Also, I'd suggest to give an example or two for "enhanced
functionality" because otherwise this sounds like marketing buzz.
:-) /SH
</remark>
+
+
+
<remark>
Might also make sense to point out that all tools (including those
"additional tools and utilities" are either XSLT or Perl.
@@ -214,9 +227,22 @@
</row>
<row>
<entry><filename>xsl.d</filename></entry>
- <entry>The standard DocBook XSL templates <remark>Hm, I think we shold say "stylesheets". /SH</remark> and the custom extensions and
- improvements used specifically for the MySQL
- documentation. <remark>May be worth noting that we haven't changed the standard XSL stylesheets in any way (like so many others have, and have regretted), but rather we've *added* new stuff that, in some cases, modifies the behaviour of the standard XSL stylesheets. /SH</remark></entry>
+ <entry>The standard DocBook XSL templates
+
+ <remark>
+ Hm, I think we shold say "stylesheets". /SH
+ </remark>
+
+ and the custom extensions and improvements used
+ specifically for the MySQL documentation.
+
+ <remark>
+ May be worth noting that we haven't changed the standard
+ XSL stylesheets in any way (like so many others have,
+ and have regretted), but rather we've *added* new stuff
+ that, in some cases, modifies the behaviour of the
+ standard XSL stylesheets. /SH
+ </remark></entry>
</row>
</tbody>
</tgroup>
@@ -230,7 +256,12 @@
definitions (including some common files), and the graphics files
used for illustrations and screenshots. In each case, there is
typically only one document target in each directory, but each
- document can be translated into any one of the desired formats. <remark>I don't understand the last sentence; can you elaborate or give an example?</remark>
+ document can be translated into any one of the desired formats.
+
+ <remark>
+ I don't understand the last sentence; can you elaborate or give
+ an example?
+ </remark>
</para>
<table id="mysqldoc-guide-overview-dirent-docs">
@@ -247,7 +278,11 @@
<tbody>
<row>
<entry><filename>administrator</filename></entry>
- <entry>The files specific to the MySQL Administrator guide. <remark>Can we stick to "manual" or "documentation"? /SH</remark></entry>
+ <entry>The files specific to the MySQL Administrator guide.
+
+ <remark>
+ Can we stick to "manual" or "documentation"? /SH
+ </remark></entry>
</row>
<row>
<entry><filename>arbitrary</filename></entry>
@@ -299,7 +334,11 @@
</row>
<row>
<entry><filename>mysqltest</filename></entry>
- <entry>The documentation for the <literal>mysqltest</literal> tool. <remark>This is not a tool but a framework. /SH</remark></entry>
+ <entry>The documentation for the <literal>mysqltest</literal> tool.
+
+ <remark>
+ This is not a tool but a framework. /SH
+ </remark></entry>
</row>
<row>
<entry><filename>ndbapi</filename></entry>
@@ -343,8 +382,22 @@
<para>
To build and work with the documentation, you will need to install
- some additional tools. <remark>I added: All required software programs are either open source software or freeware.</remark> The exact list of tools required will
- depend on what you plan to do with the documentation. <remark>We should also mention a few text editors; I'd suggest to mention jEdit (platform-independent), kate (Linux), and Notepad++ (Windows). All of them are open source and are know to work well with Unicode and Unix line endings. /SH</remark>
+ some additional tools.
+
+ <remark>
+ I added: All required software programs are either open source
+ software or freeware.
+ </remark>
+
+ The exact list of tools required will depend on what you plan to
+ do with the documentation.
+
+ <remark>
+ We should also mention a few text editors; I'd suggest to
+ mention jEdit (platform-independent), kate (Linux), and
+ Notepad++ (Windows). All of them are open source and are know to
+ work well with Unicode and Unix line endings. /SH
+ </remark>
</para>
<para>
@@ -356,10 +409,15 @@
<listitem>
<para>
<emphasis role="bold">make</emphasis> — you will need a
- standard <command>make</command> tool, either the one provided with your
- operating system, or preferably GNU <command>make</command> are the best
- solutions.
- <remark>On Windows there's no make. Is there on Powershell? If so, let's give a hint where to get Powershell. If there isn't, let's close our eyes and recommend Cygwin. .-) /SH</remark>
+ standard <command>make</command> tool, either the one provided
+ with your operating system, or preferably GNU
+ <command>make</command> are the best solutions.
+
+ <remark>
+ On Windows there's no make. Is there on Powershell? If so,
+ let's give a hint where to get Powershell. If there isn't,
+ let's close our eyes and recommend Cygwin. .-) /SH
+ </remark>
</para>
</listitem>
@@ -392,12 +450,21 @@
If you want to build PDF versions of the MySQL documentation, you
need to install a suitable Java Runtime (v1.5 is recommended) and
the Apache FOP tool
- (<ulink url="http://xmlgraphics.apache.org/fop/"/>). <remark role="update">Needs to be updated when we recommend a newer fop version.</remark> Currently we
- only recommend FOP 0.20.5.
+ (<ulink url="http://xmlgraphics.apache.org/fop/"/>).
+
+ <remark role="update">
+ Needs to be updated when we recommend a newer fop version.
+ </remark>
+
+ Currently we only recommend FOP 0.20.5.
</para>
-
- <remark>If we're going into a bit of detail regarding FOP installation, shouldn't we also mention that you need JIMI? Otherwise, they can only create PDF without images. /SH</remark>
+ <remark>
+ If we're going into a bit of detail regarding FOP installation,
+ shouldn't we also mention that you need JIMI? Otherwise, they can
+ only create PDF without images. /SH
+ </remark>
+
<para>
When installing FOP under Unix/Linux/Mac OS X, install the package
into a directory and then create a link to the
@@ -418,9 +485,10 @@
<programlisting>shell> <userinput>JAVACMD -Xmx2048m -classpath "$LOCALCLASSPATH" $FOP_OPTS org.apache.fop.apps.Fop "$@"</userinput></programlisting>
<para>
- Zum Erzeugen von CHM (kompiliertes HTML) wird Windows benötigt. Außerdem muss das Toolkit HTML Workshop von Micrsoft
+ If you want to build CHM (Compiled HTML) documents then you must
+ use Windows and install the HTML Workshop toolkit from Micrsoft
(<ulink
- url="http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc"/> installiert werden.
+ url="http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc"/>.
</para>
</section>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r6002 - trunk/mysqldoc-guide | stefan | 19 Apr |
