Pro PHP- Patterns, Frameworks, Testing and More

CHAPTER 6 ■ DOCUMENTATION AND CODING CONVENTIONS^67

Reissuing the xsltproc command will work exactly as before, and the chapter1.xml file will

be included.

Using DocBook Elements.

The previous examples demonstrated using the elements for DocBook chapters, sections,

and paragraphs. You can use many more elements to create comprehensive documentation.

Here, we’ll look at the more commonly used elements. For detailed information, see http://

http://www.docbook.org and http://docbook.sourceforge.net.

The bookinfo Element

In Listing 6-6, you can see a bookinfo element that includes title and subtitle tags. The bookinfo

element may include many more tags to give your documentation more detail. Listing 6-8 shows

some of the more common bookinfo tags.

Listing 6-8. DocBook bookinfo Tags

<bookinfo>

<title>A title</title>

<subtitle>A subtitle</subtitle>

<authorgroup>

<author>

<firstname>Kevin</firstname>

<surname>McArthur</surname>

</author>

<corpauthor>Somecorporation Inc.</corpauthor>

</authorgroup>

<editor>

<firstname>Joe</firstname>

<surname>Somebody</surname>

</editor>

<date>

Jan 1, 1970

</date>

<copyright>

<year>2006</year>

<holder>Somecorporation Inc.</holder>

</copyright>

</bookinfo>

The chapter Element

The next thing in a book is a chapter. Listing 6-9 shows a basic chapter element.

McArthur_819-9C06.fm Page 67 Friday, February 22, 2008 8:59 AM