Re: Creating a Cocoa Help Book
Re: Creating a Cocoa Help Book
- Subject: Re: Creating a Cocoa Help Book
- From: todd ransom <email@hidden>
- Date: Tue, 29 Mar 2005 23:34:44 -0700
I believe the help viewer in 10.3 supports CSS1 at least.
I would recommend hand-coding your HTML. I ran into a world of problems
because of headers my HTML editor inserted that I never thought twice
about but the Help Indexing Tool does not support. Do not use any HTML
headers other than the ones mentioned in Apple's documentation for the
help viewer.
You could generate HTML from another source, but I bet you will end up
tweaking either the generator or the generated HTML to remove some of
the cruft.
good luck,
TR
On Mar 29, 2005, at 7:12 PM, Jose Antonio Ortega wrote:
Hello.
I'm developing a shareware Cocoa application, still in early stage. I
already have a well defined toolchain for all aspects of the product
lifecycle but one: the creation of the program's help book.
Creating good documentation is, IMHO, a must for our project, and I
would appreciate any advice on what editors and other tools are your
preferred ones. Do you write directly HTML, or use some kind of
documentation system like LaTeX or DocBook? Sophisticated HTML editors
seem a bit overkill, since Cocoa Help does not support CSS or
JavaScript (please, correct me if I am wrong); and there's also the
point that we'd like to have a nice, printable PDF manual in addition
to the online help (preferably derived from the some sources).
On the other hand, editors like Word or Pages seem also out of the
question, for we would have little control on the generated HTML and
(for Word) a binary, proprietary format precludes efficient versioning
and concurrent writing. Not to mention that Word gives me the shivers!
:-)
All things considered, right now I lean to LaTeX, but I am asking
because I've got the (possibly wrong) impression that it is not a
popular choice among you seasoned Mac developers.
Thanks for your time, and please feel free to send me RTFM if I'm
missing some obvious resource.
Cheers,
José Antonio.
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden