FrameMaker (v7.2 to 11): Updating TOC Wipes Formatting

Problem

Why does updating a book strip all formatting from existing TOC entries? I’ve already imported paragraph formats to the TOC file. I haven’t altered the text of the entries or their page numbers, just applied formatting from the paragraph designer. Clicking “default font” doesn’t restore applied formats.

I would understand if new entries picked up during the update had no formatting, but I can’t see why entries that match what’s already there and don’t change would have their formatting stripped out.

This makes updating the TOC take two, three, four times as long as it should!

Solution

You need to set up how you want your TOC to look on its reference page. If you already have a TOC set up correctly, use File > Import > Formats, deselect All, then select Reference Pages and Paragraph Tags, and import.

The next time you update the book, the TOC will be in the correct formatting.

If you don’t have one set up correctly, you’ll have to do it.

  1. Click View > Reference Pages
  2. Find the reference page labeled TOC. It’ll probably have something there already with paragraph tag labels such as Heading1TOC. Use the paragraph designer to format your <heading_style>TOC tags on this page.
  3. When you’re done, click View > Body Pages and then regenerate the book

Also, when you format <heading_style>TOC in Paragraph Designer, be sure to click Update All, not Apply.

FrameMaker (v7.2 to 11): Hypertext links not working when PDF ‘ed as single files of a book

Problem

Here are a few more details in case others encounter this. When you print or save as PDF from a .book file, FrameMaker encodes the links and destinations as if you are making a single PDF file from the book. This is normally what you want. In Dave’s case, he wanted a separate PDF for each component in the book. He used the built-in option for printing a separate file for each component in the book. However, because you are printing (or saving) from the .book file, FrameMaker still encodes the links as if you were making a single PDF file.

The only way to get the individual component-to-component links to work is to open and print (or save) each component individually, not from the .book file. Obviously, if you have a book with many components, this can be a tedious task. If you find yourself in this situation, I have a FrameScript script that will save each component as PDF one-at-a-time from the book.

Fortunately, Dave’s book only contains a handful of components.

Solution

The problem is that FrameMaker was resolving the hypertext links incorrectly because I had had all the files in a .book and was printing the .book. The “fix” was to close the .book file, keep the files in their respective places, encode the links as needed, and to save each file individually.

Problem solved.

Rick did mention the use of the MicroType TimeSavers plugin for FrameMaker, but I have not yet succeeded in convincing “the powers who are” to let me get it.

FrameMaker (v7.2 to 11): Convert 1 Excel column into 3 balanced columns to paste into FM

Problem

Win 7, Excel 2003, FM 10

I have a list of 117 or so items that I get from a client as a single column in an Excel spreadsheet. I need to take that list and convert it to three balanced columns (maintaining the alpha sort) to paste into FM.

I did it once manually, but the list keeps changing, so I’m looking for a way to easily convert to three columns, so I can just copy and paste it into FM whenever it changes. I’m think there’s a way to do this in Excel, but my Excel knowledge could fit on the point of a pin (not even the head of the pin).

Anyone know how to do that in Excel?

Solution

Here’s what worked:

  1. From the Excel worksheet with the list (all in one column), save as to a text (tab delimited) file.
  2. Import the file into FM using the copy option, selecting Text as the type, then selecting a table format, make each para a cell, and three columns. (Wrote that from memory, but if someone else needs to do this, it should get you through the process).

Worked well and even got the alpha list to go alpha across instead of down.

FrameMaker (v7.2 to 11): Unavailable fonts message

Problem

I am using FrameMaker 9 on Windows 7. When I open a particular book, I get the classic ‘unavailable fonts’ error on many of the files (followed by ‘unresolved cross-reference’ errors, but for now I’m assuming the two are related). When my colleague opens the same book, he doesn’t get any errors. Fair enough, our font setup might be a little bit different.

FM doesn’t report which fonts are causing the problem in the message, so I took two files, one with the error and one without, and generated a list of fonts using Special > List Of > References. Both files contain exactly the same fonts so I can’t isolate it to any font in particular. Indeed, the fact one has a problem with one of the fonts and the other doesn’t makes me think the error itself may be incorrect. Has anyone else experienced this or have any idea what I can do next? It seems to be one particular book causing the problem. Checking the ‘Remember Missing Font Names’ option doesn’t stop the problem from re-occurring.

