Page Conditions
Previous Topic  Next Topic 

You can access this feature by clicking on the "Properties" tab, below the editor, and then clicking on the "Conditions" tab.


"Page Conditions" are an extension of "Project Conditions", which affect the whole Project, whereas Topic Conditions just affect the current page. They can affect any page, a Heading, Topic or Popup. They also apply to Translations if you use the International version.


Using Page Conditions

Before you can use a Page Condition you need to have a Project Condition. For our example, please select "Tools | Conditions" and click the [Add] button to add a new Condition and call it "Under Development". Make sure it is un-checked. This means it will be excluded next time you compile. Close the Conditions screen.


Now pick a test page, we will exclude this page next time we compile. Click on the "Properties" tab below the editor, then on the "Conditions" tab. It should look something like this:-


Now click the [<-Add] button and select "Add to this Page". It will now look like this:-


Notice how the "Conditions Status" at the top has turned red to alert you to the fact that this page will be excluded from your help file the next time you compile. This affects WinHelp, HtmlHelp, Website Help and Documentation. Try compiling. You will see that this page is no longer part of your help file, nor is it in the Index.


Now click on [Refresh All Pages]. This will check every page in your Project, Topics, Headings and Popups and apply any changes to the Project Conditions. In this case you will see that the title for this page in the Contents has changed to red. This is to further alert you to the fact that this page will be excluded when you compile.


Now, in the "List of Project Conditions", check the "Under Development" option. Your Conditions Status will change to green to show that this page will be included in the next compile. Click the [Refresh All Pages] button and it will update the contents color title as well. I hope you can get an idea of how powerful this feature can be.


Add/Remove to/from this Page and all Pages below it

This option is useful if you want to isolate a branch of your contents tree. You could for example, add a Condition that was unchecked, and when you compiled this would effectively ignore this whole branch of your contents. The opposite feature to allow you to remove the condition from the current branch is available from the "Remove" button.


Add/Remove to/from All Pages

This option is available from the Add and Remove buttons and will globally add your condition to every page in your Project.


Mixing Conditions

You could have lots and lots of Conditions and apply only one or two to selected pages, but it only takes one Condition to be un-checked, to exclude your page!


Things to be aware of!

Let's say in the above example you have a link from some page to the test page. When you compile with this page excluded and you click on that link it will not find that page. So you need to be careful about which pages you link to when using Page Conditions. Likewise, the structure of your contents may look strange if you exclude a heading that has multiple topics below it. The topics below it will not be excluded, just the heading. So please take these points into consideration when you are using Page Conditions.


Refresh All Pages

Any changes that you make to a Project Condition, i.e. checking or un-checking it, can affect pages within your Project. Clicking this button will search every Topic, Heading and Popup and update the Inclusion / Exclusion status of that page based on your changes.


Page Conditions and Translations

For users of Fast-Help International, if you want to exclude a Translation page, simply apply the Condition to the Base Language page, then compile. All Page Conditions are controlled in the Base Language, but will affect the compilation of whatever language you are compiling.


See Also

Conditions