Update: first round of mockups is available in the designs directory (be sure to download the PDF to view all the 3 screens as the github preview doesn't seem to always render the first one).
Note: in what follows all the authentication / user account / profile creation & display is done by PREreview.
In terms of "release strategy" main idea would be to release this work under a rapid.prepreview.org
subdomain under an experimental/beta flag to get user feedback asap, iterate on that feedback and then integrate the good parts to PREreview
Main page
The goal of the main page is to establish Rapid PREreview as the place where the outbreak science community comes to request, get and provide rapid feedback on their preprints.
The page is centered around:
- a searchable list of preprints for which users have provided or expressed a desire to get feedback through Rapid PREreviews
- clear call to actions to:
- create a new Rapid PREreviews
- get feedback on existing preprint content (request for Rapid PREreviews)
- install the web extension to do the same thing even more easily (see section further down)
List
To start as simple as possible, the first implementation of the list will sort items by date of last Rapid PREreview created.
Later we could refine that with a score better suited to provide visibility to preprints with a high demand for feedback. Tentative definition:
where,
v
= number of votes of an item
r
= number of Rapid PREreviews of an item
t
= time since request submission or first Rapid PREreview (unit (hours, days, weeks) to be determined)
g
= tuning factor (to be determined)
Displayed data / controls for each item:
- preprint title
- preprint server
- preprint DOI
- number of Rapid PREreviews (and/or reviewer name (or anonymous alias) with link to their PREreview profile)
- number of upvotes (request for Rapid PREreviews)
- visualization of the aggregated data collected from the structured reviews
- date of first & last review made
- call to action to add a Rapid PREreview
- call to action to request a Rapid PREreview or express the desire to see more reviews (upvote)
Search options:
- Facets (filter by):
- preprints with requests for Rapid PREreviews (votes)
- preprints with Rapid PREreviews
- Preprint server
- Dates of last posted review (last week, last month, etc.)
- Structured data collected by the Rapid PREreview creation form (see #6 for the list of facets)
- Full text search:
- Author name / username / anonymous alias of the Rapid PREreview creator
- Rapid PREreview textual content (if any)
- preprint title
- Other indexes
- preprint DOI
- preprint URL
When users perform a search the end of the list will re-iterate the call to actions to start a new Rapid PREreview or request for Rapid PREreview in case the desired content wasn't found.
Users opting to view details about an item are taken to the Rapid PREreview display page (see section further down)
Note: this list (and associated search indexes) is only generated from the data collected during the rapid PREreview creation process to minimize complexity and avoid having to maintain a sync engine / index of all the different preprint servers content. However, PREreview already provides and maintains an index of all the different preprint servers so we could merge with PREreview at a later stage. In the same way, if the maintenance of the index is difficult, PREreview could adopt the simpler approach described here.
Create new Rapid PREreview call to action
Users clicking on the call to action are asked to provides a DOI (or URL) of the preprint to review. At that point we try to get as much metadata as we can from this information (see #9) and transition the user to the Rapid PREreview creation and display page (see section further down). As a fallback, if we couldn't get metadata about the preprint the user will be asked to enter the DOI and title manually.
(if user is not logged in, user is sent through the PREreview login workflow and redirected to the page on login success)
Request for Rapid PREreviews call to action
Logged in users can:
- add entries by providing a DOI (or URL) using the same workflow as described above
- upvote existing entries (see score definition above)
Install web extension call to action
(see section further down for description)
Rapid PREreview creation and display page
This page is designed to work as a "fallback" in cases when users haven't / cannot / don't want to install the web extension (see dedicated section below). It is however fully functional (and styled).
The rendering logic depends on the Content Security Policy set by the preprint server hosting the content to review:
- if framing is allowed, an
iframe
displaying the preprint content is rendered and complemented by:
- a panel (or shell) containing the list of existing Rapid PREreviews
- a shell containing the Rapid PREreview creation form (see #1 for screenshot of a "shell")
- if framing is not allowed (e.g.,
Content-Security-Policy: frame-ancestors 'none'
) then a UI with a full window version of the list of existing Rapid PREreviews and the Rapid PREreview creation form is displayed (and complemented by metadata about the preprint (title etc.)).
The list of existing rapid PREreviews will be complemented with a summary view (interactive data visualization) allowing the user to quickly visualize aggregated results.
In both case a (permanently dismissible) call to action to install the Rapid PREreview browser extension is displayed.
When the user is not logged in (or is logged in but has already posted a Rapid PREreview), the UI to create new Rapid PREreviews is not displayed (a call to log in is added when the user is not logged in).
Note: this page is relatively similar to the one provided by PREreview with the main difference that the UI is designed to be able to also work in an extension context where we do not have control on the host page. It will be relatively easy to backport the structured review functionality to PREreview (allowing users to select the Rapid PREreview template from PREreview) or to modify the PREreview page to use a similar overlay UI and leverage the web extension described below.
Web extension
Note: development of the web extension will only start after the other parts of the MVP have been completed.
The goal of the web extension is to bring the features of Rapid PREreview where / when the user need it (therefore reducing the effort needed to write or request Rapid PREreviews). The extension is designed so that if a user visit a preprint, he/she is informed (in a non intrusive way) that he/she can Rapid PREreview it immediately (and without context switch) or ask for it to be reviewed (see upvotes and scores above).
Popup icon
the popup icon is part of the browser and lives next to the browser URL and as such is visible at all time
The icon is "highlighted" (different color / icon etc.) when:
- user is on a preprint content page that has been reviewed by members of the Rapid PREreview community (in this case the icon is complemented by a badge indicating the number of Rapid PREreviews)
- user is on a preprint content page that could be reviewed with a rapid PREreview
- user is on a preprint content page object of a "request for rapid PREreview" (in this case the icon is complemented by a badge indicating the number of requests (upvotes))
Popup UI
Clicking on the popup icon opens a popup window/menu (located right below the popup icon) containing (when relevant):
- An invitation for the user to start to write a Rapid PREreview for the page currently visited by injecting new overlay UI to the page (see content script section below)
- An invitation for the user to request for Rapid PREreview for the page currently visited
- The list of preprints for which users have requested Rapid PREreviews sorted by score (see definition above)
- A feedback section to improve the quality of the extension and allow users to easily:
- report URLs where the popup icon should have activated but didn't
- report URLs where the popup icon should not have activated but did
Content script
features injected by the extension to the webpage currently visited by the user
The content script will share its code with the Rapid PREreview creation and display page (see section above) and inject 2 UI elements (working as overlay) to the page visited:
Rapid PREreview editor
Rapid PREreview creation form displayed in a shell
Existing Rapid PREreviews panel
Panel (or shell) containing a list of existing Rapid PREreviews for the visited page content
Note: the web extension could easily be generalized to PREreview if proven useful (and we will track usage / adoption data).
See also:
#1, #3, #4, #6
History: