Re: HeaderDoc 8.0 issue
Re: HeaderDoc 8.0 issue
- Subject: Re: HeaderDoc 8.0 issue
- From: Bill Cheeseman <email@hidden>
- Date: Fri, 09 Jul 2004 09:07:51 -0400
on 2004-07-09 7:18 AM, Bill Cheeseman at email@hidden wrote:
>
HeaderDoc 8.0 produces lovely class documentation for Objective-C. (8.0
>
appeared unannounced on the Apple Darwin site within the last couple of
>
weeks.)
>
>
But the index of all methods is missing from the generated MasterTOC.html
>
page. This is a serious issue, because it means a reader cannot scan the
>
list of all methods to zero in on the one desired.
By trial and error based on the pretty darn good HeaderDoc 8.0
documentation, I figured out how to set up a custom Contents page that does
what I want. Apparently, HeaderDoc 8.0 out of the box uses a built-in html
template that contains only a list of headers and classes. I'm a little
surprised that there isn't a more complete standardized TOC template, since
it would have given users a better initial experience of HeaderDoc 8.0.
Judging by the documentation, there are several ways to build your own
custom Contents page, but here's what works for me:
The HeaderDoc 8.0 Contents page is template based. To force HeaderDoc 8.0 to
use your custom Contents template, do the following:
1. Create a text file named "com.apple.headerDoc2HTML.config" and place it
in ~/Library/Preferences. The text file should contain the following line:
TOCTemplateFile =>
/Users/cheeseb/Library/Preferences/HeaderDocTOCTemplate.html
Change "cheeseb" to your user name, of course; set the path to whatever you
find convenient; and set the name of the html file to anything you like. By
experimentation, I found that you must provide a full path;
"~/Library/Preferences/HeaderDocTOCTemplate.html" won't work. I also found
that the file name cannot contain spaces; quoting it or escaping spaces
won't work.
2. Drag a copy of the "exampletoctemplate.html" file that comes in the
HeaderDoc 8.0 release folder into your ~/Library/Preferences folder (or
whatever path you specified in step 1) and rename it to
"HeaderDocTOCTemplate.html" (or whatever you named it in the config file in
step 1).
3. Run the standard headerDoc2HTML.pl and gatherHeaderDoc.pl scripts as
usual, and you'll see a nice Contents page for your HeaderDoc documentation.
The "exampletoctemplate.html" file does not create a complete Contents page.
You'll want to tinker with it to come up with something useful. The
HeaderDoc 8.0 documentation contains a complete list of special tags for
adding various names, lists, and so on.
I now pronounce HeaderDoc 8.0 a success. Thank you for your patience.
--
Bill Cheeseman - email@hidden
Quechee Software, Quechee, Vermont, USA
http://www.quecheesoftware.com
The AppleScript Sourcebook -
http://www.AppleScriptSourcebook.com
Vermont Recipes -
http://www.stepwise.com/Articles/VermontRecipes
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives:
http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.