Conditionalizing TOC entries vs Topics for exclusion
-
berniexmeyer
- Propeller Head
- Posts: 35
- Joined: Thu Dec 23, 2010 3:09 pm
- Location: Oregon, USA
Conditionalizing TOC entries vs Topics for exclusion
What are the differences in build results between conditionalizing a topic file for exclusion (e.g. with a condition tag named "Delete") versus conditionalizing the outline TOC entry that references that topic? Are there reasons for conditionalizing the topic file in some cases and the TOC entry that references it in other cases? Is there ever any reason to apply a Delete tag to BOTH the topic file and its TOC entry?
Re: Conditionalizing TOC entries vs Topics for exclusion
It depends a lot on what output you're talking about.
In help outputs, excluding a TOC entry will only remove it from the TOC, but the topic file itself will still be in the output files (and accessible via search, index, links, CSH, etc.). If you don't want the topic in the output, you only need to exclude the topic, as Flare will automatically remove TOC entries for excluded topics.
In print outputs (e.g. PDF), as the output only includes topics in the TOC, excluding either will have the same result.
In help outputs, excluding a TOC entry will only remove it from the TOC, but the topic file itself will still be in the output files (and accessible via search, index, links, CSH, etc.). If you don't want the topic in the output, you only need to exclude the topic, as Flare will automatically remove TOC entries for excluded topics.
In print outputs (e.g. PDF), as the output only includes topics in the TOC, excluding either will have the same result.
-
berniexmeyer
- Propeller Head
- Posts: 35
- Joined: Thu Dec 23, 2010 3:09 pm
- Location: Oregon, USA
Re: Conditionalizing TOC entries vs Topics for exclusion
Thanks for much for the quick succinct and helpful response. I think Madcap should steal what you wrote and stick it in their documentation. (If it's already there, I couldn't find it.)
A further question:
In regard to online output, you said that if you exclude the topic file itself, the TOC item for that topic will automatically be removed. I assume you mean removed from the Help TOC generated in the output. The TOC item in the source's outline TOC still remains and must be removed manually, unless one has some reason for keeping it, correct?
A further question:
In regard to online output, you said that if you exclude the topic file itself, the TOC item for that topic will automatically be removed. I assume you mean removed from the Help TOC generated in the output. The TOC item in the source's outline TOC still remains and must be removed manually, unless one has some reason for keeping it, correct?
-
doc_guy
- Propellus Maximus
- Posts: 1979
- Joined: Tue Nov 28, 2006 11:18 am
- Location: Crossroads of the West
- Contact:
Re: Conditionalizing TOC entries vs Topics for exclusion
Right. The file still shows up in the TOC editor in Flare, but you won't see the topic at all in the printed target.
I do this for my printed manuals, which use the same TOC as the online manuals, but all the print-support topics (Table of Contents, Index, Glossary, Cover, etc.) are conditionalized as print only. You can apply the condition to the topic files themselves, or just to the TOC.
Here is the distinction, though: If you have many targets or many TOCs, and you conditionalize the topics themselves in the Content Explorer, the conditions will apply to ALL targets. If you conditionalize them only in the TOC editor, then the condition only applies for that specific TOC and its targets.
So, you may have a topic that goes in one printed guide, but not in another printed guide, but always in online help. In this case, you would need to apply the condition in the TOC editor for that TOC that shouldn't include that topic in print, because applying the condition in the Content Explorer would affect all TOCs and all targets.
Does that make sense?
In comparison, it's a lot like variable definitions. If the definition applies to all outputs, then you make the change in the Project Organizer. if the definition only applies to certain outputs, then you make the change in the target itself.
I do this for my printed manuals, which use the same TOC as the online manuals, but all the print-support topics (Table of Contents, Index, Glossary, Cover, etc.) are conditionalized as print only. You can apply the condition to the topic files themselves, or just to the TOC.
Here is the distinction, though: If you have many targets or many TOCs, and you conditionalize the topics themselves in the Content Explorer, the conditions will apply to ALL targets. If you conditionalize them only in the TOC editor, then the condition only applies for that specific TOC and its targets.
So, you may have a topic that goes in one printed guide, but not in another printed guide, but always in online help. In this case, you would need to apply the condition in the TOC editor for that TOC that shouldn't include that topic in print, because applying the condition in the Content Explorer would affect all TOCs and all targets.
Does that make sense?
In comparison, it's a lot like variable definitions. If the definition applies to all outputs, then you make the change in the Project Organizer. if the definition only applies to certain outputs, then you make the change in the target itself.
