MySQL Guide to MySQL Documentation :: 4 Conventions for Writing Proper DocBook XML (“Formatting
Guide”) :: 4.8 DocBook Elements We Use :: 4.8.29 programlisting
Section Navigation [Toggle]
- 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
Used for SQL examples and other code listings.
In the output created from the XML (HTML, PDF, CHM, and so
forth), everything between
<programlisting> and
</programlisting> is displayed literally.
When you indent a program listing the indentation also shows
literally.
Within programlisting elements, make sure
that code lines do not run longer than 72 characters. Code lines
should be indented using spaces, not tabs.
