Psychoanalytic-Electronic-Publishing / PEP-Web-User-Interface

Single Page App Graphical User Interface for PEP-Web
1 stars 0 forks source link

Replacement for hyperlinked Glossary entries #695

Closed nrshapiro closed 1 year ago

nrshapiro commented 1 year ago

The client has a feature to show a glossary "word cloud", which appears in one of the infocards, in addition to the popup glossary information. The words in the word cloud are linked as well.

Given the many problems with the glossary links, I had discussed with DT the possibility of removing the links to glossary words in the document, and keeping only the glossary infocard, which he said would be a good idea. Many of the matching terms that are marked up are "out of context", and shouldn't be linked anyway. For that reason, the markup code does try to skip marking up terms which are also "commonly used". But the code to do the linking does not consider context.

Unfortunately, after we discussed this, I realized the client provides the word cloud by tallying marked up words in the document. That allows it to show the more frequent words bigger, and of course, only display glossary terms used in the document. So for the current client as is, keeping the markup was necessary.

However, I have been thinking of ways to do this easily, with simple changes to the client and server.

In November, I looked into providing term frequency directly to the client from the server, and came up with a way that could be done cleanly and easily. This means that we could easily get rid of the markup altogether, and not have to work on ways to get around the links for users, such as fixes for the current click issues, and a switch to turn it off and on.

In fact, in testing my idea, it became a reality: the current server now appends a glossary word table in json format as a comment (for future use) at the end of each processed XML file, when it's regenerated by the new online XML converter. There's a switch in the server settings now to turn off the word glossary markup, and one to turn on the generation of the table. Since the table generation (as part of the test cases) is appended to the XML as a comment, it's simply ignored by the client, even when it's on and appended.

All that would be needed in the client would be a small change to use the table generated by the server to build the infocard with the word cloud.

FYI: @SophieMBennett

Glossary Terms Infocard:

image

Note: The card is designed like a word cloud, but either is not working correctly, or I'm not able to find an example where it works correctly. A word cloud shows the more frequent terms larger.

Definition from the web: Word Clouds (also known as wordle, word collage, or tag cloud) are visual representations of words that give greater prominence to words that appear more frequently. When using the Mentimeter word cloud generator, the words that are added most frequently by audience members will increase in size dynamically. This type of visualization can help presenters quickly collect data from their audience, highlight the most common answers and present the data in a way that everyone can understand.

ocappello commented 1 year ago

I really like this solution. I am not persuaded by the idea of a word cloud, which has a statistical relevance but not necessarily a glossological one (if the user is simply looking for clarification of words / themes). With a sensible presentation in the infocard, so the user knows exactly what they are looking at (i.e. a heading, ability to click on terms and these would pop up, i presume), i think we should go for this...

davidtuckett commented 1 year ago

I agree. Lets go with that. Good work.

SophieMBennett commented 1 year ago

@nrshapiro Re: the current notification on PEP-Web for the change to glossary function, I've now made a help page for the support site and posted links to it on social media.

The list of glossary terms seems to be limited to 20 words max - just noting this in case it's possible to extend it in the future, perhaps with the scrolling function discussed for other Info cards. https://github.com/Psychoanalytic-Electronic-Publishing/PEP-Web-User-Interface/issues/635

nrshapiro commented 1 year ago

@SophieMBennett - The number can be easily tweaked--that's in the client.

But when I can update the database and server in a week or so for the 2023 edition, the most frequent glossary words used in each article will be shown there. That's not true at the moment.

We can tweak it to eliminate any words hitting higher frequencies because of general use "common" language.

nrshapiro commented 1 year ago

This is now complete with the release of the 2023 data last week.

ocappello commented 1 year ago

OK, very sorry to re-open this issue. Sophie, Athena, and I are hearing more and more from users, formally (with 1 email) and informally from subs, that the old way of providing hyper-glossed words in the text was better. Working on my own research on PEP, I kinda have to agree. Not urgent, of course, given that we've just changed it and with good reason; but perhaps in the mid- to long-term we can revisit. This is a fantastic research tool that we're offering, unique and intuitive to use, I just want to make sure we're maximizing its value to our subs.

davidtuckett commented 1 year ago

This can be re-opened but not yet. There were two reasons for change - first, the pop ups were becoming very disorienting for reading; second we did not have a good way to look uo all glossary entries for a topic. I think that before making changes we need to explore options and do proper surveys. I am also uncertain what role the Glossary Term Formatting preference switch now plays. Revisit end April?

ocappello commented 1 year ago

very sensible, thanks @davidtuckett

we wanted to flag

SophieMBennett commented 1 year ago

@davidtuckett There is still glossary formatting in the glossary link pop-ups which can be turned on/off in the preference settings.

With glossary formatting: Glossary pop-up with glossary formatting

Without: Glossary pop-up without glossary formatting