-
1. Re: Robo 8: C/C++ map file is blank (urgent)
Anne,
It might help others troubleshoot your problem if you provide an example of your workflow. What is the exact procedure you are using that results in a blank map file? Have you searched other similar threads for a resolution. I ask this because I had issues with map files and discovered that my steps were out of order. The forums helped me resolve the issue (the TCS user documentation was no help at all). I'm wondering if you are having the same problems I did.
-
2. Re: Robo 8: C/C++ map file is blank (urgent)
Thanks for the response. That's actually a distinct possibility as I'm a TCS2 newbie. I come to it with this "mid-contract mindset" (e.g., "urgent") because my previous (XP) machine self-destructing after I'd already committed to the work. I'm now building rapport with a new Windows 7 machine with TCS2, on a deadline.
Late breaking news: I think I may have accidentally (!) fixed the problem. Can't be sure until the engineers confirm. They're in China, so I won't hear until tomorrow. I'd very much like to confirm with you that I've stumbled on the correct process, though. As you say, this was NOT something I got from the TCS2 documentation. Therefore, I'll provide my workflow first, which you can read OR skip to the bottom for this new revelation.
I'm working on a Frame book with a TOC, no index at present, and seven chapters. Conditionals are set to show "Online" material only. I have FileName markers at each of the headings (but as yet am not sure what TopicAlias does, so I have none of those).
I start by following the steps in R.J. Jaquez's tutorial (which I pored over like an obsessed person and from which I derived a checklist that I've been using ever since). After opening Robo:
- Open Frame (leaving it at the entry screen).
- Back in Robo, link to the book file.
- Right-click the book name and do an initial generation.
- Convert the TOC (right-click book name, select Properties, and provide a new TOC name, click OK; then right-click book name again and select Update > Update.)
- Go to File > Properties and map styles. I've been using an apparently successful script (.isf) that I saved from a good test session, plus a .css fle named "MyFave," which says much about how often I use that. This step therefore goes pretty fast.
- Click Apply, click OK, then right-click book name and select Update > Update.
- I edit stuff into the "First Topic" (sometimes Welcome) to use as a splash screen.
- Generate the single-source layout of choice, which right now is WebHelp (Primary Layout). In that dialog box I point to the correct TOC and specify that all files are to use the same .css (MyFave). Sometimes I've tried a pre-packaged skin, sometimes not.
I let this process run, then view Results, which look OK to me.
In the Project Setup pod I then select Context-Sensitive Help and right-click Map Files, select New Map File, and when I click OK it generates one for C/C++. (There was a point when I selected C/C++ in the past but can't replicate it right at the moment.)
This creates <companyname>.h, which is empty, which started this inquiry.
*** However (the new discovery), I see that I can go to Edit > Map IDs... and select just the full topic names to automap, which apparently fills the existing-if-empty <companyname>.h with Mpa ID, Map #, and Topic triads.
So I think my modified question is, Is this actually how it's done?
Thanks for your time.
Anne
-
3. Re: Robo 8: C/C++ map file is blank (urgent)
Anne,
I'm actually using TCS 1.3, so there may be an easier or better way of generating map files for context-sensitive help in your version (2.0). Here's my method for setting up context-sensitive help:
- Retrieve map ID numbers from my Engineering group, if applicable. In some cases, I simply assign my own numbers. In others, they provide a list according to the software screens from which we will provide context-sensitive help. You can also import a map file that they provide it.
- Create new marker in FM that will be used for context-sensitive help entries. I named mine CSH.
- Enter CS topic entries in FM using the new marker. RH will use these entries to create CS links to the topics that are generated from FM. For example, we have a software screen used for searching user records. In FM, I have a heading titled, "Searching User Records," which becomes an RH topic when imported. When users press F1 on the Search User Records screen of our company's software application, I want the "Searching User Records" topic to open. I enter the CS entry "Search_Records" on that heading line in FM.
- For each CS topic entry in FM, enter the same entry (e.g. Search_Records) in RH on the Edit Map IDs window and assign a map ID number. When performing an update command, RH will locate the FM CS entry that matches the map ID entry and link the two. Essentially, the CS entry in FM and map ID entry in RH must match.
- From Project Manager in RH, right-click over my imported book and select Properties.
- On the Content Settings tab, enter the marker name used in FM for CS entries (e.g. CSH) in the Define Context Sensitive Help Marker field.
- Perform an Update All command in RH.
- Verify that all map entries in RH have correctly linked to the topics generated from FM.
- If a heading that includes a CS entry changes in FM (say from "Search User Records" to "Search Records"), the context-sensitive link won't change unless the CS marker is edited, deleted, or moved.
See also Context-Sensitive HELP!!!!!
Hope this helps.
-
4. Re: Robo 8: C/C++ map file is blank (urgent)
Sorry to have been delayed in answering. Once I learned that I could edit map IDs I was on a roll. I've just delivered the OLH. I consider it flawed for other reasons, having to do with seeing the filenames in the Search list (WebHelp) and some formatting issues around numbered and bulleted lists. However, I'll post questions on those items elsewhere---I think I saw at least one of those in my Forum page-down this afternoon.
I appreciate this well-thought out workflow! I'm studying it.
I believe the differences between our workflows (aside from you being far more experienced at it than I!) probably have to do with you being in TCS1.3, and also that I'm working with an inexperienced client. (The blind leading the blind, basically.)
In my case the client stated very sincerely that they wanted CSH, and I've spent hours learning how to make that happen :-). In point of fact, though, they've never had CSH before and don't have a clue yet how to apply it to the product. (I've sent them Chpt 11 of the Robo 8 user guide for reference.) Getting map ID numbers from the engineering group is a bit advanced for this situation. :-)
In fact I won't have a good test of whether or not my map file even works for a month or so. They budgeted no time on this release cycle to test the CSH system in place. Instead they plan to apply it in a product update. I plan to experiment with your settings and see if I can get something better to them before then.
My marker name is FileName. My File > Project Settings > Edit conversion settings... > Other settings are:
Context Sensitive Help Marker: blank --- according to your workflow, this should be FileName
Topic Name Pattern: grayed out but is "(Default)"
Topic Name Marker: FileName --- so should this be blank instead?I also have chapter titles and head levels 1, 2, and 3 set for pagination, but I understand that having the Topic Name Marker field active disables paragraph pagination settings in favor of using the topic name marker.
I will continue to experiment. I appreciate your time, btw. (If you have a little more, I'd welcome answers to the settings questions above.)I've learned a lot hanging out in various Forums, but have much more to learn.
Anne -
5. Re: Robo 8: C/C++ map file is blank (urgent)
Hi Anne,
Yes, the Context Sensitive Help Marker in your case should be FileName.
The Topic Name Pattern and Topic Name Marker should have no effect on the CSH. These affect the FM headings or sections that will be converted into RH topics. Although, I don't have Topic Name Marker in my version of RH, but if my assumption is wrong, I'm sure someone can correct me. Granted, if you don't select the right FM headings or sections to convert into RH topics, then any CSH issues are secondary.
The key components of creating context-sensitive help with the TCS are the FM CS markers and the RH Map ID definitions.
And don't worry too much about the Engineering group. I, too, have had to work with engineers inexperienced with generating CSH, but they'll figure it out.
Good luck!
-