View source for Criteria for page selection

{{DPL manual|section=Parameters|subsection=Criteria for page selection}}
{{tocright}}


Articles can be selected based on:
* The category/categories they are assigned to, or the number of categories.
* Their namespace.
* Their references/links to and from other articles.
* Their usage of templates.
* The author/editor of articles.
* Their titles.
* Their character ([[mw:Help:Redirects|redirect]] or normal article).
* Their revision date.
Article result counts can be restricted to a certain limit:
* Via configuration settings within the DPL3 source.
* Via a specific parameter for a given invocation of DPL3.
A subset of results can be selected by random.


'''Important:'''
* Care to select the most appropriately narrow selection criteria is ideal to avoid large result sets; for testing and display purposes, the <code>{{DPL|count}}</code> parameter can also be used.
* Before applying format, ordering, or adjusting output volume, it is generally advised to view page selection results first (to confirm it works as expected).


==Select articles based on CATEGORY==
===category===
{{DPL parameter
 |name    = category
 |purpose = Selects articles based on categories. More than one category can be specified with pipe <code><nowiki>&#124;</nowiki></code> (tag {{DPL|syntax}}) or broken pipe <code><nowiki>¦</nowiki></code> (parser function {{DPL|syntax}}) as a separator; the effect being that pages listed have to be at least in one of the categories (logical {{tt|OR}}).
If the <code>category</code> parameter is specified more than once, the pages listed have to match all these parameters (logical {{tt|AND}}).
}}


'''Syntax:'''<br>

<code>category=''1st category name¦2nd category name¦3rd category name¦...''</code>
<br>or<br>
<code>category=''1st category name<&>2nd category name<&>3rd category name<&>...''</code>
<br>or<br>
<code>category=''_none_''</code>


Either the <code>¦</code> broken pipe can be used for logical {{tt|OR}}, or the <code>&</code> symbol wrapped with <code><></code> (so like <code><&></code>) can be used for logical {{tt|AND}}, '''mixing both is not possible!''' If more than one <code>category=</code> line is specified, their arguments are implicitly connected with {{tt|AND}}. Thus, a logical expression can be built using several {{tt|AND}} terms, with each term consisting of an {{tt|OR}} group of categories.

