Topic changes heading levels

Combs, Richard richard.combs at Polycom.com
Tue Jun 2 07:17:18 PDT 2009


Judy wrote: 
 
> The challenge is how to best handle those topics that appear in more
> than 1 output, but at different heading levels--most commonly an H3 in
> the full manual becomes an H2 in the quickstarts.
> 
> I've thought about:
>  - Multiple conditionalized headings, but that would cause xref
issues.
>  - Building a container doc for each output where the headings are
> entered directly but topic content inset by reference.  This may work,
> but I'm not sure it's the best answer.  Does anyone else have any
ideas?

By all means, put the headings in the container and only the body text
in the text inset source. Even in the absence of your heading-level
conflict, this is a pretty good idea. Cross-references to pgfs inside a
text inset are a pain. Keeping the section headings in the container doc
lets you point xrefs to those headings. 

I prefer to have the section headings in the container doc and only the
content under them in the text inset source. Haven't seen a downside.
YMMV, of course... 

Richard


Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------








More information about the framers mailing list