Rozszerzenie:Podglądy strony

This page is a translated version of the page Extension:Popups and the translation is 23% complete.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎dansk • ‎español • ‎polski • ‎português do Brasil • ‎svenska • ‎русский • ‎हिन्दी • ‎中文 • ‎日本語 • ‎한국어
Podręcznik rozszerzeń MediaWiki
OOjs UI icon advanced.svg
Popups
Status wydania: stabilne
Hovercard english.png
Realizacja Skórka
Opis Wyświetla wyskakujące okienka, gdy użytkownik najedzie kursorem na linki do artykułów i znaczniki przypisów
Autor(zy)
  • Prateek Saxena (user:Prtksxna),
  • Yair Rand,
  • Sam Smith,
  • Joaquín Oltra Hernández,
  • Bahodir Mansurov,
  • Jon Robson,
  • Piotr Miazga,
  • Jeff Hobson
  • WMDE Engineering
MediaWiki 1.30+
PHP 5.6+
Licencja GNU General Public License 2.0 or later
Pobieranie
Przykład English Wikipedia
  • $wgPopupsVirtualPageViews
  • $wgPopupsOptInDefaultState
  • $wgPopupsRestGatewayEndpoint
  • $wgPopupsHideOptInOnPreferencesPage
  • $wgPopupsTextExtractsIntroOnly
  • $wgPopupsConflictingRefTooltipsGadgetName
  • $wgPopupsPageDisabled
  • $wgPopupsEventLogging
  • $wgPopupsStatsvSamplingRate
  • $wgPopupsReferencePreviewsBetaFeature
  • $wgPopupsConflictingNavPopupsGadgetName
  • $wgPopupsOptInStateForNewAccounts
  • $wgPopupsGateway
  • $wgPopupsReferencePreviews
Przetłumacz rozszerzenie Popups jeżeli jest dostępne na translatewiki.net

Sprawdź wykorzystywanie i matrycę wersji.

Problemy Otwarte zadania · Zgłoś błąd

Rozszerzenie Popups wyświetla podglądy stron i referencji po najechaniu kursorem myszy na link do artykułu lub odnośnika. Pierwsza zawiera streszczenia treści artykułu, druga przedstawia pełną treść odsyłacza.

Jest to inicjatywa zespołu ds. Designu, zainspirowana popularnym gadżetem „Navigation popups”. Aktualnie ta opcja jest domyślnie włączona na wszystkich wersjach językowych Wikipedii dla każdego wylogowanego użytkownika. Opis działania rozszerzenia a także więcej informacji o tym jak wykorzystywane jest na wiki Fundacji WIkimedia znaleźć można na stronie Page Previews.

The Reference Previews feature was added eventually and aims to fulfill a wish from the German-speaking community's Technical Wishlist. A more detailed description and more information on its use is available at Reference Previews .

Zależności

To rozszerzenie koniecznie wymaga do działania Extension:TextExtracts i Extension:PageImages . Opcjonalnymi zależnościami są także Funkcje eksperymentalne (bez nich rozszerzenie będzie ładowane dla wszystkich użytkowników) oraz Extension:EventLogging i Extension:WikimediaEvents .

Instalacja

  • Pobierz i umieść plik(i) w katalogu o nazwie Popups w swoim katalogu extensions/.
  • Dodaj poniższy kod na dole swojego pliku LocalSettings.php:
    wfLoadExtension( 'Popups' );
    
  •   Zrobione – Przejdź do Special:Version na swojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Do użytkowników mających wersję MediaWiki 1.25 lub wcześniejszą:

Powyższe instrukcje opisują nowy sposób instalowania tego rozszerzenia, poprzez wfLoadExtension(). Jeżeli chcesz zainstalować to rozszerzenie we wcześniejszych wersjach (MediaWiki 1.25 i wcześniejsze), zamiast wfLoadExtension( 'Popups' ); użyj:

require_once "$IP/extensions/Popups/Popups.php";

Przykład konfiguracji na standardowej wiki

wfLoadExtensions( [
    'TextExtracts',
    'PageImages',
    'Popups'
] );
$wgPopupsHideOptInOnPreferencesPage = true;
$wgPopupsReferencePreviewsBetaFeature = false;

Page previews API

Every project is different, and what displays in your previews is highly dependent on the content inside your wiki.

Extension:Popups has been optimised to work with Wikipedia-like content (e.g. wikitext). If your wiki is using a different kind of content handler (for example as is the case for Wikibase ) it will need to provide its own API.

The API can be written in any language, but the response of the API must match the spec defined here:

Specs/Summary/1.2.0

Defining new APIs is out of scope for the Popups extension.

Once defined, you can configure page previews to point to your API using $wgPopupsRestGatewayEndpoint configuration option.

Opcje konfiguracyjne