Solution 1

You posting seems to reflect several small misconceptions about how FrameMaker works. Let me see if I can address them one at a time.

First, a single “unavailable fonts” message in one file can, in fact, also be the cause of subsequent “unresolved cross-references” messages in other files. When you open any file that contains cross-references, FrameMaker attempts to refresh all of those references by looking at each target location and grabbing the current text string and numbering properties (autonumbering and page numbering). If any of those cross-references point to locations that are in other files, FM has to silently open each of those files to refresh the references. But if a “target” file has an unavailable font condition, that error prevents FM from completing the “silent open” operation that is necessary to resolve the cross-reference. The result is an “unresolved cross-reference” message. But note that if the file with the unavailable font condition is already open when you open the file that refers to it, you will *not* get an “unresolved” message because FM doesn’t need to do a silent open.

Second, FrameMaker *does* report which fonts are unavailable, but does not do it in the warning message itself. Instead, you have to look in the FrameMaker console window, which most of us are in the habit of ignoring or dismissing without bothering to read it.

Third, the unavailable font does not have to be applied to any content that appears in the body of the document to cause the warning message. It is enough for the font to be specified in the definition of some format that you don’t actually use, and this font specification can be in any of your catalogs–a character format, a paragraph format, a cross-reference format, or a table format. Table formats are a particular problem because each format definition invisibly embeds the character and paragraph formatting for the table title, and for each cell in the heading row, the footing row, and the first body row of the table that was the prototype when the format was defined; you will never be able to find these using the FM GUI unless you create an instance of each table format that exists in your catalog. Unavailable fonts can also lurk on master pages and reference pages which are not examined when you do a “find font” operation (which only searches the context in the current view) or List of References operation (which only looks at body pages). They can even be hiding in certain types of graphic objects that contain font specifications (PDF, EPS, WMF, EMF).

Fourth, to get rid of an unavailable fonts condition you need to *UN-check* the “Remember Missing Font Names” preference. Remembering the names means that FM will do a *temporary* substitution of an available font for an unavailable one, but will retain the original, unavailable font specification in the version of the file that it saves. What you need is for FM to *forget* the names of the unavailable fonts and save the file with the substituted font specifications. So the procedure would be:

  1. Open the offending file, dismissing the “unavailable fonts” warning.
  2. Examine the FrameMaker console to determine whether all of the substitutions FM has made are appropriate (e.g., no sans-serif font subbed for a serif, no text font subbed for a symbol or wingding font).
  3. Close the file.
  4. Turn OFF “Remember Missing Font Names”.
  5. Open the file. Notice that the warning message has changed, and that FrameMaker now warns you that it will be permanently *replacing* the fonts rather than substituting for them.
  6. Examine the file to make sure it looks OK.
  7. Save the file. Many people neglect to do this because they haven’t made any explicit edits or format changes, but the font change will not “take” and be carried forward unless the file is saved after you let FM make the replacement.
  8. Turn “Remember Missing Font Names” back ON. (It is normally a very good idea not to reformat a file from a colleague or client to match your own less complete font library.)

This *should* take care of the problem unless the bad font name is embedded in a graphic.

Another approach that some users swear by is to save the offending file as MIF and then use a text editor to search for the names of the unavailable fonts, as reported in the FM console. After making the substitution with the font editor, the file is saved as MIF, then opened from FrameMaker and saved back to .fm file format. This approach still will not look inside graphics objects, but I have personally seen cases where the source .fm file contained a *completely* spurious font specification (for a Chinese font in my case) that was removed simply by passing it through the FM->MIF filter (i.e., the bad font was not findable in the the MIF file and was gone when the file was restored to .fm format).

Also, choosing a font set is always a bit of a matter of taste. However, it is usual to see in (company) manuals sans serif types like Arial (ususally because no one bothers to check for anything else) or the Calibri font that came with the newer MS Office suites.

I used to opt for Helvetica instead of Arial, mainly because the numbers were clearer in Helvetica. But that was clearly before Calibri times. 😉

Some serif fonts come to mind. I am working with a book now about a certain institution, and I decided to use the old Cheltenham for body and Myriad Pro for headings.

I have spent a lot of time through the years looking for and comparing fonts, and in one instance, trying to decide on the best font for the dim-sighted, I made four copies of sample text with different fonts and had people test read (from a distance to closer up). The one decided upon seemed to help the dyslexics too.

So, if you want to study fonts, you will be spending a lot of your free time. But it is fun! But your customer will not complement you on it, because he/she/they do not know what it really is that makes them like or hate the looks of the book. There are so many things to consider.

But you are right: Readability counts. So, not Arial! And not fancy fonts.

Probably this is of little help, but it is Friday night. 🙂

And, I could send you some samples in pdf if you like. Main thing is: What does your font library consist of? New fonts can be very expensive.

Solution 2

In the threads, I saw no mention of the default printer selection. Postscript printers usually have a font set loaded. If you select this printer as your default, Windows finds the fonts on the printer and allows use even though they are not on the computer. But when you create a PDF, you MUST use the Adobe PDF printer for successful results, and this virtual printer does not have the fonts, and therefore you get the missing fonts message. So, to clean up your files, do the following: -Uncheck the Remember Missing Font Names box -Set Adobe PDF as the default printer -Open and close all files in the book (you get the message for all impacted files) This permanently substitutes the fonts and will work until you again paste in content from other files and corrupt the file again.

FrameMaker (v7.2 to 11): Font suggestions for book

Problem

I’m working in FM 8, Win 7 x64 on a book that will be published this Fall. I’ve now been asked to do the book design, in addition to most of the writing and basic template design. The subject matter is primarily financial . it’s a book about the history of taxation. It’s not a scholarly work at all, but rather one designed to “wake up” American teens and young adults to some of the issues involved. Footnotes are used here and there, but more for explanation of background/details than in a traditional sense as references. The book will be published in a standard 6×9 format, paperback.

All that having been said . What are people’s favorite or recommended fonts for such a project. And since this is being published on a shoestring budget with a nonprofit/educational bent, suggestions of free fonts would be most welcome.

Solution

Besides being a matter of taste (which really cannot be argued), font choice cannot be done intelligently without knowing *lot* of other information, such as:

  • medium of the deliverable (printed, PDF, HTML, eBook, etc.)
  • page size (if fixed, or range of page size if variable)
  • column width and point size (which together determine the point size range)
  • leading
  • nature of content (fiction, general non-fiction, scholarly writing, technical documentation, etc.)
  • natural organization of content (all text in long paragraphs vs. text blocks broken up by shorter paragraphs and/or lists vs. text with lots of tables and figures, etc.)

What works well for the kind of technical content I work with most of the time (long, complex sentences but often fairly short paragraphs, and lots of tables and bulleted lists) is very different from what I would use for some of the general non-fiction I edit on the side. And neither of those correspond to what I prefer to see when I read fiction.

If you asked this question over on the Techwr-l list, I’m sure you’d get a flood of highly opinionated answers. If you asked it on the copyeditors list, I think you’d get a handful of “it depends” answers similar to mine since there are some actual book designers on that list. But over here in the world of FrameMaker, I’m not sure that we have a lot of people who fancy themselves font fondlers.

FrameMaker (v7.2 to 11): Unwanted items in the TOC

Problem

I have three unwanted items in my TOC. They appear on the TOC reference page and they are:

<$paratext> <$pagenum>

<$paratext> <$pagenum>

<$paratext> <$pagenum>

The first one is a ContentsTitleTOC.

The second one is a LOFTitleTOC.

The third is a LOTTitleTOC.

I don’t want “Contents” as an entry in the TOC; nor do I want “Figures” and “Tables” in the TOC. They are separate lists of items that appear at the beginning of the book immediately after the TOC.

How do I get rid of the three entries in the TOC Reference page and make the deletion stick? I would appreciate your counsel. Thanks in advance.

Solution

In your book, highlight the TOC file entry, right-click, and select Set Up Table of Contents…

