Help:Gadget-Navigation popups

From: Everything Food & Drink.org
Jump to: navigation, search
Shortcuts:
EFD:POP
EFD:POPUP
EFD:POPUPS
EFD:NAVPOP
EFD:NAVPOPS
Navigation popups Icon
An example of popups over the link Wikipedia, using the skin Monobook. Click to enlarge preview.

Navigation popups is a script, written in JavaScript (source), that offers easy access to article previews and several Wikipedia functions in popup windows which appear when you hover the cursor over links.

  • Quick installation: Enter Special:Preferences and click "Gadgets", check the box to enable Popups, then click save. Follow the instructions on the page to bypass your browser's cache.
  • Other installation method: add {{subst:navpop}} to your current skin's .js page. See below for full installation instructions.

If you're having trouble, you may like to peruse some frequently asked questions.

Features[edit]

Small image preview for an article (Classic skin screenshot, but works fine with Vector/Monobook).
Click to enlarge preview.
Reverting using popups- hover over history item and select revert. Click to enlarge preview.
  • Mouseover on articles (including user pages):
    • Preview the first part of the article text when mousing over a link to an article
    • Preview the first image on each article
    • Preview selected page information: size, number of links, number of images, number of categories and page age
    • Tells you about redirects, stubs and disambiguation pages
    • One click access to edit page, page history, most recent edit, edits by most recent contributor,[1] changes since my edit,[1] move page, what links here, related changes, watch or unwatch, protect or unprotect (for administrators), talk page, edit talk page and start new topic in talk page
  • Mouseover on image links:
    • Preview images
    • Preview file descriptions
    • Preview file links
    • Tells you if the image is on Commons
  • Mouseover on user links:
    • One-click access to user page, user space, user talk, edit user talk, new section in user talk, e-mail user, contributions and contributions tree, user log, (for administrators) delete user, (for administrators) block user, edit counter (X!'s Edit Counter), block log
  • Mouseover on footnotes:
    • Preview contents of footnotes
  • Mouseover on any wikilink:
    • Clear pop-up cache[2]
    • Enable/disable previews[2]
    • Enable/disable pop-ups[2]
  • Preview diffs and access both revisions in watchlist, history and related changes
  • Preview selected wikilinks when editing (use the mouse to select one wikilink)
  • One-click revert of vandalism from history browser (see image)
  • Wikipedia search, global Wikipedia search and Google search
  • Shortcut keys (optional)
  • Automatically fix links to bypass redirects and disambiguation pages (optional)
  • Should work on all Wikimedia wikis

Installation[edit]

You must have a user account to install and use the Navigation popups feature. If you do not have an account, you will need to create one and log in.

Automatic installation
  • Go to My Preferences / Gadgets / Browsing gadgets, check "Navigation popups", and click Save.
Manual installation
// [[User:Lupin/popups.js]]
importScript('User:Lupin/popups.js');

Note: the link above is to skin.js, which should take you to the correct page if you have JavaScript enabled. For reference, the relevant file you will need to edit is listed below.

Installation on remote MediaWiki installations

Add the following to your user script file:

// [[wikipedia:User:Lupin/popups]]
importScriptURI("//en.wikipedia.org/w/index.php?title=User:Lupin/popups.js&action=raw&ctype=text/javascript");
Notes

After saving the page, clear your browser's cache (on Internet Explorer Ctrl+F5; on Mozilla Firefox Shift+Ctrl+R; on Opera F5). Assuming that you have not disabled JavaScript in your browser, a popup should appear whenever you hover your mouse over an internal link in Wikipedia. If you use more than one web browser, or more than one PC, you may need to clear the caches for each so that the popup appears.

To install the script on the Commons or Wiktionary, repeat this procedure on those wikis.

To uninstall the script, delete the above lines from the same page and clear your browser's cache.

Usage guide[edit]

This tool generates "popup hints" when you hover the mouse pointer over active links and images. These popups provide information about the link's target and give quick access to a number of relevant actions.

If you hold the shift key then you can drag the popup around.

Popups depend on the type of link:

  • Links to ordinary articles: popup provides a preview of the first paragraph and image of the article; the Actions menu allows to view the History and Talk page of the article, to edit and watch the article etc.
  • In the edit box: Highlight a [[wiki link]] to get an article popup.
  • Diff links: On history or watchlist pages, hover over diff links like "(cur)" or "(prev)" to get a summary of the difference; the Actions menu allows you to revert or undo the edit.
  • User: links: information about the status of the user; User menu gives access to Talk page, recent contributions etc.
  • Image links: information from image's description page
  • In popups: most of the links in popup windows will open new popups when hovered over.

Configuration (optional)[edit]

Changing the appearance of your popups[edit]

By editing your user CSS file, you can change the appearance of the popups. Your user CSS file has exactly the same name as the javascript file, but with "css" instead of "js" at the end. So you should edit your current skin's .css page.

Here is an example which gives an orange-flavoured popup with a border and changes the font used. This makes the popups look pretty silly, but it shows the sort of thing you can do if you feel like it.

.navpopup { 
  background-color: #FFBE20  !important;
  font-family:      serif    !important;
  color:            #404     !important;
  font-size:        medium   !important;
}

Options[edit]

There are some options that you can set. To do so, edit your user javascript file and add a line of the form

window.option = value;

where option and value are chosen from the table below. For example, to turn on extensive menus and turn on admin links, you need to add something like this in your javascript file:

window.popupStructure = 'menus';
window.popupAdminLinks = true;
Configuration options
Option Values
Default values in bold
Description

Help:Gadget-Navigation popups/General options Help:Gadget-Navigation popups/Edit summary options Help:Gadget-Navigation popups/Preview options Help:Gadget-Navigation popups/Technical options Help:Gadget-Navigation popups/Experimental options

More options may be added, and requests for more configurability are welcome.

Advanced customization[edit]

Adding filters[edit]

You can define custom filters for articles. These are javascript functions which are run after the page statistics are generated, and their output is appended (as HTML) to that part of the popup. (Note that if simplePopups is true or popupSummaryData is false, then nothing will be displayed).

The way to set this up is to write a filter function which accepts a string (the wikitext of the article) as input, and returns a fragment of HTML. Repeat for as many filters as you want, and then create an array extraPopupFilters which contains all of the functions, in the order in which you want them to be run.

For example, let's say you want to be told whenever the wikitext of an article contains a table written using HTML tags rather than wiki markup. One way to do this is to add the following to your user javascript file:

// initialize the array - only do this once
window.extraPopupFilters = [];

// define the function
function popupFilterHtmlTable (wikiText) {
  if (/<table/i.test(wikiText)) return '&lt;table&gt;';
  else return '';
};

// add the function to the array (you can repeat this for lots of functions)
extraPopupFilters.push(popupFilterHtmlTable);

Then when a popup is generated for a page containing an HTML table, you should see <table> in the popup. (It may also appear for other pages, such as this page. Correcting this defect is left as an exercise for the reader).

Other examples[edit]

If you want to enable popupRedlinkRemoval, popupFixRedirs and popupFixDabs features in all pages except the special ones, histories and previews (where those features are obviously useless) you can add this lines

// Normally features are enabled
var toFix = true;

// In special pages, histories and previews disable them
if (wgCanonicalNamespace == "Special" || /*
    */ location.href.indexOf('&action=history') != -1 || /*
    */ location.href.indexOf('&action=submit') != -1)
  toFix = false;

// 
window.popupRedlinkRemoval = toFix;
window.popupFixRedirs = toFix;
window.popupFixDabs = toFix;

to your user JavaScript file.

Translations[edit]

Please see this page for translations of the script interface and of this page into other languages. You'll also find instructions for creating a translation yourself.

Browser problems[edit]

Google Chrome[edit]

If the user is using the Virtual Keyboard (by Google)extension, the popups may sometimes appear in the wrong locations, sometime off the screen entirely. Frequently, popups appear in the same location as the first, leading to a several overlapping popups since the pop-ups do not disappear even when the mouse no longer hovers over a link. This conflict with popups is present as of Version 0.9.8.8 of the Virtual Keyboard extension.

Internet Explorer[edit]

Pages with "–" in their titles will not display correctly in the popups. This bug does not exist in Internet Explorer 9, so upgrading will fix the bug.

Firefox[edit]

If a user on Firefox with the Adblock Plus extension installed cannot see the popup, only the normal tooltip, Adblock Plus may be blocking the operation of navigational popups. This can be solved by adding an exception to the filtering rules – go to the Main Page, right click the icon in the status bar and check Disable on en.wikipedia.org.

Safari[edit]

The menus do not function correctly in some older releases of Safari. Using a version 3 or higher is supported.

Opera[edit]

Using a current version (11.0 or higher) should give correctly functioning popups. Using an earlier version, you may experience problems, such as popups not loading or not disappearing after the mouse is moved away.

This tool should not be affected by any browser popup blocking settings.

Userboxes[edit]

HC Navigation popups icon.png This user watches over the Everything Food & Drink project with the help of Navigation popups.
 •  {{UBX/Navpops}}

Footnotes[edit]

  1. ^ 1.0 1.1 On selected browsers, including Microsoft Internet Explorer
  2. ^ 2.0 2.1 2.2 On selected browsers, including Mozilla Firefox

Credits and external links[edit]

This tool was primarily written by Lupin, who is currently no longer active on Wikipedia. It depends on some other people's work:

Older versions of the tool used overlib by Erik Bosrup.

Wikipedians who have helped[edit]

Language: English