Skip navigation links

The world's most popular open source database

Login | Register

Developer Zone
Downloads
Documentation

MySQL Server
MySQL Enterprise
MySQL Workbench
MySQL Cluster
MySQL Connectors
Topic Guides
Expert Guides
Other Docs
Archives
About

Documentation Library
- Table of Contents

Search manual:

MySQL Guide to MySQL Documentation

1 MySQL Documentation Overview »

Section Navigation [Toggle]

MySQL Guide to MySQL Documentation

MySQL Guide to MySQL Documentation

Abstract

This document describes the machinery, format, and operation of the MySQL documentation.

For legal information, see the Legal Notice.

Document generated on: 2014-04-03 (revision: 38312)

Table of Contents [+/-]

1 MySQL Documentation Overview [+/-]

1.1 Documentation Repositories and Directory Structure
1.2 Tools Required

2 Building Documentation Formats [+/-]

2.1 How to Build Documentation

2.2 How Different Formats are Built [+/-]

2.2.1 How HTML is Produced
2.2.2 How HTML Packages are Produced
2.2.3 How Eclipse Packages are Produced
2.2.4 How PDFs are Produced
2.2.5 How Texinfo/Info is Produced

2.3 Other Build Targets

3 Documentation Tools [+/-]

3.1 Deep Checker

3.2 ID Mapping System

3.3 Arbitrary Documentation [+/-]

3.3.1 Writing Arby XML
3.3.2 Writing an Arby Template
3.3.3 Building an Arby Document

4 Conventions for Writing Proper DocBook XML (“Formatting Guide”) [+/-]

4.1 Introduction to DocBook

4.2 Document-Writing Conventions

4.3 How to Begin a New Document

4.4 General Document Organization [+/-]

4.4.1 Partitioning Document Content into Multiple Files
4.4.2 Referring to Files in Other Directories
4.4.3 Content of Chapter Files
4.4.4 Entities and Entity Files

4.5 IDs Within a Document

4.6 Links (or References) Within a Document

4.8 DocBook Elements We Use [+/-]

4.9 Using DocBook Elements That We Have Not Used Before

4.10 File Names and Guidelines for Graphics

4.11 Special Markup [+/-]

4.11.1 Markup for Unix Man Pages
4.11.2 Help Tag Markup
4.11.3 Markup for Automatic Link Generation
4.11.4 Debugging Failed Automatic Link Generation

5 Conventions for Writing and Editing MySQL Documentation (“Styleguide”) [+/-]

5.1 Guidelines on Grammar and Style

5.2 Principles and Miscellaneous

5.3 Guidelines for Numbering

5.4 Guidelines for Capitalization of Terms

5.5 Guidelines for Using Denominations [+/-]

5.5.1 Denominations in General
5.5.2 Denominations With Regards to Collations

5.6 Guidelines on Spelling

5.7 Guidelines for GUI Documentation

A Legal Notices

Copyright © 2007, 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices

Top / Next / Table of Contents

Developer Zone
Documentation
Developer Articles
Forums
Lists
Bugs
Worklog
Planet MySQL
Labs

Downloads
MySQL Community Server
MySQL Proxy
MySQL Cluster
MySQL Workbench
MySQL Connectors
Archives

Documentation
MySQL Reference Manuals
MySQL Workbench
Expert Guides
Topic Guides
MySQL Cluster
Other Documents
About
Archives

About MySQL
Contact Us
How to Buy
Partners
Job Opportunities
Site Map

Legal
Legal Policies
Your Privacy Rights
Terms of Use
Trademark Policy
Contributor Agreement

© 2014, Oracle Corporation and/or its affiliates