Jump to content

Extensão:Popups

From mediawiki.org
This page is a translated version of the page Extension:Popups and the translation is 27% complete.
Outdated translations are marked like this.
Para the feature that is powered by this extension, veja: Page Previews.
Manual de extensões do MediaWiki
Popups
Estado da versão: estável
Implementação Tema
Descrição Exibe sobreposições quando o usuário passa o cursor sobre ligações e notas de rodapé
Autor(es)
  • 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.37+
PHP 5.6+
Licença GNU GPL (Licença Pública Geral) 2.0 ou superior
Download
Exemplo English Wikipedia
  • $wgPopupsVirtualPageViews
  • $wgPopupsOptInDefaultState
  • $wgPopupsRestGatewayEndpoint
  • $wgPopupsHideOptInOnPreferencesPage
  • $wgPopupsConflictingRefTooltipsGadgetName
  • $wgPopupsStatsvSamplingRate
  • $wgPopupsTextExtractsIntroOnly
  • $wgPopupsConflictingNavPopupsGadgetName
  • $wgPopupsPageDisabled
  • $wgPopupsGateway
  • $wgPopupsReferencePreviews
Quarterly downloads 305 (Ranked 14th)
Public wikis using 947 (Ranked 282nd)
Para traduzir a extensão Popups, verifique sua disponibilidade no translatewiki.net
Problemas Tarefas em aberto · Relatar um bug

The Popups (known in Special:Version as Previews) extension displays page and reference previews when hovering over a link to an article or respectively to a reference. The former consists of summaries of an article's content, the latter shows the full content of the reference.

The extension is an initiative of the Design team, inspired by the popular Navigation popups gadget. Currently this feature is available on all Wikipedias by default for logged-out users. A description of how the extension functions and more information on its use on Wikimedia projects is available at 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 Pré-visualizações de referência .

Dependências

Essa extensão depende especialmente de Extensão:TextExtracts e Extension:PageImages . Opcionalmente, também são recomendadas Recursos Beta (para ativar as previsões de referências como um recurso beta) e Extension:EventLogging e Extension:WikimediaEvents (para instrumentação).

Instalação

  • Baixe e coloque o(s) arquivo(s) num diretório chamado Popups na sua pasta extensions/.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php :
    wfLoadExtension( 'Popups' );
    
  • Yes Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.
=== Exemplo de configuração final do LocalSettings para uma wiki regular ===
wfLoadExtensions( [
    'TextExtracts',
    'PageImages',
    'Popups'
] );
$wgPopupsHideOptInOnPreferencesPage = true;
$wgPopupsReferencePreviewsBetaFeature = false;

Opções de configuração

Opção Valor padrão Documentação
$wgPopupsVirtualPageViews false Whether the extension should log virtual pageviews.
$wgPopupsHideOptInOnPreferencesPage false Controla se a opção de ativar ou desativar as previsões estará oculta ou não na página de preferências.
$wgPopupsOptInDefaultState 1 Visibilidade de visualizações de página padrão para contas antigas. É uma string por causa da compatibilidade com a extensão de recursos beta. For more information see task T191888. This value is internally converted to the Bool type. Therefore, a value greater than or equal to 2 has the same meaning as 1.
$wgPopupsOptInStateForNewAccounts 1 Default Page Previews visibility for newly created accounts (1.32-1.43). For more information see task 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' Qual gateway usar para buscar os dados. Opções disponíveis: mwApiPlain, restbasePlain, restbaseHTML. Uma lista completa está em src/gateway/page.js
$wgPopupsRestGatewayEndpoint '/api/rest_v1/page/summary/' Especifica um endpoint do REST de onde os sumários serão obtidos. O endpoint deve corresponder à especificação em Specs/Summary/1.2.0
$wgPopupsReferencePreviews true Temporary feature flag to disable reference previews during development.
$wgPopupsReferencePreviewsBetaFeature true Se as visualizações de referência devem estar disponíveis como um recurso Beta. Se for false, as visualizações de referência são habilitadas para todos os usuários por padrão.
$wgPopupsStatsvSamplingRate 0 Sampling rate for logging performance data to statsv.
$wgPopupsPageDisabled Several special pages. See extension.json for the full list. 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.

Conteúdo das previsões de páginas

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

Imagem

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.

Texto

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 Extensão:TextExtracts extension. This extension has various caveats and we do not actively support use of this API.

Renderizadores

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.

Page previews API

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

Popups extension has been optimized 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 in 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.

Problemas conhecidos

  • 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.
  • Small files may be in the "Рage information" (action=info), but not in the "Popups". Some requirements are set here - for a portrait image: exact (min) height 250 px & max width 203 px; for a landscape image: exact (min) width 320 px & max height 200 px[1]. To display, images must be able to become a thumbnail that is larger or equal to these "exact" sizes. (If you are cropping a large image to make a leading picture for an article, be sure that the picture you are creating is not smaller than the specified sizes.)

Extensibility

In MediaWiki 1.40, extensions and skins can extend the page previews functionality with their own custom preview types.

It does this by registering a PluginModules attribute in its extension.json or skin.json file that points to a ResourceLoaderModule that can register a preview type.

{
    "attributes": {
        "Popups": {
            "PluginModules": [
              "skins.skinjson.popup"
            ]
        }
    }
}

The plugin module should export information about when the preview should be displayed (via selector), and how the preview data should be retrieved (via gateway library).

module.exports = {
        // a unique ID representing your preview type.
        type,
        // CSS selector that matches your custom preview type
        selector: '.mycustomselector',
        // Gateway
        gateway: {
                fetchPreviewForTitle:  ( title, el ) => {
                	const deferred = $.Deferred();
                	deferred.resolve( {
                		title: 'Hello world',
                		extract: [
                			`Hi`
                		],
                		url: 'https://www.mediawiki.org/wiki/Extension:Popups',
                		type,
                		languageCode: 'en',
                		languageDirection: 'ltr',
                		thumbnail: undefined,
                		pageId: -1
                	} );
                	return deferred;
                }
        }
};

For real world examples, Extensão:Math provide smath tooltips and Extensão:Cite provides reference previews.

Perguntas frequentes

Por que não consigo copiar o texto da previsão?

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.

É possível modificar a imagem mostrada na previsão?

Posso remover uma parte do conteúdo da previsão de página?

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

Why is content removed from the summary?

Any HTML element marked with the class noexcerpt, mw-ref, reference, noprint, nomobile or sortkey will be removed from the summary. If the text should be displayed in the summary, you should under no circumstances use these classes in any templates that are used within the beginning section of an article.

De onde vêm os sumários?

These are provided by the summary REST API (Wikimedia production wikis) or the TextExtracts API in case your wiki is using the default mwApiPlain gateway.

Por que nada que está entre parênteses é exibido?

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.

Por que a extensão não funciona fora do espaço nominal padrão?

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 .

Ligações úteis

Notes