Skip navigation links
MySQL Guide to MySQL Documentation :: Chapter 4. Conventions for Writing Proper DocBook XML (“Formatting Guide”)
4.1 Introduction to DocBook »
Section Navigation      [Toggle]

Chapter 4. Conventions for Writing Proper DocBook XML (“Formatting Guide”)

Table of Contents     [+/-]

4.1. Introduction to DocBook
4.2. Document-Writing Conventions
4.3. How to Begin a New Document
4.4. General Document Organization     [+/-]
4.5. IDs Within a Document
4.6. Links (or References) Within a Document
4.7. Quotes
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     [+/-]

This chapter provides guidelines for writing MySQL documents using DocBook:

  • Introduction to DocBook

  • General document-writing conventions

  • How to begin a new document

  • How to structure a DocBook document

  • Which DocBook XML elements should be used for which purpose

  • How to use IDs, links, and quotation marks

  • What to do when you begin using a DocBook element that we have not been using before

  • Graphics markup and special markup

A few basic hints for editing before we start:

  • UTF-8: Make sure your editor uses UTF-8 encoding.

  • Spaces, not tabs: Use spaces, not tabs. Use 2 spaces to indent.

  • Unix line endings: Make sure your editor saves your edits using Unix-style line endings (LF), rather than Windows-style (CR/LF) or Mac OS-style (CR) line endings.

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