Darwin HOWTO Template

Ron Hayden

Senior Tools Manager
Apple Technical Publications
Revision History
Revision 25 August 2004frd - [email protected]
Fixed link to XML version.


Provide an abstract giving context and purpose for the document...

This HOWTO provides a simple template for creating Darwin HOWTOs, using DocBook XML. Even if you don't author your HOWTO in XML, please follow something close to this layout.

This is the HTML output from the XML file. You can get the XML version of this file here.

If you think of something that should be added to this template, please email .

Table of Contents

Section 1
Section 2
Itemized list
Ordered list
Code listing

Section 1

This is a sect1 element in Docbook. You can have as many sect1s in your document as you wish, and each can have nested sub-sections.

Section 2

This is a sub-section, in this case a sect2 element. You can continue nesting as far as sect5.

Itemized list

Here is a typical list, using the itemizedlist element...

  • HeaderDoc

  • HowTo documents

  • man pages

Ordered list

Here is an ordered list, using the orderedlist element.

  1. HeaderDoc

  2. HowTo documents

  3. man pages

Code listing

Here is a code listing, using the programlisting element.

  @function HMBalloonRect
  @discussion Use HMBalloonRect to get information about the size of a help balloon before the Help Manager displays it.
  @param inMessage The help message for the help balloon. 
  @param outRect The coordinates of the rectangle that encloses the help message. The upper-left corner of the rectangle has the coordinates (0,0).
OSErr HMBalloonRect (const HMMessageRecord *inMessage, Rect *outRect);


To specify a URL that will be hot-linked in HTML output, use the ulink element. In general, it is good practice to display the entire URL for readers.

You can join the HeaderDoc mailing lists at