Beta Features/Hovercards/Functionality

From MediaWiki.org
Jump to: navigation, search


The following page describes the functionality expected from the hovercards feature upon release. To ensure completion of the feature, we have accounted for a number of the current bugs, as well as the refactoring of the feature and its basic functionality.

Story Breakdown (Tentative)[edit]

These are the current stories for hovercards in Phabricator. Upon completion of the following stories, the feature will be considered ready for move out of beta.

Allow users to view hovercards[edit]

Story: as a user, I want the ability to view page previews so that I can gain context on a topic
Description: build hovercards
Acceptance criteria: https://phabricator.wikimedia.org/T149801

Improve Page Preview visual design[edit]

Story: as a user, I want page previews to have unified design
Description: Page previews need visual design improvement in three areas

  1. depth of shadow
  2. no border
  3. transition time

Acceptance criteria:https://phabricator.wikimedia.org/T150814

Allow generic hovercards to appear in special cases[edit]

Story: as user, I want the ability to know when a preview is not available for the page I am viewing
Description: build generic hovercard
Acceptance criteria: https://phabricator.wikimedia.org/T151054

Allow logged in users to turn hovercards on/off[edit]

Story: as a user, I want the ability to turn hovercards on/off, so that I can structure my reading experience based on my needs
Description: build logged-in settings
Acceptance criteria: https://phabricator.wikimedia.org/T146889

Allow mathematical expressions to appear within hovercards[edit]

Story: as a reader, I want the ability to view previews on articles that contain mathematical expressions
Description: display previews with math
Acceptance criteria:

Allow users to choose whether they want hovercards or not - hovercards onboarding[edit]

Story: as a user, I want the ability to be introduced to the hovercards feature before I decide whether I want it or not
Description: build onboarding
Acceptance criteria: everything in section for onboarding

Allow proper bolding[edit]

Story: As a reader, I want to see the most important part of a page preview in bold so that I know what the article is about
Description: When users highlight a hovercard, display the first instance of bolded text appearing within the article.
Acceptance Criteria: https://phabricator.wikimedia.org/T141651

Allow navigational popups to be default previews[edit]

Story: as an editor, I want the ability to view navigational popups rather than hovercards, as they are more helpful to me
Description: make navpopups appear instead of hovercards even when hovercards are on
Acceptance criteria: https://phabricator.wikimedia.org/T149801

General[edit]

For their first iteration, hovercards will appear everywhere but:

  • Pages that are non-main namespace pages
  • Links to non-main namespace page
  • in edit previews (when action = edit)
  • https://phabricator.wikimedia.org/T144545
  • For disambiguation pages (but will appear ON disambiguation pages)
  • On any special pages
  • For links to any special pages
  • Wiktionary
  • Wikispecies
  • Wikibooks
  • Wikisource

When hovercards are on, link titles will not appear For more info: https://phabricator.wikimedia.org/T14272

Basic Functionality[edit]

Example of a Hovercard being viewed in English Wikipedia

Summary of the article:[edit]

  • The article summary will contain the first 525 characters from the lead paragraph of each article
  • After the first 525 characters, a horizontal gradient will be displayed to indicate continuation (as in related pages).
  • The first instance of bolded text within the article will appear bolded within a hovercard. Any other instance of bolded text will not appear bolded
  • If an article has no lead paragraph, a generic hovercard will be used (functionality described below)

Special cases:[edit]

Generic hovercards[edit]

Example of a generic hovercard for pages with no previews

Generic hovercards will be used when we cannot display hovercards for certain pages. They will contain the following:

  • Icon: Sad face icon
  • Text: Looks like there isn’t a page preview for this topic
  • Link: Read article
    • Selecting “Read acticle” will navigate users to the article
  • Generic hovercards will not contain a settings cog
  • All other functionality will be as in other previews
  • Note: the mockup provided displays a “write page preview” link. This link will NOT be available

Generic hovercards will appear in the following cases:

  • Articles with no lead paragraph

Mathematical Expressions:[edit]

All mathematical expressions must be rendered as they appear within the article including:

Parentheticals:[edit]

If a summary contains a parenthetical, it must be excluded from the hovercard Note: there are some special cases where it’s useful, but we can ignore them for now. For more info, see: https://phabricator.wikimedia.org/T91344

Links to other pages[edit]

If an article summary contains a link to a different page, the link will be rendered in plain text

Articles with a noinclude section[edit]

If an article has a noinclude section at the top, the summary will skip this section and display content from the first paragraph Note: based on https://phabricator.wikimedia.org/T109869

Article image:[edit]

The PageImages image for an article will be displayed according to the new architecture of PageImages:

  • The image may only be displayed if an image is within the lead section of an article OR within the first paragraph
  • If there is no image within the lead section or first paragraph, no images will be displayed for the hovercard (the hovercard will only display the text summary of the article)
  • If an article contains multiple images within the first paragraph and the article has an infobox, display first image that appears in infobox
  • If an article contains multiple images within the first paragraph and the article does not have an infobox, display first image that appears in the lead paragraph
  • Hovercards may display free and non-free images (the configuration on which images to display will be based on community consensus for each project)