On the left side of the dialog that comes up, click on the items you don’t want and move them over to the right side.

Then go to your reference page, highlight these same items there and delete them. You can leave them there if you think you might want to add them later and use the same formatting.

FrameMaker (v7.2 to 11): An interesting Mif2Go project – (SalesForce)

Problem

I need to import unstructured FM content into a new SalesForce Knowledge knowledge base. Individual procedures written in FM11 get published out via Mif2Go as Standard HTML (not help), and then imported by SalesForce with the help of a .CSV file. Overall it required about a 30-step procedure to get the content into SF, but now I plan to trim down the process. Then I will write it up and present it at the STC Summit or some other place.

The first question is: Why is this so difficult? I think it’s because it is a technically challenging project that demands a lot of up-front work on the FM side, so no knowledgebase provider wants to develop and support it, and Adobe doesn’t see the value in it for the neglected FrameMaker product (and market!)

Solution

The trick is to produce what SalesForce needs from what FM can give it.

SalesForce’s importer is pretty primitive and inflexible. AFAIK this is not unusual; last year I tried the same thing with a MindTouch knowledge base and that could import only from a .CHM, and even that was plagued with problems.

SalesForce needs a set of HTML pages saved in a particular nested file structure, accompanied by a .CSV file that provides the title of each article, its address, and some other information. The HTML, folders, and CSV must all be provided in a .ZIP along with a Project file created by the SalesForce admin.

FM’s Save as HTML is buggy, barely supported by Adobe, and its HTML is not very clean. I could not generate good individual HTML pages from RoboHelp.

Mif2Go offers the flexibility I needed.

To develop the CSV was a different adventure. I needed a list of article titles mapped to the HTML file names, which are autogenerated with names like aa100543.htm. I could open each file and copy the title (there is a Mif2Go setting to make the title match the FM Heading 1 or Heading 2), but that would be tedious and error-prone for hundreds of files.

Jeremy had a workaround to get my titles and file names together. After generating the Standard HTML output, I generated OmniHelp output just to get a single .JS page with the list I needed. I deleted all the rest of the output, keeping only that file.

Then I edited the file with several search-and-replaces and saved it as .CSV.

Then I was able to zip together the HTML and the .CSV and hand it off to the SalesForce Admin, who (after a few false starts) finally reproducibly imported 24 and then 56 files. We have some bugs, but we think we know how to fix them.

Now I have to refine the process, learn how to optimize my FM content, and document it because once the knowledgebase is launched with my existing FM content, I am committed to updating it forever!

Thanks everyone for all your input on this complex project!

FrameMaker (v7.2 to 11): Chapter Numbers

Problem

I have documents that start with a tag called ‘ChapTitle’ and some that start with Heading1.

The reference pages are set up so that pages with ‘ChapTitle’ on them will use the ‘First’ master page. This has a header with the chapter number in it. Pages starting with Heading1 are Right/Left and don’t have a chapternumber.

Every file in the book is set to ‘Continue Numbering from Previous Chapter in book’.

The chapter numbers increment correctly.

The document with a Heading1 tag should show the numbering ‘3.1’. It doesn’t, it shows ‘4.1’.? The chapter number has incremented.

Why is this?

Solution 1

It sounds like you’ve got two numbering systems going on. One uses <$Chapnum>, the other uses paragraph numbers instead.

You can influence the <$Chapnum> numbering with the Format-Document-Numbering dialog, tab ‘Chapter’

You can influence the paragraph numbering with the Format-Document-Numbering dialog, tab ‘Paragraph’.

Check the Numbering properties of the ChapTitle and the Heading1 paragraph tags. You should use the same numbering system in all para tags that have a paragraph number.

Solution 2

Ah – solved my own problem with help of ‘Publishing Fundamentals: Unstructured Framemaker’.

Set the numbering to continue from previous page in book. I don’t know why this wasn’t set in my original template.

Solution 3

Ok, I’ve found out why it was going wrong.

It seems that the first document in the book using chapnum has to have an override setting the chapnum to start at 1 (this document being the third in the book, after the cover and ToC).