Template:WPBannerMeta/istemplate/doc

From Safer nicotine wiki
Jump to navigation Jump to search

Usage

This {{WPBannerMeta}} subtemplate decides what kind of page and mode of use the template is being on. It performs two checks:

  1. Is the page name the |BANNER_NAME=, or is the page a subpage of that page?
  2. Is |category=yes, |category= (blank), |category=¬ or |category=banana (anything not explicity negative)?

And then combines them together either with logical operator "and" (default) or another logical operator, e.g. "or"; this can be specified in the first unnamed parameter.

Logical operator: and (default behaviour)

This is used by the main template and some hooks. It will return "yes" only if it is on the template page and is not being used as an example (e.g. on its documentation page). In this case the banner will appear in its 'demo' version with all options demonstrated.

Logical operation "and" (default)
Is the current page
BANNER_NAME or a subpage?
Yes No
Is category blank or anything apart from "no"? Yes yes
No

Logical operator: and not

This is used by some hooks. It will return "yes" only if it is not on the template page and is not being used as an example. This is suitable for non-visual output such as categories.

Logical operation "and not"
Is the current page
BANNER_NAME or a subpage?
Yes No
Is category blank or anything apart from "no"? Yes yes
No