Extension:PageViewInfo
État de la version : stable |
|
|---|---|
| Implémentation | MyWiki |
| Description | Provides an API of Wikimedia page view data |
| Auteur(s) | Kunal Mehta (Legoktmdiscussion) |
| Politique de compatibilité | Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière. |
| MediaWiki | 1.29+ |
| PHP | 5.5+ |
| Modifie la base de données |
Non |
| Licence | Licence publique générale GNU v3.0 ou supérieur |
| Téléchargement | |
|
|
| Traduire l’extension PageViewInfo sur translatewiki.net si elle y est disponible | |
| Rôle Vagrant | pageviewinfo |
| Problèmes | Tâches ouvertes · Signaler un bogue |
L'extension PageViewInfo fournit des modules API pour accéder aux données relatives aux pages vues et ajoute des graphiques d'apparence sophistiquée à l'interface "Informations sur la page".
Elle ne collecte pas les données, ni ne les stocke ; elle s'appuie sur la classe PageViewService qui doit être implémentée dans chaque backend de collecte des données.
Installation
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
PageViewInfodans votre dossierextensions/.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageViewInfo
- Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
wfLoadExtension( 'PageViewInfo' );
Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Installer Vagrant :
- Si vous utilisez Vagrant, installez avec
vagrant roles enable pageviewinfo --provision
Développement local
For local development, you can point the extension at Wikimedia production using the following additions to LocalSettings.php:
$wgPageViewInfoWikimediaDomain = "en.wikipedia.org";
When enabled, visiting MediaWiki?action=info on your local development server will show page views for the MediaWiki article on English Wikipedia rather than on your local site.
API
prop=pageviews (pvip)
- This module requires read rights.
- Source: PageViewInfo
- License: GPL-3.0-or-later
Shows per-page pageview data (the number of daily pageviews for each of the last pvipdays days).
The result format is page title (with underscores) => date (Ymd) => count.
- pvipmetric
The metric to use for counting views. Depending on what backend is used, not all metrics might be supported. You can use the siteinfo API (action=query&meta=siteinfo) to check which ones are supported, under pageviewservice-supported-metrics / module name (siteviews, mostviewed, etc.)
- pageviews
- Plain pageviews.
- One of the following values: pageviews
- Default: pageviews
- pvipdays
The number of days to show.
- Type: integer
- The value must be between 1 and 60.
- Default: 60
- pvipcontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- Show pageview statistics for the main page.
- api.php?action=query&titles=Main_Page&prop=pageviews [open in sandbox]
meta=siteviews (pvis)
- This module requires read rights.
- Source: PageViewInfo
- License: GPL-3.0-or-later
Shows sitewide pageview data (daily pageview totals for each of the last pvisdays days).
The result format is date (Ymd) => count.
- pvismetric
The metric to use for counting views. Depending on what backend is used, not all metrics might be supported. You can use the siteinfo API (action=query&meta=siteinfo) to check which ones are supported, under pageviewservice-supported-metrics / module name (siteviews, mostviewed, etc.)
- pageviews
- Plain pageviews.
- uniques
- Unique visitors.
- One of the following values: pageviews, uniques
- Default: pageviews
- pvisdays
The number of days to show.
- Type: integer
- The value must be between 1 and 60.
- Default: 60
- Show sitewide pageview totals.
- api.php?action=query&meta=siteviews [open in sandbox]
- Show sitewide unique visitor totals.
- api.php?action=query&meta=siteviews&pvismetric=uniques [open in sandbox]
list=mostviewed (pvim)
- This module requires read rights.
- This module can be used as a generator.
- Source: PageViewInfo
- License: GPL-3.0-or-later
Lists the most viewed pages (based on last day's pageview count).
- pvimmetric
The metric to use for counting views. Depending on what backend is used, not all metrics might be supported. You can use the siteinfo API (action=query&meta=siteinfo) to check which ones are supported, under pageviewservice-supported-metrics / module name (siteviews, mostviewed, etc.)
- pageviews
- Plain pageviews.
- One of the following values: pageviews
- Default: pageviews
- pvimlimit
The number of pages to return.
- Type: integer or max
- The value must be between 1 and 500.
- Default: 10
- pvimoffset
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- Type: integer
- Default: 0
- List the top 10 pages.
- api.php?action=query&list=mostviewed [open in sandbox]
- Show pageview data for each of the top 10 pages.
- api.php?action=query&generator=mostviewed&prop=pageviews [open in sandbox]
Intégration communautaire
Currently, PageViewService class is only implemented for the Wikimedia Pageview API in this extension. You must install an additional, community-maintained extension to use other data collection backend.
- Extension:PageViewInfoGA - Supports Google Analytics integration.
- Extension:Plausible
Si vous avez implémenté votre propre PageViewService, veuillez l'indiquer ici.
Voir aussi
| Cette extension est utilisée par au moins un des projets Wikimédia. Cela signifie probablement que l’extension est assez stable et fonctionnelle pour être utilisée sur des sites à fort trafic. Recherchez le nom de cette extension dans le CommonSettings.php de Wikimédia et dans le fichier de configuration InitialiseSettings.php pour situer les endroits où elle est installée. Une liste complète des extensions installées sur un Wiki donné peut être visualisée sur la page Special:Version de ce wiki. |