Opcja Domyślna wartość Dokumentacja
$wgPopupsVirtualPageViews false Whether the extension should log virtual pageviews.
$wgPopupsHideOptInOnPreferencesPage false Whether the option to enable/disable Page Previews should be hidden on Preferences page. False by default.
$wgPopupsOptInDefaultState 1 Default Page Previews visibility for old accounts. Has to be a string as a compatibility with beta feature settings. Aby uzyskać więcej informacji, zobacz T191888.
$wgPopupsOptInStateForNewAccounts 1 Default Page Previews visibility for newly created accounts (from Q2 2018). Aby uzyskać więcej informacji, zobacz T191888.
$wgPopupsConflictingNavPopupsGadgetName Navigation_popups The local Navigation popups gadget name used as its identifier in MediaWiki:Gadgets-definition . This gadget is incompatible with page previews. The extension will disable itself for users with the gadget enabled.
$wgPopupsConflictingRefTooltipsGadgetName ReferenceTooltips The local Reference Tooltips gadget name used as its identifier in MediaWiki:Gadgets-definition . This gadget is incompatible with reference previews. Reference previews will disable itself for users with the gadget enabled.
$wgPopupsGateway mwApiPlain Which gateway to use for fetching Popups data. Available options: [mwApiPlain|restbasePlain|restbaseHTML]. Full and always up to date list is available in src/gateway/page.js.
$wgPopupsRestGatewayEndpoint /api/rest_v1/page/summary/ Specify a REST endpoint where summaries should be sourced from. Endpoint must meet the spec at Specs/Summary/1.2.0 .
$wgPopupsReferencePreviews true Temporary feature flag to disable reference previews during developement.
$wgPopupsReferencePreviewsBetaFeature true Whether Reference Previews should be available as a Beta feature. If false, Reference Previews are enabled for all users by default.
$wgPopupsEventLogging false Whether we should log events. Note if this is enabled without using that variable events will be logged for all users without any sampling! Be careful!
$wgPopupsStatsvSamplingRate 0 Sampling rate for logging performance data to statsv.
$wgPopupsPageDisabled [ "Special:CreateAccount", "Special:GlobalRenameRequest", "Special:Userlogin", "Special:MergeAccount", "Special:ChangeCredentials", "Special:OAuthListConsumers", "Special:GlobalUserRights", "Special:Notifications", "Special:UserRights", "Special:Upload", "Special:VipsTest", "Special:ApiFeatureUsage", "Special:ExpandTemplates", "Special:GadgetUsage", "Special:GraphSandbox", "Special:TemplateSandbox", "Special:MostLinkedFiles", "Special:Book" ] List of pages that should not show Popups. Includes subpages. These pages are subject to the HTML cache policy of the wiki. A purge on these pages maybe needed to see the effect of this configuration variable. Every excluded page should be defined by a canonical name, eg: Special:Userlogin.

Page previews content

The page preview popups show an image (if one is available) and a small text excerpt.

Image

The image comes from the Extension:PageImages which returns the single most appropriate thumbnail associated with an article. It ignores maintenance templates, stubs, flag icons etc.

Tekst

The page previews can be configured with any compatible API that is compatible with the Page content service summary endpoint using $wgPopupsRestGatewayEndpoint. For third parties we encourage using the Page Content Service to enjoy using Popups with your local wiki.

You can also use the Extension:TextExtracts extension. This extension has various caveats and we do not actively support use of this API.

Reference previews content

The content in the reference preview popups is taken directly from the reference section on the page itself. No external services are involved here. If the content exceeds the popup size scrollbars are shown so everything can be looked at.

Reference types

The reference types displayed are set by using specific CSS-classes on the <cite>-tag that can be used to encapsulate the content of a reference e.g. <cite class="journal">. Currently the following types are supported: web, journal, book, news, note. Apart from that there is always a generic fallback if neither the cite tag was found nor an appropriate class was used. Please note, that it's not recommended to use the CSS-classes directly in wikitext, but rather by creating templates.

Renderers

This extensions currently has only one renderer, that is for ordinary pages.

New renderers for different kind of pages, or things like references can be easily added.

One needs to create a new object with the following methods:

  • init
  • createPopup
  • getOffset
  • getClasses
  • processPopup

You can see details of these methods in ext.popups.renderer.article.js or this patch that adds a renderer for references.

Znane problemy

  • Users of the Translate extension should note that Page Previews requests previews in the content language of the page. If the preview contains a complete translatable block, then it will be translated. If, however, the preview contains an incomplete translateable block – because a sentence is cut off, say – then it isn't translated and will be displayed in the content language of the page. If you are observing this behavior, then you should consider marking up individual sentences in your lead section.
  • T167852 is for a technical audience but has more information on the underlying problem.
  • Longer math formulas cutting off in preview - long math or chemical formulas (formulas wider than the preview width) display as truncated in previews. We were not able to add a gradient in order to indicate that the formula is continued on the article itself.

FAQ

Why can't I copy and paste text from a preview?

At time of writing, the cons of doing so outweigh the pros. Essentially it boils down to decreasing the touch area to read the article in full. Once Page Previews is deployed on English and German Wikipedia, feel free to reopen this task and reignite the discussion, but right now we have no plans.

How can I change the image that I see on preview?

How can I remove content from a page preview?

Any element marked with the noexcerpt class will be stripped from the summary.

Where do summaries come from?

These are provided by the Summary REST API.

Why are parenthetical stripped?

There's a good discussion going on in T91344 in Phabricator. If you have any views on this or see any problems relating to this, please let us know there.

Why don't I see Popups outside of content namespaces?

Popups appear on links to pages in content namespaces only. This is a limitation of Popups; TextExtracts are available from other namespaces. You may work around this by appending more namespaces into $wgContentNamespaces .

Links