Author Topic: v16β - Ellipsis for shortened Notes  (Read 4489 times)

Paolo F Cantoni

  • EA Guru
  • *****
  • Posts: 8135
  • Karma: +228/-128
  • Inconsistently correct systems DON'T EXIST!
    • View Profile
v16β - Ellipsis for shortened Notes
« on: January 10, 2022, 04:57:23 pm »
Many of our items (especially those in our ontological models) have lengthy definitions and/or descriptions (sometimes many hundreds to - occasionally - thousands of characters) in the Notes field. We developed a mechanism to allow us to break these notes into separate portions. We created a "widget" (in this case the string "<--+-->"). By convention, text before the widget is the normative definition of the item (the notional "25 words or less"), whereas text following the widget is used for discursive narrative providing more detail about the item, its usage etc. We have a script to set the length of the visible notes to the start of the widget. Thus we only provide the full notes on the appropriate diagrams and no or minimal notes on the majority of diagrams.

The problem is that the script does such a good job of hiding the (larger) detail that often users aren't aware of "but wait, there's more!". We feel it would be most useful to provide an ellipsis character at the end of the shortened note display to indicate that there is more text but it is not visible. The use case I have outlined is our specific usage, but the use of the ellipsis to indicate a shortened note is of general applicability.

Thoughts?
Report,
Paolo
« Last Edit: January 10, 2022, 04:59:27 pm by Paolo F Cantoni »
Inconsistently correct systems DON'T EXIST!
... Therefore, aim for consistency; in the expectation of achieving correctness....
-Semantica-
Helsinki Principle Rules!

Richard Freggi

  • EA User
  • **
  • Posts: 383
  • Karma: +14/-7
    • View Profile
Re: v16β - Ellipsis for shortened Notes
« Reply #1 on: January 10, 2022, 09:11:05 pm »
hhhmmmm... why not use Notes for the short description and tagged values for the long semantic description?

qwerty

  • EA Guru
  • *****
  • Posts: 12735
  • Karma: +361/-295
  • I'm no guru at all
    • View Profile
Re: v16β - Ellipsis for shortened Notes
« Reply #2 on: January 10, 2022, 10:34:57 pm »
I think the ellipsis is generally a good idea. The question would be IF and HOW it would be implemented.

TVs are for stereotyped elements (that's why they are stereotype properties!) and have a sematic that should be different from a normative description (for which purpose you have the notes).

q.

Paolo F Cantoni

  • EA Guru
  • *****
  • Posts: 8135
  • Karma: +228/-128
  • Inconsistently correct systems DON'T EXIST!
    • View Profile
Re: v16β - Ellipsis for shortened Notes
« Reply #3 on: January 10, 2022, 10:40:01 pm »
hhhmmmm... why not use Notes for the short description and tagged values for the long semantic description?
Because we want to see them in the same compartment.  Also, why bother allowing a max length for Notes in the UI?   If you don't show the full notes, for whatever reason, you should indicate so.

We take the view that we need to tell the user that the "picture" they are seeing may not be "the full story".  For example, we automatically add a widget on a diagram if there are hidden relationships.  For the present, if we have truncated notes, we add a widget indicating that the descriptions shown may not be "the truth, the whole truth and nothing but the truth". ;)

To paraphrase a famous quote:  "There are lies, damned lies, and modelling diagrams"   ;D


Paolo


Inconsistently correct systems DON'T EXIST!
... Therefore, aim for consistency; in the expectation of achieving correctness....
-Semantica-
Helsinki Principle Rules!