Re: cross reference vs variables
> In these documents that I am currently cleaning up, the title, > customer name, document date, and document number are all variables on > the title page, but then are cross-referenced throughout the chapters. > It would make more sense that they are variables throughout? Yes, having them all as variables would be better. You get the same result, but without the added overhead of making sure links don't get broken. Variables don't have links. Mike Wickham ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: cross reference vs variables
> Just to mix things up, the next question will appear in the form of a > statement. > > There is very little difference between cross-references and variables. > > Discuss. > > Deirdre One advantage of variables is that you can't delete them accidentally. More than once, I have deleted a section of text and not noticed that it contained a cross-reference or cross-reference marker referenced from somewhere else. Deleteing either one breaks the cross-reference, leaving an unresolved cross-reference. But if I delete text that contains a variable, big deal. I only deleted the text, because the variable definition still exists to work everywhere else it has been, and ever will be, used. There are lots of differences between cross-references and variables. Use cross-references to link to somewhere else you want the reader to go. "See figure x on page nnn" for example. Use user variables for data you may want to change. For example, some create user variables for product names because the final name of the product may change before it goes into production-- like the way Microsoft called a product "Chicago" before it was eventually released as Windows 95-- or maybe the product is sold to others to be resold under different proprietary brand names. So changing the definition of a variable can instantly change the product data sheet for "Joe's Snake Oil" to one for "Rebecca's Magic Elixir" without having to search and replace for every location of that phrase. Mike Wickham ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: cross reference vs variables
By the way ... just to "plug" the BookVars plugin further ... For a simple example (this is a complete file), here is the content of the text file first generated automatically by BookVars (and edited from then on by me): [General] AltBookVarsFile= DelVarCode= RenVarChar= LogFile=GSM Mobile Device Management-BookVars-log.txt LogType=1 ; WARNING: Changing EditorType may corrupt high-ascii characters! EditorType=0 [Groups] Count=1 1=RevGroup [RevGroup] ; User Variables Revision Date=2007-08-14 Revision Number=1.1 Document Name=GSM Mobile Device Management System Specification Company Name=Aeris Communications, Inc. As you can see above, I can then use the User Variables in *all* the documents inside the book - *just* like the scenario you asked about, Deirdre! :) The BookVars plugin allows me to read the user variable group into each and every document/file in the book. A more complex example (with many lines left out here to simplify this e-mail). In this example, I use two separate groups of User Variables (called RevGroup and UserGroup) and can choose to *separately* read each group into the documents/files in the book. The first version of this text file was automatically generated from BookVars, and all subsequent edits have been by me (using the built-in text editor in the plugin). This is a "work in progress" ... hence the [very] unusual Revision Date and [far less] unusual Revision Number! :) Our internal review drafts get the "a", "b", etc., after the version number, till the document is released formally. In this example, it would become 2.2 for the next customer release - I just edit this file, re-run the plugin and re-read the variables and voila! ... all references to the version number and date are updated cleanly and correctly! By the way, the use of the User Variables shown in "UserGroup" (boy, was that a mouthful!) is to make sure that I *always* get the correct numerical value in all locations in the documents/files in the book - this is an API spec, and it would be *very* bad for the code samples in the API doc to have the wrong value for that variable. [General] AltBookVarsFile= DelVarCode= RenVarChar= LogFile=Aeris System Interface-BookVars-log.txt LogType=1 ; WARNING: Changing EditorType may corrupt high-ascii characters! EditorType=0 [Groups] Count=2 1=RevGroup 2=UserGroup [RevGroup] ; User Variables Revision Date=2007-99-99 Revision Number=2.1a Document Name=Aeris System Interface Technical Description Company Name=Aeris Communications, Inc. [UserGroup] ; User Variables PASSWORD=200 PASSWORD_ACK=201 PASSWORD_REJECT=202 ... ... <*Lots* of lines deleted here for brevity> ... SMSRES_ORIG_ANSI_ACK=421 SMSRES_ORIG_GSM=422 SMSRES_ORIG_GSM_ACK=423 Z > -Original Message- > From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of > Syed Zaeem Hosain ([EMAIL PROTECTED]) > Sent: Wednesday, February 20, 2008 1:42 PM > To: Art Campbell; Deirdre Reagan > Cc: Fred Ridder; Frame Users > Subject: RE: cross reference vs variables > > > -Original Message- > > From: Art Campbell [mailto:[EMAIL PROTECTED] > > > > If it is, then you should be able to import them into all the other > > files so that all component files in the book have the same consistent > > set of variables. And then you could do a series of > > search-and-replaces to replace the cross-refs with variables. > > And, yes, this is *exactly* where using BookVars from Leximation makes > so much sense to me - "book level" variables! :) ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: cross reference vs variables
Thank you all! This helps so much in learning how the program works and how the documents work! I'm looking like a hero to my co-workers. (Ok, not really.) Thanks! Deirdre On 2/20/08, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote: > > -Original Message- > > From: Art Campbell [mailto:[EMAIL PROTECTED] > > > > If it is, then you should be able to import them into all the other > > files so that all component files in the book have the same consistent > > set of variables. And then you could do a series of > > search-and-replaces to replace the cross-refs with variables. > > And, yes, this is *exactly* where using BookVars from Leximation makes > so much sense to me - "book level" variables! :) > > Z > ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: cross reference vs variables
Deidra, There are at least two ways to set it up that will accomplish the same thing. 1. Define the variables you need in the Title Chapter, then import them into all of the other chapters. Insert the variables themselves wherever you need them. When a change is needed, change the variables in the Title chapter and import them into the rest of the chapters again. 2. Define the variables in the Title chapter as before. Insert each one at least once in a paragraph by itself in the Title chapter, even on a master page that you never use. In the paragraph with each variable, insert a cross-reference marker. In each place you need the text cross-reference back to the appropriate marker. If you change one of the variable definitions, all the other instances will update when the book is updated. Clint Owen Technical Publications Crane Aerospace & Electronics 425-743-8674 -Original Message- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Deirdre Reagan Sent: Wednesday, February 20, 2008 1:34 PM To: [EMAIL PROTECTED] Cc: Fred Ridder; Frame Users Subject: Re: cross reference vs variables In these documents that I am currently cleaning up, the title, customer name, document date, and document number are all variables on the title page, but then are cross-referenced throughout the chapters. It would make more sense that they are variables throughout? I don't think I am acutally referencing them, just using them over and over again. Did I get the terminology right? Thanks! Deirdre ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/clint.owen%40craneae rospace.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info. We value your opinion! How may we serve you better? Please click the below survey link to tell us how we are doing. http://www.craneae.com/surveys/satisfaction.htm Your feedback is of the utmost importance to us! Thank you for your time! ## Attention: The information contained in this email message may be privileged and is confidential information intended only for the use of the recipient, or any employee or agent responsible to deliver it to the intended recipient. Any unauthorized use, distribution or copying of this information is strictly prohibited and may be unlawful. If you have received this communication in error, please notify the sender immediately and destroy the original message and all attachments from your electronic files. This email was scanned and cleared by MailMarshal. ## ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: cross reference vs variables
> -Original Message- > From: Art Campbell [mailto:[EMAIL PROTECTED] > > If it is, then you should be able to import them into all the other > files so that all component files in the book have the same consistent > set of variables. And then you could do a series of > search-and-replaces to replace the cross-refs with variables. And, yes, this is *exactly* where using BookVars from Leximation makes so much sense to me - "book level" variables! :) Z ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: cross reference vs variables
Yes, and yes. However, they'd only be "variables on the title page" if it's a stand-alone file. If it is, then you should be able to import them into all the other files so that all component files in the book have the same consistent set of variables. And then you could do a series of search-and-replaces to replace the cross-refs with variables. Art On Wed, Feb 20, 2008 at 4:34 PM, Deirdre Reagan <[EMAIL PROTECTED]> wrote: > In these documents that I am currently cleaning up, the title, > customer name, document date, and document number are all variables on > the title page, but then are cross-referenced throughout the chapters. > It would make more sense that they are variables throughout? > > I don't think I am acutally referencing them, just using them over and > over again. Did I get the terminology right? > > Thanks! > > Deirdre > > > ___ > > > You are currently subscribed to Framers as [EMAIL PROTECTED] > > Send list messages to [EMAIL PROTECTED] > > To unsubscribe send a blank email to > [EMAIL PROTECTED] > or visit > http://lists.frameusers.com/mailman/options/framers/art.campbell%40gmail.com > > Send administrative questions to [EMAIL PROTECTED] Visit > http://www.frameusers.com/ for more resources and info. > -- Art Campbell [EMAIL PROTECTED] "... In my opinion, there's nothing in this world beats a '52 Vincent and a redheaded girl." -- Richard Thompson No disclaimers apply. DoD 358 ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: cross reference vs variables
In these documents that I am currently cleaning up, the title, customer name, document date, and document number are all variables on the title page, but then are cross-referenced throughout the chapters. It would make more sense that they are variables throughout? I don't think I am acutally referencing them, just using them over and over again. Did I get the terminology right? Thanks! Deirdre ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: cross reference vs variables
I agree entirely with your observations, Fred! They are different and needed for different purposes. I use cross-references for paragraph and other document information that I want to reference elsewhere in the document or book. Like table titles for example. I use variables to hold commonly used text that I can insert in the document to ensure consistent usage. If the text changes, all the variable uses are automatically changed. Z > -Original Message- > From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of > Fred Ridder > Sent: Wednesday, February 20, 2008 12:54 PM > To: Deirdre Reagan; Frame Users > Subject: RE: cross reference vs variables > > > Deirdre Reagan wrote:> Just to mix things up, the next question will appear > in the form of a > statement. > > > > There is very little difference between cross-references and variables. > > > > Discuss. > > > Disagree almost completely. IMO, about the only thing they have in > common is that they are methods of inserting content into a > FrameMaker document by reference. > > Cross-references are used to retrieve some combination of attributes > (e.g. page location, paragraph autonumbering) and content of a > specific target paragraph. You can build cross-reference formats that > specify different attributes and include various bits of static text and > punctuation, and you can globally redefine these formats to repurpose > the same files for use in different deliverables (e.g. including the page > number in printed or PDF outputs but omitting it in HTML deliverable). > Cross-references always point to a specific paragraph, which makes > them less useful ifd you are using some of the same component files > in multiple books. > > User variables, on the other hand, retrieve a fixed text string of up > to 255 characters. Period. No page number. No autonumbering. No > ability to build different variations of the content. Just a text string. > Eminently useful for things like product names or model numbers, > and document titles and reference numbers. Variable definitions > are stored locally in each file, but are easily updated across a book > by importing them as format properties from one file (e.g., a template), > which works well when you are sharing some chapters among multiple > books. > > Cross-references are automatically refreshed every time you open > a file. This is overkill for relatively static content like document titles > and product names. > > Cross-references get turned into hyperlinks when you publish a > document to PDF (and usually to HTML, as well). To me, this is > worse than overkill if you use x-refs for book titles because I think > it's a major annoyance to have each and every instance of the > title be a live hyperlink that takes you to the title page of the book. > _ > Helping your favorite cause is as easy as instant messaging. You IM, we give. > http://im.live.com/Messenger/IM/Home/?source=text_hotmail_join > ___ > > > You are currently subscribed to Framers as [EMAIL PROTECTED] > > Send list messages to [EMAIL PROTECTED] > > To unsubscribe send a blank email to > [EMAIL PROTECTED] > or visit > http://lists.frameusers.com/mailman/options/framers/syed.hosain%40aeris.net > > Send administrative questions to [EMAIL PROTECTED] Visit > http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: cross reference vs variables
Thank you Fred -- I'm pretty sure the help pages and the user guide said the same thing, but I haven't been able to make heads or tails of them. Your explanation is much clearer. Perhaps you should offer your services to the Adobe Company? ;) Deirdre On 2/20/08, Fred Ridder <[EMAIL PROTECTED]> wrote: > > Deirdre Reagan wrote: > > > Just to mix things up, the next question will appear in the form of a > statement. > > > > There is very little difference between cross-references and variables. > > > > Discuss. > > > Disagree almost completely. IMO, about the only thing they have in > common is that they are methods of inserting content into a > FrameMaker document by reference. > > Cross-references are used to retrieve some combination of attributes > (e.g. page location, paragraph autonumbering) and content of a > specific target paragraph. You can build cross-reference formats that > specify different attributes and include various bits of static text and > punctuation, and you can globally redefine these formats to repurpose > the same files for use in different deliverables (e.g. including the page > number in printed or PDF outputs but omitting it in HTML deliverable). > Cross-references always point to a specific paragraph, which makes > them less useful ifd you are using some of the same component files > in multiple books. > > User variables, on the other hand, retrieve a fixed text string of up > to 255 characters. Period. No page number. No autonumbering. No > ability to build different variations of the content. Just a text string. > Eminently useful for things like product names or model numbers, > and document titles and reference numbers. Variable definitions > are stored locally in each file, but are easily updated across a book > by importing them as format properties from one file (e.g., a template), > which works well when you are sharing some chapters among multiple > books. > > Cross-references are automatically refreshed every time you open > a file. This is overkill for relatively static content like document titles > and product names. > > Cross-references get turned into hyperlinks when you publish a > document to PDF (and usually to HTML, as well). To me, this is > worse than overkill if you use x-refs for book titles because I think > it's a major annoyance to have each and every instance of the > title be a live hyperlink that takes you to the title page of the book. > > > Helping your favorite cause is as easy as instant messaging. You IM, we > give. Learn more. ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
Re: cross reference vs variables
False. > Just to mix things up, the next question will appear in the form of a > statement. > > There is very little difference between cross-references and variables. > > Discuss. > > Deirdre > ___ ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: cross reference vs variables
Deirdre Reagan wrote:> Just to mix things up, the next question will appear in the form of a statement. > > There is very little difference between cross-references and variables. > > Discuss. Disagree almost completely. IMO, about the only thing they have in common is that they are methods of inserting content into a FrameMaker document by reference. Cross-references are used to retrieve some combination of attributes (e.g. page location, paragraph autonumbering) and content of a specific target paragraph. You can build cross-reference formats that specify different attributes and include various bits of static text and punctuation, and you can globally redefine these formats to repurpose the same files for use in different deliverables (e.g. including the page number in printed or PDF outputs but omitting it in HTML deliverable). Cross-references always point to a specific paragraph, which makes them less useful ifd you are using some of the same component files in multiple books. User variables, on the other hand, retrieve a fixed text string of up to 255 characters. Period. No page number. No autonumbering. No ability to build different variations of the content. Just a text string. Eminently useful for things like product names or model numbers, and document titles and reference numbers. Variable definitions are stored locally in each file, but are easily updated across a book by importing them as format properties from one file (e.g., a template), which works well when you are sharing some chapters among multiple books. Cross-references are automatically refreshed every time you open a file. This is overkill for relatively static content like document titles and product names. Cross-references get turned into hyperlinks when you publish a document to PDF (and usually to HTML, as well). To me, this is worse than overkill if you use x-refs for book titles because I think it's a major annoyance to have each and every instance of the title be a live hyperlink that takes you to the title page of the book. _ Helping your favorite cause is as easy as instant messaging. You IM, we give. http://im.live.com/Messenger/IM/Home/?source=text_hotmail_join ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.
RE: cross reference vs variables
Precisely! Cross-references are to variables as crayfish are to lightning. > -Original Message- > From: [EMAIL PROTECTED] [mailto:framers- > [EMAIL PROTECTED] On Behalf Of Deirdre Reagan > Sent: Wednesday, February 20, 2008 2:17 PM > To: Frame Users > Subject: cross reference vs variables > > Just to mix things up, the next question will appear in the form of a > statement. > > There is very little difference between cross-references and variables. > > Discuss. > > Deirdre > ___ > > > You are currently subscribed to Framers as [EMAIL PROTECTED] > > Send list messages to [EMAIL PROTECTED] > > To unsubscribe send a blank email to > [EMAIL PROTECTED] > or visit > http://lists.frameusers.com/mailman/options/framers/kmcdaniel%40pavtech. co > m > > Send administrative questions to [EMAIL PROTECTED] Visit > http://www.frameusers.com/ for more resources and info. ___ You are currently subscribed to Framers as [EMAIL PROTECTED] Send list messages to [EMAIL PROTECTED] To unsubscribe send a blank email to [EMAIL PROTECTED] or visit http://lists.frameusers.com/mailman/options/framers/archive%40mail-archive.com Send administrative questions to [EMAIL PROTECTED] Visit http://www.frameusers.com/ for more resources and info.