MySQL Guide to MySQL Documentation  /  MySQL Documentation Overview

Chapter 1 MySQL Documentation Overview

MySQL develops all of the documentation internally. This includes the various version-specific reference manuals, the documentation for the GUI tools such as MySQL Workbench, and specialized guides such as the NDB API Internals manual.

These manuals are provided in multiple formats and are accessible from the main MySQL Documentation page.

This guide provides information on the format, structure, and build processes that are used to develop and produce the documentation, and information on how you can build your own custom documentation using the publicly available Subversion repository. (Note, though, that publishing MySQL documentation is subject to the limitations stated in our legal notice.) It also contains a style guide on writing proper documentation, and a DocBook guide covering mark-up.

All of the MySQL documentation is written using the DocBook XML format. Using DocBook XML enables us to easily generate the documentation in a number of different output formats, including:

  • HTML, provided in both an online format and formatted, downloadable, packages. These are provided in either section-by-section, chapter-by-chapter, or single HTML formats

  • PDF in both A4 and Letter page sizes as a single document

  • Eclipse Documentation Plugin, which is essentially a repackaging of the HTML format

  • RPM, which is another repackaging of the HTML and PDF output

  • EPUB, which is a special kind of HTML used by (mostly) mobile screen readers

  • Unix Man pages

  • Texinfo for use within the Info file format browsers within Linux/Unix

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 not modified the DocBook XML DTD. All our custom tools are written for either XSLT or Perl.