{{note|'''Important:''' the <code>category</code> command uses the pipe <code><nowiki>|</nowiki></code> symbol to delimit its arguments (logical {{tt|OR}}). When using DPL3 with the parser function {{DPL|syntax}} (the more powerful syntax), the pipe symbol '''must be escaped''' either by using the '''broken pipe''' <code><nowiki>¦</nowiki></code> symbol, or the [[mw:Help:Magic words#Escaped characters|magic word]] <code><nowiki>{{!}}</nowiki></code>.}}


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: category (example 1)|Example}}
{{ViewTest|Examples|Parameter: category (example 1)}}


'''Notes:'''<br>
* A set of [[Special:Uncategorizedpages|Uncategorized]] pages can be specified as a normal category, with the keyword {{tt|_none_}}, for example:
** <code>category=''_none_''</code> for uncategorized pages only.
** <code>category=''_none_¦Animals''</code> or <code>namespace=''Animals¦_none_''</code> for the Uncategorized or the Animals category.
** <code>category=''Mammals¦_none_¦Insects''</code> for the Mammals category, uncategorized pages or the Insects category.

* If <code><nowiki>*</nowiki></code> is put before the name of a category, DPL3 adds all DIRECT subcategories of that category to the statement.
* Using TWO asterisks ( <code><nowiki>**</nowiki></code> ) extends the tree search to two levels. This provides some minimal support for hierarchies of categories. The syntax and/or semantics of this feature might be changed in a future version.

{{note|In some special cases (when DPL3 queries refer to 'uncategorized pages') DPL3 needs a special database view ([https://github.com/Universal-Omega/DynamicPageList3/blob/main/maintenance/CreateView.php dpl_clview]) in the MySQL database.|warn}}


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: category (example 2)|Example}}
{{ViewTest|Examples|Parameter: category (example 2)}}


If <code>{{DPL|ordermethod}}=''category,...''</code> and <code>{{DPL|headingmode}}=</code> are enabled, categories output as headings in the result can be restricted by preceding the list of categories (specified with the category parameter) with <code>+</code> or <code>-</code>:
* <code>+</code> – Only the categories listed in the statement are allowed to appear as headings in the output.
* <code>-</code> – The categories listed in the statement are NOT allowed to appear as headings in the output (but all others).


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: category (example 3)|Example}}
{{ViewTest|Examples|Parameter: category (example 3)}}


'''Notes:'''

* To use [[mw:Help:Magic words#Variables|magic words]] in the category name, the parser function {{DPL|syntax}} method must be used.
* To prevent a DPL3 query from returning huge output (or consuming too many resources) there are some [[Manual#Configuration|configuration variables]], for related configuration settings also see the complete list of [[mw:Extension:DynamicPageList3|DynamicPageList3]] configuration variables.
* Using the <code>{{DPL|category}}</code> statement without an argument will have '''no effect''' (note that in previous DPL3 versions, this acted like <code>category=''_none_''</code>).

===categorymatch===
{{DPL parameter
 |name    = categorymatch
 |purpose = Selects articles based on categories. One or more patterns can be specified ([https://www.w3schools.com/sql/sql_like.asp SQL LIKE]); a page is selected if at least one of its categories matches at least one of the patterns.
}}


'''Syntax:'''<br>

<code>categorymatch=''1st category pattern¦...''</code>

<code>%</code> is used to denote "any number of any characters".


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: categorymatch (example 1)|Example}}
{{ViewTest|Examples|Parameter: categorymatch (example 1)}}


===categoryregexp===
{{DPL parameter
 |name    = categoryregexp
 |purpose = Selects pages with a category matching a regular expression.
}}


The complete text behind "categoryregexp" is taken as '''one''' argument and used in a SQL REGEXP clause (i.e., <code>|</code> characters can be used as a normal part of the regexp).


'''Note:''' {{regexpinfo}}


===notcategory===
{{DPL parameter
 |name    = notcategory
 |purpose = Much like the <code>{{DPL|category}}</code> parameter, but requires that every page listed ''not'' be in a particular category. Unlike in the <code>category</code> parameter, categories cannot be combined using logical {{tt|OR}}, only one criterion can be specified per line.
}}


'''Syntax:'''<br>

<code>notcategory=''category name''</code>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: notcategory (example 1)|Example}}
{{ViewTest|Examples|Parameter: notcategory (example 1)}}


'''Notes:'''
* To use [[mw:Help:Magic words#Variables|magic words]] in the category name, the parser function {{DPL|syntax}} method must be used.
* There are some related [[Manual#Configuration|configuration variables]], also see the complete list of [[mw:Extension:DynamicPageList3|DynamicPageList3]] configuration variables.


===notcategorymatch===
{{DPL parameter
 |name    = notcategorymatch
 |purpose = Works like {{DPL|notcategory}} but based on [https://www.w3schools.com/sql/sql_like.asp SQL LIKE].
}}


===notcategoryregexp===
{{DPL parameter
 |name    = notcategoryregexp
 |purpose = Works like notcategory but based on SQL REGEXP.
}}


'''Note:''' {{regexpinfo}}


===categoriesminmax===
{{DPL parameter
 |name    = categoriesminmax
 |purpose = Restricts article selection to those assigned to at least [min] categories, and/or at most to [max] categories.
}}


'''Syntax:'''<br>

<code>categoriesminmax=''[min]'',''[max]''</code> where {{tt|min}} and {{tt|max}} are each a desired number.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: categoriesminmax (example 1)|Example}}
{{ViewTest|Examples|Parameter: categoriesminmax (example 1)}}


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: categoriesminmax (example 2)|Example}}
{{ViewTest|Examples|Parameter: categoriesminmax (example 2)}}


==Select articles based on NAMESPACES==

===namespace===
{{DPL parameter
 |name    = namespace
 |purpose = Restricts article selection to the given namespace(s). 
}}


'''Syntax:'''<br>

<code>namespace=''1st_namespace_name¦2nd namespace_name¦3rd_namespace_name¦...''</code>


'''Notes:'''
* The [[mw:Help:Namespaces|namespace]] name may be any, assuming it represents a valid namespace in the system, including custom ones, BUT no pseudo-namespace such as ''Media'', ''Special'' which have negative namespace IDs. 
* The empty string is the main article namespace. This behavior may be removed in future versions, so explicitly specifying <code>namespace=Main</code> is recommended. For example:
:* <code>namespace=</code> for pages in ''Main'' namespace only, but <code>namespace=Main</code> is preferred.
:* <code>namespace=''User¦¦Category''</code> for ''User'', ''Main'', or ''Category'', but <code>namespace=''User¦Main¦Category''</code> is preferred.
* Name spaces are ''case-sensitive'', <code>namespace=''User_talk''</code> works, but <code>namespace=''User_Talk''</code> does not.
* Instead of using the title of a namespace its numeric ID can be used, although this is '''not recommended'''; DPL3 always tries to interpret the argument as a name first. So, if a user namespace is created with the title "1" (which is possible in principle) DPL3 takes this namespace if given a "1" as an argument. In this case, the "Talk" namespace (which has the numeric ID "1") cannot be specified by its number, but only by the literal "Talk".


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: namespace (example 1)|Example}}
{{ViewTest|Examples|Parameter: namespace (example 1)}}


'''Example (with [[mw:Help:Magic words#Namespaces|magic word]]):'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: namespace (example 2)|Example}}
{{ViewTest|Examples|Parameter: namespace (example 2)}}


===notnamespace===
{{DPL parameter
 |name    = notnamespace
 |purpose = Much like the <code>{{DPL|notcategory}}</code> parameter, but for namespaces. Restricts article selection to those '''not''' in the given namespace(s).
}}


'''Syntax:'''<br>

<code>notnamespace=''namespace_name''</code>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: notnamespace (example 1)|Example}}
{{ViewTest|Examples|Parameter: notnamespace (example 1)}}


'''Example (with [[mw:Help:Magic words#Namespaces|magic word]]):'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: notnamespace (example 2)|Example}}
{{ViewTest|Examples|Parameter: notnamespace (example 2)}}

==Select articles based on LINKS==

===linksfrom===
{{DPL parameter
 |name    = linksfrom
 |purpose = Selects articles that are referenced/linked from at least one of the specified pages. 
}}


'''Syntax:'''<br>

<code>linksfrom=''full page name¦...'</code>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: linksfrom (example 1)|Example}}
{{ViewTest|Examples|Parameter: linksfrom (example 1)}}


'''Notes:'''
* Normally <code>linksfrom</code> '''only shows existing pages'''. With <code>{{DPL|openreferences}}=''yes''</code> this can be changed.
* The <code>{{DPL|distinct}}</code> parameter can be used to control the amount of output received.
* The page mentioned in the DPL3 query can be retrieved via <code>{{DPL|PAGESEL|%PAGESEL%}}</code> variable.


===openreferences===
{{DPL parameter
 |name    = openreferences
 |purpose = Extends <code>linksfrom</code> to unresolved references (non-existing articles or image links). Implicitly sets <code>{{DPL|ordermethod}}{{=}}''none''</code> if set to {{tt|yes}} or {{tt|missing}}. 
{{note|Most DPL3 parameters depend on the existence of a page. If <code>openreferences</code> is set, none of those parameters can be used. Examples of conflicting parameters are all parameters related to categories, revisions, authors, redirections, and some other parameters.|warn}}
}}


'''Syntax:'''<br>

<code>openreferences=''criteria''</code> where {{tt|criteria}} can be one of:
* <code>''yes''</code> – Pages that do not exist are '''included''' –  conflicts with some options; implicitly sets <code>{{DPL|ordermethod}}{{=}}''none''</code>.
* <code>''missing''</code> – '''Only''' includes pages that do not exist from missing articles in the [[mw:Manual:Pagelinks_table|pagelinks]] table; conflicts with some options. Implicitly sets <code>{{DPL|ordermethod}}{{=}}''none''</code>.
:* This option may be useful to create a list of wanted pages (redlinks) (e.g., wanted pages for a specific namespace). 
* <code>''no''</code> – Pages that do not exist are '''excluded''' – ('''default''', need not be specified).


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: openreferences (example 1)|Example}}
{{ViewTest|Examples|Parameter: openreferences (example 1)}}


===notlinksfrom===
{{DPL parameter
 |name    = notlinksfrom
 |purpose = Selects articles that are NOT referenced/linked from any of the specified pages. 
}}


'''Syntax:'''<br>

<code>notlinksfrom=''full page name¦...''</code>


Similar to <code>linksfrom</code> the <code><nowiki>{{FULLPAGENAME}}</nowiki></code> [[mw:Help:Magic words#Page names|magic word]] could be used, to not include any pages linked to from the current page; however this generally results in errors.


===linksto===
{{DPL parameter
 |name    = linksto
 |purpose = Selects articles that link to at least one of the specified pages.
}}


'''Syntax:'''<br>

<code>linksto=''full page name¦...''</code>


'''Notes:'''
* <code>%</code> can be used as a wildcard ([https://www.w3schools.com/sql/sql_like.asp SQL LIKE] expression).
* If more than one criterion is specified, they act as a logical {{tt|AND}}. In this case, the <code>{{DPL|%PAGESEL%}}</code> variable points to the '''first''' condition. 
* <code>{{DPL|%PAGESEL%}}</code> can be used to display the name of the page linking to the criteria specified.
* If two criteria are set, and a result links to both, the result appears twice in the output.
** The <code>{{DPL|distinct}}</code> parameter can be used to control the amount of output received.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: linksto (example 1)|Example}}
{{ViewTest|Examples|Parameter: linksto (example 1)}}


'''Example (with [[mw:Help:Magic words#Page names|magic word]]):'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: linksto (example 2)|Example}} {{ViewTest|Examples|Parameter: linksto (example 2)|nosandbox=y}}


===notlinksto===
{{DPL parameter
 |name    = notlinksto
 |purpose = Selects articles that do NOT link to any of the specified pages. 
}}


'''Syntax:'''<br>

<code>notlinksto=''full page name¦...''</code>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: notlinksto (example 1)|Example}}
{{ViewTest|Examples|Parameter: notlinksto (example 1)}}


'''Notes:'''
* The implementation of this feature is not very efficient. Use with care and avoid huge result sets.
* The <code>{{DPL|distinct}}</code> parameter can be used to control the amount of output received.


===linkstoexternal===
{{DPL parameter
 |name    = linkstoexternal
 |purpose = Selects articles that contain an external link that matches a given text pattern. 
}}


'''Syntax:'''<br>

<code>linkstoexternal=''text pattern¦...''</code>

This command selects pages which contain external HTTP links that match a certain pattern. The pattern is used in [https://www.w3schools.com/sql/sql_like.asp SQL LIKE] expression, i.e., <code>_</code> and <code>%</code> are treated as special symbols that match any character respecting a group of arbitrary characters.


'''Notes:'''
* The pattern is case-sensitive.
* The pattern is matched against the whole URL. Therefore, <code>%</code> is required around the pattern if only part of a string is given:
:<code>linkstoexternal=''%mywebpage%''</code>
* If more than one <code>linkstoexternal</code> parameter is specified, articles must match '''all''' conditions (logical {{tt|AND}}).
* The URL of the external link can be retrieved via <code>{{DPL|%EXTERNALLINK%}}</code>.
* See also the <code>{{DPL|addexternallink}}</code> parameter.


===imageused===
{{DPL parameter
 |name    = imageused
 |purpose = Selects articles that use a certain image.
}}


'''Syntax:'''<br>

<code>imageused=''image name¦...''</code>


The Namespace "File" need not be specified.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: imageused (example 1)|Example}}
{{ViewTest|Examples|Parameter: imageused (example 1)}}


'''Note:''' There is a variable <code>{{DPL|IMAGESEL|%IMAGESEL%}}</code> which contains the image name(s) used for selection.


===imagecontainer===
{{DPL parameter
 |name    = imagecontainer
 |purpose = Select images that are contained in one or more articles. 
}}


'''Syntax:'''<br>

<code>imagecontainer=''page name¦...''</code>

{{note|Normally setting <code>openreferences</code> to {{tt|true}} lists non-existing images, including those not housed locally, such as images used from Wikimedia Commons; however, currently this function may cause errors that prevent a page from being saved.|warn}}


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: imagecontainer (example 1)|Example}}
{{ViewTest|Examples|Parameter: imagecontainer (example 1)}}

'''See:''' [[Images used (examples)]] for more image-related examples.


==Select articles based on the use of TEMPLATES==

===uses===
{{DPL parameter
 |name    = uses
 |purpose = Selects articles that use (transclude) at least one of the specified templates (wiki syntax: <code><nowiki>{{...}}</nowiki></code>).
}}


'''Syntax:'''<br>

<code>uses=''Template:name¦Template:...''</code>


The "Template" namespace must be specified, or other namespaces can be specified.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: uses (example 1)|Example}}
{{ViewTest|Examples|Parameter: uses (example 1)}}


'''Note:''' It is '''not''' possible to find pages that use two templates (e.g., Template:Foo {{tt|AND}} Template:Bar).


===notuses===
{{DPL parameter
 |name    = notuses
 |purpose = Selects articles that do not use any of the specified templates.<br>
{{note|'''Caution:''' The implementation of this feature is not very efficient. Use with care and avoid huge result sets.|warn}}
}}


'''Syntax:'''<br>

<code>notuses=''Template:name¦Template:...''</code>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: notuses (example 1)|Example}}
{{ViewTest|Examples|Parameter: notuses (example 1)}}


===usedby===
{{DPL parameter
 |name    = usedby
 |purpose = Selects articles (templates) that are used (transcluded) by a specified page. 
}}


'''Syntax:'''<br>

<code>usedby=''page''</code>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: usedby (example 1)|Example}}
{{ViewTest|Examples|Parameter: usedby (example 1)}}


==Select articles based on authors / editors==

===createdby===
{{DPL parameter
 |name    = createdby
 |purpose = Selects articles that were created by the specified user.<br/>{{slow}}
}}


'''Syntax:'''<br>

<code>createdby=''username''</code>


'''Notes:''' (applies for all user related selection criteria):

* User related selections can be combined. For example, pages which were not created by {{tt|user1}} but modified by them could be specified, or pages which were created by {{tt|user1}} and <code>{{DPL|lastmodifiedby}}</code> {{tt|user2}} could be specified.
* Several or all versions of articles can be shown by specifying one or more of the "revision" group of parameters, like <code>{{DPL|allrevisionsbefore}}</code>.


===notcreatedby===
{{DPL parameter
 |name    = notcreatedby
 |purpose = Selects articles that were '''not''' created by the specified user.<br/>{{slow}}
}}


'''Syntax:'''<br>

<code>notcreatedby=''username''</code>


'''Note:''' To avoid huge result sets, this is typically accompanied by other selection criteria.


===modifiedby===
{{DPL parameter
 |name    = modifiedby
 |purpose = Selects articles that were created or at least once modified by the specified user. 
}}


'''Syntax:'''<br>

<code>modifiedby=''username''</code>


'''Note:''' <code>modifiedby</code> is always a superset of <code>{{DPL|createdby}}</code> as the creation of a page is interpreted as its first modification.


===notmodifiedby===
{{DPL parameter
 |name    = notmodifiedby
 |purpose = Selects articles that were '''not''' (created or) modified by the specified user. 
}}


'''Syntax:'''<br>

<code>notmodifiedby=''username''</code>


'''Note:''' To avoid huge result sets, this is typically accompanied by other selection criteria.


===lastmodifiedby===
{{DPL parameter
 |name    = lastmodifiedby
 |purpose = Selects articles where the last modification was done by the specified user. 
}}


'''Syntax:'''<br>

<code>lastmodifiedby=''username''</code>


===notlastmodifiedby===
{{DPL parameter
 |name    = notlastmodifiedby
 |purpose = Selects articles where the last modification was '''not''' done by the specified user. 
}}


'''Syntax:'''<br>

<code>notlastmodifiedby=''username''</code>


'''Note:''' To avoid huge result sets, this is typically accompanied by other selection criteria.


==Select articles based on TITLE==
<br>
There are several possibilities to select articles by their title. When the titles of matching articles are displayed later in the output list, their names can be shown in different ways: The namespace may be shown or skipped and even parts of the name can be changed. See <code>{{DPL|shownamespace}}</code>, <code>{{DPL|replaceintitle}}</code>, <code>{{DPL|escapelinks}}</code> and <code>{{DPL|titlemaxlength}}</code> for details.


===title===
{{DPL parameter
 |name    = title
 |purpose = Select '''one single''' page by its (namespace and) title, sets <code>{{DPL|mode}}{{=}}''userformat''</code> giving no output by default, and '''requires''' an <code>{{DPL|include}}</code> statement. For '''single''' page ''selection'' see <code>{{DPL|include}}</code> notes.
{{note|This parameter's behavior is different from most other selection criteria, it is primarily useful for including/transcluding contents from one specific page.}}
}}


'''Syntax:'''<br>

<code>title=''pagetitle''</code>


Given its unique behavior, specifying an exact "title" makes sense if transcluding (including) contents from one specific page is desired. E.g., All content, a page section, labeled sections, or template calls of one page. Thus, DPL may serve as a more flexible alternative to [[mw:Labeled Section Transclusion|Labeled Section Transclusion]]. 


Using this parameter causes the following:
* <code>{{DPL|mode}}{{=}}''userformat''</code> is automatically set, causing no output to be given by default until specified.
* Some type of <code>{{DPL|include}}=</code> statement must be specified to get output.
** The content can be presented as-is directly from the include statement, or the output can be [[Controlling output format|formatted]]:
*** By setting <code>{{DPL|format}}=</code> arguments.
*** By using other types of [[Controlling output format|formatting]] (or a combination of compatible formatting types).
*** By specifying a {{DPL|include|surrogate template}}. 
** Specified formatting affects if article title is displayed, is repeated, and/or if results appear separated or grouped.
*** If there is more than one section with the same name, the contents of each are displayed one after the other.  
*** When content is formatted using <code>{{DPL|table}}</code>, by default each result with the same name appears in a separate row with a separate heading, as can be seen in the example for [[Controlling output volume#include page sections (chapters)|including page sections]].
** The <code>{{DPL|SECTION|%SECTION%}}</code> variable can be used, but only in <code>{{DPL|secseparators}}</code>, to retrieve page section/chapter heading text. 


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: title (example 1)|Example}}
{{ViewTest|Examples|Parameter: title (example 1)}}


===titlelt (Previously title&lt;)===
{{DPL parameter
 |name    = titlelt
 |purpose = Restrict the selection to articles with a title less or equal to a given value.
}}


'''Syntax:'''<br>

<code>titlelt=''string''</code>


The {{tt|string}} given need not be a valid page title.
{{note|This parameter was standardized to <code>titlelt</code> and it is recommended to switch instances to the new wording. For compatibility purposes, <code>title&lt;</code> continues to work.}}


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: titlelt (example 1)|Example}}
{{ViewTest|Examples|Parameter: titlelt (example 1)}}


'''Notes:'''
* It may be helpful to remember:
** The last two letters of <code>titlelt</code> ("lt") correspond to letters in "left", so result(s) to the left of the article specified are returned.
* This parameter may allow efficient navigation between pages in the same category or result set, or large result sets.
* In DPL3 parser function syntax [[General usage and invocation syntax|method]]: 
** <code>titlelt</code> could be set to <code><nowiki>{{PAGENAME}}</nowiki></code>, a <code>{{DPL|count}}</code> of one, and used to compose a left/previous navigation.
** <code>[[Criteria for page selection#titlegt (Previously title&gt;)|titlegt]]</code> could be set to <code><nowiki>{{PAGENAME}}</nowiki></code>, a <code>{{DPL|count}}</code> of one, and used to compose a right/next navigation.
* For other methods of scrolling navigation between items in a category, that makes implicit use of this parameter, see [[General usage and invocation syntax#Scrolling/URL Parameters|scrolling]].


'''Combined (multipart) Result:'''<br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: titlelt (example 2)|Combined use on-page}}

{{ViewTest|Examples|Parameter: titlelt (example 2)|margintop=1em|margin=1em}}

===titlegt (Previously title&gt;)===
{{DPL parameter
 |name    = titlegt
 |purpose = Restrict the selection to articles with a title greater or equal to a given value.
}}


'''Syntax:'''<br>

<code>titlegt=''string''</code>


The ''string'' given need not be a valid page title.
{{note|This parameter was standardized to <code>titlegt</code> and it is recommended to switch instances to the new wording.  For compatibility purposes, <code>title&gt;</code> continues to work.}}


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: titlegt (example 1)|Example}}
{{ViewTest|Examples|Parameter: titlegt (example 1)}}


'''Notes:'''

* It may be helpful to remember:
** The last two letters of <code>titlegt</code> ("gt") correspond to letters in "right", so result(s) to the right of the article specified are returned.
* This parameter may allow efficient navigation between pages in the same category or result set, or large result sets.
* In DPL3 parser function syntax [[General usage and invocation syntax|method]]:
** <code>titlegt</code> could be set to <code><nowiki>{{PAGENAME}}</nowiki></code>, a <code>{{DPL|count}}</code> of one, and used to compose a right/next navigation.
** <code>[[Criteria for page selection#titlelt (Previously title&lt;)|titlelt]]</code> could be set to <code><nowiki>{{PAGENAME}}</nowiki></code>, a <code>{{DPL|count}}</code> of one, and used to compose a left/previous navigation.
* For other methods of scrolling navigation between items in a category, that makes implicit use of this parameter, see [[General usage and invocation syntax#Scrolling/URL Parameters|scrolling]].


===titlematch===
{{DPL parameter
 |name    = titlematch
 |purpose = Select articles with a title matching at least one of the specified patterns. The patterns are used as a [https://www.w3schools.com/sql/sql_like.asp LIKE argument] in an SQL query. Namespaces are ignored, as the <code>{{DPL|namespace}}</code> parameter can be used to further narrow the selection.
}}


'''Syntax:'''<br>

<code>titlematch=''pattern¦...''</code>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: titlematch (example 1)|Example}}
{{ViewTest|Examples|Parameter: titlematch (example 1)}}


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: titlematch (example 2)|Example}}
{{ViewTest|Examples|Parameter: titlematch (example 2)}}


'''Notes:'''
* Can be used ''without'' <code>%</code> to query a '''single page''', since the <code>{{DPL|title}}</code> parameter operates as full page ''transclusion'' and cannot be used for single page selection. 
* The match is case-sensitive, even regarding the first character; to make it case-insensitive, use the parameter <code>{{DPL|ignorecase}}</code>. 
* Spaces are translated to <code>\_</code> (escaped underscore) as MediaWiki internally stores names with underscores instead of spaces. Using an underscore in your <code>titlematch</code> argument means 'any single character' in [https://www.w3schools.com/sql/sql_like.asp SQL LIKE] expressions.


===titleregexp===
{{DPL parameter
 |name    = titleregexp
 |purpose = Select articles with a title matching the specified regular expressions. The pattern is used as a REGEXP argument in a SQL query. Namespaces are ignored, as the <code>{{DPL|namespace}}</code> parameter can be used to further narrow the selection.
}}


'''Syntax:'''<br>

<code>titleregexp=''regular expression''</code>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: titleregexp (example 1)|Example}}
{{ViewTest|Examples|Parameter: titleregexp (example 1)}}


'''Note:''' {{regexpinfo}}


===nottitlematch===
{{DPL parameter
 |name    = nottitlematch
 |purpose = Select articles with a title '''not''' matching any of the specified patterns. The patterns are used as a [https://www.w3schools.com/sql/sql_like.asp LIKE argument] in a SQL query. Namespaces are ignored, as the <code>{{DPL|namespace}}</code> parameter can be used to further narrow the selection. Normally, you would want to use this selection only in combination with other criteria. Otherwise, output could become huge.
}}


'''Syntax:'''<br>

<code>nottitlematch=''pattern¦...''</code>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: nottitlematch (example 1)|Example}}
{{ViewTest|Examples|Parameter: nottitlematch (example 1)}}


===nottitleregexp===
{{DPL parameter
 |name    = nottitleregexp
 |purpose = Select articles with a title that does '''not''' match the specified regular expression. The pattern is used as a REGEXP argument in a SQL query. Namespaces are ignored, as the <code>{{DPL|namespace}}</code> parameter can be used to further narrow the selection. Normally, you would want to use this selection only in combination with other criteria. Otherwise, output could become huge.
}}


'''Syntax:'''<br>

<code>nottitleregexp=''regular expression''</code>


'''Note:''' {{regexpinfo}}


==Select articles based on CONTENTS==

===includematch===
{{DPL parameter
 |name    = includematch
 |purpose = Controls the selection of articles based on the content that is included from them.
}}


'''Syntax:'''<br>

<code>includematch=''regexp1,regexp2,...''</code>

This option only works with the output of {{DPL|include}}. A page is only selected (and its contents included) if the contents to be included matches a regular expression. In the case of (heading based) chapter inclusion and labeled section inclusion, the ''relevant contents of the page'' must match the pattern; in the case of template based matching it is the ''complete wikitext of the calling code of your template'' which is tested against your regular expression. Be careful to design your regexp in a proper way so that it can match all syntactical variations, and note that we use '''Perl regular expressions'''. This means that the regexp must be delimited with two identical characters that are not part of the regexp itself, e.g., with <code>/</code>. Otherwise, strange error messages are given from the PHP interpreter.


'''Note:''' {{regexpinfo}}


For '''named parameters''' something like this should be used, to be on the safe side:
<pre>
includematch = /\{{!}}\s*myParameter\s*=\s*myPattern/s
</pre> 
* Thus, spaces can be put around the <code>=</code> and line breaks used in the original article when calling the template – and the pattern will still match. 
* '''Note:''' <code><nowiki>{{!}}</nowiki></code> must be used to produce a pipe symbol – otherwise the pipe breaks the parameter structure of the DPL call.


For '''unnamed parameters''' something like the following could be specified
<pre>
includematch = /\{{!}}\s*myPattern/s
</pre>


If the parameter is not the last one in the template call, this might be used:
<pre>
includematch = /\{{!}}\s*myPattern\s*\{{!}}/s
</pre> 


See the <code>[[Controlling output volume#include|include]]</code> parameter.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: includematch (example 1)|Example}}
{{ViewTest|Examples|Parameter: includematch (example 1)}}


'''Note(s):'''<br>

* In combination with templates, the regexp matching only works if some output is produced via the <code>{{DPL|include}}</code> statement. So, if a dummy parameter only is called, or a surrogate/phantom template is called that does not produce any output, no matches are seen. It is, however, sufficient to produce a space character to get output. It is not necessary to output the parameter which matches your regexp.
* Remember, the pipe <code>|</code> '''must''' be replaced with either broken pipe <code>¦</code> or <code><nowiki>{{!}}</nowiki></code>, or with in <code><nowiki>[^¦]</nowiki></code> when parser function <code><nowiki>{{#dpl:}}</nowiki></code> {{DPL|syntax}} is used, or the statement won't work because the pipe would be mistaken as a field delimiter for #dpl itself, and break the parameter structure of the DPL3 call.


To stop the pattern matching at field boundaries (i.e., at pipe characters) something such as this might be used:


'''Parser ''function'' syntax''' (note that '''broken''' pipe <code>¦</code> is used). 
<pre>
includematch = /languages\s*=\s*[^¦]*English/s
</pre>


'''Parser ''extension'' syntax''' (note that ''regular'' '''pipe''' <code>|</code> is used). 
<pre>
includematch = /languages\s*=\s*[^|]*English/s
</pre>


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: includematch (example 2)|Example}}
{{ViewTest|Examples|Parameter: includematch (example 2)}}


===includematchparsed===
{{DPL parameter
 |name    = includematchparsed
 |purpose = Controls the selection of articles based on (pre-parsed) contents that is included from them.
}}

Works exactly like <code>{{DPL|includematch}}</code> but the contents are parsed before it is tested against the regular expression.


===includenotmatch===
{{DPL parameter
 |name    = includenotmatch
 |purpose = Controls the selection of articles based on contents that is included from them.
}}


'''Syntax:'''<br>

<code>includenotmatch=''regexp1,regexp2,...''</code>

The idea is that a page is only selected (and its contents included) if the contents to be included '''does not match''' a given regular expression. In the case of (heading based) chapter inclusion and labelled section inclusion, the relevant contents of the page must not match the pattern; in the case of template based matching, it is the calling code of the template which must not match the regular expression. Be careful to design the regexp in a proper way, so it covers all syntactical variations. Something like the following should be used to be on the safe side:
<pre>
includenotmatch = myParameter\s*=\s*myPattern/s
</pre>

Thus, spaces can be put around the <code>=</code> and line breaks used in the original article when calling the template – and still, the pattern will do its job.

See the <code>{{DPL|include}}</code> parameter.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: includenotmatch (example 1)|Example}}
{{ViewTest|Examples|Parameter: includenotmatch (example 1)}}


'''Note:''' {{regexpinfo}}


===includenotmatchparsed===
{{DPL parameter
 |name    = includenotmatchparsed
 |purpose = Controls the selection of articles based on (pre-parsed) contents that are included from them.
}}

Works exactly like <code>{{DPL|includenotmatch}}</code> but the contents are parsed before it is tested against the regular expression.

==Select articles based on REVISION dates==
By default, DPL uses "Y-m-d H:i:s" to display date and time. Note that MediaWiki stores all dates/times in UTC format. When displaying a time stamp, DPL translates it according to:
# The timezone preference (difference to UTC/GMT) given by the user in user settings.
# If no preference is given, and for all anonymous users, the local time on the server is used.

So, either a time based on the user's local time (browser based), or based on the timezone in which the wiki server is running is seen.

The same kind of translation applies to dates specified when selecting articles by revision date/time.


===lastrevisionbefore===
{{DPL parameter
 |name    = lastrevisionbefore
 |purpose = Selects articles that existed before the specified date, and displays the last revision before that date (this latter date can be accessed using the <code>{{DPL|REVISION}}</code> variable in <code>{{DPL|mode}}{{=}}''userformat''</code>).
}}


'''Syntax:'''<br>

<code>lastrevisionbefore=''dateandoptionaltime''</code> where {{tt|dateandoptionaltime}} is a numeric string of up to 14 digits, like "200812041300" (4th of Dec., 2008, 13:00).


The string may contain separation characters like "2008/12/04--13:00".


'''Note:''' If this parameter is used, the variable <code>{{DPL|REVISION|%REVISION%}}</code> contains/returns the revision of the selected page(s).


===firstrevisionsince===
{{DPL parameter
 |name    = firstrevisionsince
 |purpose = Selects articles that had a revision created after the specified date, and displays that revision date (this latter date can be accessed using the <code>{{DPL|REVISION}}</code> variable in <code>{{DPL|mode}}{{=}}''userformat''</code>).
}}


'''Syntax:'''<br>

<code>firstrevisionsince=''dateandoptionaltime''</code> where {{tt|dateandoptionaltime}} is a numeric string of up to 14 digits, like "200812041300" (4th of Dec., 2008, 13:00).


The string may contain separation characters like "2008/12/04--13:00".


'''Note:''' if this parameter is used, the variable <code>{{DPL|REVISION|%REVISION%}}</code> contains/returns the revision of the selected page(s).


===allrevisionsbefore===
{{DPL parameter
 |name    = allrevisionsbefore
 |purpose = Shows all revisions that existed before the specified date. The date of each revision is shown (and is available as <code>{{DPL|REVISION}}</code> in <code>{{DPL|mode}}{{=}}''userformat''</code>).
}}


'''Syntax:'''<br>

<code>allrevisionsbefore=''dateandoptionaltime''</code> where {{tt|dateandoptionaltime}} is a numeric string of up to 14 digits, like "200812041300" (4th of Dec., 2008, 13:00).


The string may contain separation characters like "2008/12/04--13:00".


'''Note:''' if this parameter is used, the variable <code>{{DPL|REVISION|%REVISION%}}</code> will contain the revision of the selected page(s).


===allrevisionssince===
{{DPL parameter
 |name    = allrevisionssince
 |purpose = Shows all revisions that were created after the specified date. The date of each revision is shown (and is available as <code>{{DPL|REVISION}}</code> in <code>{{DPL|mode}}{{=}}''userformat''</code>). If there was no new revision of an existing article after the specified date, that article will not appear in the output.
}}


'''Syntax:'''<br>

<code>allrevisionssince=''dateandoptionaltime''</code> where  {{tt|dateandoptionaltime}} is a numeric string of up to 14 digits, like "200812041300" (4th of Dec., 2008, 13:00).


The string may contain separation characters like "2008/12/04--13:00".


'''Note:''' if this parameter is used, the variable <code>{{DPL|REVISION|%REVISION%}}</code> will contain the revision of the selected page(s).


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: allrevisionssince (example 1)|Example}}
{{ViewTest|Examples|Parameter: allrevisionssince (example 1)}}


===maxrevisions===
{{DPL parameter
 |name    = maxrevisions
 |purpose = Shows an article (or its revisions) only if its number of revisions are less than the value specified. 
}}


'''Syntax:'''<br>

<code>maxrevisions=''number''</code> where {{tt|number}} must be greater than or equal to 1.


===minrevisions===
{{DPL parameter
 |name    = minrevisions
 |purpose = Shows an article (or its revisions) only if its number of revisions are greater than the value specified.  
}}


'''Syntax:'''<br>

<code>minrevisions=''number''</code> where {{tt|number}} must be greater or equal than 1. 


In practice, only values of 2 or greater make sense. Using a value of {{tt|2}}, freshly created pages could be excluded from a result set.


==Select articles based on OTHER criteria==

===articlecategory===

{{DPL parameter
 |name    = articlecategory
 |purpose = Selects a talk page based on the corresponding base article (in the default namespace) category.
}}


'''Syntax:'''<br>

<code>articlecategory= ''categoryname''</code>

To select articles in <code>namespace=''Talk''</code> this statement could be used to define (in addition) a category for an article with an identical name in namespace 0 (default namespace).


===includesubpages===
{{DPL parameter
 |name    = includesubpages
 |purpose = Controls the inclusion or exclusion of pages which have a '/' in their name. The default is <code>true</code>.
}}


'''Syntax:'''<br>

<code>includesubpages=''false''</code>


As subpages are by default always included, only {{tt|no}} or {{tt|false}} makes sense as an argument for <code>includesubpages</code>.


===redirects===
{{DPL parameter
 |name    = redirects
 |purpose = Controls the inclusion or exclusion of redirect pages in the output. By default, redirections are '''not''' shown.
}}


'''Syntax:'''<br>

<code>redirects=''criteria''</code> where ''criteria'' can be one of:
* <code>''include''</code> – Redirect pages are '''allowed''' in lists.
* <code>''only''</code> – Lists '''only''' redirect pages in lists.
* <code>''exclude''</code> – Redirect pages are '''excluded''' from lists – ('''default''', need not be specified).


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: redirects (example 1)|Example}}
{{ViewTest|Examples|Parameter: redirects (example 1)}}


'''Note:''' this parameter does ''not'' show pages that ''link'' to the redirect (as [[Special:Whatlinkshere/United States]] does); only redirect pages themselves.


===minoredits===
{{DPL parameter
 |name    = minoredits
 |purpose = Controls the inclusion or exclusion of minor edits in output. '''Requires''' <code>{{DPL|ordermethod}}{{=}}''[...]firstedit¦lastedit''</code>.
}}


'''Example:'''<br>

<code>minoredits=''criteria''</code> where ''criteria'' can be one of:
* <code>''exclude''</code> – Minor edits are '''excluded''' from lists. 
* <code>''include''</code> – Minor edits are '''included''' in lists – ('''default''', need not be specified)


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: minoredits (example 1)|Example}}
{{ViewTest|Examples|Parameter: minoredits (example 1)}}


===stablepages===
{{DPL parameter
 |name    = stablepages
 |purpose = Controls the inclusion or exclusion of pages which are flagged as 'stable'.
}}


'''Syntax:'''<br>

<code>stablepages=''criteria''</code> where {{tt|criteria}} can be one of:
* <code>''exclude''</code> – Stable pages are '''excluded''' from lists.
* <code>''only''</code> – '''Only''' stable pages appear in lists.
* <code>''include''</code> – Stable pages '''appear''' in lists  – ('''Default''', need not be specified). 


'''Note:''' This parameter is only useful if the wiki uses [[mw:FlaggedRevs|FlaggedRevs]]; it controls whether the pages flagged as 'stable' are part of the DPL result or not. 


===qualitypages===
{{DPL parameter
 |name    = qualitypages
 |purpose = Controls the inclusion or exclusion of pages which are flagged as 'quality pages'.
}}


'''Syntax:'''<br>

<code>qualitypages=''criteria''</code> where {{tt|criteria}} can be one of: 
* <code>''exclude''</code> – Quality pages are '''excluded''' from lists
* <code>''only''</code> – '''Only''' quality pages appear in lists.
* <code>''include''</code> – Quality pages are '''included''' in lists – ('''default''', need not be specified)


'''Purpose:''' This parameter is only useful if the wiki uses [[mw:FlaggedRevs|FlaggedRevs]]. It controls whether pages flagges as 'quality pages' are part of the DPL result or not.


===skipthispage===
{{DPL parameter
 |name    = skipthispage
 |purpose = Includes the page containing the DPL query in the result set (self reference, which is excluded by default).
}}


'''Syntax:'''<br>

<code>skipthispage=''no''</code> – ('''default''' is ''yes'', need not be specified and may cause problems if specified).


'''Notes:'''
* The source page of the query is not included in the result set by default, even if it meets the query's criteria. 
* Setting this parameter to ''no'' may lead to runtime errors which are hard to track down. This value should only be used if the query is straightforward in structure, and the current page is required in the result set (if it matches the selection criteria). 


==Restrict the output (selection) volume==

===count===
{{DPL parameter
 |name    = count
 |purpose = Controls the number of results shown.
}}


'''Syntax:'''<br>

<code>count=''n''</code>, where {{tt|n}} is a positive integer.


'''Notes:'''

* DPL3 '''limits the result count to 500 by default''' for performance reasons, this can be changed depending on extension configuration variables:
** <code>$wgDplSettings['maxResultCount']</code> – Query result number maximum limit.
** <code>$wgDplSettings['allowUnlimitedResults']</code>  – Allow unlimited query results, which may result in slow or failed page loads.
*** A blank value (<code>count=</code>) sets results to unlimited, which may also result in slow or failed page loads.
* See [[mw:Extension:DynamicPageList3|DynamicPageList3]] more information on all configuration variables.
* Count can also be set or overridden from outside a DPL3 query, by using the URL parameter <code>{{DPL|DPL_count}}</code>.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: count (example 1)|Example}}
{{ViewTest|Examples|Parameter: count (example 1)}}


===scroll===
{{DPL parameter
 |name    = scroll
 |purpose = Enables built-in support for scrolling through large result sets, allowing them to be split into smaller result sets.
}}


'''Syntax:'''<br>

<code>scroll=''yes''</code> – ('''default''' is ''no'' which need not be specified, it only makes sense to set ''yes'' when required).

DPL3 can take certain URL parameters from the command line, like <code>&DPL_fromTitle</code> and <code>&DPL_toTitle</code>.  Within the <code>{{DPL|resultsheader}}</code> and/or <code>{{DPL|resultsfooter}}</code> a template can be called that generates links to fetch the next / previous page.

Enabling scrolling does the following:
* DPL3 enables the acceptance of special scroll URL parameters, such as <code>&DPL_fromTitle</code> and <code>&DPL_toTitle</code>.
** If these arguments are given, the commands <code>title&gt;</code> and <code>title&lt;</code> are implicitly be set.
** To make scrolling possible, DPL3 relies on such variables, which give the name of the first and last result items actually shown.
* <code>scroll=''yes''</code> is used to fill the special URL parameters with proper values, and to set the title limits according to URL parameters derived from them.
** See [[General usage and invocation syntax#Scroll variable syntax|scroll parameter/URL syntax]] for use.
** See [[General usage and invocation syntax#Scroll/URL parameters|scroll/URL parameters]] for a full list of special parameters.
* URLs can then be used to create scroll navigation between results in the result set, or a template can be used within the {{DPL|resultsheader}} and/or {{DPL|resultsfooter}} that generates links to fetch the next / previous page(s), though if such is used it is likely that <code>{{DPL|allowcachedresults}}=''false''</code> needs to be set.
** Doing such sets auxiliary selection criteria <code>{{DPL|titlelt}}=</code> and <code>{{DPL|titlegt}}=</code>.


This mechanism can be used to create a generic page scroll feature – provided the value of DPL_offset can also be accessed in other templates outside of DPL3. This is where the other parameter <code>{{DPL|execandexit}}</code> comes in, it stores the URL parameters in a variable which can be accessed via {{DPL|#dplvar}}.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: scroll (example 1)|Example}}
{{ViewTest|Examples|Parameter: scroll (example 1)}}


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: scroll (example 2)|Example}}
{{ViewTest|Examples|Parameter: scroll (example 2)}}


===offset===
{{DPL parameter
 |name    = offset
 |purpose = Shows only a portion of a big result list; typically used in combination with {{DPL|count}}.
}}


'''Syntax:'''<br>

<code>offset=''n''</code> where {{tt|n}} is the number of result lines to skip, (integer) – ('''default''' = 0)


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: offset (example 1)|Example}}
{{ViewTest|Examples|Parameter: offset (example 1)}}


'''Notes:'''
* A DPL query could be put into a template with <code>{{DPL|count}}</code> and <code>{{DPL|offset}}</code> parameters. Calling this template with different values would allow different portions of the result list to be displayed. 
* If  <code>{{DPL|mode}}=''ordered''</code> is used, the numbers are adjusted to reflect the absolute position of the entries, i.e., in the above example, numbers starting from 11 are observed.
* If 'offset' is missing, it can be set from outside via the URL parameter <code>DPL_offset</code>.


===randomcount===
{{DPL parameter
 |name    = randomcount
 |purpose = Selects a subset from the result set for display, based on a random count.
}}


'''Syntax:'''<br>

<code>randomcount=''n''</code> where {{tt|n}} is a positive integer.


If randomcount is larger than the number of results, the complete result set is displayed.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: randomcount (example 1)|Example}}
{{ViewTest|Examples|Parameter: randomcount (example 1)}}


===randomseed===
{{DPL parameter
 |name    = randomseed
 |purpose = Sets an initial value for the random generator.
}}


'''Syntax:'''<br>

<code>randomseed=''n''</code> where {{tt|n}} is a positive integer.


'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: randomseed (example 1)|Example}}
{{ViewTest|Examples|Parameter: randomseed (example 1)}}


===distinct===
{{DPL parameter
 |name    = distinct
 |purpose = Allows / suppresses duplicates in the output.
}}


'''Syntax:'''<br>

<code>distinct=''critria''</code> where {{tt|criteria}} can be one of:
* <code>''false''</code> – A page can occur '''more than once''' in the output.
* <code>''strict''</code> – A page can occur '''only once''' in the output if more than one page is specified for <code>linksto</code> or <code>linksfrom</code>, and the same page is referenced by more than one.
* <code>''true''</code> – A page can occur '''only once''' in the output – ('''default''', need not be specified)


Works in connection with <code>{{DPL|linksto}}</code> and <code>{{DPL|linksfrom}}</code>:
* A page can occur more than once in the output.
** This happens if more than one page is specified in <code>linksfrom=</code> or <code>linksto=</code> parameters, and the same page contains links to more than one of them ({{tt|linksto}}), or if the same page is referenced by more than one of them ({{tt|linksfrom}}).
** To see a page only once also in these cases, use <code>distinct=''strict''</code>.
** To see multiple result entries, set the value to <code>''false''</code>. This may make sense in combination with <code>linksto=</code> or <code>linksfrom=</code> to see how many links from one document to another document exist.

'''Example:'''<br><br><!-- transclude example from subpage-->{{#lsth:Examples/Parameter: distinct (example 1)|Example}}
{{ViewTest|Examples|Parameter: distinct (example 1)}}

===ignorecase===
{{DPL parameter
 |name    = ignorecase
 |purpose = Makes comparisons insensitive to case.
}}


'''Syntax:'''<br>

<code>ignorecase=''true''</code>:
* <code>''true''</code> – Comparisons are case-insensitive (only {{tt|true}} makes sense as an argument)
* <code>''false''</code> – Comparisons are case-sensitive – ('''default''', need not be specified)


The parameter has an effect on <code>{{DPL|linksto}}</code>, <code>{{DPL|uses}}</code>, <code>{{DPL|titlematch}}</code>, <code>{{DPL|titleregexp}}</code> and their not-equivalents.


'''Note:''' For case-insensitivity in ordering result sets, see <code>[[Controlling output order#ordercollation|ordercollation]]</code>.

[[Category:Primary Module|01]]