home *** CD-ROM | disk | FTP | other *** search
- Path: senator-bedfellow.mit.edu!bloom-beacon.mit.edu!pad-thai.aktis.com!pad-thai.aktis.com!not-for-mail
- From: r4jmcco@srv.PacBell.COM (Robert McCormick)
- Newsgroups: comp.text.frame,news.answers,comp.answers
- Subject: FrameMaker FAQ (Frequently Asked Questions) 1/2
- Supersedes: <frame/faq/part1_745041620@GZA.COM>
- Followup-To: comp.text.frame
- Date: 19 Aug 1993 00:00:18 -0400
- Organization: Teknekron Communications Systems, Inc.
- Lines: 755
- Sender: faqserv@GZA.COM
- Approved: news-answers-request@MIT.Edu
- Expires: 2 Oct 1993 04:00:08 GMT
- Message-ID: <frame/faq/part1_745732808@GZA.COM>
- Reply-To: bobmcc@tcs.com,r4jmcco@pacbell.com
- NNTP-Posting-Host: pad-thai.aktis.com
- Summary: This posting contains a list of Frequently Asked
- Questions (and answers) about the FrameMaker set
- of document publishing products. These FAQs should
- be read by anyone who wishes to post to the
- comp.text.frame newsgroup or the framers mailing
- list. This is part 1 of 2 parts.
- X-Last-Updated: 1993/08/17
- Xref: senator-bedfellow.mit.edu comp.text.frame:6298 news.answers:11569 comp.answers:1663
-
- Archive-name: frame/faq/part1
- Version: 2.0
- Last-modified: 1993/08/16
-
- FrameMaker Frequently Asked Question (FAQ) List
- ===============================================
-
- ============================================================
- * OFFICIAL STUFF
-
- ------------------------------------------------------------
- ** What is this all about?
-
- This article contains answers to some Frequently Asked Questions (FAQ)
- about FrameMaker, often seen in the Usenet newsgroup "comp.text.frame"
- and on the "framers" mailing list. It is posted to help reduce volume
- in this newsgroup and to provide hard-to-find information of general
- interest. This FAQ is in two parts.
-
- ------------------------------------------------------------
- ** Copyright & Distribution
-
- This article, as a collection of information, is Copyright 1993 Robert
- McCormick. Distribution through any means other than regular Usenet
- channels must be by permission. The removal of this copyright notice
- is forbidden.
-
- Please redistribute this article to people who ask for it or people
- who use FrameMaker! However, distribute the whole file, including the
- copyright notices and the attributions.
-
- ------------------------------------------------------------
- ** Credits
-
- Many people all over the world have contributed to this FAQ, and have
- graciously provided mail servers and FTP sites. Their names are
- included with their contributions. I usually edit contributions, so
- what you see here may not be the contributor's exact words.
-
- ------------------------------------------------------------
- ** Corrections & Additions
-
- Send corrections or new questions WITH ANSWERS to Bob McCormick at
- bobmcc@tcs.com. If you have a question and need an answer, post or
- mail your questions to the group, collect the responses, put together
- a summary answer, and then mail it to me for inclusion in the FAQ.
-
- ------------------------------------------------------------
- ** Disclaimer
-
- comp.text.frame and the framers mailing list are not officially read
- or supported by Frame Technologies, Inc. To speak officially with
- Frame Technologies Inc., especially to report a problem or to suggest
- and enhancement, contact them at:
-
- Frame Technology, Inc. Tel: +1 408-922-2744
- Frame Technical Support Fax: +1 408-433-1928
- 1010 Rincon Circle Internet-USA: comments@frame.com
- San Jose, CA 95131 USA Internet-Eur: intltechsup@frame.com
- AppleLink: FRAME.TECH
- BBS: +1 408-433-4841 (2400)
- +1 408-433-4867 (9600)
-
- I and the contributors do not accept any liability for the accuracy or
- applicability of this information to your situation. Make a backup
- copy of your file(s) before you attempt any complex procedure,
- especially one done outside of the FrameMaker program. Be careful.
-
- ------------------------------------------------------------
- ** Other Items
-
- Most answers are written for FrameMaker version 3.0, 3.0.1, or 3.1,
- and may not work for (or be applicable to) earlier versions.
-
- Unless the posting is of local interest (like a user group meeting),
- please use Distribution: world in your posts.
-
- This article is in EMACS outline format, using the standard header
- symbol "*".
-
- Abbreviations:
- FM FrameMaker
- TOC Table of Contents
- XREF Cross-reference or cross-reference marker
-
- ------------------------------------------------------------
- ** If you are new to Usenet, subscribe to news.announce.newusers
- and read the postings there. They give you general information and
- tips on making life easier for you and everybody else. Read:
- "A Primer on How to Work With the Usenet Community"
- "Answers to Frequently Asked Questions about Usenet"
- "Hints on writing style for Usenet"
-
- ------------------------------------------------------------
- ** Other FAQs
-
- To find other FAQs, subscribe to news.answers, or send e-mail:
- To: mail-server@rtfm.mit.edu
- body contains: send usenet/news.answers/index
- or, use anonymous FTP:
- Host: rtfm.mit.edu
- Directory: /pub/usenet/news/group/name
- As an example, this FAQ is stored in the directory:
- /pub/usenet/comp/text/frame
-
- ------------------------------------------------------------
- ** FTP (File Transfer Protocol/Program) Instructions
-
- FTP is a way of copying files between networked computers. If you
- need help in using or getting started with FTP, send e-mail:
- To: mail-server@rtfm.mit.edu
- body contains: send usenet/news.answers/ftp-list/faq
-
- Most files available by FTP have been archived and compressed. The
- unpacking programs for Unix are included on most systems. Those for
- Mac and PC are available from most FTP sites; consult README files.
-
- ============================================================
-
- * VERSION INFO, LEGEND, CONTENTS
-
- ------------------------------------------------------------
- ** Notes about this version
-
- The FAQ has been re-organized, to group items by topic and add EMACS
- outline mode (leading asterisks). It has also been split into two
- parts.
-
- Eagle-eyed correctors for this issue:
- Ken d'Albenas <kendal@autotrol.cuc.ab.ca>
- Jane Clark <jane@citr.uq.oz.au>
- Greg Wohlenberg <wohlenbe@inter-tel.com>
-
- ------------------------------------------------------------
- ** Legend
- + indicates questions new to this issue;
- ! indicates those with significant changes since the last issue.
-
- ------------------------------------------------------------
- ** Table of Contents
-
- part1:* OFFICIAL STUFF
- part1:** What is this all about?
- part1:** Copyright & Distribution
- part1:** Credits
- part1:** Corrections & Additions
- part1:** Disclaimer
- part1:** Other Items
- part1:** If you are new to USENET, subscribe to news.announce.newusers
- part1:** Other FAQs
- part1:** FTP (File Transfer Protocol/Program) Instructions
-
- part1:* VERSION INFO, LEGEND, CONTENTS
- part1:** Notes about this version
- part1:** Legend
- part1:** Table of Contents
- part1:** Future Items (contributions gladly considered)
-
- part1:* INFORMATION SOURCES
- part1:** INF-1: Electronic Media (mailing lists, newsgroups, BBSs, fax)
- part1:** INF-2: Printed Media (books, magazines, etc.)
- part1:** INF-3: User Groups
-
- part1:* TEXT FORMATTING AND FLOWS
- part1:** TXT-1: How can I control which master page is used when text flows off
- of the current page?
- part1:** TXT-2: What exactly is copied during File:Use Formats?
-
- part1:* AUTONUMBERING, CROSS-REFERENCES, VARIABLES, TOC
- part1:** NUM-1: How do I set up autonumbers for Figures as "Figure 5-1"?
- part1:** NUM-2: How do I place an autonumbered figure number in an anchored
- frame? Why doesn't it update properly?
- part1:** NUM-3: How can I get "Page 3 of 152" to work for a multi-file book?
- part1:** NUM-4: I want chapter number and title on separate lines, both in TOC.
- part1:** NUM-5: Can I generate a table-of-contents directly inside a file?
- part1:** NUM-6: Why do some of my cross-references keep changing to point
- to the wrong paragraph?
-
- part2:* PAGE LAYOUT
- part2:** PAG-1: Is there any easy way to move one or more pages to a different
- place in the document? (Two layout models.)
- part2:** PAG-2: How do I force a page break?
- part2:** PAG-3: How can I change the page size of an existing document?
- part2:** PAG-4: I used a rotated (landscape) page for a large figure, but the
- figure keeps moving to a portrait page!
-
- part2:* PRINTING
- part2:** PRT-1: How can I print "DRAFT" on the background of every page?
- part2:** PRT-2: How can I print with the "-h" switch in FM3.0/3.1?
- part2:** PRT-3: How can I set the default printer name?
- part2:** PRT-4: How can I print pages in pamphlet/booklet/signature order?
- part2:** PRT-5: Is there a way to print certain pages or ranges from a book
- or file, besides the one-range-at-a-time printing via FM?
-
- part2:* FILTERS, IMPORT/EXPORT, POSTSCRIPT
- part2:** FIL-1: Where can I find a filter to convert <XXXXXX> to Frame?
- part2:** FIL-2: How do I convert a Frame document from Mac to Sun? (etc.)
- part2:** FIL-3: Why do my imported images show up as gray rectangles when I
- transfer a file from <platform-A> to <platform-B>?
- part2:** FIL-4: How can I automatically import a graphic file whose format is
- not recognized by FM, if I can do the conversion manually?
- part2:** FIL-5: How do I incorporate code fragments in a Frame doc?
- part2:** FIL-6: Are there any SGML converters for FM?
- part2:** FIL-7: I am having problems transferring PostScript in and out of FM.
-
- part2:* SPELLING, GRAMMAR, BIBLIOGRAPHYS, ENDNOTES, ETC.
- part2:** SGB-1: Are there any grammar checkers for FM?
- part2:** SGB-2: Do you know what happens if the spell checker finds "Interleaf"
- part2:** SGB-3: How can I do bibliographies in FrameMaker?
- part2:** SGB-4: Can FM produce automatically numbered endnotes?
-
- part2:* CONFIGURING FM, PLATFORM-SPECIFIC ISSUES
- part2:** PLT-1: How do I display white text on a black background?
- part2:** PLT-2: How do I open documents from the command line using an already
- running FrameMaker (and thus only a single license)?
- part2:** PLT-3: Where can I find keyboard shortcuts for [platform]?
-
- part2:* TEMPLATES AND CLIP ART
- part2:** TMP-1: Where can I get the FUN tape?
-
- ------------------------------------------------------------
- ** Future Items (contributions gladly considered)
-
- - Any generally-useful info on Postscrip-FM issues (lines that need
- to be added/removed, import/export, etc.)
-
- - How can I place FM documents under configuration management/
- software control? (I have some info on this already.)
-
- - How can I merge a list of names and addresses with a FM document
- to generate personalized letters? (fmmerge from FUN tape.)
-
- ============================================================
- * INFORMATION SOURCES
-
- ------------------------------------------------------------
- ** INF-1: Electronic Media (mailing lists, newsgroups, BBSs, fax)
-
- *** A. How to get the latest version of this FAQ
-
- This FAQ is posted monthly to comp.text.frame, comp.answers, and
- news.answers. To get the latest copy via mail server, send e-mail:
- To: mail-server@rtfm.mit.edu
- with body containing: send usenet/news.answers/frame/faq/part1
- send usenet/news.answers/frame/faq/part2
-
- The FAQ is also available via anonymous FTP:
- Host: rtfm.mit.edu
- Directory: pub/usenet/news.answers/frame/faq
- Files: part1, part2
-
- *** B. comp.text.frame Usenet newsgroup
-
- Subscribe to the Usenet newsgroup comp.text.frame.
- To find out how to read a newsgroup, ask your system administrator.
-
- *** C. "framers" reflective mailing list
-
- This is a reflective mailing list, which is also partially gatewayed
- with comp.text.frame in one direction: from the newsgroup to the
- mailing list but not vice versa. The 'cream of comp.text.frame' is
- forwarded to the mailing list.
-
- To get on the mailing list, use the automated administrator; to find
- out how, send e-mail:
- To: majordomo@drd.com
- body contains: help
-
- If you have trouble with the automated administrator, send email to:
- framers-request@drd.com
-
- *** D. Frame Technology's Bulletin Board System
-
- Frame Technology has created a bulletin board system that can be used
- to submit bug reports, leave messages, read bulletins and technical
- tips, or upload/download files.
- 2400 bps: +1 408-433-4841
- 9600 bps: +1 408-433-4867
- Recommend terminal emulation: ANSI
-
- Contributor: Al at Frame Tech Support
-
- *** E. Frame Technology's FrameFacts FAX Retrieval System
-
- Frame Technology has created the FrameFacts FAX retrieval system.
- This system is activated by your touch-tone phone, and will send
- requested documents to the FAX machine of your choosing. FrameFacts
- contains the latest Technical Notes and tips for all the FrameMaker
- platforms and products. This system is updated weekly, as is the BBS.
- You can reach FrameFacts by calling +1 408-428-6153. You may wish to
- request the Index of Documents the first time you call. (This system
- may only work if you are calling from USA or Canada.)
-
- *** F. Other Usenet newsgroups of interest to desktop publishing.
-
- comp.text, comp.text.desktop, comp.text.sgml, comp.lang.postscript,
- comp.sources.postscript, alt.hypertext
-
- ------------------------------------------------------------
- ** INF-2: Printed Media (books, magazines, etc.)
-
- *** A. Michael Fraase. 1992. "Structured Publishing from the
- Desktop: Frame Technology's FrameMaker." Business One Irwin,
- Homewood, IL. 336 pp. Softbound. $24.95 ISBN 1-55623-616-6.
-
- Contributor: Binion Amerson
-
- *** B. Juergen Gulbins. 1992. "Desktop Publishing mit FrameMaker".
- Published in German. Springer-Verlag Berlin Heidelberg New York.
- ISBN 3-540-54455-0.
-
- Contributor: Karl Obermayr
-
- *** C. Framers forum Magazine
- Published quarterly. $24.95 yearly in USA, $29.95 outside USA.
- Framers forum Magazine Tel: +1 503-637-3275
- Subscription Department Fax: +1 503-637-6876
- 37213 SE WildCat Mt. Dr.
- Eagle Creek OR 97022 USA
-
- *** D. FrameFootnotes: The technical newsletter for FrameMaker users.
- Published (quarterly?) by Frame Technical Support. Contact:
- Technical Support/FrameFootnotes
- Frame Technology Corporation (address above)
-
- *** E. FrameFocus: Marketing newsletter from Frame.
- Published quarterly by Frame Technologies. Contact:
- Editor, FrameFocus
- Frame Technology Corporation (address above)
-
- ------------------------------------------------------------
- ** INF-3: User Groups
-
- Usually called FUN for Frame User Network. Country code is +1.
-
- Atlanta, GA USA
- Dana O'Farrell 404-417-4811 Meets quarterly.
- Chicago IL USA
- Lester LaPierre 708-576-4445
- Cleveland OH USA
- Eric LaPresto 216-445-9368
- Columbus OH USA
- Alan Addis 614-477-3600 x2497
- Peggy Sutliff " x3200
- Dallas-Fort Worth TX USA
- Darja Adams 214-869-0680 x2257
- Dayton OH USA
- Brian Bermhardt 513-257-2479
- Detroit MI USA
- Myron Hayden 313-459-5630
- Indianapolis IN USA
- Brad Williamson 317-230-5564 317-471-3055
- 317-872-7220 x632
- Los Angeles, CA USA
- Brian Keith 818-883-3838
- Milwaukee WI USA
- Luke Heffron 414-782-0007
- Minneapolis MN USA
- Nancee Melby 612-726-2277
- New England USA
- Dan York funne@copley.mv.com 603-894-4500
- Phoenix, AZ USA
- Ken Arnold 602-862-6699
- Pittsburgh, PA USA
- Alan S. Koch ask@sei.cmu.edu 412-268-6395
- San Diego, CA USA
- Cynthia Hilsinger 619-556-9167
- San Francisco Bay Area, CA USA
- Ruth LoCurto rlocurt@cadev6.intel.com 408-765-4157
-
- Frame has installed a pre-recorded message to find out about user
- group meetings. The number is +1 408-433-3311 x2286.
-
- If you want to start one of your very own FUN group, contact Sandy
- Knox, slk@frame.com, +1 408-433-3311.
-
- ============================================================
- * TEXT FORMATTING AND FLOWS
-
- ------------------------------------------------------------
- ** TXT-1: How can I control which master page is used when text flows off
- of the current page?
-
- When you push text out of a column with Autoconnect turned on, how
- does FM choose which master page to use for the new page?
-
- - If the number and type (letter tag) of the autoconnect flows on the
- current body page exactly match the autoconnect flows on the Right
- master page, then the Right master page is used.
-
- - Otherwise, the master page for the current body page is used.
-
- The Right master page is kind of the default master page. (Unless it
- is a double-sided document, in which case there are Left and Right
- defaults.) For example, if you were typing a memo, you would have (at
- least) two master pages, one called "First" which contained the big
- header, and one called "Right" for all of the continuation pages.
-
- You cannot get FM to automatically go from one non-Right master to
- another. For example, assume that a memo has 3 masters: Fax, First,
- and Right. There is no way to start the document with only the Fax
- page, and have it automatically change to First, and then to Right.
- The solution is to create 3 pages, apply the appropriate masters,
- connect the flows as needed, and make sure that empty pages are not
- deleted (turn this off in Format->Document or add dummy text to each
- page).
-
- Another item to note is that when changing master pages with Page
- Layout, the same "union" rules apply, as done with "Use Formats." For
- example, if the body page currently has one column of flow B, and you
- apply a master page which has one column with flow A, you will wind up
- with two text columns. You can then copy the text from the old column
- to the new column (if appropriate), and then delete the old column.
-
- ------------------------------------------------------------
- ** TXT-2: What exactly is copied during File:Use Formats?
-
- Here is a description of what is copied and what actions occur during
- Use Formats. (This is from the Reference Manual, but I think it bears
- repeating, since it is not in the on-line help.)
-
- P Formats
- P Catalog
- All paragraphs are updated with the new formats
- Footnote properties (where placed, prefix, format, etc.)
- Equation sizes
- Document Properties: Allow Line Breaks After
- Flow Properties: Feather
-
- C Formats
- C Catalog
- All tagged characters are updated with the new formats
-
- Page Layouts
- Master Pages
- Background and Column Layout applied to all body pages
- Change Bar Properties
- Document Properties: First Page Number and Page Number Style
- View Options
-
- Reference Pages
- Reference Pages
- Reference Frames in current doc that are not in source doc are removed!
-
- Variable Definitions
- Variables
-
- Cross Reference Formats
- Cross Reference Formats
- Updates internal cross-references (x-refs)
-
- Table Formats
- Table Format Catalog
- Ruling Style Catalog
- Update all tables
-
- Conditional Text
- Conditional Tags
- Show/Hide Settings
- Use Format Overrides
-
- If you are going to apply P Formats, than you should also apply C
- Formats. Otherwise, text tagged with C formats will still be tagged
- correctly, but will be displayed with the default P format.
-
- ============================================================
- * AUTONUMBERING, CROSS-REFERENCES, VARIABLES, TOC
-
- ------------------------------------------------------------
- ** NUM-1: How do I set up autonumbers for Figures as "Figure 5-1"?
-
- First, FM organizes paragraph number into multiple series, each
- series indicated by an upper case letter and colon (H:). There is
- also a series with no indicator.
-
- Second, within a series, the numbers are in a hierarchy, where the
- default behavior is that when a number in incremented, all numbers to
- the right are reset to zero. This can be overridden; see below.
-
- In autonumbering, if you include "< >" in the number, this means
- "don't display and don't reset the number in this position." Note the
- space between the angle brackets.
-
- Use one number series for both headers and figure numbers. The
- positions of the numbers in the series are as follows:
-
- <level1> <figure> <table> <example> <level2> <level3> <level4> <level5>
-
- The resultant autonumbers are:
-
- Head1 H:<n+>
- Figure H:<n>-<n+>< >< >< >< >< >< >
- Table H:<n>-< ><n+>< >< >< >< >< >
- Example H:<n>-< >< ><n+>< >< >< >< >
- Head2 H:<n>< >< >< >.<n+>
- Head3 H:<n>< >< >< >.<n>.<n+>
- Head4 H:<n>< >< >< >.<n>.<n>.<n+>
- Head5 H:<n>< >< >< >.<n>.<n>.<n>.<n+>
-
- Contributor: Alan Koch <ask@sei.cmu.edu>
-
- ------------------------------------------------------------
- ** NUM-2: How do I place an autonumbered figure number in an anchored
- frame? Why doesn't it update properly?
-
- There are three ways to place figure numbers so that they are
- automatically updated. They each have advantages and disadvantages.
- Note that you cannot use a "text line" (the A tool) for the figure
- number, because text lines cannot be autonumbered, since they are not
- real paragraphs in a text column.
-
- *** A. In-Frame
-
- The figure number is contained in a text column which is inside the
- anchored frame.
-
- Advantages:
- + Can use "floating" figures, because the title is inside the floating
- frame.
-
- Disadvantages:
- - Text column must be properly placed (see below).
- - Cannot be used if you want other autonumbered text cols in frame.
-
- If you use this method, the text column with the figure number must be
- the first text column in the drawing order. To ensure this, select the
- column and do Graphics->Back.
-
- *** B. Out-of-Frame
-
- The figure number is outside the frame, usually in the paragrah that
- contains the anchor or the paragraph after the anchor paragraph. Use
- Keep With Next and Keep With Previous in Format Paragraph to keep
- things together.
-
- Advantages:
- + Don't have to worry about text column in frame.
- + Can have an autonumbered text column in frame.
-
- Disadvantages:
- - Cannot use floating figures.
-
- *** C. Frame in One-cell Table
-
- Create a one-cell table, put the anchored frame in the cell, and place
- the figure title in the table title column.
-
- Advantages:
- + Can use all the formatting features of tables:
- Title above or below
- Controlled spacing between title and figure
- Controlled ruling (could use top and bottom rule lines)
- etc.
- + Don't have to worry about placement of text column in frame.
- + Can easily place 2 (or more) figures side-by-side in a column.
- (If using more than one row, use the Table Format:Basic:Numbering
- property to set row-first or column-first numbering.)
- Disadvantages:
- - Yet another layer of nesting (table contains frame which contains
- graphic)
-
- Note that this method provides an easy way to do side-by-side figures
- (or other groupings), but you must then place the figure title inside
- the table cell. Figure number ordering can be set from Table Format.
-
- Contributor: Harro Kremer <kremer@cs.utwente.nl>
-
- ------------------------------------------------------------
- ** NUM-3: How can I get "Page 3 of 152" to work for a multi-file book?
-
- If you place text such as "Page <Current Page #> of <Page Count>"
- (where <xxx> signifies a variable) in the footer, you will get the
- expected results for a single-file document, but not for a multi-file
- book. The solution is replace the variable <Page Count> with a
- cross-reference to a paragraph on the last page of the last file in
- the book. The format of the cross-reference should be <$pagenum>.
- Make sure that you perform "File Generate/Update Files" from the book
- before you print, to update all cross-references.
-
- ------------------------------------------------------------
- ** NUM-4: I want chapter number and title on separate lines, both in TOC.
-
- At the beginning of each chapter I want:
-
- Chapter <n>
-
- Title of Chapter Goes Here
-
- This requires two paragraphs, one for the number and one for the
- title. However, in the TOC I want:
-
- Chapter <n> Title of Chapter Goes Here...............<pagenum>
-
- Solution: Use different paragraph tags for your Chapter number and
- Title (e.g. ChapNum & ChapTitle). In your TOC Setup, gather only
- ChapTitle. In the TOC document itself, modify the Paragraph Format
- for ChapTitleTOC to set Numbering Properties to:
- Chapter <n+>.\t
- This will reproduce or mimic the chapter numbering, instead of pulling
- it from the chapter file. You may have to use a separate series (H:,
- C:) or use Book: File: Setup File to reset the numbering
- appropriately. On the TOC Reference page, set the entry for
- ChapTitleTOC to:
- <$paratext>\t<$pagenum>
-
- Contributors: Steve Harding <harding@sun444.nas.nasa.gov>
- Rob Weinberg
-
- ------------------------------------------------------------
- ** NUM-5: Can I generate a table-of-contents directly inside a file?
-
- Sort of, by using Cross-References instead of the Generate facility.
-
- At the front of your document, start setting up cross references to
- all the paragraphs you want to appear in the TOC. You can experiment with
- all the flexibility offered by X-Ref formats and autonumbers.
-
- Every time you add a new section to your document, you must manually
- add a corresponding cross reference in your TOC, but from then on it's
- self-maintaining. To update the TOC, just do Special :
- Cross-Reference : Update : Internal. If you delete a section and
- forget to delete the cross reference in the TOC, no problem! You use
- the standard methods to search- and-destroy (or fix) unresolved cross
- references. After the update, visually inspect the TOC to look for
- missing numbers, which may indicate sections that did not get
- referenced.
-
- This isn't as automated as the Generate method, but it has the major
- bonus of giving you the "Go To" hyperlink on the Cross Reference
- dialogue box. When you want to go to a section, you just double-click
- on the cross reference in the TOC, hit "Go To" in the dialogue box,
- and there you are! Very popular if you have various people reviewing
- a document on-line.
-
- Contributor: Ken d'Albenas <kendal@autotrol.cuc.ab.ca>
-
- ------------------------------------------------------------
- ** NUM-6: Why do some of my cross-references keep changing to point
- to the wrong paragraph?
-
- *** SITUATION: We have a document with many figures (or tables or
- equations). Each figure is cross-referenced in the body text.
-
- *** SYMPTOM: Some cross-references seem to be "unstable". For example,
- when one places a cross-reference to 'Figure 3' in the text, the
- number is correctly displayed ('Figure 3'). Later on, when the
- cross-references are updated, the cross-reference suddenly changes,
- e.g. to 'Figure 1'.
-
- (Manually changing the cross-reference back to 'Figure 3' (Special
- Cross-Reference, Replace) restored the correct number (3), but when
- the 'Update' was performed again, the number again reverted to 1!)
-
- *** CAUSE: The problem is caused by the use of the copy/paste functions to
- duplicate a block of text that contains an X-Ref (aka Cross-Ref)
- marker. First, here is some background on cross-reference markers.
-
- FM puts an X-Ref marker at the beginning of a paragraph when one first
- sets a cross-reference to that paragraph. Normally, users don't have
- to bother about such X-Ref markers. The marker symbol ('T') is
- visible if you have View Text Symbols turned on.
-
- Each marker has a marker number and a descriptive text, such as
- <MText `15755: Figure: Figure 1 Caption one'>
-
- (The Paragraph tag and text are set in the marker when the marker is
- first created, and they are not updated when the paragraph changes.
- When a cross-reference is updated, the actual paragraph text is used.)
-
- The marker number is crucial; it identifies the source of the
- cross-reference (i.e., the paragraph to which one refers), therefore
- it seems essential that each such number be UNIQUE in a document! FM
- generates a new, unique number whenever you add a new cross-reference
- source.
-
- *** THE SOURCE OF THE PROBLEM: However, if you copy a block of text that
- contains an X-Ref marker, such as a figure caption, and then paste it
- into another location (e.g., to create a new, similar figure), you end
- up with TWO identical X-Ref markers, with the same marker number.
-
- If you insert a reference to this new caption, it will show correctly
- in the list box and on-screen, and will read the correct paragraph
- text or number. However, whenever you Update your cross-references,
- the destination cross-reference will look for the X-Ref marker with
- the particular number, and it will find the first instance of a marker
- with that number. This will cause the cross-reference to be
- incorrect, as it will refer to the originally copied paragraph.
-
- *** DIAGNOSIS: Is there a simple method to see if an existing document
- contains the problem described above? There are two methods.
-
- Method 1: Choose File Generate, choose 'Alphabetical Marker List',
- include X-Ref (or Cross-Ref) type markers. This will produce a list of
- all X-Ref markers, sorted by marker number. Visually inspect the
- generated file: the presence of two or more (consecutive) lines with
- the same marker number indicates the presence of the problem. The
- marker texts may be different.
-
- Method 2: Save the document as MIF, for example 'report.mif', then
- issue the following Unix command:
- grep MText report.mif | sort > report.lst
- This searches for all markers in the document and sorts them by
- number. Visually inspect the list of markers: the presence of two or
- more (consecutive) lines with the same marker number indicates the
- presence of the problem. The marker texts may be different.
-
- *** THERAPY: Is it possible to fix the problem? Yes. It is a tedious
- manual process, but it works reliably.
-
- First, find and delete all duplicated X-Ref markers. Open the Special
- Marker dialog. Use Edit Find/Search to search for "Marker of Type:
- X-Ref" or "Marker of Type: Cross-Ref". (Look in the Marker Type list
- in the Marker dialog to find the exact spelling.) Once it has found a
- marker, examine the marker number in the Marker Text box in the Marker
- dialog. If this marker is one of the ones with duplicated numbers,
- delete it. (The marker should be already highlighted by the search,
- so just give the document window the focus and hit <backspace> or
- <delete>.) Repeat until all markers that had the duplicated numbers
- have been deleted. You must delete ALL instances of markers with
- duplicated numbers, even the original marker which formerly was
- correct.
-
- Second, update all cross-references (File Generate-Update from the
- book, or Special Cross-References, Update from a single document.)
- All of the references to the deleted markers will become "unresolved
- cross-references". Search for these using Edit Find/Search, searching
- for "Unresolved Cross-Reference". Double-click to bring up the
- Cross-Reference dialog, and replace the cross-reference with the
- correct paragraph. Repeat for each unresolved reference.
-
- Third, update all cross-references again, and check for incorrect
- references. You should also regenerate the marker list and check it
- again for duplicates, in case you missed one.
-
- *** PREVENTION (short term): You can prevent this in the future by noting
- whenever you duplicate text containing markers. Turn on View Text
- Symbols to see the markers. Note whenever you copy and paste text
- containing a marker. If you duplicate text with a marker, if it is an
- X-Ref marker, delete it! (This may also apply to other types of
- markers.)
-
- When you are ready to publish a document, if there is a possibility of
- duplicated markers, generate the marker list and check it for
- duplicates.
-
- *** PREVENTION (long term): Frame has been asked to update the Paste
- function to check for markers in the pasted text, and ask the user
- what should be done about the pasted markers (delete them, renumber
- them, or leave them alone).
-
- Contributor: Folco Casadei <folco.casadei@jrc.it>
-
- =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
- end of part 1 of 2
- =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
-