First, figure out your standard cross-reference style.

See Appendix D
See Appendix D, "Frying Pans and Toasters,"
See Appendix D, "Frying Pans and Toasters," on p. 247
See "Frying Pans and Toasters" on p. 247

Whatever it's going to be, standardize as much as you can. Think about whether 
the style you select works with headed paragraphs as well as 
chapters/appendices. Do your paragraphs have heading numbers? Should these be 
included in the cross-reference definitions? Bust out your Chicago Manual and 
choose wisely, Luke.

Concerning the punctuation inside the terminal quote, you can either pick a 
style that moots it (any of the above examples, except the second) or you add 
two styles, one for commas, another for periods. In a template I built, I 
called 
these xref tags +p and +c (for an added period or comma) styles, e.g. 
ChapterXref+p.

In the second example above, you could dispense with the +c xref definition, 
because the title is an appositive and must be offset with commas, but you 
would 
still need a +p to bring it on home.

--William


Nancy Allison wrote:
> Once more, this time with content!
> 
> For your technical manuals, what is your preferred set of cross-reference
> formats?
> 
> I'm setting up a template and am trying to figure out a way to avoid having
> to create multiple x-refs to accommodate different punctuation. You know
> (x-ref is inside the underscores):
> 
> ---See __Appendix D, "Frying Pans and Toasters,"__  for more information.
> (X-ref includes comma inside quotation marks)
> 
> ---For more information, see __Appendix D, "Frying Pans and Toasters."__
> (X-ref includes period inside quotation marks)
> 
> ---[Inspiration fails me, but I am sure there's a similar example that does
> not use any punctuation within the quotation marks]
> 
> If I create only one x-ref format, using only one kind of punctuation, most
> nimble tech writers will be able to construct nicely flowing sentences to
> employ it. Right?
> 
> Or, I could decree that we never quote the titles of referenced sections, and
> omit any punctuation:
> 
> ---For more information, see __Appendix D__.
> 
> But I think that's a lousy solution: I don't want to omit a descriptive title
> just because it's a pain to set up the x-ref formats for it.
> 
> What is your solution?
> 
> _______________________________________________
> 
> 
> You are currently subscribed to Framers as william at inch.com.
> 
> Send list messages to framers at lists.frameusers.com.
> 
> To unsubscribe send a blank email to framers-unsubscribe at 
> lists.frameusers.com
>  or visit
> http://lists.frameusers.com/mailman/options/framers/william%40inch.com
> 
> Send administrative questions to listadmin at frameusers.com. Visit 
> http://www.frameusers.com/ for more resources and info.
> 
> 

Reply via email to