Other parameters: Difference between revisions

{{DPL Parameter

|name = updaterules

The <code>updaterules</code> feature is intended for wiki expert users only. It is recommended that articles usind this statement are 'protected':

 

Defines a regular expression which matches text portions that shall be replaced. It is in the responsibility of the user to provide enclosing characters for the regexp; modifiers line 'U' or 'm' can be used.

 

Defines the replacement for the above pattern; back references like \1 can be used.

 

Defines locations where text will be inserted. The location(s) will be immediately before the match(es) of the pattern. If a pattern matches multiple times, multiple inserts will be performed.

 

The regexp will implicitly be enclosed in slashes. Hence literal slash characters must be escaped by backslashes.

 

Defines locations where text will be inserted. The location(s) will be immediately after the match(es) of the pattern. If a pattern matches multiple times, multiple inserts will be performed.

 

The regexp will implicitly be enclosed in slashes. Hence literal slash characters must be escaped by backslashes.

 

Defines the text to be inserted.

 

Only one 'replace'-'by' sequence, one insertion 'before' and one insertion 'after' can be specified. 'replace' is always executed first, followed by 'insert before' and 'insert after', regardless of the sequence in which the rules appear in the DPL source ´text.

 

The name of the template; the prefix "Template:" must be given.

 

be inserted. The location(s) will be immediately before the match(es) of the pattern. If a pattern matches multiple times, multiple inserts will be performed.

 

The regexp will implicitly be enclosed in slashes. Hence literal slash characters must be escaped by backslashes.

 

a regular expression

replace ''pattern'';

by ''replacement'';

 

For safety reasons the update statements will only be performed if "exec yes" is specified. So, leaving this away, you can check what would happen if the update were to be executed.

 

The size of the form fields will dapt to the size of the displayed content.

 

To make the use of the <code>updaterules</code> feature easier we provide a [[Template:Bulk Update|special user interface]].

''text'' is plain text; ''replacement'' is text which may contain references (like \1) to the matching ''pattern'' (provided that this pattern contains match groups).

 

{{DPL Parameter

|name = deleterules

This will delete the selected pages; If "exec true" is missing, nothing will happen.

 

{{DPL Parameter

|name = goal

Due to some limitations in MySQL it is currently not possible to restrict the intermediate result set of pages to a certain maximum (using the LIMIT clause). In addition the generated SQL code is not in all cases optimal (as its structure provides for complex selection criteria and therefore is unnecessarily complex in simple cases). So be careful and apply precise selection criteria.

 

{{DPL Parameter

|name = allowcachedresults

All queries are cached by default to reduce server load as generally articles do not change often enough to require updating every page load. If immediate updates are required every page load then set this parameter to false. The cache period is handled by the [[#cacheperiod]] parameter.

 

{{DPL Parameter

|name = reset

 

If you want to avoid the above described effect of <code>reset</code> on your 'own' links you can use <code>[[eliminate]]</code>. But you should know that ''eliminate'' is rather expensive in terms of computer power as it does a second parse for all included contents.

 

<u>In parser fuction mode ('''<nowiki>{{#DPL:....}}</nowiki>'''):</u>

If you have '''more than one DPL query''' in a document the effects will depend on the exact mode (parser extension or parser function mode), on the sequence of the statements and on the presence of 'reset' or 'eliminate' statements in each of the queries and on their individual arguments. As this is a very rare case we only give a simple rule of thumb here: Once you have used 'reset' in parser function mode or 'reset=links' in parser extension mode the effect of these statements will dominate the rest.

 

{{DPL Parameter

|name = fixcategory

The <code>fixcategory</code> allows you to make a category assignment which is not blocked by the [[reset]] command.

 

{{DPL Parameter

|name = eliminate

Please note that the use of <code>eliminate</code> needs a considerable amount of extra computing power as it performs a second parser step for each included document.

 

{{DPL Parameter

|name = debug

'debug=1' will suppress warning messages (e.g. if the result set of a DPL query is empty). As an alternative, you can use the <code>[[suppresserrors]]</code> statement.

 

{{DPL Parameter

|name = execandexit

Note <code>execandexit</code> acts like a short-circuit evaluation. This means, for example, that successive statements to influence caching behaviour (like [[allowcachedresults]]) will not be interpreted.

 

{{DPL Parameter

|name = cacheperiod