Glossary Entry from External Source to WordPress

In order to allow for the desired  interaction there must be a format for the authoring application, whether WordPress web or Liquid Author to send this to the WordPress post for special viewing like this if the template supports it or as a basic use for non-optimised templates. I suggest:

  • some text and then the term which in this case is fish (⋮ a marine animal that swims https://jrnl.global/2018/11/30/fish/ ⋮) with other text to follow to better show context

This means that by default a short definition is shown with a link to the full definition but the plugin or theme can parse this (based on ⋮ by the closing and opening bracket) to allow for the interaction show on https://jrnl.global/2018/11/30/hyperglossary-in-document/ based on the creation method shown on https://jrnl.global/2018/11/30/posting-dialogue-with-in-situ-short-definition/

Term

Short Definition

Short definition in HTML text.

Long Definition

Short definition in HTML text including formatting and links etc.

This is a

Sentences of relationships with line breaks between each one.

Tags

Freeform tags separated by comma,

This term relates to previous terms

relationships – URL to post

 

_______________________

 

HTML for this:

<h1>Short Definition</h1>
Short definition in HTML text.
<h1>Long Definition</h1>
Short definition in HTML text including formatting and links etc.
<h1>This is a</h1>
Sentences of relationships with line breaks between each one.
<h1>Tags</h1>
Freeform tags separated by comma,
<h1>This term relates to previous terms</h1>
relationships – URL to post

Entry Format

Short Definition

This is where the text for the short definition would go.

Long Definition

This is where the text for a long definition would go.

This is a

The text from the field would simply go here.

Tags

Tags are listed here

This term relates to previously published terms

Relationship URL

Relationship URL

Relationship Terms

Relationships turned On

agrees with
cites as evidene
cites as potential solution
confirms
contains assertion from
corrects
credits
critiques
derides
describes
disagrees with
discusses
disputes
documents
extends
gives background to
gives support to
has citation characterization
includes quotation from
is agreed with by
is cited as authority by
is cited as potential solution by
is cited as recommended reading by
is cited as source document by
is cited by
is confirmed by
is corrected by
is credited by
is critiqued by
is derided by
is described by
is disagreed with by
is disputed by
is documented by
is extended by
is parodied by
is plagiarized by
is qualified by
is refuted by
is retracted by
is reviewed by
is ridiculed by
is speculated on by
is supported by
is updated by
likes
links to
provides assertion for
qualifies
refutes
replies to
retracts
supports
updates
uses conclusions from

Full list of Relationships

agrees with
citation
cites
cites as authority
cites as data source
cites as evidene
cites as metadata document
cites as potential solution
cites as recommended reading
cites as related
cites as source document
cites for information
compiles
confirms
contains assertion from
corrects
credits
critiques
derides
describes
disagrees with
discusses
disputes
documents
extends
gives background to
gives support to
has citation characterization
has cited entity
has citing entity
has reply from
includes excerpt from
includes quotation from
is agreed with by
is cited as authority by
is cited as data source by
is cited as evidence by
is cited as metadata document by
is cited as potential solution by
is cited as recommended reading by
is cited as related by
is cited as source document by
is cited by
is cited for information by
is compiled by
is confirmed by
is corrected by
is credited by
is critiqued by
is derided by
is described by
is disagreed with by
is discussed by
is disputed by
is documented by
is extended by
is linked to by
is parodied by
is plagiarized by
is qualified by
is refuted by
is retracted by
is reviewed by
is ridiculed by
is speculated on by
is supported by
is updated by
likes
links to
obtains background from
obtains support from
parodies
plagiarizes
provides assertion for
provides conclusions for
provides data for
provides excerpt for
provides method for
provides quotation for
qualifies
refutes
replies to
retracts
reviews
ridicules
shares author institution with
shares author with
shares funding agency with
shares journal with
shares publication venue with
speculates on
supports
updates
uses conclusions from
uses data from
uses method in

The Reader’s Experience

There are many ways to access the glossary data for the user and we will need to both experiment to find an optimal solution for the general user as a default option and provide naturally accessible options for any user with specific needs or preferences. We will be building a WordPress plugin to provide this functionality.

 

The design of what happens when a document with glossary terms attached is published to WordPress is difficult since there are so many ways it could be handled and there should be degrees of reveal for the reader without the reader being confused: It should be possible to not have any glossary text visible, to have the short definition visible and to access the full definition and then the full graph connected kahuna.

Visual tests

There should be a way to indicate that certain text has a glossary term available for reading but which is not opened up (in brackets to show the short definition). See are some tests using () ( • ∫  ‡ + ⋮ which should not stand out when scanning the page but be clear when reading a sentence. This is the same logic as Boldbeing designed to see when scanning a page but italicshould only call attention to itself when reading a sentence, it should not be eye-catching at page view level:

Experiments In-Situ

However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets Frode Hegland() However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets Frode Hegland( However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets Frode Hegland• However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets

However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets Frode Hegland∫  However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets Frode Hegland‡ However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets Frode Hegland+ However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets Frode Hegland⋮ However, the issue comes up that if the term is used at the end of a sentence it would be and that would be ugly, so therefore it seems best to make it fit inside brackets

Solution

One solution is to have the short definition in brackets but by default the view is with an icon after the glossary term which, when clicked, open (all of) the short definitions as shown below, with spaces either side of the brackets and a vertical ellipsisat the end⋮ to indicate click for options.

  • some text and then the term which in this case is fish⋮ with other text to follow to better show context

So the user clicks on ⋮ which then instantly in-line expands to show the short definition in brackets:

  • some text and then the term which in this case is fish ( a marine animal that swims⋮ ) with other text to follow to better show context

If the user clicks on the vertical ellipsis it opens to show options:

  • some text and then the term which in this case is fish ( a marine animal that swims⋮ [Hide] [Show Full Definition] ) with other text to follow to better show context

Here the user can click to Hide all the short definitions in the document or to open the web page which contains the definition in a new window/tab. This definition page will further have a link to show in a graph database or Liquid Space.

 

Other solutions considered for the future

 

Blue Dot

User can select text and if there is no glossary text selected or partially selected, a blue dot appears for the user to optionally mouse over:

If the user chooses to, options are revealed, including: To Copy as Citation, Copy High Resolution Link, perform searches, including of the current blog and choose to ‘highlight first occurrence of all glossary entries’:

If the user selects text and it includes text that matches a glossary entry, show the first sentence of the glossary entry in a pop-up box. The user can click on the entry itself to open the full blog post for this entry or click outside to close. The user can also click on the dot which is still there, to perform any normal dot interactions.

The user can furthermore mouse over the heading ‘Glossary’ for it to expand and show options. Further display options can include showing the first sentence of any glossary definition in the document in [hard brackets] which can be clicked on, with some icon* or through colours etc.

The very clear formatting of the glossary entries allows the system to feed any knowledge graph including the liquid space graph, where relationships are retained and can be shown and interacted with visually.

This approach is very simple and experimental, it could very well be characterised as a hack, but the reason for the work is to provide something useful in daily work which can then be improved upon in collaboration with users. Issues for the future include:

The question of whether the reader wants to access a glossary entry made when the document was authored or later, if the document was read much later. A solution to this can be to allow the built-in versioning system in WordPress to be surfaced to give access to earlier versions, if any are available or to lock the entries into the document on publishing, not to keep them separate.

Glossary Entries

Glossary entries can be authored from anywhere and stored as blog posts on a wordpress server. The reason for this is that wordpress pages are standard HTML pages and therefore are readable through many systems without concern for what might happen to any one specific access mechanism.

The glossary entry has the following attributes:

  • A subject/term, which is the text it refers to, with ‘,’ dividing terms if there are more than one. For example, an entry might be ‘OHS, Open Hyperdocument System’
  • Short Definition:The first sentence will be part of the normal body text but may be treated specially by the reader application/system
  • Long Definition:The fully body text, which may contain any valid HTML formatting including links, though links are suggested in a following field
  • ‘This is a’ with autocomplete to specify what type of entity is referred to, such as ‘human, author, British’
  • Specified relationships with other glossary terms.The authoring application may provide this in any of several different interface styles but the result is that the user can semantic meaning which can be used in graphs such as:
    • was invented by [other term chosen]
    • is employed by [other term chosen]
  • List of URLs with suggested relationships, such as ‘personal’, company’ etc.

The post can also contain a reference to which glossary list it contains.

Glossary Entry Creation

The glossary entries can be created and stored as WordPress blog post articles with special, though human-understandable formatting using the Heading and body text only.

The author can create an entry in WordPress by simply assigning the Category ‘[Glossary Entry]’ and that’s all that’s required.

The user can also use external systems to create the entry in order to add further, useful meta-data, such as this in Liquid | Flow:

 

Apart from the Short Definition, all the fields are optional. Note that as the user types the short definition, it shows up in brackets after the glossary term in the heading, to better help the user see how it will potentially employed.

Further to the short definition, the user can:

  • Type a Long Definition with normal formatting including HTML
  • Specify that this entry is a: ‘Person, author’ or ‘company large’ etc….
  • Choose from a list of previously defined glossary terms which are presented in a popup, and assign a relationship to this using plain text which will be auto-completed based on previously used terms
  • Specify associated URLS with relationships, such as: ‘Person, author’ or ‘company large’ etc….

The user can click on the bottom left text to load hyperglossary.info and choose which wordpress blog this entry will be posted to.

We may also add a way for the user to specify a specific glossary here, rather than simply have all the terms go to a master glossary.