Re: [Framers] [WTF ramemaker] Best Practices for HTML Online help
Sure, it's technically possible, but automatically generating the map file is a basic feature of help authoring tools. Doing it manually in a text editor invites human error. The FrameMaker doc itself points to the RoboHelp "Information for Developers" section. That's the correct way to write help calls in applications. The help calls you described in https://forums.adobe.com/thread/2314670 are a kludge and I would strongly recommend not doing that. At a previous job I had to rewrite hundreds of help calls in the source code because developers used a similar kludge, which by the time I took over the project a few years later had resulted in many broken links. On Tue, May 14, 2019 at 11:48 AM Caroline Tabach wrote: > > I have made context sensitive help without RoboHelp. ... > > On Tue, 14 May 2019, 20:58 Robert Lauriston, wrote: > > > Looks like having both FrameMaker and RoboHelp (i.e. Adobe Technical > > Communication Suite) is essential for publishing context-sensitive > > help. > > > > RoboHelp can generate the map file from the TopicAlias markers: > > > > > > https://help.adobe.com/en_US/robohelp/2017/robohtml/#t=book%2Frob_createhelp_ch%2FManaging_map_files-.htm%23TOC_Export_a_map_filebc-3&rhtocid=_10_2_1_2 > > > > FrameMaker multi-channel publishing requires you to maintain the map > > file manually in a text editor, which is insane: > > > > > > https://help.adobe.com/en_US/framemaker/2019/using/using-framemaker-2019/WS2d2a17056e2191986533fc06144fd9afdc4-8000.html > > > > On Tue, May 14, 2019 at 9:58 AM Robert Lauriston > > wrote: > > > > > > Since you're posting this on the Framers list, I presume you're using > > > FrameMaker. > > > > > > Its "multi-channel publishing" feature is a subset of RoboHelp. You > > > probably want to choose Responsive HTML. Do not choose Microsoft HTML > > > Help. > > > > > > Alternatively, link the FrameMaker source to RoboHelp, and you'll have > > > the full RoboHelp feature set. In that case, you might choose WebHelp > > > over Responsive HTML. Look at both. > > > > > > On the FrameMaker side, define the target topics using TopicAlias > > > markers. That's covered in the FrameMaker user guide. > > > > > > On the app side, you can find detailed information on CSH calls in the > > > "Information for Developers" section of "Context-sensitive help" > > > chapger of the RoboHelp user guide. > > > > > > > > https://help.adobe.com/en_US/robohelp/2017/robohtml/#t=book%2Frob_createhelp_ch%2FInformation_for_developers-.htm > > > > > > *** You want to create and maintain the map file and provide it to the > > > developers, not vice-versa. *** > > > > > > You do not need a separate target topic for every application context. > > > Many application contexts can point to the same help topic. > > > > > > Be sure that the developers implement a default help topic to open > > > when a context is unmapped or the map is wrong. > > > > > > On Tue, May 14, 2019 at 7:44 AM Art Campbell > > wrote: > > > > > > > > My company is developing a new browser-based software package that is > > specced to include screen-level context sensitive help. > > > > > > > > The coders haven't done this before and are asking for > > help/assistance/advice on developing the coding standard for this and other > > products going forward. > > > > > > > > I'm thinking the basics are the basics -- a call in the program goes > > to a mapping table that invokes the HTML help screen in a new tab/window or > > a popup. > > > > > > > > What I'm looking for feedback / ideas on are a good method to call > > Help from the application (icon/keystroke/widget), and any Best Practices > > that people are already using, either on the coding or information > > development side. ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] [WTF ramemaker] Best Practices for HTML Online help
I have made context sensitive help without RoboHelp. See links sent above. Frame 2017 Caroline Tabach On Tue, 14 May 2019, 20:58 Robert Lauriston, wrote: > Looks like having both FrameMaker and RoboHelp (i.e. Adobe Technical > Communication Suite) is essential for publishing context-sensitive > help. > > RoboHelp can generate the map file from the TopicAlias markers: > > > https://help.adobe.com/en_US/robohelp/2017/robohtml/#t=book%2Frob_createhelp_ch%2FManaging_map_files-.htm%23TOC_Export_a_map_filebc-3&rhtocid=_10_2_1_2 > > FrameMaker multi-channel publishing requires you to maintain the map > file manually in a text editor, which is insane: > > > https://help.adobe.com/en_US/framemaker/2019/using/using-framemaker-2019/WS2d2a17056e2191986533fc06144fd9afdc4-8000.html > > On Tue, May 14, 2019 at 9:58 AM Robert Lauriston > wrote: > > > > Since you're posting this on the Framers list, I presume you're using > > FrameMaker. > > > > Its "multi-channel publishing" feature is a subset of RoboHelp. You > > probably want to choose Responsive HTML. Do not choose Microsoft HTML > > Help. > > > > Alternatively, link the FrameMaker source to RoboHelp, and you'll have > > the full RoboHelp feature set. In that case, you might choose WebHelp > > over Responsive HTML. Look at both. > > > > On the FrameMaker side, define the target topics using TopicAlias > > markers. That's covered in the FrameMaker user guide. > > > > On the app side, you can find detailed information on CSH calls in the > > "Information for Developers" section of "Context-sensitive help" > > chapger of the RoboHelp user guide. > > > > > https://help.adobe.com/en_US/robohelp/2017/robohtml/#t=book%2Frob_createhelp_ch%2FInformation_for_developers-.htm > > > > *** You want to create and maintain the map file and provide it to the > > developers, not vice-versa. *** > > > > You do not need a separate target topic for every application context. > > Many application contexts can point to the same help topic. > > > > Be sure that the developers implement a default help topic to open > > when a context is unmapped or the map is wrong. > > > > On Tue, May 14, 2019 at 7:44 AM Art Campbell > wrote: > > > > > > My company is developing a new browser-based software package that is > specced to include screen-level context sensitive help. > > > > > > The coders haven't done this before and are asking for > help/assistance/advice on developing the coding standard for this and other > products going forward. > > > > > > I'm thinking the basics are the basics -- a call in the program goes > to a mapping table that invokes the HTML help screen in a new tab/window or > a popup. > > > > > > What I'm looking for feedback / ideas on are a good method to call > Help from the application (icon/keystroke/widget), and any Best Practices > that people are already using, either on the coding or information > development side. > ___ > > This message is from the Framers mailing list > > Send messages to framers@lists.frameusers.com > Visit the list's homepage at http://www.frameusers.com > Archives located at > http://www.mail-archive.com/framers%40lists.frameusers.com/ > Subscribe and unsubscribe at > http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com > Send administrative questions to listad...@frameusers.com > ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] [WTF ramemaker] Best Practices for HTML Online help
Looks like having both FrameMaker and RoboHelp (i.e. Adobe Technical Communication Suite) is essential for publishing context-sensitive help. RoboHelp can generate the map file from the TopicAlias markers: https://help.adobe.com/en_US/robohelp/2017/robohtml/#t=book%2Frob_createhelp_ch%2FManaging_map_files-.htm%23TOC_Export_a_map_filebc-3&rhtocid=_10_2_1_2 FrameMaker multi-channel publishing requires you to maintain the map file manually in a text editor, which is insane: https://help.adobe.com/en_US/framemaker/2019/using/using-framemaker-2019/WS2d2a17056e2191986533fc06144fd9afdc4-8000.html On Tue, May 14, 2019 at 9:58 AM Robert Lauriston wrote: > > Since you're posting this on the Framers list, I presume you're using > FrameMaker. > > Its "multi-channel publishing" feature is a subset of RoboHelp. You > probably want to choose Responsive HTML. Do not choose Microsoft HTML > Help. > > Alternatively, link the FrameMaker source to RoboHelp, and you'll have > the full RoboHelp feature set. In that case, you might choose WebHelp > over Responsive HTML. Look at both. > > On the FrameMaker side, define the target topics using TopicAlias > markers. That's covered in the FrameMaker user guide. > > On the app side, you can find detailed information on CSH calls in the > "Information for Developers" section of "Context-sensitive help" > chapger of the RoboHelp user guide. > > https://help.adobe.com/en_US/robohelp/2017/robohtml/#t=book%2Frob_createhelp_ch%2FInformation_for_developers-.htm > > *** You want to create and maintain the map file and provide it to the > developers, not vice-versa. *** > > You do not need a separate target topic for every application context. > Many application contexts can point to the same help topic. > > Be sure that the developers implement a default help topic to open > when a context is unmapped or the map is wrong. > > On Tue, May 14, 2019 at 7:44 AM Art Campbell wrote: > > > > My company is developing a new browser-based software package that is > > specced to include screen-level context sensitive help. > > > > The coders haven't done this before and are asking for > > help/assistance/advice on developing the coding standard for this and other > > products going forward. > > > > I'm thinking the basics are the basics -- a call in the program goes to a > > mapping table that invokes the HTML help screen in a new tab/window or a > > popup. > > > > What I'm looking for feedback / ideas on are a good method to call Help > > from the application (icon/keystroke/widget), and any Best Practices that > > people are already using, either on the coding or information development > > side. ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] FM 2019: graphics losing DPI and scaling information upon import
If you're importing into a table cell, this is a known bug that is being worked on. See here: https://tracker.adobe.com/#/view/FRMAKER-6271 I'm using FM 2019 on Windows 10 and importing an image directly to the body of the document, as opposed to into a table cell, works fine. Unless it's an SVG graphic created from Visio. I thought things had been fixed, since recently I'd found that ungrouping all objects in Visio before saving to SVG was apparently importing correctly. Right up until late yesterday afternoon, when it all went screwy again. On Tue, May 14, 2019 at 1:26 PM Harding, Dan wrote: > Graphic import appears to work differently in FM2019 compared to FM2017. > To me it appears to be broken. > > If I import a TIF file by reference that is NOT one of the default > resolution options, let's say a 600dpi TIFF: > > 1. Under FM 2017 it would read the resolution as 600dpi and the scaling > percentage shown in the object properties would be correct, e.g., an 8-inch > wide image displayed at 6 inches wide would be 75%. > > 2. Under FM 2019, it no longer shows the correct dpi resolution and the > scaling percentage shown in object properties is WAY off even if the item > visually displays properly on the page. For example, what shows up as 85% > scale in FM2017 shows up as 10.39% under FM2019, using the same image. > > This is incredibly annoying, as I know to resize images of a certain type > and source to XX% and from a different type and source to YY%, and now that > no longer works. > > Suggestions? > > -Dan > ___ > > This message is from the Framers mailing list > > Send messages to framers@lists.frameusers.com > Visit the list's homepage at http://www.frameusers.com > Archives located at > http://www.mail-archive.com/framers%40lists.frameusers.com/ > Subscribe and unsubscribe at > http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com > Send administrative questions to listad...@frameusers.com > -- Lin Sims ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
[Framers] FM 2019: graphics losing DPI and scaling information upon import
Graphic import appears to work differently in FM2019 compared to FM2017. To me it appears to be broken. If I import a TIF file by reference that is NOT one of the default resolution options, let's say a 600dpi TIFF: 1. Under FM 2017 it would read the resolution as 600dpi and the scaling percentage shown in the object properties would be correct, e.g., an 8-inch wide image displayed at 6 inches wide would be 75%. 2. Under FM 2019, it no longer shows the correct dpi resolution and the scaling percentage shown in object properties is WAY off even if the item visually displays properly on the page. For example, what shows up as 85% scale in FM2017 shows up as 10.39% under FM2019, using the same image. This is incredibly annoying, as I know to resize images of a certain type and source to XX% and from a different type and source to YY%, and now that no longer works. Suggestions? -Dan ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] [WTF ramemaker] Best Practices for HTML Online help
Since you're posting this on the Framers list, I presume you're using FrameMaker. Its "multi-channel publishing" feature is a subset of RoboHelp. You probably want to choose Responsive HTML. Do not choose Microsoft HTML Help. Alternatively, link the FrameMaker source to RoboHelp, and you'll have the full RoboHelp feature set. In that case, you might choose WebHelp over Responsive HTML. Look at both. On the FrameMaker side, define the target topics using TopicAlias markers. That's covered in the FrameMaker user guide. On the app side, you can find detailed information on CSH calls in the "Information for Developers" section of "Context-sensitive help" chapger of the RoboHelp user guide. https://help.adobe.com/en_US/robohelp/2017/robohtml/#t=book%2Frob_createhelp_ch%2FInformation_for_developers-.htm *** You want to create and maintain the map file and provide it to the developers, not vice-versa. *** You do not need a separate target topic for every application context. Many application contexts can point to the same help topic. Be sure that the developers implement a default help topic to open when a context is unmapped or the map is wrong. On Tue, May 14, 2019 at 7:44 AM Art Campbell wrote: > > My company is developing a new browser-based software package that is specced > to include screen-level context sensitive help. > > The coders haven't done this before and are asking for help/assistance/advice > on developing the coding standard for this and other products going forward. > > I'm thinking the basics are the basics -- a call in the program goes to a > mapping table that invokes the HTML help screen in a new tab/window or a > popup. > > What I'm looking for feedback / ideas on are a good method to call Help from > the application (icon/keystroke/widget), and any Best Practices that people > are already using, either on the coding or information development side. ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] Best Practices for HTML Online help
Hi Please see this link on Adobe forum, and the threads it links to https://forums.adobe.com/message/10912271#10912271 Caroline Tabach On Tue, 14 May 2019, 19:20 Caroline Tabach, wrote: > I implemented this successfully. > > Tomorrow I will be in the office, and be able to send you the code we > used. > > It is also on the Adobe forum, if I find the link I will send it to you. > > Caroline Tabach > ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] Best Practices for HTML Online help
I implemented this successfully. Tomorrow I will be in the office, and be able to send you the code we used. It is also on the Adobe forum, if I find the link I will send it to you. Caroline Tabach ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
[Framers] Best Practices for HTML Online help
My company is developing a new browser-based software package that is specced to include screen-level context sensitive help. The coders haven't done this before and are asking for help/assistance/advice on developing the coding standard for this and other products going forward. I'm thinking the basics are the basics -- a call in the program goes to a mapping table that invokes the HTML help screen in a new tab/window or a popup. What I'm looking for feedback / ideas on are a good method to call Help from the application (icon/keystroke/widget), and any Best Practices that people are already using, either on the coding or information development side. Art Art Campbell art.campb...@gmail.com "... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl." -- Richard Thompson No disclaimers apply. DoD 358 ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
