- 1 MySQL Documentation Overview
- 2 Building Documentation Formats
- 3 Documentation Tools
- 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.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
- 5 Conventions for Writing and Editing MySQL Documentation (“Styleguide”)
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.8.1. answer
- 4.8.2. caution
- 4.8.3. colspec
- 4.8.4. command
- 4.8.5. email
- 4.8.6. emphasis
- 4.8.7. entry
- 4.8.8. figure
- 4.8.9. filename
- 4.8.10. graphic
- 4.8.11. guibutton
- 4.8.12. guilabel
- 4.8.13. guimenu
- 4.8.14. imagedata
- 4.8.15. imageobject
- 4.8.16. indexterm
- 4.8.17. informaltable
- 4.8.18. itemizedlist
- 4.8.19. keycap
- 4.8.20. link
- 4.8.21. listitem
- 4.8.22. literal
- 4.8.23. mediaobject
- 4.8.24. option
- 4.8.25. orderedlist
- 4.8.26. para
- 4.8.27. phrase
- 4.8.28. primary
- 4.8.29. programlisting
- 4.8.30. qandaentry
- 4.8.31. quandaset
- 4.8.32. question
- 4.8.33. quote
- 4.8.34. remark
- 4.8.35. replaceable
- 4.8.36. row
- 4.8.37. secondary
- 4.8.38. tbody
- 4.8.39. tgroup
- 4.8.40. textobject
- 4.8.41. title
- 4.8.42. ulink
- 4.8.43. userinput
- 4.8.44. xref
- 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 quotes
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:
svn update: Update your copy of the SVN repository before you start editing files in that repository. That reduces the chance of having to do manual merges because of conflicts.
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.
