Author: shinz
Date: 2007-11-26 17:45:50 +0100 (Mon, 26 Nov 2007)
New Revision: 8885
Log:
Completed review of mysqldoc-guide overview, added more words and terms to dictionaries
Modified:
trunk/dicts/en.additional
trunk/dicts/en.terms
trunk/mysqldoc-guide/overview.xml
Modified: trunk/dicts/en.additional
===================================================================
--- trunk/dicts/en.additional 2007-11-26 15:30:17 UTC (rev 8884)
+++ trunk/dicts/en.additional 2007-11-26 16:45:50 UTC (rev 8885)
Changed blocks: 1, Lines Added: 166, Lines Deleted: 166; 4920 bytes
@@ -1615,170 +1615,170 @@
screenshots
targets
downloadable
- stylesheets
- referring
- stylesheet
+stylesheets
+referring
+stylesheet
URLs
- subsections
- hyphens
- listings
- sentences
- tags
- Denominations
- capitals
- disambiguate
- endings
- entities
- figures
- packaged
- parens
- titles
- Figures
- Footnotes
- capitalized
- checkbox
- dashes
- developed
- footnotes
- multi
- optimize
- publishers
- referencing
- remapped
- scenes
- sheets
- spelled
- subroutine
- validated
- validating
- Parses
- Posix-like
- Precambrian
- Prepositions
- Principles
- Styleguide
- Stylesheet
- Subselect
- Titles
- authentify
- authorize
- automatically
- awaited
- boldface
- bugfix
- center
- checkboxes
- clickable
- colons
- commenting
- compresses
- conjunctions
- constructors
- contructs
- conversly
- corrections
- corresponding
- customizations
- datafile
- datatype
- declarations
- denominations
- deprecated
- directives
- discussing
- distributing
- documenters
- dots
- dynamically
- editor's
- element's
- emoticons
- enables
- ensuring
- enumerated
- equivalents
- following
- fulltext
- gigabytes
- gigahertz
- greyed
- hotspot
- hyperlinks
- hyperventilating
- implies
- indenting
- indidicates
- influenced
- initials
- intervening
- italic
- lettercase
- margins
- materials
- merges
- monospaced
- multi-thread
- multibyte
- multiple-CPU
- multithread
- naturalized
- nesting
- newsgroup
- nouns
- numerals
- onscreen
- oranges
- organizing
- outputting
- overrules
- owned
- paragraphs
- parents
- parses
- placeholder
- placeholders
- placing
- posed
- pre-Columbian
- pre-amble
- precedes
- prefers
- prepends
- prepositions
- principles
- prioritization
- producing
- publicly
- questionnaires
- reader's
- readers
- rebuilds
- reduces
- reformat
- registers
- reintroduced
- relates
- relies
- remapper
- rendered
- reproducing
- reveals
- rewriting
- roots
- schemas
- single-CPU
- singluar
- sloppier
- sourcefile
- stages
- staticly
- subfunction
- submenu
- suited
- syntaxes
- toolset
- transforms
- translates
- typos
- validates
- webpage
+subsections
+hyphens
+listings
+sentences
+tags
+Denominations
+capitals
+disambiguate
+endings
+entities
+figures
+packaged
+parens
+titles
+Figures
+Footnotes
+capitalized
+checkbox
+dashes
+developed
+footnotes
+multi
+optimize
+publishers
+referencing
+remapped
+scenes
+sheets
+spelled
+subroutine
+validated
+validating
+Parses
+Posix-like
+Precambrian
+Prepositions
+Principles
+Styleguide
+Stylesheet
+Subselect
+Titles
+authentify
+authorize
+automatically
+awaited
+boldface
+bugfix
+center
+checkboxes
+clickable
+colons
+commenting
+compresses
+conjunctions
+constructors
+contructs
+conversly
+corrections
+corresponding
+customizations
+datafile
+datatype
+declarations
+denominations
+deprecated
+directives
+discussing
+distributing
+documenters
+dots
+dynamically
+editor's
+element's
+emoticons
+enables
+ensuring
+enumerated
+equivalents
+following
+fulltext
+gigabytes
+gigahertz
+greyed
+hotspot
+hyperlinks
+hyperventilating
+implies
+indenting
+indidicates
+influenced
+initials
+intervening
+italic
+lettercase
+margins
+materials
+merges
+monospaced
+multi-thread
+multibyte
+multiple-CPU
+multithread
+naturalized
+nesting
+newsgroup
+nouns
+numerals
+onscreen
+oranges
+organizing
+outputting
+overrules
+owned
+paragraphs
+parents
+parses
+placeholder
+placeholders
+placing
+posed
+pre-Columbian
+pre-amble
+precedes
+prefers
+prepends
+prepositions
+principles
+prioritization
+producing
+publicly
+questionnaires
+reader's
+readers
+rebuilds
+reduces
+reformat
+registers
+reintroduced
+relates
+relies
+remapper
+rendered
+reproducing
+reveals
+rewriting
+roots
+schemas
+single-CPU
+singluar
+sloppier
+sourcefile
+stages
+staticly
+subfunction
+submenu
+suited
+syntaxes
+toolset
+transforms
+translates
+typos
+validates
+webpage
\ No newline at end of file
Modified: trunk/dicts/en.terms
===================================================================
--- trunk/dicts/en.terms 2007-11-26 15:30:17 UTC (rev 8884)
+++ trunk/dicts/en.terms 2007-11-26 16:45:50 UTC (rev 8885)
Changed blocks: 1, Lines Added: 81, Lines Deleted: 82; 2117 bytes
@@ -702,85 +702,84 @@
XSL
xmllint
xsltproc
- FO
- Pearson
- Arby
- CSS
- UCA
- imageobject
- prepped
- OK
- XSLT
- allkeys
- quandaset
- txt
- CLI
- CR
- DTD
- LF
- LL
- O'Reilly
- column1
- indexterm
- mediaobject
- ok
- orderedlist
- rowid
- tbody
- tgroup
- DBMS
- Emacs
- GB
- GHz
- GZip
- HEBREW
- HTMLHelp
- IEC
- KB
- MHz
- Megahertz
- Netware
- PDFs
- ROWID
- SORTKEY
- SUBKEY
- SVN
- Styleguide
- Stylesheet
- Subselect
- TB
- TOC
- Tex
- UK
- UNIX
- Unix-style
- colspec
- deepcheck
- fulltext
- gigabytes
- gigahertz
- guibutton
- guilabel
- guimenu
- htmlhelp
- idvalidate
- imagedata
- informaltable
- keycap
- kilobytes
- makeinfo
- megabits
- org
- programlisting
- qandaentry
- quandaentry
- sortkey
- stmt
- svn
- terabytes
- textobject
- ulink
- userinput
- weight_string
- xref
-
+FO
+Pearson
+Arby
+CSS
+UCA
+imageobject
+prepped
+OK
+XSLT
+allkeys
+quandaset
+txt
+CLI
+CR
+DTD
+LF
+LL
+O'Reilly
+column1
+indexterm
+mediaobject
+ok
+orderedlist
+rowid
+tbody
+tgroup
+DBMS
+Emacs
+GB
+GHz
+GZip
+HEBREW
+HTMLHelp
+IEC
+KB
+MHz
+Megahertz
+Netware
+PDFs
+ROWID
+SORTKEY
+SUBKEY
+SVN
+Styleguide
+Stylesheet
+Subselect
+TB
+TOC
+Tex
+UK
+UNIX
+Unix-style
+colspec
+deepcheck
+fulltext
+gigabytes
+gigahertz
+guibutton
+guilabel
+guimenu
+htmlhelp
+idvalidate
+imagedata
+informaltable
+keycap
+kilobytes
+makeinfo
+megabits
+org
+programlisting
+qandaentry
+quandaentry
+sortkey
+stmt
+svn
+terabytes
+textobject
+ulink
+userinput
+weight_string
+xref
\ No newline at end of file
Modified: trunk/mysqldoc-guide/overview.xml
===================================================================
--- trunk/mysqldoc-guide/overview.xml 2007-11-26 15:30:17 UTC (rev 8884)
+++ trunk/mysqldoc-guide/overview.xml 2007-11-26 16:45:50 UTC (rev 8885)
Changed blocks: 11, Lines Added: 88, Lines Deleted: 86; 13130 bytes
@@ -59,7 +59,7 @@
PDF in both A4 and Letter page sizes as a single document
</para>
</listitem>
-
+
<listitem>
<para>
Eclipse Documentation Plugin, which is essentially a repackaging
@@ -97,12 +97,11 @@
<para>
In addition to the standard DocBook XML source and transformations
- into these formats, we have built custom templates and
- translations to generate custom markup, and a number of
- tools and utilities that provide enhanced functionality.
- Note, though, that we have <emphasis>not</emphasis> modified the
- DocBook XML DTD. All our custom tools are written for either XSLT
- or Perl.
+ into these formats, we have built custom templates and translations
+ to generate custom markup, and a number of tools and utilities that
+ provide enhanced functionality. Note, though, that we have
+ <emphasis>not</emphasis> modified the DocBook XML DTD. All our
+ custom tools are written for either XSLT or Perl.
</para>
<section id="mysqldoc-guide-overview-dirent">
@@ -115,8 +114,8 @@
you will need to install Subversion
(<ulink url="http://subversion.tigris.org"/>). To just browse the
documentation tree for a first impression you can simply go to
- <ulink url="http://svn.mysql.com/svnpublic/mysqldoc"/> with a
- web browser.
+ <ulink url="http://svn.mysql.com/svnpublic/mysqldoc"/> with a web
+ browser.
</para>
<para>
@@ -130,7 +129,7 @@
<para>
The repository contains a combination of the actual documentation
source and the components and systems required to build the
- documentation, including tools for related tasks such as
+ documentation, including tools for related tasks such as
validating the XML or counting words.
</para>
@@ -147,14 +146,17 @@
</thead>
<tbody>
<row>
+ <entry><filename>dicts</filename></entry>
+ <entry>Dictionaries for the spell checker</entry>
+ </row>
+ <row>
<entry><filename>dtd.d</filename></entry>
<entry>The DocBook DTDs used to verify the structure of the DocBook XML</entry>
</row>
<row>
<entry><filename>make.d</filename></entry>
<entry>Makefile rules used to create specific targets and output formats in the
- documentation (examples: validation, HTML output)
- </entry>
+ documentation (examples: validation, HTML output)</entry>
</row>
<row>
<entry><filename>proto-doc</filename></entry>
@@ -164,17 +166,16 @@
<row>
<entry><filename>tools</filename></entry>
<entry>A series of scripts and other tools used to help build the
- documentation, including tools for related tasks such as validating
- </entry>
+ documentation, including tools for related tasks such as
+ validating</entry>
</row>
<row>
<entry><filename>xsl.d</filename></entry>
- <entry>The standard DocBook XSL style sheets
- and the custom extensions and improvements used
- specifically for the MySQL documentation.
- Note that we've modified neither the DocBook DTD nor the
- DocBook XSL style sheets, which enables us to update
- DocBook regularly.</entry>
+ <entry>The standard DocBook XSL style sheets and the custom extensions and
+ improvements used specifically for the MySQL
+ documentation. Note that we've modified neither the
+ DocBook DTD nor the DocBook XSL style sheets, which
+ enables us to update DocBook regularly.</entry>
</row>
</tbody>
</tgroup>
@@ -203,15 +204,15 @@
<tbody>
<row>
<entry><filename>administrator</filename></entry>
- <entry>The files specific to the MySQL Administrator manual</entry>
+ <entry>Files specific to the MySQL Administrator manual</entry>
</row>
<row>
<entry><filename>arbitrary</filename></entry>
- <entry>The directory which holds specifications for arbitrary documentation</entry>
+ <entry>Directory which holds specifications for arbitrary documentation</entry>
</row>
<row>
<entry><filename>common</filename></entry>
- <entry>Files common to all documents.</entry>
+ <entry>Files common to all documents</entry>
</row>
<row>
<entry><filename>dynamic-docs</filename></entry>
@@ -222,73 +223,88 @@
</row>
<row>
<entry><filename>falcon</filename></entry>
- <entry>Falcon documentation guide.</entry>
+ <entry>Falcon manual</entry>
</row>
<row>
- <entry><filename>gui-common</filename></entry>
- <entry>Files common to all of the GUI tools.</entry>
- </row>
- <row>
<entry><filename>guibook</filename></entry>
- <entry>The GUI book which bonds together the content from all the GUI tools
- into a single book.</entry>
+ <entry>The GUI book which bonds together the content from all the GUI tool
+ manuals into a single book</entry>
</row>
<row>
- <entry><filename>illustrations</filename></entry>
- <entry>Source files for illustrations in various parts of the documentation.
- Illustrations are exported to PNG graphics files and then
- referenced directly into the DocBook XML source.</entry>
+ <entry><filename>gui-common</filename></entry>
+ <entry>Files common to all of the GUI tool documentation</entry>
</row>
<row>
<entry><filename>internals</filename></entry>
- <entry>MySQL internals manual.</entry>
+ <entry>MySQL internals manual</entry>
</row>
<row>
<entry><filename>migration-toolkit</filename></entry>
- <entry>The source of the Migration Toolkit GUI tool manual.</entry>
+ <entry>Migration Toolkit GUI tool manual</entry>
</row>
<row>
+ <entry><filename>mysqldoc-guide</filename></entry>
+ <entry>This guide</entry>
+ </row>
+ <row>
+ <entry><filename>mysqlqb</filename></entry>
+ <entry>Specially marked-up version of MySQL Manual chapters for MySQL Query
+ Browser</entry>
+ </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>Documentation for the <literal>mysqltest</literal> framework</entry>
</row>
<row>
<entry><filename>ndbapi</filename></entry>
- <entry>The Cluster/NDB API documentation.</entry>
+ <entry>Cluster/NDB API documentation</entry>
</row>
<row>
<entry><filename>query-browser</filename></entry>
- <entry>The source for the MySQL Query Browser.</entry>
+ <entry>MySQL Query Browser manual</entry>
</row>
<row>
+ <entry><filename>quick-guides</filename></entry>
+ <entry>Quick references for inclusion in the MySQL Manual</entry>
+ </row>
+ <row>
<entry><filename>refman-<replaceable>#.#</replaceable></filename></entry>
- <entry>The source for documentation specific to different major versions of
- MySQL. The documentation here is augmented by the contents
- of <filename>refman-common</filename>.</entry>
+ <entry>DocBook XML source for documentation specific to different major
+ versions of MySQL. The documentation here is augmented by
+ the contents of <filename>refman-common</filename> and
+ other files</entry>
</row>
<row>
<entry><filename>refman-common</filename></entry>
<entry>Documentation common to all the reference manuals. This directory
contains elements such as the documentation for MySQL
- connectors, graphics common to all versions and chapters
- and appendices that appear in all versions of the
- reference manual.</entry>
+ Connectors, graphics common to all versions, and chapters
+ and appendices that appear in all versions of the MySQL
+ Reference Manual</entry>
</row>
<row>
+ <entry><filename>sample-data</filename></entry>
+ <entry>Sample databases used in various parts of the documentation</entry>
+ </row>
+ <row>
<entry><filename>userguide</filename></entry>
- <entry>The MySQL User Guide source files.</entry>
+ <entry>MySQL User Guide files</entry>
</row>
<row>
<entry><filename>workbench</filename></entry>
- <entry>The source for the MySQL Workbench GUI tool.</entry>
+ <entry>MySQL Workbench GUI manual</entry>
</row>
</tbody>
</tgroup>
</table>
+ <para>
+ Additionally, there are a few directories for translation
+ purposes. These can be considered experimental at this point, and
+ might or might not be moved to language-specific repositories
+ soon.
+ </para>
+
</section>
<section id="mysqldoc-guide-overview-toolsreq">
@@ -297,22 +313,10 @@
<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, all of which are open source software with
+ the exception of Microsoft Help Workshop (which is free but not
+ open source). The exact list of tools required will depend on what
+ you plan to do with the documentation.
</para>
<para>
@@ -323,16 +327,18 @@
<listitem>
<para>
+ A text editor capable of handling plain-text files. We use a
+ variety of editors, for example Oxygen (a commercial product),
+ vi, kate, jEdit, or Notepad++.
+ </para>
+
+ <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>
+ <command>make</command>. On Windows, this might require you to
+ install Cygwin or a similar Unix emulator that has
+ <command>make</command> support.
</para>
</listitem>
@@ -365,21 +371,17 @@
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/"/>).
+ (<ulink url="http://xmlgraphics.apache.org/fop/"/>). At the time
+ of writing this (December 2007) we recommend FOP 0.20.5.
+ </para>
- <remark role="update">
- Needs to be updated when we recommend a newer fop version.
- </remark>
-
- Currently we only recommend FOP 0.20.5.
+ <para>
+ For image support in PDF files you'll have to install a library
+ such as <literal>Jimi</literal> or <literal>JAI</literal>. JAI is
+ available from <ulink url="http://java.sun.com"/>. Jimi is
+ available from <ulink url="http://java.sun.com/products/jimi/"/>.
</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>
-
<para>
When installing FOP under Unix/Linux/Mac OS X, install the package
into a directory and then create a link to the
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r8885 - in trunk: dicts mysqldoc-guide | stefan | 26 Nov |
