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

Fri Dec 2 16:52:34 PST 2016

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

<X-Ref>Chapter <$paranumonly></>

Chapter #: Text

<X-Ref>Chapter <$chapnum>: <$paratext></>

Heading & Title

<X-Ref><$paranum> <$paratext></>

Heading # Only

<X-Ref><$paranum></>

Step #

<X-Ref>step <$paranumonly></>

Figure # Only

<X-Ref>Figure <$paranumonly></>

Table # Only

<X-Ref>Table <$paranumonly></>

Text Match

<X-Ref><$paratext></>

FYI: <X-Ref> is a character tag style.

Alison Craig
Technical Documentation Specialist
BK Ultrasound | acraig at bkultrasound.com<mailto:acraig at bkultrasound.com> | bkultrasound.com<www.bkultrasound.com>

From: Framers [mailto:framers-bounces+acraig=bkultrasound.com at lists.frameusers.com] On Behalf Of Bernard Aschwanden (Publishing Smarter)
Sent: Friday, December 02, 2016 9:01 AM
To: 'Fred Ridder'; framers at 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:DocuDoc at hotmail.com]
Sent: Friday, December 2, 2016 11:38 AM
To: framers at lists.frameusers.com<mailto:framers at lists.frameusers.com>; bernard at publishingsmarter.com<mailto:bernard at 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 <framers-bounces+docudoc=hotmail.com at lists.frameusers.com><mailto:framers-bounces+docudoc=hotmail.com at lists.frameusers.com%3e> on
behalf of Bernard Aschwanden (Publishing Smarter)
<bernard at publishingsmarter.com><mailto:bernard at publishingsmarter.com%3e>
Sent: Friday, December 2, 2016 10:19 AM
To: framers at lists.frameusers.com<mailto: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<mailto:bernard at publishingsmarter.com>

www.publishingsmarter.com<http://www.publishingsmarter.com>

<http://www.publishingsmarter.com/><http://www.publishingsmarter.com/%3e>

<http://www.publishingsmarter.com/><http://www.publishingsmarter.com/%3e> Publishing Smarter

www.publishingsmarter.com<http://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<mailto:framers at lists.frameusers.com>
Visit the list's homepage at http://www.frameusers.com

<http://www.frameusers.com/><http://www.frameusers.com/%3e> FrameUsers.com - The Adobe FrameMaker Online
Reference Site

www.frameusers.com<http://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/><http://www.mail-archive.com/framers%40lists.frameusers.com/%3e> framers -
mail-archive.com

www.mail-archive.com<http://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><http://lists.frameusers.com/listinfo.cgi/framers-frameusers.com%3e> 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 listadmin at frameusers.com<mailto:listadmin at frameusers.com>

_______________________________________________

This message is from the Framers mailing list

Send messages to framers at lists.frameusers.com<mailto:framers at 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 listadmin at frameusers.com<mailto:listadmin at frameusers.com>

________________________________
-------------- next part --------------
An embedded message was scrubbed...
From: "Bernard Aschwanden (Publishing Smarter)"
	<bernard at publishingsmarter.com>
Subject: Re: [Framers] Cross reference format (what do you use?)
Date: Fri, 2 Dec 2016 17:00:32 +0000
Size: 8803
URL: <http://lists.frameusers.com/pipermail/framers-frameusers.com/attachments/20161203/2fa90f78/attachment.eml>