[Framers] Cross reference format (what do you use?)

[Fred Ridder]

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 <framers-bounces+docudoc=hotmail.com at lists.frameusers.com> on behalf of Bernard Aschwanden (Publishing Smarter) <bernard at publishingsmarter.com>
Sent: Friday, December 2, 2016 10:19 AM
To: framers at 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
bernard at 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 at 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 listadmin at frameusers.com