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

Reng, Dr. Winfried wreng at tycoint.com
Tue Dec 6 23:46:24 PST 2016


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.com at lists.frameusers.com] On Behalf Of Bernard Aschwanden (Publishing Smarter)
Sent: Friday, December 02, 2016 4:20 PM
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

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.


More information about the Framers mailing list