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-

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/archive%40web.techwr-l.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


References:
Re: Hiding things (was RE: Optimizing OnlineHelp for Mobile Viewing): From: Ed Marsh
Re: Hiding things (was RE: Optimizing OnlineHelp for Mobile Viewing): From: Ruth Sessions

Previous by Author: Re: Wiki for Customer Facing documentation?
Next by Author: Re: editing javadoc comments
Previous by Thread: Re: Hiding things (was RE: Optimizing OnlineHelp for Mobile Viewing)
Next by Thread: Wiki for Customer Facing documentation?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads