Template:Transclude selected current events/doc
This is a documentation subpage for Template:Transclude selected current events. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This templates transcludes current events on specified topics from the daily subpages of Portal:Current events. It is intended for use in the "In the news" sections of Portals.
Usage
{{Transclude selected current events | <search pattern 1> | ... | <search pattern n> | not1= | ... | notn= | days= | max= | none= | dates= | more= |header= |footer= }}
- Basic
{{Transclude selected current events| search pattern }}
- Multiple search patterns
{{Transclude selected current events| search pattern | second search pattern | third search pattern }}
- Add as many search patterns as needed
- With patterns to exclude items
{{Transclude selected current events| search pattern | not=search pattern to exclude from results }}
- Add additional search patterns to exclude items from results using
|not2=
,|not3=
, etc. - As a portal component which only displays when news items are found
{{Transclude selected current events| header= header template | footer= footer template | other parameters }}
- As a suggestion generator, e.g. on the portal talk page
{{Transclude selected current events| wikitext=yes | other parameters }}
Parameters
|1=
,|2=
,|3=
...- Search patterns for items
|not1=
,|not2=
,|not3=
...- Search patterns for excluding items
|days=
- Number of days to search through for current events (counting backwards from the current day); default is
30
(nb. you may find large numbers equal to several years won't work for technical reasons). |max=
- Maximum number of items to display; default is
6
|wikitext=
- Set to
yes
to display the wikitext of the items, e.g. when using this template just to generate suggestions |none=
- Wikitext to display if no matching items are found; default is "No recent news"
|dates=
- Set to
mdy
to use MDY-formatted dates (e.g. Nov 4, 2024 rather than 4 Nov 2024) |more=
- Wikitext to show at the bottom of the list; OR
- Set to
yes
to show More current events... link at the bottom of the list |header=
- Wikitext to show above the items; typically
{{Box-header}}
or{{Box-header colour}}
or similar (with appropriate parameters filled in) - If set, this template only displays output when items are found (overriding
|more=
if set) |footer=
- Wikitext to show below the items; defaults to
{{Box-footer}}
- Can only be used in conjunction with
|header=
Search patterns
Search patterns are Lua patterns, which are similar to regular expressions. This means that ^$()%.[]*+-?
characters have special meaning, such as .
matching any character. To search for those characters themselves, they need to be escaped by prefixing a %
For piped links, both the target article name as well as the displayed text are searched for matches. External links are not searched for matches.
Tip: To make a letter in a search pattern case-insensitive, put both the upper-case and lowercase letter inside square-brackets, i.e. [Aa]pple
will match both An apple is... and Apples are....
Examples
Europe
{{Transclude selected current events|Europe}}
No recent news
Europe (as portal component that is only displayed when there is news; limited to a maximum of 4 items)
{{Transclude selected current events|Europe|header={{Box-header color|In the news}}|max=4}}
United Kingdom
{{Transclude selected current events|United Kingdom}} |
---|
No recent news |
Europe OR United Kingdom
{{Transclude selected current events|Europe|United Kingdom}} |
---|
No recent news |
Europe AND United Kingdom
{{Transclude selected current events|Europe.*United Kingdom|United Kingdom.*Europe|days=10}} |
---|
No recent news |
United Kingdom AND NOT Australia
{{Transclude selected current events|United Kingdom|not=Australia}} |
---|
No recent news |
SomethingWithNoMatches
{{Transclude selected current events|SomethingWithNoMatches}} |
---|
No recent news |
TemplateData
TemplateData
| ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Transclude selected current events in articles based on its TemplateData.
TemplateData for Transclude selected current events This templates transcludes current events on specified topics from the daily subpages of Portal:Current Events. Can use Lua search patterns.
|
See also
- {{Template cache}} – companion template