Skip to content
This repository has been archived by the owner on Mar 5, 2019. It is now read-only.

AmerMathSoc/AMS-Lens

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

88 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AMS Lens

Install

  1. Clone the AMS-Lens repository
$ git clone https://github.com/AmerMathSoc/AMS-Lens.git
  1. Fetch dependencies
$ cd AMS-Lens
$ npm install
  1. Run the server
$ npm start
Lens running on port 4001
http://127.0.0.1:4001/

With this work AMS provides extensions for the Lens reader to display JATS files with Math content, i.e. environments and formulas.

Visualization

Basically there are two important areas, the content panel displaying the article body, and the math panel showing math environments. In addition to math environments there are inline-formulas, display-formulas, and references to any of these.

In the content panel everthing is rendered in the common document flow.

Math environments consist of a title, a comment, and a body which if possible is started on the same line as the title.

image

A bracket is used to denote the range of the theorem for better distinction from common content. Additionally the bracket is used as a place for hihglighting and triggering user interaction.

Proofs are rendered in a rather conventional way, with a terminating q.e.d. symbol.

image

The math panel (on the righthand side) is used to show math content side-by-side with the articles text, e.g., to make it easier to follow a narrative containing a reference to a theorem.

image

At the moment, all environments are added to the math panel, and labeled display-formulas not being part of an environment which are referenced in the text.

Highlights are used to show all related resources (environments, references).

image

The scrollbar shows every related resource. To allow easy spotting of the original occurrence of an environment (or formula), a different styling is used for the highlight. This follows the basic idea of the Lens interface, that everything which is possibly referenced should be provided in a resource panel to allow side-by-side reading.

Interaction

There are several different scenarios how to interact with the math related content in Lens. The following describes in what actions are taken in the various cases.

  1. Click on a reference in the content panel:

  2. open the math panel and scroll to the referenced resource

  3. highlight all related resources and references in the content panel

  4. emphasize the original occurrence of the referenced resource

  5. highlight the resource in the math panel (to pinpoint the location of the currently focussed resource)

  6. Click on the header of a math resource within the math panel

1.2 - 1.4

  1. Click on the bracket of a math resource within the content panel

1.2 - 1.4

Generally, we avoid to change the scroll position within the content panel implicitly to preserve the current reading position.