External xrefs from FM to... CHM or HTML
Hi Framers, We just converted an SDK project from Robohelp to FM/ePublisher because of Robohelp being discontinued. This project contains two sections: a Programmer Guide with overviews, descriptions, and sample code, and a Reference Guide that is automatically generated by extracting comments in the actual C# code. The final product was two CHM files. The tool used to generate the Reference Guide is NDoc and is part of the .NET Framework. The available output formats are HTML and HTML Help only (no XML or PDF). When in Robohelp, I merged the Reference Guide CHM file into the Programmer Guide, and was able to do external cross-references from the Programmer Guide to the Reference Guide (typically on class or interface names). However, now in FrameMaker, how can I do that? From what I see, I can only do xrefs to another FM document. Are there plug-ins available? Or new tools to use? Please answer me directly since I'm on the digest. I'm using FM 7.0 on Windows XP. Thanks a lot. --- Elise Nantel Rédactrice technique/Technical Writer Video Intelligence Solutions Verint Systems Inc. Phone 450 686-9000 x252 Email [EMAIL PROTECTED] www.verint.com __ This electronic message may contain proprietary and confidential information of Verint Systems Inc., its affiliates and/or subsidiaries. The information is intended to be for the use of the individual(s) or entity(ies) named above. If you are not the intended recipient (or authorized to receive this e-mail for the intended recipient), you may not use, copy, disclose or distribute to anyone this message or any information contained in this message. If you have received this electronic message in error, please notify us by replying to this e-mail. (1) ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: External xrefs from FM to... CHM or HTML
On Mon, 11 Dec 2006 12:07:55 -0500, Nantel, Elise [EMAIL PROTECTED] wrote: When in Robohelp, I merged the Reference Guide CHM file into the Programmer Guide, and was able to do external cross-references from the Programmer Guide to the Reference Guide (typically on class or interface names). However, now in FrameMaker, how can I do that? From what I see, I can only do xrefs to another FM document. That's correct. Frame xrefs are only for use with other Frame docs. However, you can use Frame hypertext links to anything. To do that, you would place a Frame marker of type Hypertext with content like: message URL ./path/filename.htm#anchor for a file in a subdirectory below the Frame file. You need to specify a path that will be valid from the HTML produced for the Frame file. To mark the hotspot for the link, apply a char format (which can be all as is) to the hotspot text; the marker must also be within the span of the char format. See the Frame docs for more on the many kinds of hypertext markers available. HTH! -- Jeremy H. Griffith, at Omni Systems Inc. [EMAIL PROTECTED] http://www.omsys.com/ ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: External xrefs from FM to... CHM or HTML
On Tue, 12 Dec 2006 15:14:26 -0500, Nantel, Elise [EMAIL PROTECTED] wrote: Thanks for this info. However, I have one question: Since I'm not generating the target document (HTML or CHM), how will I know the anchor to specify in the Hypertext command? The anchor part in: message URL ./path/filename.htm#anchor is optional; use it if you need to point at a paragraph within the HTML file. For that, open the HTML file in Notepad and look for an anchor tag like a name=anchorname/a at the start of the paragraph you want to display. Otherwise, if you want to show the HTML file at its top, just use: message URL ./path/filename.htm References to CHMs are a little trickier: message URL mk:@MSITStore:Helpfile.chm::/topic.htm#anchor The .chm must be in the same directory as the Frame- produced HTML file, unlass you can specify an absolute (not relative) path to it that will be valid on all users' machines. Registering the .chm doesn't help. HTH! -- Jeremy H. Griffith, at Omni Systems Inc. [EMAIL PROTECTED] http://www.omsys.com/ ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: External xrefs from FM to... CHM or HTML
Jeremy, Thanks for this info. However, I have one question: Since I'm not generating the target document (HTML or CHM), how will I know the anchor to specify in the Hypertext command? Elise -Original Message- From: Jeremy H. Griffith [mailto:[EMAIL PROTECTED] Sent: 12 décembre 2006 15:03 To: Nantel, Elise Cc: framers@FrameUsers.com Subject: Re: External xrefs from FM to... CHM or HTML On Mon, 11 Dec 2006 12:07:55 -0500, Nantel, Elise [EMAIL PROTECTED] wrote: When in Robohelp, I merged the Reference Guide CHM file into the Programmer Guide, and was able to do external cross-references from the Programmer Guide to the Reference Guide (typically on class or interface names). However, now in FrameMaker, how can I do that? From what I see, I can only do xrefs to another FM document. That's correct. Frame xrefs are only for use with other Frame docs. However, you can use Frame hypertext links to anything. To do that, you would place a Frame marker of type Hypertext with content like: message URL ./path/filename.htm#anchor for a file in a subdirectory below the Frame file. You need to specify a path that will be valid from the HTML produced for the Frame file. To mark the hotspot for the link, apply a char format (which can be all as is) to the hotspot text; the marker must also be within the span of the char format. See the Frame docs for more on the many kinds of hypertext markers available. HTH! -- Jeremy H. Griffith, at Omni Systems Inc. [EMAIL PROTECTED] http://www.omsys.com/ __ This electronic message may contain proprietary and confidential information of Verint Systems Inc., its affiliates and/or subsidiaries. The information is intended to be for the use of the individual(s) or entity(ies) named above. If you are not the intended recipient (or authorized to receive this e-mail for the intended recipient), you may not use, copy, disclose or distribute to anyone this message or any information contained in this message. If you have received this electronic message in error, please notify us by replying to this e-mail. (1) ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
External xrefs from FM to... CHM or HTML
On Mon, 11 Dec 2006 12:07:55 -0500, "Nantel, Elise" wrote: >When in Robohelp, I merged the Reference Guide CHM file >into the Programmer Guide, and was able to do external >cross-references from the Programmer Guide to the >Reference Guide (typically on class or interface names). >However, now in FrameMaker, how can I do that? From what >I see, I can only do xrefs to another FM document. That's correct. Frame xrefs are only for use with other Frame docs. However, you can use Frame hypertext links to anything. To do that, you would place a Frame marker of type Hypertext with content like: message URL ./path/filename.htm#anchor for a file in a subdirectory below the Frame file. You need to specify a path that will be valid from the HTML produced for the Frame file. To mark the hotspot for the link, apply a char format (which can be all "as is") to the hotspot text; the marker must also be within the span of the char format. See the Frame docs for more on the many kinds of hypertext markers available. HTH! -- Jeremy H. Griffith, at Omni Systems Inc. http://www.omsys.com/
External xrefs from FM to... CHM or HTML
On Tue, 12 Dec 2006 15:14:26 -0500, "Nantel, Elise" wrote: >Thanks for this info. However, I have one question: >Since I'm not generating the target document (HTML or >CHM), how will I know the anchor to specify in the >Hypertext command? The "anchor" part in: message URL ./path/filename.htm#anchor is optional; use it if you need to point at a paragraph within the HTML file. For that, open the HTML file in Notepad and look for an anchor tag like at the start of the paragraph you want to display. Otherwise, if you want to show the HTML file at its top, just use: message URL ./path/filename.htm References to CHMs are a little trickier: message URL mk:@MSITStore:Helpfile.chm::/topic.htm#anchor The .chm must be in the same directory as the Frame- produced HTML file, unlass you can specify an absolute (not relative) path to it that will be valid on all users' machines. Registering the .chm doesn't help. HTH! -- Jeremy H. Griffith, at Omni Systems Inc. http://www.omsys.com/
External xrefs from FM to... CHM or HTML
Jeremy, Thanks for this info. However, I have one question: Since I'm not generating the target document (HTML or CHM), how will I know the anchor to specify in the Hypertext command? Elise -Original Message- From: Jeremy H. Griffith [mailto:jer...@omsys.com] Sent: 12 d?cembre 2006 15:03 To: Nantel, Elise Cc: framers at FrameUsers.com Subject: Re: External xrefs from FM to... CHM or HTML On Mon, 11 Dec 2006 12:07:55 -0500, "Nantel, Elise" wrote: >When in Robohelp, I merged the Reference Guide CHM file >into the Programmer Guide, and was able to do external >cross-references from the Programmer Guide to the >Reference Guide (typically on class or interface names). >However, now in FrameMaker, how can I do that? From what >I see, I can only do xrefs to another FM document. That's correct. Frame xrefs are only for use with other Frame docs. However, you can use Frame hypertext links to anything. To do that, you would place a Frame marker of type Hypertext with content like: message URL ./path/filename.htm#anchor for a file in a subdirectory below the Frame file. You need to specify a path that will be valid from the HTML produced for the Frame file. To mark the hotspot for the link, apply a char format (which can be all "as is") to the hotspot text; the marker must also be within the span of the char format. See the Frame docs for more on the many kinds of hypertext markers available. HTH! -- Jeremy H. Griffith, at Omni Systems Inc. http://www.omsys.com/ __ This electronic message may contain proprietary and confidential information of Verint Systems Inc., its affiliates and/or subsidiaries. The information is intended to be for the use of the individual(s) or entity(ies) named above. If you are not the intended recipient (or authorized to receive this e-mail for the intended recipient), you may not use, copy, disclose or distribute to anyone this message or any information contained in this message. If you have received this electronic message in error, please notify us by replying to this e-mail. (1)
External xrefs from FM to... CHM or HTML
Hi Framers, We just converted an SDK project from Robohelp to FM/ePublisher because of Robohelp being discontinued. This project contains two sections: a Programmer Guide with overviews, descriptions, and sample code, and a Reference Guide that is automatically generated by extracting comments in the actual C# code. The final product was two CHM files. The tool used to generate the Reference Guide is NDoc and is part of the .NET Framework. The available output formats are HTML and HTML Help only (no XML or PDF). When in Robohelp, I merged the Reference Guide CHM file into the Programmer Guide, and was able to do external cross-references from the Programmer Guide to the Reference Guide (typically on class or interface names). However, now in FrameMaker, how can I do that? From what I see, I can only do xrefs to another FM document. Are there plug-ins available? Or new tools to use? Please answer me directly since I'm on the digest. I'm using FM 7.0 on Windows XP. Thanks a lot. --- Elise Nantel R?dactrice technique/Technical Writer Video Intelligence Solutions Verint Systems Inc. Phone 450 686-9000 x252 Email elise.nantel at verint.com www.verint.com __ This electronic message may contain proprietary and confidential information of Verint Systems Inc., its affiliates and/or subsidiaries. The information is intended to be for the use of the individual(s) or entity(ies) named above. If you are not the intended recipient (or authorized to receive this e-mail for the intended recipient), you may not use, copy, disclose or distribute to anyone this message or any information contained in this message. If you have received this electronic message in error, please notify us by replying to this e-mail. (1)
