View source for Template:Transclude selected current events/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{lua|Module:Selected current events}}

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 [[Wikipedia:Portal|Portals]].

== Usage ==
<pre style="overflow:auto">{{Transclude selected current events | <search pattern 1> | ... | <search pattern n> | not1= | ... | notn= | days= | max= | none= | dates= | more= |header= |footer= }}</pre>

;Basic
:<code><nowiki>{{Transclude selected current events|</nowiki> ''search pattern'' <nowiki>}}</nowiki></code>
;Multiple search patterns:
:<code><nowiki>{{Transclude selected current events|</nowiki> ''search pattern'' |  ''second search pattern'' |  ''third search pattern'' <nowiki>}}</nowiki></code>
:Add as many search patterns as needed
;With patterns to exclude items
:<code><nowiki>{{Transclude selected current events|</nowiki> ''search pattern'' |  not=''search pattern to exclude from results'' <nowiki>}}</nowiki></code>
:Add additional search patterns to exclude items from results using {{para|not2}}, {{para|not3}}, etc.
;As a portal component which only displays when news items are found
:<code><nowiki>{{Transclude selected current events|</nowiki> header= ''header template'' | footer= ''footer template'' | ''other parameters'' <nowiki>}}</nowiki></code>
;As a suggestion generator, e.g. on the portal talk page
:<code><nowiki>{{Transclude selected current events|</nowiki> wikitext=yes |  ''other parameters'' <nowiki>}}</nowiki></code>

===Parameters===
;{{para|1}}, {{para|2}}, {{para|3}} ...
:[[#Search patterns|Search patterns]] for items
;{{para|not1}}, {{para|not2}}, {{para|not3}} ...
:[[#Search patterns|Search patterns]] for excluding items
;{{para|days}}
:Number of days to search through for current events (counting backwards from the current day); default is <code>30</code> (nb. you may find large numbers equal to several years won't work for technical reasons).
;{{para|max}}
:Maximum number of items to display; default is <code>6</code>
;{{para|wikitext}}
:Set to <code>yes</code> to display the wikitext of the items, e.g. when using this template just to generate suggestions
;{{para|none}}
:Wikitext to display if no matching items are found; default is "No recent news"
;{{para|dates}}
:Set to <code>mdy</code> to use MDY-formatted dates (e.g. {{#time:M j, Y}} rather than {{#time:j M Y}})
;{{para|more}}
:Wikitext to show at the bottom of the list; ''OR''
:Set to <code>yes</code> to show '''[[Portal:Current events|More current events...]]''' link at the bottom of the list
;{{para|header}} 
:Wikitext to show above the items; typically {{tlx|Box-header}} or {{tlx|Box-header colour}} or similar (with appropriate parameters filled in)
:If set, this template only displays output when items are found (overriding {{para|more}} if set)
;{{para|footer}}
:Wikitext to show below the items; defaults to {{tlx|Box-footer}}
:Can only be used in conjunction with {{para|header}} 

====Search patterns====
Search patterns are [[mw:Extension:Scribunto/Lua_reference_manual#Patterns|Lua patterns]], which are similar to [[regular expressions]]. This means that <code>^$()%.[]*+-?</code> characters have special meaning, such as <code>.</code> matching any character. To search for those characters themselves, they need to be escaped by prefixing a <code>%</code>

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.

{{bulb}} '''Tip:''' To make a letter in a search pattern case-insensitive, put both the upper-case and lowercase letter inside square-brackets, i.e. <code>[Aa]pple</code> will match both {{xt|An apple is...}} and {{xt|Apples are...}}.

==Examples==
{{{{ROOTPAGENAME}}/doc/examples}}

==TemplateData==
{{cot|TemplateData}}
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Search Pattern (unnamed)",
			"description": "Pattern to search for (multiple instances separated with pipes)",
			"example": "Europe.*United Kingdom",
			"type": "string",
			"default": "(empty)",
			"required": true
		},
		"not": {
			"label": "Not",
			"description": "Pattern to exclude (multiple instances use notX)",
			"example": "not=Africa, not2=Asia",
			"type": "string",
			"default": "(empty)"
		},
		"days": {
			"label": "Days",
			"description": "Number of days back to search (from today)",
			"example": "days=45",
			"type": "date",
			"default": "30",
			"suggested": true
		},
		"max": {
			"label": "Max",
			"description": "Maximum number of values to display",
			"example": "max=10",
			"type": "number",
			"default": "6"
		},
		"none": {
			"label": "None",
			"description": "Wikitext to display if no results found",
			"example": "none='''Oops.''' Nothing found.",
			"type": "content",
			"default": "No recent news"
		},
		"dates": {
			"label": "Dates",
			"description": "Set date format to use MDY instead of DMY",
			"example": "dates=mdy",
			"type": "string",
			"default": "(empty)"
		},
		"more": {
			"label": "More",
			"description": "Wikitext for bottom of listing",
			"example": "more=[[/currentevents|See more]], more=yes",
			"type": "content",
			"default": "(empty)"
		}
	},
	"description": "This templates transcludes current events on specified topics from the daily subpages of Portal:Current Events. Can use Lua search patterns.",
	"format": "inline",
	"paramOrder": [
		"1",
		"not",
		"days",
		"max",
		"none",
		"dates",
		"more"
	]
}
</templatedata>
{{cob}}

== See also ==
* {{tl|Template cache}} – companion template
{{Portal templates navbox}}

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Wikipedia Portal templates]]
}}</includeonly>