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: Hiding things (was RE: Optimizing OnlineHelp for Mobile Viewing)
Subject:Re: Hiding things (was RE: Optimizing OnlineHelp for Mobile Viewing) From:Robert Lauriston <robert -at- lauriston -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Wed, 3 Aug 2011 14:04:30 -0700
Most of the API references I've done in the past ten years have been
generated from comments in the source using javadoc, Doc++, Doxygen,
Document! X, or the like.
Any HAT that can generate PDFs ought to be able to dump all API topics
into a single HTML file, though if your API reference has thousands of
topics that might be a bad idea.
On Wed, Aug 3, 2011 at 1:17 PM, Ruth Sessions
<ruthsessions03051 -at- yahoo -dot- com> wrote:
> Robert:
>
> Actually, I've received complaints from some technical customers (for SDKs)
> about being forced to click with the mouse too often in Help files.
>
> One such techie suggested we use a continuous scrolling approach. I'm not sure
> if everyone would like it this solution for reference Help, but it fulfills his request:
> Put all APIs in a single topic and link from the contents to a subheading for each API.
> The customer can then click OR scroll to select a particular API.
>
> Or some HATs might have features to arrange the APIs that way even after you put
> each in its own topic. Ideally, the option should be available.
>
> Do you think such a result could be achieved using RoboHelp, AuthorIT, or another
> HAT you have experience with?
>
> Ruth
>
> ------------------------------------------------------------
> Ruth Sessions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create and publish documentation through multiple channels with Doc-To-Help.
Choose your authoring formats and get any output you may need. Try
Doc-To-Help, now with MS SharePoint integration, free for 30-days. http://www.doctohelp.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
