MySQL Guide to MySQL Documentation  /  MySQL Documentation Overview  /  Documentation Repositories and Directory Structure

1.1 Documentation Repositories and Directory Structure

The documentation tools are in the mysqldoc-toolset repository. This repository can be downloaded in tgz (tarred zip) format from http://dev.mysql.com/doc/index-other.html.

The repository contains components and systems required to build documentation, including tools for related tasks such as validating the XML or counting words.

Table 1.1 Core Directories in mysqldoc-toolset

DirectoryDescription
dictsDictionaries for the spell checker
dtd.dThe DocBook DTDs used to verify the structure of the DocBook XML
make.dMakefile rules used to create specific targets and output formats in the documentation (examples: validation, HTML output)
toolsA series of scripts and other tools used to help build the documentation, including tools for related tasks such as validating
xsl.dThe 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.

The remaining directories hold the documentation itself, either in DocBook XML format or in a format that can be built and translated into DocBook XML for publishing. These directories also contain any additional files required for the document, such as the entity definitions (including some common files), and the graphics files used for illustrations and screenshots.