Please help...generating with frames

Post here questions and problems related to editing and publishing DITA content.
n_white
Posts: 4
Joined: Thu Nov 24, 2011 5:22 pm

Please help...generating with frames

Post by n_white »

Hi
Please forgive my ignorance when describing my issues. I got thrown into this without any training, and I'm desparately trying to learn.

I have a set of online help written in oxygen. I am supposed to generate it using webhelp. (That's what I've been told that I need to do.) I understand how to get it generated, but when I generate it, the output does not display in frames. Each of the topics opens with an Open with frames link at the top. I need the topics to open with the index open on the left and the topic information open on the right.

Is there some way that I can get oxygen to automatically generate the help topics to open in the frames?

Thanks for any help you can give.
Natasha
Radu
Posts: 9434
Joined: Fri Jul 09, 2004 5:18 pm

Re: Please help...generating with frames

Post by Radu »

Hi Natasha,

If you are publishing the DITA content by applying a DITA scenario of type "WebHelp" then at the end of the transformation Oxygen should open an "index.html" which is a frameset containing a TOC on the left and the topics content on the right.

Our User Manual is also generated in WebHelp and it looks like this:
http://www.oxygenxml.com/doc/ug-oxygen/

If you are opening individual topic files from the output directory by double clicking then those opened topics do not contain the left-side topic.
You should use the "index.html" instead to open the entire WebHelp frameset.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
n_white
Posts: 4
Joined: Thu Nov 24, 2011 5:22 pm

Re: Please help...generating with frames

Post by n_white »

Thanks. That clears up that part. Now of course I have another question :)
The helpset that I am working with is context sensitive. In this case it is connected to a whole application built using Oracle forms. When the user clicks the help button, they are supposed to be directed to help for that specific form. I am having troubles telling the developers what to launch when the button is clicked. When I run index.html, I get the frames like I need...Yay! But there is nothing in the address bar that indicates which page I'm accessing. Is there a way of calling Index.html and referencing a specific topic. The only thing that I can think of is like a bookmark or something? Does my question even make sense? :oops:

Thanks again.
Radu
Posts: 9434
Joined: Fri Jul 09, 2004 5:18 pm

Re: Please help...generating with frames

Post by Radu »

Hi Natasha,
Does my question even make sense?
Actually your question is the most asked question with regard to WebHelp :)

So if you open a single individual topic in the browser, it will contain an extra link at top called "With Frames". If you click that button the browser will open a location which will have the TOC on the left and the topic on the right.
The URL of that location looks like:

http://www.oxygenxml.com/doc/ug-oxygen/ ... -dita.html

So the trick is to open the "index.html" but also to pass it a parameter which points to the topic which should be opened in the right part.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com
n_white
Posts: 4
Joined: Thu Nov 24, 2011 5:22 pm

Re: Please help...generating with frames

Post by n_white »

Thanks so much for your help. I managed to get it working YAY!
Post Reply