Extensión:DynamicPageList3

From mediawiki.org
This page is a translated version of the page Extension:DynamicPageList3 and the translation is 27% complete.
Manual de extensiones de MediaWiki
DynamicPageList3
Estado de lanzamiento: estable
Implementación Etiqueta , Función del analizador
Descripción Crea listas de otros artículos en función de su categoría, espacio de nombres, título, referencias o uso de plantillas e incluye contenidos o argumentos de llamadas a plantillas de esos artículos en tu página.
Autor(es) Universal Omega, Alexia E. Smith, Algorithmix, Dangerville, IlyaHaykinson, Theaitetos, Unendlich~dewiki
Última versión 3.5.2 (2023-01-14)
MediaWiki 1.39.0+
Cambios de la base de datos
Composer universal-omega/dynamic-page-list3
Licencia GNU Licencia Pública general 3.0 o posterior
Descarga
Ejemplo DPL:Manual - Gamepedia Help Wiki
  • $wgDplSettings
  • dpl_param_update_rules
  • dpl_param_delete_rules
Traduce el DynamicPageList3 extensión
This is a continuation and fork of Extension:DynamicPageList (third-party) . Se trata de una base de código orientada a objetos totalmente reelaborada, con importantes mejoras en la velocidad del código y la base de datos, y totalmente compatible con las versiones anteriores.

La extensión DynamicPageList3 es una herramienta de informes para MediaWiki, que enumera los miembros de las categorías y las intersecciones con varios formatos y detalles. Para la documentación completa, consulte el manual.

Cuando se invoca con un conjunto básico de parámetros de selección, DPL muestra una lista de páginas en una o más categorías. Las selecciones también pueden basarse en factores como el autor, el espacio de nombres, la fecha, el patrón de nombres, el uso de plantillas o las referencias a otros artículos. La producción adopta diversas formas, algunas de las cuales incorporan elementos de artículos seleccionados.

Esta extensión se invoca con la función parser {{#dpl: .... }} o la etiqueta parser ‎<DPL>. Una implementación compatible con Wikimedia de ciertas características puede ser invocada con ‎<DynamicPageList>.

Las búsquedas complejas pueden dar lugar a consultas en la base de datos que resulten costosas desde el punto de vista informático. Sin embargo, por defecto todos los resultados se almacenan en la caché durante un período de una hora para reducir la necesidad de volver a ejecutar la consulta cada vez que se carga la página. La página del manual DPL:Parámetros: Otros parámetros contiene información sobre los parámetros que pueden utilizarse para desactivar la caché y permitir las actualizaciones instantáneas.

Manual y documentación completa
Documentación en la Wiki de Ayuda de Gamepedia
Código fuente
Source code at GitHub
Bugs y peticiones de características en GitHub
[1]
Licenciamiento
DynamicPageList3 se publica bajo GNU General Public License, version 2.

Instalación

Configuración

These are DPL3's configuration settings along with their default values.

To change them make sure they are defined before including the extension on the wiki.

In release 3.0.4, the configuration variable name was changed from $dplSettings to $wgDplSettings. This was to facilitate compatibility with MediaWiki 1.25's extension registration change.
Opción Predeterminado Descripción
$wgDplSettings['allowedNamespaces'] null By default all existing namespaces are used when DPL3 initializes. Customize this setting with an array of namespace constants to restrict DPL3 to work only in those namespaces.
$wgDplSettings['allowUnlimitedCategories'] false Set this to true to ignore 'maxCategoryCount' and allow unlimited categories. Please note that large amounts of categories in a query can slow down or crash servers.
$wgDplSettings['allowUnlimitedResults'] false Set this to true to ignore 'maxResultCount' and allow unlimited results. Please note that large result sets may result in slow or failed page loads.
$wgDplSettings['alwaysCacheResults'] false Set this to true to ignore 'allowcachedresults' and always enable the parser cache.
$wgDplSettings['categoryStyleListCutoff'] 6 Maximum number of items in a category list before being cut off.
$wgDplSettings['functionalRichness'] 3 Set the level of parameters available to end users.
$wgDplSettings['maxCategoryCount'] 4 Maximum number of categories to allow in queries.
$wgDplSettings['minCategoryCount'] 0 Minimum number of categories to allow in queries.
$wgDplSettings['maxResultCount'] 500 Maximum number of results to return from a query.
$wgDplSettings['recursiveTagParse'] false Do recursive tag parsing on ‎<dpl> parser tags converting tags and functions such as magic words like {{PAGENAME}}. This is similar to the {{#dpl}} parser function call, but may not work exactly the same in all cases.
$wgDplSettings['runFromProtectedPagesOnly'] false Set this to true to allow DPL3 to run from protected pages only. This is recommend if wiki administrators are having issues with malicious users creating computationally intensive queries.
$wgDplSettings['handleSectionTag'] false Set this to true to have DPL3 handle ‎<section> tags outside of DPL parser tags.
$wgDplSettings['maxQueryTime'] 10000 Maximum allowed time for database queries in milliseconds.
$wgDplSettings['queryCacheTime'] 0 Configure query cache time. The query cache cannot be purged. Suggested value between 30 to 600.

The global variable $wgNonincludableNamespaces is automatically respected by DPL3.

It will prevent the contents of the listed namespaces from appearing in DPL3's output.

$wgDplSettings['maxResultCount'] is a LIMIT on the SQL query itself. Some DPL query parameters like includematch are applied after the SQL query, however, so results here may easily be misleading.

Richness funcional

DynamicPageList3 has many features which are unlocked based on the maximum functional richness level.

There are some that can cause high CPU or database load and should be used sparingly.

  • $wgDplSettings['functionalRichness'] = 0 - equivalent to Wikimedia's DynamicPageList (Intersection)
  • $wgDplSettings['functionalRichness'] = 1 - adds additional formatting parameters
  • $wgDplSettings['functionalRichness'] = 2 - adds performance equivalent features for templates and pagelinks
  • $wgDplSettings['functionalRichness'] = 3 - allows more-expensive page inclusion features and regular expression queries
  • $wgDplSettings['functionalRichness'] = 4 - permits exotic and potentially dangerous batch update and delete operations; not recommended for public websites. Includes debugging parameters for testing and development.

Uso

Funcionalidad DPL ampliada

Extended DPL is invoked by using the parser function {{#dpl: .... }}, or the parser extension tag ‎<DPL>...‎</DPL>.

See Manual - General Usage and Invocation Syntax and DPL:Parameters: Criteria for Page Selection

Compatibilidad con versiones anteriores

Functionality compatible with Wikimedia's DPL extension can be invoked with ‎<DynamicPageList>...‎</DynamicPageList>.

Further information can be found on the Compatibility manual page.


Filosofía de uso y visión general

With the assumption there are some articles written about countries those articles will typically have three things in common:

  • They will belong to a common category
  • They will have a similar chapter structure, i.e. they will contain paragraphs named 'Religion' or 'History'
  • They will use a template which is used to present highly structured short data items ('Capital', 'Inhabitants', ..) in a nice way (e.g. as a wikitable)

Generate a report based on countries

If there was a need to assemble a report of what countries practice a certain religion this could be easily done with the category and linksto parameters.

{{#dpl:
category=countries
|linksto=Pastafarianism
}}

With DPL one could:

  • Generate a list of all those articles (or a random sample)
  • Show metadata of the articles (popularity, date of last update, ..)
  • Show one or more chapters of the articles ('transclude' content)
  • Show parameter values which are passed to the common template
  • Order articles appropriately
  • Present the result in a sortable table (e.g.)
  • Generate multiple column output

¿Qué pasos son necesarios?

Find the articles you want to list:

  • Select by a logical combination (AND,OR,NOT) of categories
  • Specify a range for the number of categories the article must be assigned to
  • Select by a logical combination (AND,OR,NOT) of namespaces
  • Define a pattern which must match the article's name
  • Name a page to which the article must or must not link
  • Name a template which the article must or must not use
  • Name a text pattern which must occur within external links from a page
  • Exclude or include redirections
  • Restrict your search to stable pages or quality pages ("flagged revisions")
  • Use other criteria for selection like author, date of last change etc.
  • Define regular expressions to match the contents of pages you want to include

Order the result list of articles according to

  • Article name
  • Article size
  • Date of last change
  • Last user to make an edit

Define attributes you want to see

  • Article name
  • Article namespace
  • Article size
  • Date of last change
  • Date of last access
  • Last user to make an edit

Define contents you want to show

  • Whole article
  • Contents of certain sections (identified by headings)
  • Text portions (defined by special marker tags in the article)
  • Values of template calls
  • Use a custom template to show output

Define the output format

  • Specify header and footer for the default output
  • Use ordered list, unordered list
  • Use tables
  • Format table fields individually by applying templates to their content
  • Use category style listing
  • Truncate title or contents to a certain maximum length
  • Add a link to the article or to one or more of its sections

Consideraciones

Rendimiento

DPL3's code execution and database access is typically fast for typical category and article look ups.

However, using loose LIKE and REGEXP match parameters and/or requesting large data sets can result in long database access times.

Parser time should also be kept in consideration.

For example, having the query of image results go into a template that displays them will result in a parser media transform for each one.

This can quickly eat up 2MBs of RAM per media transform.

Version 3.4.0 introduces two new configuration options, $wgDplSettings['maxQueryTime'], which allows configuration the max execution length for queries, in milliseconds, and $wgDplSettings['queryCacheTime'], which allows configuration of query cache. It also adds support for PoolCounter to limit query concurrency.

Véase también

Lectura adicional

DPL3 can do much more than we can explain here.

A complete manual is available with full parameter documentation.