Publishers of technology books, eBooks, and videos for creative people

Home > Articles > Design > Adobe FrameMaker

  • Print
  • + Share This
This chapter is from the book

Generated Files for Single Documents

The content for generated files is extracted from one or more source documents. You can generate TOCs and other generated lists for a book, but you can also generate a standalone file for a single document as the source.

Generating lists for a single document

You can generate files, such as a TOC or index, for single documents. You can also generate files for information purposes, for example, to see a list of condition tags used in the document.

To generate a TOC for a single document:

  1. From the Special menu of the document for which you want to generate a TOC, choose Table of Contents (Figure 13.80). A prompt appears to confirm that you want to create a standalone TOC.

    Figure 13.80Figure 13.80 In the document, choose Special > Table of Contents.

  2. Click Yes (Figure 13.81). The Set Up Table of Contents dialog box appears. Note that the Add File pop-up menu is inactive.

    Figure 13.81Figure 13.81 When prompted to confirm that you want to create a standalone TOC, click Yes.

  3. Move the paragraph tags you want to include in the TOC to the Include Paragraphs Tagged list (Figure 13.82).

    Figure 13.82Figure 13.82 Move paragraphs to the Include list. When you're finished, click Set.

  4. To add hypertext links from the TOC entry to the source of the paragraph in the document, select Create Hypertext Links.

  5. Click Set. FrameMaker generates the TOC, with the same page layout as the original file but with no paragraph formatting, and displays it (Figure 13.83).

    Figure 13.83Figure 13.83 The TOC has the same page layout as the original file and the paragraphs aren't formatted.

  6. Save the generated TOC in the same folder or use the Save As command to save it in a different location.

Tips

  • You can generate a standard index from a single document in much the same way as a TOC. Choose Special > Standard Index.

  • If you close a TOC or list that you generate from a single document without saving it the first time, the document disappears. You must save it the first time you generate it.

In addition to a TOC and a standard index, you can generate several types of lists. For example, you can generate a list of figure titles or table titles. One of the most widely used lists is a list of imported graphics.

To generate a list for a single document:

  1. From the Special menu of the document for which you want to generate a list, choose List Of > References (Figure 13.84). A prompt appears to confirm that you want to create a standalone list of references.

    Figure 13.84Figure 13.84 Choose Special > List Of > References.

  2. Click Yes (Figure 13.85). The Set Up List of References dialog box appears. Note that the Add File pop-up menu is inactive.

    Figure 13.85Figure 13.85 When prompted, click Yes.

  3. Move the items you want to include in the list to the Include References list (Figure 13.86).

    Figure 13.86Figure 13.86 In this example, move Imported Graphics to the Include list and click Set.

  4. To add hypertext links from the list entry to the source of the paragraph in the document, select Create Hypertext Links.

  5. Click Set. FrameMaker generates the list, with the same page layout as the original file but with no paragraph formatting, and displays it (Figure 13.87).

    Figure 13.87Figure 13.87 The list of references has the same page layout as the original file and the paragraphs aren't formatted.

  6. Save the generated list in the same folder, or use the Save As command to save it in a different location.

Tips

  • Lists present entries in the order in which paragraphs occur in the source document; indexes, such as an index of references (Figure 13.88), present entry paragraphs in alphabetical order.

    Figure 13.88Figure 13.88 Choose Special > Index Of > References.

  • Lists and indexes of references help you track special categories of information, such as a fonts used in the document (Figure 13.89). You can generate lists of all the items shown in Figure 13.90, including condition tags, external cross-references, publishers, text insets, unresolved cross-references, and unresolved text insets.

    Figure 13.89Figure 13.89 A list of references with fonts used in the document.

    Figure 13.90Figure 13.90 All of the special information about a document you can include in lists.

To add a title to a generated file:

  1. Type the title before the first entry on the first body page after you generate the file for the first time.

  2. Create a new paragraph format for the title, such as TOC Title or Index Title. Do not use a standard suffix, such as TOC, IX, or LOR, for this paragraph tag. When the file is regenerated, the title will remain in place as long as you haven't used a standard FrameMaker suffix (Figure 13.91).

    Figure 13.91Figure 13.91 The next time the TOC in this example is regenerated, the title, "Contents," will remain in place.

Updating standalone generated files and changing file setup

When a generated file is part of a book, it can be regenerated when you update the book. You can also update standalone generated lists.

To change the setup of or update a standalone TOC or list:

  1. Make changes in the document that is the source for the generated file.

  2. In the source document, from the Special menu, choose the same command you used to generate the file originally.

  3. When prompted to create a standalone document, click Yes.

  4. To change the setup, in the dialog box that appears, move items between lists (Figure 13.92).

    Figure 13.92Figure 13.92 To change the setup, move items between lists.

  5. Click Set. Entries in the generated file are updated reflect the new setup. Any formatting made in the file is retained.

Finding the source of an entry

When you spell check an index or other generated file, you might find a spelling error so, you'll need to correct the marker text entry. Or you might see some first-level that you should change to second-level. You could go to the page in the entry select marker symbols to find the right if you selected Create Hypertext Links you generated the file, you can easily find the source of an entry.

To find the source of a list entry by using a link:

  • In the generated list, Alt-Ctrl-click or Control-Option-click the page number in an entry (Figure 13.93). FrameMaker opens the source document, displays the page with the source paragraph or marker, and selects the source paragraph or marker (Figure 13.94).

    Figure 13.93Figure 13.93 Alt-Ctrl-click or Control-Option-click an entry ...

    Figure 13.94Figure 13.94 ... to go to the source.

Troubleshooting generated files

  • If you find a spelling or other error, go back to the source document, fix the error, and regenerate the file.

  • An empty entry in a TOC (Figure 13.95) means that you may have an empty paragraph in the source document tagged with an included tag. Delete the empty paragraph in the source document and regenerate the TOC.

    Figure 13.95Figure 13.95 Example of an empty TOC entry.

  • Because FrameMaker allows you to index a word automatically by inserting an index marker with no marker text (see page 282), if you insert an "empty" index marker, the index entry displays the next word from the source document (Figure 13.96). If you see a word that clearly doesn't belong in the index, this could be the problem. Go to its source and delete the index marker.

    Figure 13.96Figure 13.96 An example of a bogus index entry caused by an index marker with no marker text. An empty index marker has been accidentally inserted before the word "While" in the source document.

  • If a list contains an entry that doesn't appear to belong there, go to the source paragraph and check the entry's tag—you may need to apply a different tag so that the paragraph will not be included.

  • If an index is missing an entry, its marker may be a marker type other than Index. Go to the source and display the Marker window (choose Special > Marker). From the Marker Type pop-up menu, chooseIndex and click Edit Marker.

  • Double question marks in an index (Figure 13.97) mean that FrameMaker can find only one of the start or end markers or that the marker text doesn't match exactly (see page 283). Search for double question marks, and if you find them, check that you have both start and end range markers and that marker text is identical, including spelling, punctuation, and capitalization.

    Figure 13.97Figure 13.97 In this example, because the marker text doesn't match, FrameMaker thinks it's two different ranges with missing markers in each.

  • You can make changes in entries in generated lists, but the next time the list is updated, the change will be overwritten. If you find an error or something you want to change in a generated list, change the paragraph or marker text at its source and then regenerate the file.

Touching up generated files

While you are getting your files ready for print or PDF, you need to do a few thing in and the index after the content in files is frozen.

  • Fix bad line breaks. In a TOC, if a paragraph the source document contains a forced return, it will appear as an unneeded forced return (Figure 13.98). Delete the forced return symbol in the TOC (Figure 13.99).

    Figure 13.98Figure 13.98 Example of a forced return in a TOC chapter title entry.

    Figure 13.99Figure 13.99 After deleting the forced return.

  • Insert page breaks.

  • Visually inspect the file and apply any custom master pages, such as a Blank page for a last page with no entries.

Tips

  • Touch-up formatting is overwritten when you regenerate the file, so plan to perform touch-up work only at the end of the production process, when you won't be regenerating the file. Of course, if you need to create a draft document, you may want to touch up generated files, even though you know you'll have to repeat the process again (probably several more times) later.

  • Although many writers do this, it is not necessary to re-import formats from templates during final production. In fact, it's better practice not to do so. When you import formats from a template, you may accidentally impact parts of the document you don't intend to change.

  • + Share This
  • 🔖 Save To Your Account

Peachpit Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Peachpit and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about Peachpit products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites; develop new products and services; conduct educational research; and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email ask@peachpit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by Adobe Press. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.peachpit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020