Re: [Framers] Cross reference format (what do you use?)
Hi Bernard, I have several kinds of cross-reference formats: o Only section number/figure number/title number/step number. For figure and title number that's <$paranumonly>. For the others <$paranum>. o Section number + heading text <$paranum> "<$paratext>" I have also a heading4 format without section numbering. (I have 4 heading levels, no chapter level.) There I use only "<$paratext>". I use double-quotes. In my oppinion better than another character format. With several cross-references on each page and with different character formats the page layout would be confusing. For translations the double quotes must be replaced with those of the target language. I have a FrameScript which does this. Here I do not trust the translator. o The same as above plus: on page <$pagenum> I use this for those cross-references which are on another page of the PDF. I find the page number helpful, especially for steps of instructions (I need this format rarely) or for cross-references to heading4 (without section numbering). I do not include any words before the cross-reference format into the format. I never know where such words should be positioned in another language. Or whether they must be inflected or can remain unchanged. In your source language this might be the same: in section 123 see section 123 (section 123) However, do you know, if this word is also the same in your target language? Best regards Winfried -Original Message- From: Framers [mailto:framers-bounces+wreng=tycoint@lists.frameusers.com] On Behalf Of Bernard Aschwanden (Publishing Smarter) Sent: Friday, December 02, 2016 4:20 PM To: framers@lists.frameusers.com Subject: [Framers] Cross reference format (what do you use?) Here is a simple question that I'm sure will have a LOT of opinion. I hope... Building some print-friendly xref formats, and I'm curious what people here actually use. We're all familiar with the function (I think) or at least, we should be. You may have text like this: Chapter 1. Canada Blah blah 1.A Alberta Blah blah 1.B New Brunswick Blah blah Plus you have tables, figures, equations, sections, examples, steps, etc, etc, etc. You link to stuff like "Canada" or "Chapter 1" or "Chapter 1. Canada" or even "Canada on page 23" or whatever. Some xref content may be "See <$paratext>" or "<$paranumonly>" or "step <$paranumonly>". You may also choose to put in sentences like "For more information see section <$paranumonly> on page\ <$pagenum>. " so that it is a self-contained sentence. I don't know. There are a LOT of ways to xref to stuff though. My question is this: What would be the top 3 or 4 ways *you* xref something? Not the steps to insert an xref, but the way it looks in your output. What does the code or the xref look like? Do you put in full sentence xrefs? Do you use words in them? Do you use quotes around content? I know that there are a bizzilion ways to xref stuff, so input would be greatly appreciated. Lastly, I'm not concerned about online as that can be changed at publish time. What do you do though in the print materials? For example, if I use "For more info see pg <$pagenum>. " as a sentence in the online I can just replace it with <$paranumonly>, or <@paratext>, or whatever. The issue for me is "what do people do for print" in regards to the numbering, text, quotes, etc. Thanks to all. Bernard Bernard Aschwanden bern...@publishingsmarter.com www.publishingsmarter.com Write Less. Write Better. This e-mail contains privileged and confidential information intended for the use of the addressees named above. If you are not the intended recipient of this e-mail, you are hereby notified that you must not disseminate, copy or take any action in respect of any information contained in it. If you have received this e-mail in error, please notify the sender immediately by e-mail and immediately destroy this e-mail and its attachments. ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] Cross reference format (what do you use?)
Hi, Bernard I like to keep it clean and simple; the shorter the cross-ref the more distinctive it is, and the less cluttered the effect (particularly important if you need to cross-ref out of a table to a fuller explanation). My cross-refs (except for task lists) take the form[s]: [For more information] see Section N.N/Figure N-N/Table N-N I don't reference a page number, unless absolutely necessary. I use a character style, rather than quotes, to highlight the cross-ref. Depending upon context, I may also use brackets. Cross-refs to task lists are another story, however. Our style guide does not allow for numbering the headings of task lists. This causes me immense grief as I have no choice but to reference the heading text. It looks ugly and cumbersome (especially in contrast with the other cross-refs). The consequence is that I have to word the headings to accommodate the way the cross-ref will appear. This always feels as though the tool is dictating the content, though, which is definitely "base above apex". One of these days I shall rebel...;) BTW I output to print and pdf only. Hope this helps Sue Thomson -Original Message- From: Bernard Aschwanden (Publishing Smarter) [mailto:bern...@publishingsmarter.com] Sent: 02 December 2016 15:20 To: framers@lists.frameusers.com Subject: [Framers] Cross reference format (what do you use?) Here is a simple question that I'm sure will have a LOT of opinion. I hope... Building some print-friendly xref formats, and I'm curious what people here actually use. We're all familiar with the function (I think) or at least, we should be. You may have text like this: Chapter 1. Canada Blah blah 1.A Alberta Blah blah 1.B New Brunswick Blah blah Plus you have tables, figures, equations, sections, examples, steps, etc, etc, etc. You link to stuff like "Canada" or "Chapter 1" or "Chapter 1. Canada" or even "Canada on page 23" or whatever. Some xref content may be "See <$paratext>" or "<$paranumonly>" or "step <$paranumonly>". You may also choose to put in sentences like "For more information see section <$paranumonly> on page\ <$pagenum>. " so that it is a self-contained sentence. I don't know. There are a LOT of ways to xref to stuff though. My question is this: What would be the top 3 or 4 ways *you* xref something? Not the steps to insert an xref, but the way it looks in your output. What does the code or the xref look like? Do you put in full sentence xrefs? Do you use words in them? Do you use quotes around content? I know that there are a bizzilion ways to xref stuff, so input would be greatly appreciated. Lastly, I'm not concerned about online as that can be changed at publish time. What do you do though in the print materials? For example, if I use "For more info see pg <$pagenum>. " as a sentence in the online I can just replace it with <$paranumonly>, or <@paratext>, or whatever. The issue for me is "what do people do for print" in regards to the numbering, text, quotes, etc. Thanks to all. Bernard Bernard Aschwanden bern...@publishingsmarter.com www.publishingsmarter.com Write Less. Write Better. ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] Cross reference format (what do you use?)
For those of us from the Vancouver, BC area - not so much of the "white", but we are doing great ;-)) I agree with Fred about keeping it simple. Where possible I use just the Table, Figure and Heading numbers: a) For details on UPS configuration, refer to 3.3.4. b) Verify the room in which the system is to be operated meets the environmental requirements listed in Table 3-1. c) Examine the "Tip'n Tell" attachment on the outside of the package to ensure the crate has not been tipped too far during transport and delivery (refer to Figure 3-1 for details). d) To configure the printer, refer to Chapter 6: Peripherals and Accessories. Sometimes the heading title is included in order to orient the user to the broader context of the xRef This is pretty much my set of xRef (except I also have 2 for Appendices that match the 2 for Chapters). Alison xRef Title xRef Structure Chapter # Only Chapter <$paranumonly> Chapter #: Text Chapter <$chapnum>: <$paratext> Heading & Title <$paranum> <$paratext> Heading # Only <$paranum> Step # step <$paranumonly> Figure # Only Figure <$paranumonly> Table # Only Table <$paranumonly> Text Match <$paratext> FYI: is a character tag style. Alison Craig Technical Documentation Specialist BK Ultrasound | acr...@bkultrasound.com<mailto:acr...@bkultrasound.com> | bkultrasound.com From: Framers [mailto:framers-bounces+acraig=bkultrasound@lists.frameusers.com] On Behalf Of Bernard Aschwanden (Publishing Smarter) Sent: Friday, December 02, 2016 9:01 AM To: 'Fred Ridder'; framers@lists.frameusers.com Subject: Re: [Framers] Cross reference format (what do you use?) Thanks Fred. All is still well north of the border J Bernard From: Fred Ridder [mailto:docu...@hotmail.com] Sent: Friday, December 2, 2016 11:38 AM To: framers@lists.frameusers.com<mailto:framers@lists.frameusers.com>; bern...@publishingsmarter.com<mailto:bern...@publishingsmarter.com> Subject: Re: [Framers] Cross reference format (what do you use?) Hey, Bernard! How's things up in the Great White North? At my last three employers (i.e., for the last ~25 years...) we've used numbered headings (at least 5 levels, although I always try to hold it to 4 levels) and numbered figure captions and table titles. Because of this, the standard practice has always been to keep the cross-reference format simple and only use the label (chapter/section/figure/table) and the number. Old fashioned? Yes, but it works and it keeps the clutter down. Fred Ridder _ From: Framers <mailto:framers-bounces+docudoc=hotmail@lists.frameusers.com%3e> on behalf of Bernard Aschwanden (Publishing Smarter) <mailto:bern...@publishingsmarter.com%3e> Sent: Friday, December 2, 2016 10:19 AM To: framers@lists.frameusers.com<mailto:framers@lists.frameusers.com> Subject: [Framers] Cross reference format (what do you use?) Here is a simple question that I'm sure will have a LOT of opinion. I hope... Building some print-friendly xref formats, and I'm curious what people here actually use. We're all familiar with the function (I think) or at least, we should be. You may have text like this: Chapter 1. Canada Blah blah 1.A Alberta Blah blah 1.B New Brunswick Blah blah Plus you have tables, figures, equations, sections, examples, steps, etc, etc, etc. You link to stuff like "Canada" or "Chapter 1" or "Chapter 1. Canada" or even "Canada on page 23" or whatever. Some xref content may be "See <$paratext>" or "<$paranumonly>" or "step <$paranumonly>". You may also choose to put in sentences like "For more information see section <$paranumonly> on page\ <$pagenum>. " so that it is a self-contained sentence. I don't know. There are a LOT of ways to xref to stuff though. My question is this: What would be the top 3 or 4 ways *you* xref something? Not the steps to insert an xref, but the way it looks in your output. What does the code or the xref look like? Do you put in full sentence xrefs? Do you use words in them? Do you use quotes around content? I know that there are a bizzilion ways to xref stuff, so input would be greatly appreciated. Lastly, I'm not concerned about online as that can be changed at publish time. What do you do though in the print materials? For example, if I use "For more info see pg <$pagenum>. " as a sentence in the online I can just replace it with <$paranumonly>, or <@paratext>, or whatever. The issue for me is "what do people do for print" in regards to the numbering, text, quotes, etc. Thanks to all. Bernard Bernard Aschwanden bern...@publishingsmarter.com<mailto:bern...@publishingsmarter.com> www.publishingsmarter.com<http://www.publishingsmarter
Re: [Framers] Cross reference format (what do you use?)
Our corporate template has about 10 or so xref formats. The ones I use most are the three that provide both the section number AND the section name, or the table number AND table name, or the figure number AND figure name. The number of people who prefer looking for numbers as a location indication versus the number of people who scan for key words in titles are about equal, so I provide both. For me when I'm working in the files, the numbers can change depending on the condition setting and how recently I updated the xrefs, but the names don't. Also, we produce PDFs with the expectation that our customers will use the PDFs about 50% of the time and printouts the other 50% of the time, so I try to avoid using "the following table/figure" and use the full cross-reference instead. It looks a bit more cluttered, but it means there's no question at all what the user is supposed to be looking at, and I consider that a win. YMMV, and probably does. :) On Fri, Dec 2, 2016 at 2:45 PM, Robert Lauriston wrote: > I stopped using chapter numbers years ago. I don't use captions or > figure numbers or any of that stuff, it all seems like print-era > clutter to me. > > I cross-reference headings, so " For more information, see > <$paratext>." In PDF output I add "on page #." If I need to > cross-reference a table, I give it a heading. > > On Fri, Dec 2, 2016 at 7:19 AM, Bernard Aschwanden (Publishing > Smarter) wrote: > > Here is a simple question that I'm sure will have a LOT of opinion. I > > hope... > > > > Building some print-friendly xref formats, and I'm curious what people > here > > actually use. We're all familiar with the function (I think) or at > least, we > > should be. > > > > You may have text like this: > > > > Chapter 1. Canada > > Blah blah > > 1.A Alberta > > Blah blah > > 1.B New Brunswick > > Blah blah > > > > Plus you have tables, figures, equations, sections, examples, steps, etc, > > etc, etc. > > > > You link to stuff like "Canada" or "Chapter 1" or "Chapter 1. Canada" or > > even "Canada on page 23" or whatever. Some xref content may be "See > > <$paratext>" or "<$paranumonly>" or "step <$paranumonly>". You may also > > choose to put in sentences like "For more information see section > > <$paranumonly> on page\ <$pagenum>. " so that it is a self-contained > > sentence. > > > > I don't know. There are a LOT of ways to xref to stuff though. > > > > > > My question is this: What would be the top 3 or 4 ways *you* xref > something? > > Not the steps to insert an xref, but the way it looks in your output. > > > > What does the code or the xref look like? Do you put in full sentence > xrefs? > > Do you use words in them? Do you use quotes around content? I know that > > there are a bizzilion ways to xref stuff, so input would be greatly > > appreciated. > > > > Lastly, I'm not concerned about online as that can be changed at publish > > time. What do you do though in the print materials? For example, if I use > > "For more info see pg <$pagenum>. " as a sentence in the online I can > just > > replace it with <$paranumonly>, or <@paratext>, or whatever. The issue > for > > me is "what do people do for print" in regards to the numbering, text, > > quotes, etc. > > > > Thanks to all. > > > > Bernard > > > > > > > > Bernard Aschwanden > > bern...@publishingsmarter.com > > > > www.publishingsmarter.com > > > > Write Less. Write Better. > > > > ___ > > > > This message is from the Framers mailing list > > > > Send messages to framers@lists.frameusers.com > > Visit the list's homepage at http://www.frameusers.com > > Archives located at http://www.mail-archive.com/ > framers%40lists.frameusers.com/ > > Subscribe and unsubscribe at http://lists.frameusers.com/ > listinfo.cgi/framers-frameusers.com > > Send administrative questions to listad...@frameusers.com > ___ > > This message is from the Framers mailing list > > Send messages to framers@lists.frameusers.com > Visit the list's homepage at http://www.frameusers.com > Archives located at http://www.mail-archive.com/ > framers%40lists.frameusers.com/ > Subscribe and unsubscribe at http://lists.frameusers.com/ > listinfo.cgi/framers-frameusers.com > Send administrative questions to listad...@frameusers.com > -- Lin Sims ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] Cross reference format (what do you use?)
I stopped using chapter numbers years ago. I don't use captions or figure numbers or any of that stuff, it all seems like print-era clutter to me. I cross-reference headings, so " For more information, see <$paratext>." In PDF output I add "on page #." If I need to cross-reference a table, I give it a heading. On Fri, Dec 2, 2016 at 7:19 AM, Bernard Aschwanden (Publishing Smarter) wrote: > Here is a simple question that I'm sure will have a LOT of opinion. I > hope... > > Building some print-friendly xref formats, and I'm curious what people here > actually use. We're all familiar with the function (I think) or at least, we > should be. > > You may have text like this: > > Chapter 1. Canada > Blah blah > 1.A Alberta > Blah blah > 1.B New Brunswick > Blah blah > > Plus you have tables, figures, equations, sections, examples, steps, etc, > etc, etc. > > You link to stuff like "Canada" or "Chapter 1" or "Chapter 1. Canada" or > even "Canada on page 23" or whatever. Some xref content may be "See > <$paratext>" or "<$paranumonly>" or "step <$paranumonly>". You may also > choose to put in sentences like "For more information see section > <$paranumonly> on page\ <$pagenum>. " so that it is a self-contained > sentence. > > I don't know. There are a LOT of ways to xref to stuff though. > > > My question is this: What would be the top 3 or 4 ways *you* xref something? > Not the steps to insert an xref, but the way it looks in your output. > > What does the code or the xref look like? Do you put in full sentence xrefs? > Do you use words in them? Do you use quotes around content? I know that > there are a bizzilion ways to xref stuff, so input would be greatly > appreciated. > > Lastly, I'm not concerned about online as that can be changed at publish > time. What do you do though in the print materials? For example, if I use > "For more info see pg <$pagenum>. " as a sentence in the online I can just > replace it with <$paranumonly>, or <@paratext>, or whatever. The issue for > me is "what do people do for print" in regards to the numbering, text, > quotes, etc. > > Thanks to all. > > Bernard > > > > Bernard Aschwanden > bern...@publishingsmarter.com > > www.publishingsmarter.com > > Write Less. Write Better. > > ___ > > This message is from the Framers mailing list > > Send messages to framers@lists.frameusers.com > Visit the list's homepage at http://www.frameusers.com > Archives located at > http://www.mail-archive.com/framers%40lists.frameusers.com/ > Subscribe and unsubscribe at > http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com > Send administrative questions to listad...@frameusers.com ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] Cross reference format (what do you use?)
More good stuff. Thanks and keep it coming folks :) -Original Message- From: Steve Rickaby [mailto:srick...@wordmongers.demon.co.uk] Sent: Friday, December 2, 2016 12:16 PM To: bern...@publishingsmarter.com; framers@lists.frameusers.com Subject: Re: [Framers] Cross reference format (what do you use?) Hi Bernard >I don't know. There are a LOT of ways to xref to stuff though. Sure are. Quite often dictated by some sort of style guide, or an existing template. What follows are only my personal preferences. >My question is this: What would be the top 3 or 4 ways *you* xref something? >Not the steps to insert an xref, but the way it looks in your output. Given the choice, 'This is shown in Figure 12', where only 'Figure 12' is the xref. Avoid unnecessary words: less is more. So in this case the xref would I guess be 'Figure <$paranum>'. In my opinion the more words you put into an zref format, the more inflexible it becomes. >Do you put in full sentence xrefs? I'm not sure whether you mean an xref containing a full sentence in the xref format (in which case, not if I can help it), or a <$paratext> xref to a sentence somewhere else in the document. I've used the latter case to ensure that a key text block is written once and cited by xref to ensure that it is identical wherever it occurs. I found it tedious to use variables for this, but I have forgotten why - probably the inability to inset character formats within variables. >Do you use words in them? The minimum, and only if absolutely necessary: I prefer to avoid more than one word. However, an exception would be if you want to repurpose the content for print and online by (amongst other things) switching templates, and you want to have words (for example, 'See page <>') for print, but not for online. Single-sourcing means that xref formats needs a lot more thought. As an aside, publishers of textbooks destined for both print and eBook were keen to ensure that *every* object in a document had an xref to it. This makes sense, as an unreferenced object often (always?) cannot be found in eBook format. We had to include this in our editorial checks, but it sometimes resulted in a bit of a deluge of xrefs that didn't entirely make sense in the context of the body text. Superfluous xrefs are an irritant. > Do you use quotes around content? Definitely not, looks old-fashioned imho: much better to use a distinctive font or text face to make it clear that it's an xref. This is just my 10c. Ultimately it all depends on the context. As Fred has pointed out, the situations are different in documents that haves numbered headings. If you want more info I can look back through past books and list some actual xref formats for you if that would help. In many cases I inherited templates that contained xrefs like 'For more information, see Section "<$paratext>" on page <$pagenum>'. I found these very cumbersome and usually reformatted them. -- Steve ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] Cross reference format (what do you use?)
Hi Bernard >I don't know. There are a LOT of ways to xref to stuff though. Sure are. Quite often dictated by some sort of style guide, or an existing template. What follows are only my personal preferences. >My question is this: What would be the top 3 or 4 ways *you* xref something? >Not the steps to insert an xref, but the way it looks in your output. Given the choice, 'This is shown in Figure 12', where only 'Figure 12' is the xref. Avoid unnecessary words: less is more. So in this case the xref would I guess be 'Figure <$paranum>'. In my opinion the more words you put into an zref format, the more inflexible it becomes. >Do you put in full sentence xrefs? I'm not sure whether you mean an xref containing a full sentence in the xref format (in which case, not if I can help it), or a <$paratext> xref to a sentence somewhere else in the document. I've used the latter case to ensure that a key text block is written once and cited by xref to ensure that it is identical wherever it occurs. I found it tedious to use variables for this, but I have forgotten why - probably the inability to inset character formats within variables. >Do you use words in them? The minimum, and only if absolutely necessary: I prefer to avoid more than one word. However, an exception would be if you want to repurpose the content for print and online by (amongst other things) switching templates, and you want to have words (for example, 'See page <>') for print, but not for online. Single-sourcing means that xref formats needs a lot more thought. As an aside, publishers of textbooks destined for both print and eBook were keen to ensure that *every* object in a document had an xref to it. This makes sense, as an unreferenced object often (always?) cannot be found in eBook format. We had to include this in our editorial checks, but it sometimes resulted in a bit of a deluge of xrefs that didn't entirely make sense in the context of the body text. Superfluous xrefs are an irritant. > Do you use quotes around content? Definitely not, looks old-fashioned imho: much better to use a distinctive font or text face to make it clear that it's an xref. This is just my 10c. Ultimately it all depends on the context. As Fred has pointed out, the situations are different in documents that haves numbered headings. If you want more info I can look back through past books and list some actual xref formats for you if that would help. In many cases I inherited templates that contained xrefs like 'For more information, see Section "<$paratext>" on page <$pagenum>'. I found these very cumbersome and usually reformatted them. -- Steve ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] Cross reference format (what do you use?)
Thanks Fred. All is still well north of the border J Bernard From: Fred Ridder [mailto:docu...@hotmail.com] Sent: Friday, December 2, 2016 11:38 AM To: framers@lists.frameusers.com; bern...@publishingsmarter.com Subject: Re: [Framers] Cross reference format (what do you use?) Hey, Bernard! How's things up in the Great White North? At my last three employers (i.e., for the last ~25 years...) we've used numbered headings (at least 5 levels, although I always try to hold it to 4 levels) and numbered figure captions and table titles. Because of this, the standard practice has always been to keep the cross-reference format simple and only use the label (chapter/section/figure/table) and the number. Old fashioned? Yes, but it works and it keeps the clutter down. Fred Ridder _ From: Framers on behalf of Bernard Aschwanden (Publishing Smarter) Sent: Friday, December 2, 2016 10:19 AM To: framers@lists.frameusers.com Subject: [Framers] Cross reference format (what do you use?) Here is a simple question that I'm sure will have a LOT of opinion. I hope... Building some print-friendly xref formats, and I'm curious what people here actually use. We're all familiar with the function (I think) or at least, we should be. You may have text like this: Chapter 1. Canada Blah blah 1.A Alberta Blah blah 1.B New Brunswick Blah blah Plus you have tables, figures, equations, sections, examples, steps, etc, etc, etc. You link to stuff like "Canada" or "Chapter 1" or "Chapter 1. Canada" or even "Canada on page 23" or whatever. Some xref content may be "See <$paratext>" or "<$paranumonly>" or "step <$paranumonly>". You may also choose to put in sentences like "For more information see section <$paranumonly> on page\ <$pagenum>. " so that it is a self-contained sentence. I don't know. There are a LOT of ways to xref to stuff though. My question is this: What would be the top 3 or 4 ways *you* xref something? Not the steps to insert an xref, but the way it looks in your output. What does the code or the xref look like? Do you put in full sentence xrefs? Do you use words in them? Do you use quotes around content? I know that there are a bizzilion ways to xref stuff, so input would be greatly appreciated. Lastly, I'm not concerned about online as that can be changed at publish time. What do you do though in the print materials? For example, if I use "For more info see pg <$pagenum>. " as a sentence in the online I can just replace it with <$paranumonly>, or <@paratext>, or whatever. The issue for me is "what do people do for print" in regards to the numbering, text, quotes, etc. Thanks to all. Bernard Bernard Aschwanden bern...@publishingsmarter.com www.publishingsmarter.com <http://www.publishingsmarter.com/> <http://www.publishingsmarter.com/> Publishing Smarter www.publishingsmarter.com When creating, managing, or distributing content, you can count on Publishing Smarter to save you time and money Write Less. Write Better. ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com <http://www.frameusers.com/> FrameUsers.com - The Adobe FrameMaker Online Reference Site www.frameusers.com Adobe FrameMaker software is a template-based authoring and publishing solution for unstructured, structured, and XML/DITA content. There is a large and loyal ... Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ <http://www.mail-archive.com/framers%40lists.frameusers.com/> framers - mail-archive.com www.mail-archive.com Messages by Thread [Framers] A FrameMaker bug or is something wrong with my files? Dennis Brunnenmeyer. Re: [Framers] A FrameMaker bug or is something wrong with my ... Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com <http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com> Framers Info Page - FrameUsers.com lists.frameusers.com About the Framers email list. The purpose of this list is to share information about using Adobe Framemaker. We welcome experienced users, newcomers, and people ... Send administrative questions to listad...@frameusers.com ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
Re: [Framers] Cross reference format (what do you use?)
Hey, Bernard! How's things up in the Great White North? At my last three employers (i.e., for the last ~25 years...) we've used numbered headings (at least 5 levels, although I always try to hold it to 4 levels) and numbered figure captions and table titles. Because of this, the standard practice has always been to keep the cross-reference format simple and only use the label (chapter/section/figure/table) and the number. Old fashioned? Yes, but it works and it keeps the clutter down. Fred Ridder From: Framers on behalf of Bernard Aschwanden (Publishing Smarter) Sent: Friday, December 2, 2016 10:19 AM To: framers@lists.frameusers.com Subject: [Framers] Cross reference format (what do you use?) Here is a simple question that I'm sure will have a LOT of opinion. I hope... Building some print-friendly xref formats, and I'm curious what people here actually use. We're all familiar with the function (I think) or at least, we should be. You may have text like this: Chapter 1. Canada Blah blah 1.A Alberta Blah blah 1.B New Brunswick Blah blah Plus you have tables, figures, equations, sections, examples, steps, etc, etc, etc. You link to stuff like "Canada" or "Chapter 1" or "Chapter 1. Canada" or even "Canada on page 23" or whatever. Some xref content may be "See <$paratext>" or "<$paranumonly>" or "step <$paranumonly>". You may also choose to put in sentences like "For more information see section <$paranumonly> on page\ <$pagenum>. " so that it is a self-contained sentence. I don't know. There are a LOT of ways to xref to stuff though. My question is this: What would be the top 3 or 4 ways *you* xref something? Not the steps to insert an xref, but the way it looks in your output. What does the code or the xref look like? Do you put in full sentence xrefs? Do you use words in them? Do you use quotes around content? I know that there are a bizzilion ways to xref stuff, so input would be greatly appreciated. Lastly, I'm not concerned about online as that can be changed at publish time. What do you do though in the print materials? For example, if I use "For more info see pg <$pagenum>. " as a sentence in the online I can just replace it with <$paranumonly>, or <@paratext>, or whatever. The issue for me is "what do people do for print" in regards to the numbering, text, quotes, etc. Thanks to all. Bernard Bernard Aschwanden bern...@publishingsmarter.com www.publishingsmarter.com<http://www.publishingsmarter.com> [http://www.publishingsmarter.com/_/rsrc/1249651640285/Home/Writer.jpg]<http://www.publishingsmarter.com/> Publishing Smarter<http://www.publishingsmarter.com/> www.publishingsmarter.com When creating, managing, or distributing content, you can count on Publishing Smarter to save you time and money Write Less. Write Better. ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com FrameUsers.com - The Adobe FrameMaker Online Reference Site<http://www.frameusers.com/> www.frameusers.com Adobe FrameMaker software is a template-based authoring and publishing solution for unstructured, structured, and XML/DITA content. There is a large and loyal ... Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ framers - mail-archive.com<http://www.mail-archive.com/framers%40lists.frameusers.com/> www.mail-archive.com Messages by Thread [Framers] A FrameMaker bug or is something wrong with my files? Dennis Brunnenmeyer. Re: [Framers] A FrameMaker bug or is something wrong with my ... Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Framers Info Page - FrameUsers.com<http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com> lists.frameusers.com About the Framers email list. The purpose of this list is to share information about using Adobe Framemaker. We welcome experienced users, newcomers, and people ... Send administrative questions to listad...@frameusers.com ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
[Framers] Cross reference format (what do you use?)
Here is a simple question that I'm sure will have a LOT of opinion. I hope... Building some print-friendly xref formats, and I'm curious what people here actually use. We're all familiar with the function (I think) or at least, we should be. You may have text like this: Chapter 1. Canada Blah blah 1.A Alberta Blah blah 1.B New Brunswick Blah blah Plus you have tables, figures, equations, sections, examples, steps, etc, etc, etc. You link to stuff like "Canada" or "Chapter 1" or "Chapter 1. Canada" or even "Canada on page 23" or whatever. Some xref content may be "See <$paratext>" or "<$paranumonly>" or "step <$paranumonly>". You may also choose to put in sentences like "For more information see section <$paranumonly> on page\ <$pagenum>. " so that it is a self-contained sentence. I don't know. There are a LOT of ways to xref to stuff though. My question is this: What would be the top 3 or 4 ways *you* xref something? Not the steps to insert an xref, but the way it looks in your output. What does the code or the xref look like? Do you put in full sentence xrefs? Do you use words in them? Do you use quotes around content? I know that there are a bizzilion ways to xref stuff, so input would be greatly appreciated. Lastly, I'm not concerned about online as that can be changed at publish time. What do you do though in the print materials? For example, if I use "For more info see pg <$pagenum>. " as a sentence in the online I can just replace it with <$paranumonly>, or <@paratext>, or whatever. The issue for me is "what do people do for print" in regards to the numbering, text, quotes, etc. Thanks to all. Bernard Bernard Aschwanden bern...@publishingsmarter.com www.publishingsmarter.com Write Less. Write Better. ___ This message is from the Framers mailing list Send messages to framers@lists.frameusers.com Visit the list's homepage at http://www.frameusers.com Archives located at http://www.mail-archive.com/framers%40lists.frameusers.com/ Subscribe and unsubscribe at http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com Send administrative questions to listad...@frameusers.com
