Help:Parameter Quick Reference

Manual

Parameter Quick Reference

The following is a quick-reference for all parameters for basic comparison, and selection without having to pour though all manual pages. The below table gives only a brief explanation of each parameter's use, for full usage information click a parameter name that links to its corresponding documentation page and section.

Criteria for page selection	name purpose category Selects articles based on categories. More than one category can be specified with pipe | (tag syntax) or broken pipe ¦ (parser function syntax) as a separator; the effect being that pages listed have to be at least in one of the categories (logical OR). If the category parameter is specified more than once, the pages listed have to match all these parameters (logical AND). categorymatch Selects articles based on categories. One or more patterns can be specified (SQL LIKE); a page is selected if at least one of its categories matches at least one of the patterns. categoryregexp Selects pages with a category matching a regular expression. notcategory Much like the category parameter, but requires that every page listed not be in a particular category. Unlike in the category parameter, categories cannot be combined using logical OR, only one criterion can be specified per line. notcategorymatch Works like notcategory but based on SQL LIKE. notcategoryregexp Works like notcategory but based on SQL REGEXP. categoriesminmax Restricts article selection to those assigned to at least [min] categories, and/or at most to [max] categories. namespace Restricts article selection to the given namespace(s). notnamespace Much like the notcategory parameter, but for namespaces. Restricts article selection to those not in the given namespace(s). linksfrom Selects articles that are referenced/linked from at least one of the specified pages. openreferences Extends linksfrom to unresolved references (non-existing articles or image links). Implicitly sets ordermethod=none if set to yes or missing.   Most DPL3 parameters depend on the existence of a page. If openreferences 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. notlinksfrom Selects articles that are NOT referenced/linked from any of the specified pages. linksto Selects articles that link to at least one of the specified pages. notlinksto Selects articles that do NOT link to any of the specified pages. linkstoexternal Selects articles that contain an external link that matches a given text pattern. imageused Selects articles that use a certain image. imagecontainer Select images that are contained in one or more articles. uses Selects articles that use (transclude) at least one of the specified templates (wiki syntax: {{...}}). notuses Selects articles that do not use any of the specified templates.   Caution: The implementation of this feature is not very efficient. Use with care and avoid huge result sets. usedby Selects articles (templates) that are used (transcluded) by a specified page. createdby Selects articles that were created by the specified user.   This is an expensive and slow function. notcreatedby Selects articles that were not created by the specified user.   This is an expensive and slow function. modifiedby Selects articles that were created or at least once modified by the specified user. notmodifiedby Selects articles that were not (created or) modified by the specified user. lastmodifiedby Selects articles where the last modification was done by the specified user. notlastmodifiedby Selects articles where the last modification was not done by the specified user. title Select one single page by its (namespace and) title, sets mode=userformat giving no output by default, and requires an include statement.   This parameter's behavior is different from most other selection criteria, it is primarily useful for including/transcluding contents from one specific page. titlelt Restrict the selection to articles with a title less or equal to a given value. titlegt Restrict the selection to articles with a title greater or equal to a given value. titlematch Select articles with a title matching at least one of the specified patterns. The patterns are used as a LIKE argument in an SQL query. Namespaces are ignored, as the namespace parameter can be used to further narrow the selection. titleregexp 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 namespace= parameter can be used to further narrow the selection. nottitlematch Select articles with a title not matching any of the specified patterns. The patterns are used as a LIKE argument in a SQL query. Namespaces are ignored, as the namespace= 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. nottitleregexp Select articles with a title that does not match the specified regular expression. Normally, you would want to use this selection only in combination with other criteria. Otherwise, output could become huge. includematch Controls the selection of articles based on the content that is included from them. includematchparsed Controls the selection of articles based on (pre-parsed) contents that is included from them. includenotmatch Controls the selection of articles based on contents that is included from them. includenotmatchparsed Controls the selection of articles based on (pre-parsed) contents that are included from them. lastrevisionbefore Selects articles that existed before the specified date, and displays the last revision before that date (this latter date can be accessed using the REVISION variable in mode=userformat). firstrevisionsince Selects articles that had a revision created after the specified date, and displays that revision date (this latter date can be accessed using the REVISION variable in mode=userformat). allrevisionsbefore Shows all revisions that existed before the specified date. The date of each revision is shown (and is available as REVISION in mode=userformat). allrevisionssince Shows all revisions that were created after the specified date. The date of each revision is shown (and is available as REVISION in mode=userformat). If there was no new revision of an existing article after the specified date, that article does not appear in the output. maxrevisions Shows an article (or its revisions) only if its number of revisions are less than the value specified. minrevisions Shows an article (or its revisions) only if its number of revisions are greater than the value specified. articlecategory Selects a talk page based on the corresponding base article (in the default namespace) category. includesubpages Controls the inclusion or exclusion of pages which have a '/' in their name. The default is true. redirects Controls the inclusion or exclusion of redirect pages in the output. By default, redirections are not shown. minoredits Controls the inclusion or exclusion of minor edits in output. Requires ordermethod=[...]firstedit¦lastedit. stablepages Controls the inclusion or exclusion of pages which are flagged as 'stable'. qualitypages Controls the inclusion or exclusion of pages which are flagged as 'quality pages'. skipthispage Includes the page containing the DPL query in the result set (self reference, which is excluded by default). count Controls the number of results shown. scroll Enables built-in support for scrolling through large result sets, allowing them to be split into smaller result sets. offset Shows only a portion of a big result list; typically used in combination with count. randomcount Selects a subset from the result set for display, based on a random count. randomseed Sets an initial value for the random generator. distinct Allows / suppresses duplicates in the output. ignorecase Makes comparisons insensitive to case.
Controlling output format	name purpose mode Provide basic control over the output of DPL3. inlinetext To define the inline text used in mode=inline. format Customize the output format completely. Implicitly sets "mode=userformat". Uses variable references like Help:Controlling output format to describe the output format. See also the secseparators parameter. Note: format is incompatible with tablerow. listseparators An alias for format, see the format parameter. Implicitly sets mode=userformat. secseparators Customize the output format of included sections. Can be used with standard output modes and with mode=userformat. multisecseparators Put a tag between multiple transcluded parts which refer to (use) the same template or article section/chapter. dominantsection Define a section with multiple occurrences as dominant, i.e., each piece of the contents of this section (which is associated with a template call or an article section/chapter within the original document) creates a separate output line. table A simple syntax to create standard tabular output; see also tablerow. Requires an include statement, and is a shortcut that implicitly sets values for other DPL3 parameters, namely mode, listseparators / format, secseparators, and multisecseparators. tablerow A simple syntax to precisely position tabular data within formatting syntax; requires a table statement. Note: tablerow is incompatible with format tablesortcol Define a column to be used as a sort key (see also table) headingmode To control the output of the headings in a DPL3 with complex/multi-parameter ordermethod (has no effect with single-parameter ordermethods). For ordermethod=method1,method2,..., method1 is used for headings. E.g., In ordermethod=category,title a 2-parameter ordermethod, headingmode affects category headings. See also headingcount. hlistattr Add attributes to the HTML heading/top level elements, which enclose all other elements in the result, depending on headingmode (HTML element would be ol for ordered, ul for unordered, dl for definition; or div for others) Not yet applicable to headingmode=none. hitemattr Add attributes all list item headings in the result, depending on headingmode (HTML element would be li for ordered/unordered, div for others). To be used with headingmode=unordered or ordered. (Not yet applicable for others.) listattr Add attributes to HTML list type declaration elements, depending on mode (HTML element is ol for ordered, ul for unordered, div for others). Can be used with pseudo mode=inline where inline text contains one or more <br/>. Only applicable to mode=ordered or mode=unordered. Not applicable to mode=category or mode=inline (with no <br/> in inline text). itemattr Add attributes to HTML list items, depending on mode (element is li for ordered/unordered, span for others). Not applicable to mode=category. headingcount Decides, combined with headingmode, whether to show a text line with the number of articles per group or not. userdateformat Define a special layout for date formatting. shownamespace Restrict the appearance of the namespace name of a page before the page. As the switch is true by default, it should be set to false to avoid namespaces being shown in the output. escapelinks Determines if links are escaped as a link, or used directly as-is. When used to display File: namespace image names, or Category: namespace page names, this causes: A link to the image or to the category page to be produced (escapelinks=true – default, need not be set). The image or category to be directly inserted (the former displays the image on-page, the latter categorizes the page it appears on, into the categories of the result set; escapelinks=false). titlemaxlength To limit the number of characters of the title to display. If the page title (this does not include the namespace or any other prefix before the title) is bigger than the titlemaxlength value, the title is truncated and ended by '...'. replaceintitle execute a string replacement operation on the %TITLE% variable. columns Defines a column layout for the output. Currently non-working, though a workaround has been provided. rows Define a row layout for the output. A "row" is a group of output lines for which the heading is repeated. If how big your result will be is unknown, it may be better to use the rowsize parameter. Currently non-working rowsize Define a row layout for the output. A "row" is a group of n output lines for which the heading are repeated. Currently non-working rowcolformat Defines layout properties (using allowed HTML table tag parameters) for the row/column grid. Currently non-working
Controlling output order	name purpose ordermethod Sets the criteria used to order the list by; often combined with order=descending for descending sort (otherwise ascending is default); or, alternatively, may be combined with headingmode. order Controls the sort direction of the list; a value of descending requires ordermethod to be set, so that DPL3 knows which criterion (or criteria) to sort by. ordercollation Defines the collating sequence for ordering. Allows individual collations, makes case-insensitive sorting possible.
Controlling output volume	name purpose resultsheader Output a headline, before DPL3 results, if there is at least one article to display. resultsfooter Output a 'footline', after DPL3 results, if there is at least one article to display. oneresultheader Output a headline, before DPL3 results, if there is exactly one article to display. oneresultfooter Output a 'footline', after DPL3 results, if there is exactly one article to display. noresultsheader Output a headline if there is no article to display (empty result). suppresserrors Suppress the warning message if no matching article was found. noresultsfooter Output a footline if there is no article to display (empty result). addcategories Shows all categories to which an article belongs as a small text line after the article name. addpagecounter Shows number of times the page has been viewed.   This function is depreciated. addpagesize Shows the size of the page. addcontribution Shows how much a user contributed to an article. adduser Requires ordermethod=[...,]firstedit or ordermethod=[...,]lastedit (where the [...,] signifies a complex ordermethod with extra parameters). If firstedit (or lastedit), adduser=true displays the user who made the first (or last) revision of the page. In this way, the parameter is equivalent to the addauthor (addlasteditor) parameter (see below). addauthor Show the user who created the article, cannot be used with addlasteditor addlasteditor Show the user who edited the most recent revision of a page, cannot be used with addauthor addpagetoucheddate Shows date/time of last change to the page according to the definition of the 'page_touched' field on Page_table. Requires ordermethod=[...,]pagetouched or ordermethod=[...,]title. ([...,] means complex ordermethods with an extra parameter before are allowed.) addeditdate If firstedit (resp. lastedit), addeditdate=true shows the date of the first revision/creation (resp. last revision) of the page. Requires ordermethod=[...,]firstedit or ordermethod=[...,]lastedit. ([...,] means complex ordermethods with an extra parameter before firstedit addexternallink Add the URL of an external link to the output list. addfirstcategorydate Shows the date/time the article was added to one of the listed include categories. If there is more than one category listed and an article belongs to more than one of them, the result is ambiguous. From a logical standpoint, it is recommended to include one category only with the 'category' parameter, or to make sure that each of the articles in the result set belongs to only one of the categories listed. Conflicts with other "add*date" (addeditdate, etc.) parameters. showcurid Page links will contain the current page ID, cannot be used together with openreferences=true. include Include pages (whole content) or include certain sections of articles or template parameters. This functionality is based on the ideas and work of Steve Sanbeg and his extension Labeled Section Transclusion. DPL3 comes with a modified version of Sanbeg's source, so there is no need for additional installation. includepage This can be used as a longer name for include. includemaxlength Delimit the size of an included article to a maximum of n number of characters. Only used with includepage=*. includetrim Removes all leading and trailing whitespace from transcluded contents.
Other parameters	name purpose debug Sets debugging level. allowcachedresults Cache query results to improve performance, keep servers from crashing under high load. cacheperiod Defines the expiration period for the DPL3 cache. goal Set the goal for DPL3 to either show pages (default) or categories these pages belong to. eliminate Suppress references to pages, templates, images, categories in DPL3 output reset Suppress references to pages, templates, images, categories in DPL3 output fixcategory Assign the article containing a DPL3 statement to a category, although reset was used. execandexit Process the command given as an argument and then exit immediately. updaterules Define a set of rules which are executed to perform an update on selected articles (bulk update or template value editing)   Important: The updaterules feature is intended for wiki expert users only. It is recommended that articles using this statement are 'protected'. deleterules Allow the mass deletion of wiki pages