Re: Tool for XML - Online Help
Hi Angela, There are a number of possible pathways you might follow to provide the solution you're looking for. You could generate HTML from your XML content and post this as online help, or you could post your XML content and transform this on the fly as requested by users. Both solutions have their advantages and disadvantages. Typically, to implement context sensitive online help, you'll need to provide some type of mapping between PIDs and topic IDs or URLs. This can be implemented in various ways. Using a custom help viewer simplifies the issue, but even with a generic browser you can use server side search functionality with unique keywords for each PID. Obviously, this is dependent on implementing some sort of search functionality. One solution worth looking at is MS Content Management Server (CMS) with SharePoint Portal Services (SPS). CMS provides a high performance transformation framework out of the box and SPS gives you a highly customizable web interface and search functionality. Be aware that any solution that goes beyond posting static HTML with a basic nav frame is likely to involve a serious commitment of dev time. FWIW, Word (and Office) online help was developed and is support by a substantial team. OTOH, with the right skillset, it's possible to implement a similar type of solution for a small team. Hope this is helpful. John On 5/2/06 4:46 PM, Angela Akridge [EMAIL PROTECTED] wrote: Hi, I've never worked with setting up an Online Help system. I know how to write in raw html/sgml, but that's about the extent of my experience with Online Help. I'm familiar with single-source authoring (using Epic) to create customized documentation, but have NO experience designing a help system I currently edit existing context-sensitive online help. I don't use an Online Help application (JavaHelp or RoboHelp). I simply have some hooks in the code that call some html files (nothing sophisticated). I'd like to use the content that I produce in manuals to produce online help topics. If this means that the Online Help can no longer be context sensitive without a lot of infrastrucuture, then so be it (although a hybird would be ideal). My company is okay with dumping the manual into a clean collection of individual procedures (modules) if the design provides a search box. What tool will take my Frame xml output and generate a pretty look-and-feel for online help? I like MS Word's Online Help. Thank yoiu, -- Angela Akridge [EMAIL PROTECTED] 408/393-9249 (cell) ___ 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/jroot%40publisys.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info. ___ 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: Tool for XML - Online Help
Angela, I'm assuming your FrameMaker XML output is from Structured Frame. Also, you don't say whether the app is a desktop app or a Web app. If you are using the Docbook or DITA flavors of XML, there are free tools that you can download to create help from the XML. If you are using your own schema, you have a couple of options. As Jeremy said, you can check out Web Works Publisher Pro or Mif2Go. Both will turn a FrameMaker document/book into online help (.chm, web-based, JavaHelp, etc.). I don't think you can easily customize the output so that it is like MS Word's help, but I'm not positive. Another option is to use XSLT. If you are creating Web-based help, you'll have to figure out how you want to handle search. Of course, you'll also need to know XSLT or have access to someone who does. (It's not as easy as HTML, but it's probably easier than C++.) Provided you have the right skills available, this option opens up a lot of possibilities. Mike -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] om] On Behalf Of Angela Akridge Sent: Tuesday, May 02, 2006 7:47 PM To: framers@lists.frameusers.com Subject: Tool for XML - Online Help Hi, I've never worked with setting up an Online Help system. I know how to write in raw html/sgml, but that's about the extent of my experience with Online Help. I'm familiar with single-source authoring (using Epic) to create customized documentation, but have NO experience designing a help system I currently edit existing context-sensitive online help. I don't use an Online Help application (JavaHelp or RoboHelp). I simply have some hooks in the code that call some html files (nothing sophisticated). I'd like to use the content that I produce in manuals to produce online help topics. If this means that the Online Help can no longer be context sensitive without a lot of infrastrucuture, then so be it (although a hybird would be ideal). My company is okay with dumping the manual into a clean collection of individual procedures (modules) if the design provides a search box. What tool will take my Frame xml output and generate a pretty look-and-feel for online help? I like MS Word's Online Help. Thank yoiu, -- Angela Akridge [EMAIL PROTECTED] 408/393-9249 (cell) ___ 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/mike.feimster%40acstechn ologies.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info. ___ 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.
Tool for XML -> Online Help
Hi Angela, There are a number of possible pathways you might follow to provide the solution you're looking for. You could generate HTML from your XML content and post this as online help, or you could post your XML content and transform this on the fly as requested by users. Both solutions have their advantages and disadvantages. Typically, to implement context sensitive online help, you'll need to provide some type of mapping between PIDs and topic IDs or URLs. This can be implemented in various ways. Using a custom help viewer simplifies the issue, but even with a generic browser you can use server side search functionality with unique keywords for each PID. Obviously, this is dependent on implementing some sort of search functionality. One solution worth looking at is MS Content Management Server (CMS) with SharePoint Portal Services (SPS). CMS provides a high performance transformation framework out of the box and SPS gives you a highly customizable web interface and search functionality. Be aware that any solution that goes beyond posting static HTML with a basic nav frame is likely to involve a serious commitment of dev time. FWIW, Word (and Office) online help was developed and is support by a substantial team. OTOH, with the right skillset, it's possible to implement a similar type of solution for a small team. Hope this is helpful. John On 5/2/06 4:46 PM, "Angela Akridge" wrote: > Hi, > > I've never worked with setting up an Online Help system. I know how to write > in raw html/sgml, but that's about the extent of my experience with Online > Help. I'm familiar with single-source authoring (using Epic) to create > customized documentation, but have NO experience designing a help system I > currently edit existing context-sensitive online help. I don't use an Online > Help application (JavaHelp or RoboHelp). I simply have some hooks in the > code that call some html files (nothing sophisticated). > > I'd like to use the content that I produce in manuals to produce online help > topics. If this means that the Online Help can no longer be context > sensitive without a lot of infrastrucuture, then so be it (although a hybird > would be ideal). My company is okay with dumping the manual into a clean > collection of individual procedures (modules) if the design provides a > search box. What tool will take my Frame xml output and generate a pretty > look-and-feel for online help? I like MS Word's Online Help. > > Thank yoiu, > > -- > Angela Akridge > angela.akridge at gmail.com > 408/393-9249 (cell) > ___ > > > You are currently subscribed to Framers as jroot at publisys.com. > > Send list messages to framers at lists.frameusers.com. > > To unsubscribe send a blank email to > framers-unsubscribe at lists.frameusers.com > or visit > http://lists.frameusers.com/mailman/options/framers/jroot%40publisys.com > > Send administrative questions to lisa at frameusers.com. Visit > http://www.frameusers.com/ for more resources and info.
Tool for XML -> Online Help
Angela, I'm assuming your FrameMaker XML output is from Structured Frame. Also, you don't say whether the app is a desktop app or a Web app. If you are using the Docbook or DITA flavors of XML, there are free tools that you can download to create help from the XML. If you are using your own schema, you have a couple of options. As Jeremy said, you can check out Web Works Publisher Pro or Mif2Go. Both will turn a FrameMaker document/book into online help (.chm, web-based, JavaHelp, etc.). I don't think you can easily customize the output so that it is like MS Word's help, but I'm not positive. Another option is to use XSLT. If you are creating Web-based help, you'll have to figure out how you want to handle search. Of course, you'll also need to know XSLT or have access to someone who does. (It's not as easy as HTML, but it's probably easier than C++.) Provided you have the right skills available, this option opens up a lot of possibilities. Mike -Original Message- From: framers-bounces+mike.feimster=acstechnologies@lists.frameusers.com [mailto:framers-bounces+mike.feimster=acstechnologies.com at lists.frameusers.c om] On Behalf Of Angela Akridge Sent: Tuesday, May 02, 2006 7:47 PM To: framers at lists.frameusers.com Subject: Tool for XML -> Online Help Hi, I've never worked with setting up an Online Help system. I know how to write in raw html/sgml, but that's about the extent of my experience with Online Help. I'm familiar with single-source authoring (using Epic) to create customized documentation, but have NO experience designing a help system I currently edit existing context-sensitive online help. I don't use an Online Help application (JavaHelp or RoboHelp). I simply have some hooks in the code that call some html files (nothing sophisticated). I'd like to use the content that I produce in manuals to produce online help topics. If this means that the Online Help can no longer be context sensitive without a lot of infrastrucuture, then so be it (although a hybird would be ideal). My company is okay with dumping the manual into a clean collection of individual procedures (modules) if the design provides a search box. What tool will take my Frame xml output and generate a pretty look-and-feel for online help? I like MS Word's Online Help. Thank yoiu, -- Angela Akridge angela.akridge at gmail.com 408/393-9249 (cell) ___ You are currently subscribed to Framers as mike.feimster at acstechnologies.com. Send list messages to framers at lists.frameusers.com. To unsubscribe send a blank email to framers-unsubscribe at lists.frameusers.com or visit http://lists.frameusers.com/mailman/options/framers/mike.feimster%40acstechn ologies.com Send administrative questions to lisa at frameusers.com. Visit http://www.frameusers.com/ for more resources and info.
Tool for XML - Online Help
Hi, I've never worked with setting up an Online Help system. I know how to write in raw html/sgml, but that's about the extent of my experience with Online Help. I'm familiar with single-source authoring (using Epic) to create customized documentation, but have NO experience designing a help system I currently edit existing context-sensitive online help. I don't use an Online Help application (JavaHelp or RoboHelp). I simply have some hooks in the code that call some html files (nothing sophisticated). I'd like to use the content that I produce in manuals to produce online help topics. If this means that the Online Help can no longer be context sensitive without a lot of infrastrucuture, then so be it (although a hybird would be ideal). My company is okay with dumping the manual into a clean collection of individual procedures (modules) if the design provides a search box. What tool will take my Frame xml output and generate a pretty look-and-feel for online help? I like MS Word's Online Help. Thank yoiu, -- Angela Akridge [EMAIL PROTECTED] 408/393-9249 (cell) ___ 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: Tool for XML - Online Help
On Tue, 2 May 2006 16:46:31 -0700, Angela Akridge [EMAIL PROTECTED] wrote: I've never worked with setting up an Online Help system. I know how to write in raw html/sgml, but that's about the extent of my experience with Online Help. I'm familiar with single-source authoring (using Epic) to create customized documentation, but have NO experience designing a help system I currently edit existing context-sensitive online help. I don't use an Online Help application (JavaHelp or RoboHelp). I simply have some hooks in the code that call some html files (nothing sophisticated). I'd like to use the content that I produce in manuals to produce online help topics. If this means that the Online Help can no longer be context sensitive without a lot of infrastrucuture, then so be it (although a hybird would be ideal). My company is okay with dumping the manual into a clean collection of individual procedures (modules) if the design provides a search box. What tool will take my Frame xml output and generate a pretty look-and-feel for online help? I like MS Word's Online Help. First, there's another list that's devoted to Help, that you may want to join and ask on. The Welcome message gives you a set of questions to answer about your needs that you can use to make up a good query: http://groups.yahoo.com/group/HATT/ One of the regulars there has developed a grid of Help tool comparison information: http://www.helpstuff.com That said, for single-sourcing from Frame, there are really two choices: Mif2Go (our product), and WebWorks Pro. Both have free eval versions, and you may want to try both: http://www.omsys.com/ http://www.quadralay.com/ 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.
Tool for XML -> Online Help
Hi, I've never worked with setting up an Online Help system. I know how to write in raw html/sgml, but that's about the extent of my experience with Online Help. I'm familiar with single-source authoring (using Epic) to create customized documentation, but have NO experience designing a help system I currently edit existing context-sensitive online help. I don't use an Online Help application (JavaHelp or RoboHelp). I simply have some hooks in the code that call some html files (nothing sophisticated). I'd like to use the content that I produce in manuals to produce online help topics. If this means that the Online Help can no longer be context sensitive without a lot of infrastrucuture, then so be it (although a hybird would be ideal). My company is okay with dumping the manual into a clean collection of individual procedures (modules) if the design provides a search box. What tool will take my Frame xml output and generate a pretty look-and-feel for online help? I like MS Word's Online Help. Thank yoiu, -- Angela Akridge angela.akridge at gmail.com 408/393-9249 (cell)
Tool for XML -> Online Help
On Tue, 2 May 2006 16:46:31 -0700, "Angela Akridge" wrote: >I've never worked with setting up an Online Help system. I know how to write >in raw html/sgml, but that's about the extent of my experience with Online >Help. I'm familiar with single-source authoring (using Epic) to create >customized documentation, but have NO experience designing a help system I >currently edit existing context-sensitive online help. I don't use an Online >Help application (JavaHelp or RoboHelp). I simply have some hooks in the >code that call some html files (nothing sophisticated). > >I'd like to use the content that I produce in manuals to produce online help >topics. If this means that the Online Help can no longer be context >sensitive without a lot of infrastrucuture, then so be it (although a hybird >would be ideal). My company is okay with dumping the manual into a clean >collection of individual procedures (modules) if the design provides a >search box. What tool will take my Frame xml output and generate a pretty >look-and-feel for online help? I like MS Word's Online Help. First, there's another list that's devoted to Help, that you may want to join and ask on. The Welcome message gives you a set of questions to answer about your needs that you can use to make up a good query: http://groups.yahoo.com/group/HATT/ One of the regulars there has developed a grid of Help tool comparison information: http://www.helpstuff.com That said, for single-sourcing from Frame, there are really two choices: Mif2Go (our product), and WebWorks Pro. Both have free eval versions, and you may want to try both: http://www.omsys.com/ http://www.quadralay.com/ HTH! -- Jeremy H. Griffith, at Omni Systems Inc. http://www.omsys.com/