Last edited date (tentative)[edit]

The last edited date for the article will appear at the bottom of the hovercard. Allow t = last edited date rounded to the nearest hour

  • If t < 24 hours ago, display: Edited X hours ago
  • If 24 < t < one week, display: Edited X days ago
  • If one week < t < 4 weeks, display: Edited X weeks ago
  • Else, display: Edited on X (where X = date of edit)

Settings cog[edit]

The settings cog will appear at the bottom of the hovercard. It will be a button used to allow users to turn hovercards on an off Selecting the settings cog will open the user settings modal.

Design Criteria[edit]

Visual[edit]

The following visual constraints will be applied:

.mwe-popups {
box-shadow: 0 45px 70px -20px rgba(0,0,0,0.3), 0px 0px 1px rgba(0,0,0,0.5);
border:none;
}

Transition Time[edit]

The transition time will be 0.2s

More info here: https://phabricator.wikimedia.org/T150814

Settings[edit]

Logged-out users[edit]

Logged out users will be able to turn hovercards off via the settings link at the bottom of each page preview. Users will be able to turn hovercards on via the “Enable Previews” link at the bottom of each page. These settings will be saved per browser session.

Basic functionality:[edit]

Page preview settings for logged out users

Page Preview Settings

  • Button: X
    • Selecting X will close the settings modal AND the hovercard from which it was triggered
    • No settings will be changed if user selects X
  • Button: Save
    • Selecting “Save” will save the user settings and close the user settings modal (note: if user decides to disable previews, the enable modal will appear)
    • If no change in settings was selected, no change will be made in user settings
    • If a change was selected, the appropriate change will be saved
  • Radio button: Enable (DEFAULT)
    • Subtitle: Get quick previews of a topic while reading an article
    • If this radio button is selected, hovercards will be ON when user selects “Save”
  • Radio button: Disable
    • Subtitle: You can always re-enable them later
    • If this radio button is selected, hovercards will be OFF when user selects save
  • Upon selecting Save, the enable previews modal will appear. This modal will contain the following:
    • Title: Page Preview Settings
    • Text: You can turn page previews back on using the “Enable Previews” link in the footer of the page.
    • Illustration: (as seen below)
    • Button: X - selecting X will close the modal (page previews will be OFF)
    • Button: Done - selecting Done will close the modal (page previews will be OFF)

Enable previews link

Reenable previews link appears in the footer of the page
  • When page previews are off, the enable previews link will appear at the footer of each page
  • Selecting the enable previews link will open the user settings modal
  • The default of the user settings modal will be ENABLED
  • When page previews are OFF, the enable previews link will not appear

Logged-in users[edit]

Logged-in users will be able to control their settings from two places - the settings cog and the user preferences page. User Preferences:

Users will be able to specify whether they want hovercards on or off via a section within the user preferences page. This will contain the following:

  • Section title: Reading Preferences
  • Item title: Page Previews
  • Subtitle: Get quick previews of a topic while reading an article
  • Radio button: Enable
    • Selecting Enable and Save will turn page previews ON
    • Selecting Enable and not saving will do nothing
  • Radio button: Disable
    • Selecting Disable and Save will turn page previews OFF
    • Selecting Disable without saving will do nothing

Note: when hovercards are disabled for logged-in users, the “Enable Previews” link will NOT appear

Hovercard - original preferences

Settings cog For logged in users, the settings cog at the bottom of the article will navigate users to the user preferences page

Preferences for logged in users

Navigational Popups behavior:[edit]

  • If users enable hovercards from the user preferences page AND navigational popups are on:
    • Hovercards will not be turned on. The user will be given a message that, in order to turn hovercards on, navigational popups must be turned off.

Onboarding[edit]

Logged-out users Hovercards will be ON by default upon release. Users will go through the following workflow User views hovercard n times On nth card, system displays modal asking if user would like to disable feature More info here: https://phabricator.wikimedia.org/T133230


Logged-in users Hovercards will be OFF by default upon release (as reflected by the radio button in user preferences)


EventLogging[edit]

Current schema, with the following changes:

  • https://phabricator.wikimedia.org/T147314 (“Add reading depth to hovercards schema (defined as time spent on page)”)
  • Remove the "version" field
  • Remove the "api" field
  • Remove the "error" event
  • Merge the "opened in new tab", "opened in new window" and "opened in same tab" events into a new "opened" event
  • For events that involve a card (having been / being) shown, add a "cardType" field indicating whether the card is generic (no preview available, phab:T151054) or regular

Should work like this (Tilman made this :):

State diagram for Schema-Popups (Hovercards instrumentation).svg

Bugs not accounted for:

Tentative Improvements[edit]