Re: HTML 5 web help versioning

Subject: Re: HTML 5 web help versioning
From: Hannah Drake <hannah -at- formulatrix -dot- com>
To: Robert Lauriston <robert -at- lauriston -dot- com>
Date: Wed, 19 Nov 2014 14:29:07 -0500

What we are planning on doing is have the software try to connect to the
Internet, and if it can't then pull the help file locally, so yes installed
software. Any additional thoughts?? Thanks, you have all been very helpful!

On Wednesday, November 19, 2014, Robert Lauriston <robert -at- lauriston -dot- com>
wrote:

> The FrameMaker URLs are the links in my first reply. The base URLs use
> the format /<language>/<product>/<version>:
>
> /en_US/FrameMaker/11.0/
>
> /en_US/FrameMaker/10.0/
>
> Local help installed with the product would use the same path, or you
> could drop local help and use only the web version. Or is this an
> installed product at all?
>
> On Wed, Nov 19, 2014 at 9:40 AM, Hannah Drake <hannah -at- formulatrix -dot- com
> <javascript:;>> wrote:
> > Thanks! I've actually never used FrameMaker. We are planning on using new
> > directories currently -- what are the FrameMaker URLs?
> >
> >
> > On Wednesday, November 19, 2014, Robert Lauriston <robert -at- lauriston -dot- com
> <javascript:;>>
> > wrote:
> >>
> >> The simple way to do it is to have the developers change the directory
> >> for the help files in each version, along the lines of those
> >> FrameMaker URLs.
> >>
> >> Then you don't need to do anything special in Flare, and the versions
> >> can coexist happily on a web site.
> >>
> >> On Wed, Nov 19, 2014 at 9:24 AM, Hannah Drake <hannah -at- formulatrix -dot- com
> <javascript:;>>
> >> wrote:
> >> > Flare
> >> >
> >> >
> >> > On Wednesday, November 19, 2014, Robert Lauriston <
> robert -at- lauriston -dot- com <javascript:;>>
> >> > wrote:
> >> >>
> >> >> Which authoring tool are you using?
> >> >>
> >> >> Standard practice is to put the product and version in the URL, so
> >> >> each release of the product has a unique base URL for the help. For
> >> >> example:
> >> >>
> >> >>
> >> >>
> >> >>
> http://help.adobe.com/en_US/FrameMaker/11.0/Using/WSd817046a44e105e21e63e3d11ab7f7561e-7fff.html
> >> >>
> >> >>
> >> >>
> >> >>
> http://help.adobe.com/en_US/FrameMaker/10.0/Using/WSd817046a44e105e21e63e3d11ab7f7561e-7fff.html
> >> >>
> >> >> Typically on the web site the latest release has no version, so a URL
> >> >> without a version gets you the latest and greatest:
> >> >>
> >> >>
> >> >>
> >> >>
> http://help.adobe.com/en_US/framemaker/using/WSd817046a44e105e21e63e3d11ab7f7561e-7fff.html
> >> >>
> >> >> What tool Adobe uses to generate the pop-up version menu in the
> bottom
> >> >> corner I don't know but that's external to the help. Maybe
> >> >> Dreamweaver, Flex, or Cold Fusion.
> >> >>
> >> >> MadCap used to do much the same thing but they seem to have removed
> >> >> the older versions from their site.
> >> >>
> >> >>
> >> >>
> >> >>
> http://webhelp.madcapsoftware.com/flare10/Default.htm#Output/Determining_the_Output_Type.htm
> >> >>
> >> >> On Wed, Nov 19, 2014 at 8:13 AM, Hannah Drake <
> hannah -at- formulatrix -dot- com <javascript:;>>
> >> >> wrote:
> >> >> > Hi all,
> >> >> >
> >> >> > Hope you're having a wonderful Wednesday. I'm wondering what you do
> >> >> > for
> >> >> > products that have online help and different software versions. We
> >> >> > are
> >> >> > thinking we need versions, as in website.com/3.1, and so on, but I
> >> >> > don't
> >> >> > think I've ever seen a release in a URL? How is this done at other
> >> >> > companies?
> >> >> >
> >> >> > The concern is that the users with older products will go find
> online
> >> >> > help
> >> >> > and it will be unhelpful since it's not related to their version,
> if
> >> >> > we
> >> >> > only put the latest up.
>

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Read about how Georgia System Operation Corporation improved teamwork, communication, and efficiency using Doc-To-Help | http://bit.ly/1lRPd2l

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

References:
HTML 5 web help versioning: From: Hannah Drake
Re: HTML 5 web help versioning: From: Robert Lauriston
Re: HTML 5 web help versioning: From: Hannah Drake
Re: HTML 5 web help versioning: From: Robert Lauriston
Re: HTML 5 web help versioning: From: Hannah Drake
Re: HTML 5 web help versioning: From: Robert Lauriston

Previous by Author: Re: HTML 5 web help versioning
Next by Author: Flare: Export/Print to PDF w. Single Topic?
Previous by Thread: Re: HTML 5 web help versioning
Next by Thread: Re: HTML 5 web help versioning


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

Sponsored Ads


Sponsored Ads