Expand all

mobile.startup/references

Internal for use inside Minerva only. See module:mobile.startup for access.

Classes

ReferencesHtmlScraperGateway
Gateway for retrieving references via the content of the Page
Gateway

Abstract base class Gateway for retrieving references

Source:

Methods

referenceDrawer(props) → {module:mobile.startup/Drawer}static #

Drawer for references

Parameters:

Name Type Description
props Object
Properties:
Name Type Attributes Description
error boolean optional

whether an error has occurred
title string

of reference e.g [1]
text string

is the HTML of the reference
parentText string optional

is the HTML of the parent reference if there is one
isSubref boolean

true when this reference has a parent
onNestedReferenceClick function optional

callback for when a reference inside the reference is clicked.
Source:

Returns:

Type
module:mobile.startup/Drawer
Drawer for references

showReference(id, page, refNumber, pageHTMLParser, gateway, props, onShowNestedReference) → {jQuery.Deferred}static #

Fetch and render nested reference upon click

Parameters:

Name Type Description
id string

of the reference to be retrieved
page Page

to locate reference for
refNumber string

the number it identifies as in the page
pageHTMLParser module:mobile.startup/PageHTMLParser
gateway module:mobile.startup/references~Gateway
props Object

for referenceDrawer
onShowNestedReference function

function call when a nested reference is triggered.
Source:

Returns:

Type
jQuery.Deferred
Fetch and render nested reference upon click