Glossaries. Over Coffee.

Mark and Chris and I had a long discussion about glossaries where we ended up with the simplified dialog box shown here.

The logic is that the user creates a new entry, as in the case of an entry for ‘Mark Anderson’ here. The text [in the hard brackets] is the brief summary which will appear if the reader chooses to view brief summaries. The main body text is full rich text, which the user can enter URLs into etc. and where any mentioned Glossary entries will be interactable.

There is further an option to save this entry into the person’s glossary or just keep it for this document only.

The Botton underlined ‘Mark’ is showing what other text strings will activate this glossary.

Glossary Logic: If the glossary entry is two or more words long, even though it can also be spawned on one (as shown in the screenshot in the blog entry referred to above), then if the single word spawn is followed by a capitalised word, it will not spawn. This is so that an entry can be for a name and if the author refers to another name where the first name is the same as what’s in a glossary entry, but has a different last name, it will not interfere.


Chris’ notes:


Audio record of the meeting (marked private):


And Chris’ notes via email later:


What we see here is the representation of a kind of relationship object which relates the following:

A search term within a scope [ “Mark” within the scope of the whole document ]

A (liquid) text #1 “Anderson Southampton PhD Student”. This is constrained to contain no structural elements (paragraphs etc.) but can have other elements (links, bold, etc.)

A (liquid) text string #2 “Mark Anderson\nHe is also at Southampton…”. This is constrained that it is a titled article, so the first text in the string must be a heading. The dialogue has chosen to place the rendering of the heading in a different part of the form, but editing it edits the text.

There is a heading relationship/range/whatever we call markup in this system, defined as the Mark Anderson text range at the start of text #2 to the end of character 13, indicating this is a title of level 1 within the article. This constrains the content that it may not contain additional markup. It also implicitly designates a section which exists between the start of this heading and the end of the flow of text, or the next title of the same or higher-level.