Template:FindYDCportal/doc

This is a documentation subpage for Template:FindYDCportal.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:FindYDCportal (sandbox)

This template is used on approximately 181,000 pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

A helper template to find the most specific chronology portal which actually exists for a given year or decade. Used to simplify linking to a chronology portal.

It is a wrapper template around Module:FindYDCportal. For use within templates, it is most efficient to invoke the module directly. For one-off use, the template requires less typing and makes the code easier to read.

Parameters

Takes one parameter, which must be either a year (e.g. "1879", "1123") or a decade (e.g. "1940s", "730s").

If the parameter is missing, empty, or does not fit the required format, an empty string is returned.

Output

If a portal is found, returns its name without the namespace prefix, e.g.

for "Portal:1980s" return 1980s

If no portal is found, it returns an empty string.

Usage

Year parameter

{{FindYDCportal|YYYY}} ... where YYYY is a 3- or 4-digit year

Decade parameter

{{FindYDCportal|YYY0s}} ... where YYY0s is a 3- or 4-digit decade

Examples

Years

{{FindYDCportal|2018}} → 2010s
{{FindYDCportal|1982}} → 1980s
{{FindYDCportal|1946}} →
{{FindYDCportal|1857}} →
{{FindYDCportal|736}} →
{{FindYDCportal|1800}} →

Decades

{{FindYDCportal|2000s}} → 2000s
{{FindYDCportal|1940s}} →
{{FindYDCportal|560s}} →

Missing parameter

{{FindYDCportal}} →

Empty parameter

{{FindYDCportal|}} →

Invalid parameter

{{FindYDCportal|1927-related}} →
{{FindYDCportal|Swedish chef}} →

Logic

If the parameter is a year:

If the year portal exists, return its name.
Otherwise try the decade.
If the decade portal exists, return its name.
Otherwise try the century
If the century portal exists, return its name.
Otherwise return an empty string

If the parameter is a decade:

If the decade portal exists, return its name.
Otherwise try the century
If the century portal exists, return its name.
Otherwise return an empty string