| |||||
There may be times when you only want links to certain pages to have tooltips attached, or perhaps want to take the opposite approach and exclude links to certain pages from having tooltips attached. TippingOver has features relying on categorization to support these functions, but they are not enabled by default.
Configuration[]
To set up an enabling category[]
An enabling category functions like a whitelist. Only links to pages somewhere within that category can have tooltips attached.
In most cases, and especially when the configuration is otherwise default, an enabling category can be activated by asking your wiki manager to change these settings:
- Change
$wgtoEarlyCategoryFilteringtotrue - Change
$wgtoLateCategoryFilteringtotrue
Note that these settings are sometimes a little sticky. Even after they are applied, it may take several minutes and may also require opening pages for editing and saving them without changes before the links update accordingly. In general, links should eventually update on their own.
If the wiki has $wgtoEarlyTargetRedirectFollow set to false while $wgtoLateTargetRedirectFollow is set to true, then $wgtoEarlyCategoryFiltering is generally better left set to false. Otherwise, the category filtering will be done before any links are checked to see if they are redirects, which would mean links to redirects would only get tooltips attached if the redirect itself is in the enabling category.
In rare cases where wikis may have exceptionally large numbers of links on many pages, it may be better to leave $wgtoEarlyCategoryFiltering set to false to avoid potential timeouts, especially on page saves. Alternatively, setting $wgtoPreprocessCategoryFilter to false may help, but only if most of the links on pages lead to tooltips outside the enabling category. Otherwise, it may exacerbate performance problems.
By default, the root enabling category is Category:Has tooltips enabled. You may ask your wiki manager to change this by setting $wgtoEnablingCategory to a different title.
To set up a disabling category[]
Setting up a disabling category, which works as a blacklist, is the same as above, but requires one extra step: $wgtoEnablingCategory will need to be blank.
By default, the root disabling category is Category:Has tooltips disabled. You may ask your wiki manager to change this by setting $wgtoDisablingCategory to a different title.
Using an enabling category[]
When an enabling category is active, any page whose incoming links should display a tooltip will need to be in the enabling category, or any categories within that category to any depth.
For example, if any link to the page Example should have a tooltip, simply adding [[Category:Has tooltips enabled]] (or the appropriate category when not using the default) to Example would be enough.
Often, though, it will be desirable to enable tooltips for all pages within a given category. For example, if a wiki has a large number of pages in Category:Food, rather than adding [[Category:Has tooltips enabled]] (or the appropriate category) to each one of those pages, it could instead be added to the Category:Food page itself. Then all links to pages within Category:Food will have tooltips enabled as well.
Using a disabling category[]
Using a disabling category is the opposite of the above.
For example, if any link to the page Example should not have a tooltip, simply adding [[Category:Has tooltips disabled]] (or the appropriate category when not using the default) to Example would prevent it.
Entire categories of pages can be omitted from tooltip attachment the same way as above. Adding [[Category:Has tooltips disabled]] (or the appropriate category when not using the default) to Category:Food would prevent links to any pages within it from having tooltips.
Limitations[]
As of this writing, it is only possible to use an enabling or a disabling category. The ability to use both, where the disabling category overrules the enabling category, may be added in a future version.
| |||||