Extensão:Popups

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.30+
PHP	5.6+
Licença	GNU GPL (Licença Pública Geral) 2.0 ou superior
Download	Baixar extensão Git [?]: Baixar master do Git navegar pelo repositório (GitHub) histórico de commits contribuidores do repositório (GitHub) revisão de código
Exemplo	English Wikipedia
Parâmetros $wgPopupsVirtualPageViews $wgPopupsOptInDefaultState $wgPopupsRestGatewayEndpoint $wgPopupsHideOptInOnPreferencesPage $wgPopupsTextExtractsIntroOnly $wgPopupsConflictingRefTooltipsGadgetName $wgPopupsPageDisabled $wgPopupsEventLogging $wgPopupsStatsvSamplingRate $wgPopupsReferencePreviewsBetaFeature $wgPopupsConflictingNavPopupsGadgetName $wgPopupsOptInStateForNewAccounts $wgPopupsGateway $wgPopupsReferencePreviews
Hooks usados BeforePageDisplay GetBetaFeaturePreferences GetPreferences LocalUserCreated MakeGlobalVariablesScript PreferencesFormPreSave ResourceLoaderGetConfigVars UserGetDefaultOptions
Para traduzir a extensão Popups, verifique sua disponibilidade no translatewiki.net
Verificar uso e matriz de versões
Problemas	Tarefas em aberto · Relatar um bug

The Popups 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 Ajuda: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

• Instale as dependências.

• Baixe e coloque o(s) arquivo(s) num diretório chamado Popups na sua pasta extensions/.
• Adicione o seguinte código ao final do seu arquivo LocalSettings.php:

  wfLoadExtension( 'Popups' );
  

•  Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.

Para usuários executando o MediaWiki 1.25 ou anteriores:

As instruções acima descrevem a nova forma de instalar essa extensão utilizando wfLoadExtension(). Se precisar instalar essa extensão em versões antigas (MediaWiki 1.25 e anteriores), em vez de wfLoadExtension( 'Popups' );, você precisa usar:

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

Exemplo de configuração final do LocalSettings para uma wiki regular

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.

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. Note que PopupsBetaFeature sendo true já oculta essa opção. Padrão: false False by default.
$wgPopupsOptInDefaultState	1	Visibilidade padrão das previsões. É uma string por causa da compatibilidade com a extensão de recursos beta For more information see T191888
$wgPopupsOptInStateForNewAccounts	1	Default Page Previews visibility for newly created accounts (from Q2 2018). For more information see 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 developement.
$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.
$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.

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.

Conteúdo das previsões de referências

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.

Tipos de referências

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.

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.

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.

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?

See Extension:PageImages#Image choice.

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.

De onde vêm os sumários?

These are provided by the Summary REST API.

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

• Page Previews help page and central feedback page on MediaWiki.org
• Reference Previews help page and central feedback page on MediaWiki.org
• Reference Previews main project page on Meta
• Related research: Wikimedia Performance Team/Authoring Popups: Best Practices