TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Re: RoboHelp: Ready to Publish...how do I do that?
Subject:Re: RoboHelp: Ready to Publish...how do I do that? From:Robert Lauriston <robert -at- lauriston -dot- com> To:ASK TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 14 Jan 2010 11:38:00 -0800
Per the META tags in the HTML, that's being generated by WebWorks Pro.
It's not standard Webhelp output, looks like somebody created a
template to create javadoc-style API reference for some C functions.
Typically such things are generated by pulling comments out of the
source code.
The WebWorks documentation explains (more or less) how to distribute
that with search, TOC, and index tabs, should you want to do that.
I don't think developers would expect or want to get an API reference
like that in a .chm. Neither would I assume that those developers are
running Windows.
On Thu, Jan 14, 2010 at 11:21 AM, Missy Smith <techpubsmistress -at- live -dot- com> wrote:
>
> Here is a link to the webpage that displays the same "index.htm" as is in the zip file. http://www.rabbit.com/documentation/docs/manuals/DynCFunctionReference/index.htm
>
>
>
>
>
>> Date: Thu, 14 Jan 2010 11:09:32 -0800
>> Subject: Re: RoboHelp: Ready to Publish...how do I do that?
>> From: robert -at- lauriston -dot- com
>> To: techwr-l -at- lists -dot- techwr-l -dot- com
>>
>> A .chm generally has to be downloaded to the local hard drive. And it
>> won't work on non-Windows platforms.
>>
>> On Thu, Jan 14, 2010 at 11:04 AM, Missy Smith <techpubsmistress -at- live -dot- com> wrote:
>> >
>> > The help system is actually a user manual. No software application.
>> >
>> > Currently they post three links per manual on the website: a pdf, a zip file that contains html and image files, and the html system.
>> >
>> > Do you have to save a chm to a specific place? Will it not run from anywhere?
>> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>>
>> Are you looking for one documentation tool that does it all? Author,
>> build, test, and publish your Help files with just one easy-to-use tool.
>> Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
>> http://www.doctohelp.com/
>>
>> Explore CAREER options and paths related to Technical Writing,
>> learn to create SOFTWARE REQUIREMENTS documents, and
>> get tips on FUNCTIONAL SPECIFICATION best practices. Free at:
>> http://www.ModernAnalyst.com
>>
>> ---
>> You are currently subscribed to TECHWR-L as techpubsmistress -at- live -dot- com -dot-
>>
>> To unsubscribe send a blank email to
>> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
>> or visit http://lists.techwr-l.com/mailman/options/techwr-l/techpubsmistress%40live.com
>>
>>
>> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>>
>> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>> http://www.techwr-l.com/ for more resources and info.
>>
>> Please move off-topic discussions to the Chat list, at:
>> http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>>
>
> _________________________________________________________________
> Hotmail: Trusted email with powerful SPAM protection.
>http://clk.atdmt.com/GBL/go/196390707/direct/01/
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> Are you looking for one documentation tool that does it all? Author,
> build, test, and publish your Help files with just one easy-to-use tool.
> Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at:
>http://www.doctohelp.com/
>
> Explore CAREER options and paths related to Technical Writing,
> learn to create SOFTWARE REQUIREMENTS documents, and
> get tips on FUNCTIONAL SPECIFICATION best practices. Free at:
>http://www.ModernAnalyst.com
>
> ---
> You are currently subscribed to TECHWR-L as robert -at- lauriston -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/robert%40lauriston.com
>
>
> To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
>http://www.techwr-l.com/ for more resources and info.
>
> Please move off-topic discussions to the Chat list, at:
>http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat
>
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Are you looking for one documentation tool that does it all? Author,
build, test, and publish your Help files with just one easy-to-use tool.
Try the latest Doc-To-Help 2009 v3 risk-free for 30-days at: http://www.doctohelp.com/
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
