Page Preview Application

Last modified by Thomas Mortagne on 2023/01/09 00:06

cogDisplays a page preview popover on internal wiki links.
Developed by

slauriere, Ludovic Dubost, XWiki SAS

Active Installs14
1 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager


XWiki Page Preview displays a popup when hovering internal wiki links, as illustrated hereafter. The application consists of a page which returns an HTML preview of a given page. By default, it is called automatically for the .wikilink and .wikiinternallink CSS selectors on all pages of the wiki on which it is installed.

The application requires programming rights at this stage.

Technical notes

The script returns a JSON object containing:

  • The rendered content of the page corresponding to the path given as parameter in the request.
  • The relative URL of the first image attached to that page, if any.

A typical input / output consists of:

  • Input: /XWiki/PagePreviewer?path=/xwiki/wiki/sandbox/view/Sandbox/&xpage=plain&outputSyntax=plain
  • Output:
 "html": "<p>Lorem ipsum dolor sit amor.</p>",
 "image": "/xwiki/wiki/kuava/download/Sandbox/WebHome/XWikiLogo.png?rev=1.1"

See also


Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes


The following translations have been updated with this release:


The following translations have been updated:





  • Popovers are not fired for internal links anymore
  • Popovers are not fired on touch-only browsers since the real action is a click
  • Ligher code: pure JavaScript, no Velocity code needed anymore
Created by slauriere on 2019/10/25 14:15

Get Connected