Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Display of <expan> #260

Open
michaelnmmeyer opened this issue Jan 12, 2024 · 2 comments
Open

Display of <expan> #260

michaelnmmeyer opened this issue Jan 12, 2024 · 2 comments
Assignees

Comments

@michaelnmmeyer
Copy link
Member

I am not sure how I should display abbreviations, depending on the display mode. For:

 <expan><abbr>aug<am>g</am></abbr><ex>usti duo</ex></expan>

... I propose:

Physical:
Text: "augg"
Tooltip: "Abbreviation (expansion: augusti duo)"

Logical:
Text: "augusti duo"
Tooltip: "Expanded text (abbreviation: augg)"

Full:
Text: "auggusti duo"
Tooltip: "Abbreviation"

Is this ok?

We decided to use a background color for <abbr>. Should <am> have a peculiar format, too?

So far, <am> is not used, and we only find the pattern <expan><abbr>...</abbr><ex>...</ex></expan>, with a single occurrence of <abbr> + <ex>.

@arlogriffiths
Copy link
Collaborator

I never use expansions so I am not directly concerned... I approve of what you propose for Physical and Logical, but I don't see why display should be so undiplomatic in Full. I'd rather the abbreviation be displayed as such with some bracket or symbol marking that it is an abbreviation. The tooltip is not necessary in this display which is intended mainly for copy/pasting to print context.

@danbalogh
Copy link
Collaborator

I have never used expansions either, and especially the form with an "abbreviation marker" that is not part of the expanded abbreviation is expected to be very rare to nonexistent. It was included in the EGD just in case it occurs one day, because the provision exists in EpiDoc.

<abbr> plus <ex> without <expan> is an encoding error; <expan> must be present if the abbreviation is expanded.

Now some general thoughts. I think it is very important that expansions, if they are displayed at all, should be clearly indicated as non-original, preferably with hard markup (brackets of some sort), and not just colour. This applies to logical display as well as to the full one.
I also think that even in logical view, things present in the original (as the <am> in this example) should never be suppressed.
I do not think it is a good idea to show the contents of <abbr> in any kind of brackets, which would in my opinion be confusing to the reader. Brackets should be reserved for philological markup, and this is semantic business. If Arlo (and/or others) consider it important to have some sort of hard markup for abbreviations in any display, then a dagger or other symbol might be used, perhaps before rather than after the abbreviation, similarly to how personal and place names are indicated in the display.

Given the above, I propose the following, in all display modes:

  • display contents of <abbr> (and <am> if any) with light brown (or whatever we agreed on) background colour. The contents of these elements should always be displayed in every mode.
  • for <abbr> on its own (without <expan> and therefore without any other related elements), show tooltip with text "<abbr> is an abbreviation." E.g. "aug is an abbreviation."
  • for <abbr> within <expan>, with mandatorily present <ex> and optionally present <am>, compose the tooltip like this: "<abbr><am> is an abbreviation of <abbr><ex>." E.g. "aug is an abbreviation of augusti" (for <expan><abbr>aug</abbr><ex>usti</ex></expan>) or "augg is an abbreviation of augusti duo" (for <expan><abbr>aug</abbr><am>g</am><ex>usti duo</ex></expan>)
  • note that I don't think the tooltip should be eliminated in mixed mode. Its presence does no harm.

Beyond this, I'm not sure how far we should go. In my opinion, nothing beyond the above should be done in diplomatic view. I could imagine showing a dagger, as I suggest above, next to the abbreviation in logical and mixed mode,
I'm not at all sure that the contents of <ex> should ever be displayed in any mode other than through a tooltip. I would slightly prefer never to display it, but if Arlo or anyone else thinks displaying the expansion is essential, then I'm OK with showing it in logical and mixed mode. If it is shown, I propose that it should appear without the background colour for abbreviations, but with grey font colour, in angle brackets ⟨⟩, and in subscript. This would make the display similar to that of line numbers and milestones as well as to that of editorial emendations (which in my opinion makes intuitive sense), but the subscript would distinguish this from both of those things.
If this kind of display for <ex> is approved, then I further propose that simultaneously <am>, if it ever occurs, should be shown in superscript (without any brackets or suchlike).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants