< Previous PageNext Page > |
You can set values for some commonly altered variables. Currently, the configuration file lets you set these things:
|
The path leading up to the current framework must be included manually in the htmlHeader or htmlHeaderFile directive. The breadcrumb is inserted wherever
|
appears in the htmlHeader or htmlHeaderFile content.
HeaderDoc looks in three places for values for these variables, in this order:
In the script itself (see the declaration of the %config hash near the top of headerDoc2HTML).
In the home directory of the user, in Library/Preferences/com.apple.headerDoc2HTML.config
In a file named headerDoc2HTML.config in the same folder as the script.
A variable can be assigned a value in any of these places, but only the last value read for a given variable will affect the output of a run of the script. If you are happy with the default values for these variables (as described above), you don't need to provide a configuration file. If you want to change just one or more values, provide a configuration file that declares just those values.
The format of the configuration file is this:
|
Listing 1-1 is an example of a very basic HeaderDoc configuration file. Several additional examples are included as part of the HeaderDoc distribution.
< Previous PageNext Page > |
© 1999, 2004 Apple Computer, Inc. All Rights Reserved. (Last updated: 2004-10-27)