Skip to content

Augmented References

I am proposing this new functionality for Reader, based on Visual-Meta export from Author, to really help kick the benefit of using this environment into high gear. I may or may not be able to implement this in time for my PhD work to be done, so I am simply adding it as an appendix. The idea is to implement an Augmented Reference section in PDF and to market it to teachers and students by making it clear that this makes an examiner’s or teacher’s job of going through the references much less laborious:

1) Give the user instant access to the citation sources when reading the document

2) Allow the user to choose how to Sort the Reference section in addition to the default ordering:
– Occurrence in the document with Headings to help show where the citations occur
– Time of Publication
– Media Type

3) User can click on any source in the References to see where they appear in the document

I plan to demonstrate this to prominent academics (I am already getting advice from a few), and then hopefully getting a quote someone along the lines of this aspiration:

The most powerful student-teacher authoring, citing and reading environment.
In addition to marketing to teachers how much time they save if their students use Author and then use Reader, the cover page will proclaim that:

“This PDF document was authored to provide
Augmented References when viewed in the free PDF viewer Reader
for macOS developed by the Future Text Initiative:

1) Enhanced In-Body Citation (in Reader, from Author)

Intent: This should make it easy for a student to access the source document cited in order to read it themselves and to let a teacher judge a citation if unknown to them.
The user can click on a citation in the body of a document to generate a pop-up showing that citation’s entry in the References section.
Click outside to dismiss, click on a DOI or URL to open in Browser or click on any other text to search Google based on that text.
Note: This should be designed so that in the future we can add buttons for Scholarcy integration.
This should work on author exported PDFs but also for PDFs with citations in a known format such as [1], (1) and (author date), although that can be for a 1.1 version, it is not necessary for 1.0 though in cases where the in-body citations are actual blue weblink to the References, it should definitely work though.
Visual: The box has a good size margin, as shown, with a single black frame:

Export from Author to Enable Augmented References

The process cannot presume that an examiner or teacher is reading the resulting PDF in any specific software, including Reader. However, the PDF generation could still support the examiner’s specific reading needs (by showing standard References) and do so more in Reader (by letting the user choose how to order the list). In all the views the citations are listed in the same was as if this was a listing by Title, apart from the ‘Author’ sorting, which will be sorted by ‘author’. In addition to the standard list, it will also include the following (default export will show up and no sorting will be selected/bolded by default): References Sorted By: Author | Title | Occurrence | Time | Media.

Author (alphabetical list by author’s last name)
Title (alphabetical by document/book title)
Occurrence (this a list of the citations as they occur in the document and this view shows all the headings in the document so that the author or reader can see what’s cited where.
Time (listing citations by date, starting with oldest)
Media (alphabetical by title within the sub categories)
– Books
– Journals (this is the primary use for this category, for the teacher to easily see if the
right journals have been used)
– Videos
– Web

Note that all these sorting are in full in the Visual-Meta, there is no need to re-parse in Reader. They will likely be in the JSON format. This should also enable easier extraction for graph views and other analysis.

2) Sorting The Reference Section

Intent: Allow the teacher to view the References in the most useful manner to get a good understanding of the student’s use of citations, with minimal effort and to allow a student the same, to decide what documents to read further.
‘Reader’ can parse this enhanced Reference section and make the list interactive, rather than spanning several pages, by having the References at the back of the document show ‘Author | Title | Occurrence | Time | Media’ after the title ‘References Sorted By:’, which the user can click on, as shown below. User can also click on ‘References’ to see the default view and then there will be no bolding.
Visual: Shown as double page spread, with Title in bold (since in this case should be by ‘Title’), with exactly the same layout, fonts and sizes as now, except the ‘Author | Title | Occurrence | Time | Media’ headings are clickable to sort/display the References in the desired order, with whatever order is shown being in bold. Initially only ‘References’ is in bold, since the view is the default view the author chose:

In this case the user can clicked ‘Title’ causing ‘Title’ to be bolded and the document sorted by Title. User can click again on ‘Title’ or on ‘References’ to show the default view again:

3) Reference Section Interactions

Intent: Allow the teacher to quickly see how the citations were used by the student and for a student to see the same, and to easily decide to access the documents to read further.
Toggle References/Document pages with two finger horizontal swipe (fast flip) or cmd-r (no visible flip, if possible)
Click on link (URL/DOI) to open in browser.
User can click on any non-link text to open the page (the citation appears in, ideally with the citation momentarily highlighting in yellow as a normal Find) in a fully functional page so that that the user can click on any citation to see a small dialog showing the References section in case the user wants to search for the citation in Google or access click on other citations to do the same.
This page will be placed on the same page/side as the citation was where clicked (not centre), full size, with a 1 pixel black (or white in Dark Mode) surrounding it, which can be drawn inside the document if this works better, since Reader draws a white frame around the PDF in normal view.
Click outside to dismiss.

Requirements & Other

Non-Author produced PDFs with citations should work, as far as is reasonable. integration should be possible in the future.
A new new cover page will be designed to add text explaining this feature and a more appropriate design, including adding to the bottom of the cover on export, as listed on the front of this document.

Published inPhDVisual-Meta

One Comment

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.