Display bibliographic citations as popups

[Conal-Tuohy]

Pop-up/floating boxes denoted by a book icon when ever a citation is encountered in the mss

• Pop-up should stay open, user should close the pop when done
• Show abbreviated citation (title, author, imprint info: date & place of publication)
  • Michelle will provide XPath to these elements once we do some TEI clean-up for the bibliography XML
  • Link title to anchor (#id) in the full bibliography listing

[mdalmau]

Here's how we have implemented the bibl pop-ups in dev: http://carbon.dlib.indiana.edu:8215/newton-dev/mss/dipl/ALCH00200/query/field1=text&text1=index%20chemicus. We would like for all citations in the Index Chemicus to render the pop-up per citation. @wehooper can make sure you have the latest TEI versions with the updated bibls. @ayarnell and Michelle will work on the TEI for the bibliography to do some clean-up of elements and propose what should display in the pop-up (team is still discussion).

[Conal-Tuohy]

Thanks, @mdalmau that's very helpful.

[Conal-Tuohy]

I've made the following additions and alterations:

• Added a new pipeline called chymistry:download-bibliography, to download the bibliography file from Xubmit. The Administration page has a button which invokes this pipeline by doing a HTTP POST to the URL /download-bibliography.
• Added a pipeline called chymistry:bibliography-as-html to display the bibliography as a single HTML page. The pipeline uses a very simple stylesheet to convert the listBibl into a web page.
• Edited the menus.json file to add a reference to the bibliography page to the "Online Tools" menu
  • Modified the existing pipeline for converting an individual MS into HTML, so that it first includes the entire <listBibl> from the bibliography into each MS file's <sourceDesc>, so that the full details of each citation are available for being rendered into the HTML Each <bibl> in the transcript is then rendered as a hyperlink, with a popup title attribute which is just the plain text of the full citation <biblStruct>.

So the plumbing is in place, but there are still questions of how to display an individual citation which are waiting for your input, @ayarnell and @mdalmau

[Conal-Tuohy]

I added the book icon

[Conal-Tuohy]

What should the popup show?

[wehooper]

I've been looking at the bibl popups in Keynes 13 (ALCH00001) and I like them and maybe the others will too. It's great to get the whole entry. Is there formatting in the message, italics, bold?

[Conal-Tuohy]

Cheers Wally. The popups are just native browser functionality of displaying an element's title attribute. That doesn't allow for formatting. But it would be easy enough to use some Javascript to display a popup div, if it's necessary to go beyond plain text. It seemed to me from looking at the XTF site, that the jquery-based mechanism used there to implement popups would be able to popup snippets of structured HTML, but that it was pretty much only fed plain text, for which HTML's title attribute is adequate.

[ayarnell]

@wehooper @mdalmau What do you think about leaving out the title page transcription from the pop-up? I think we had originally come up with the idea of the "short title" as a way of avoiding having the QFT in the pop-up, since it is kind of a lot of hard to read information for such a small space. Is it possible/desirable to format the information more like a standard citation? Like: Author. Title. PubPlace: Publisher, Year.

[Conal-Tuohy]

@ayarnell it's certainly possible (and super easy) to change the way the citation text is displayed, e.g. displaying only certain elements, displaying labels, and so on.

But NB if there's a requirement to display more than just plain text (i.e. bold, italics, centering of headings, etc) then I will need to add a feature to format the citation popup as an HTML div, and add Javascript code to pop it up, etc, whereas the mechanism used for the popup at the moment is just the browser's default feature of displaying the content of a title attribute.

[mdalmau]

Here's information, including XPaths, for the pop-up citations: https://iu.app.box.com/notes/545445019301. We are working through some of the details with the team, but all agree that it's a good start. Includes instructions for italics, for example. We will need these to be a Javascript or HTML/CSS pop-up since the box should remain until user either x'es out of box or selects a link.

[Conal-Tuohy]

done in https://github.com/IUBLibTech/newton_chymistry/commit/283df7253586ce4826667c45a2d4a302398c17be

[mdalmau]

Emailed the Newton team on 8 Dec 2019 for final feedback.

Hi, all,

Many weeks ago Con completed the integration of the pop-up citations in the Newton mss that Amy has completed thus far (mss before ALCH00032 roughly).

For example, you can see how the pop-up is working here: https://newton.dlib.indiana.edu/text/ALCH00001/normalized

Could you please review some examples and send your feedback ASAP (by Weds, 12/11), please?

The main thing I see is more of a design/interface thing and not anything we have funds to fix. It works. And if this is implemented in a slicker fashion for the Swinburne project, maybe we can use that code.

Thanks, Michelle

[mdalmau]

Hello Michelle and Con,

The latest version of the citation popups look good.

Removing the onMouseover in favor of a click does prevent the user experiencing unexpected popups when moving the cursor across a page: it's cleaner.

Then offering links to both the authoritative bibliography entry and any full text reproduction seems useful. Inevitably we found content issues like a missing title that we need to fix, but the machinery certainly seems to be working well.

This looks good too.

Wally and meeting