performant-software / textlab

A collaborative space for creating and publishing digital critical editions.
http://www.textlab.org
GNU General Public License v3.0
13 stars 4 forks source link

Diplomatic Text Display Filtering #222

Open jamiefolsom opened 4 years ago

jamiefolsom commented 4 years ago

Need capability to display transcriptions according to specific revision stages (ie, “Preliminary revision” only, or “Final revision, only”), as opposed to the two present choices of base and full diplomatic versions.

Here is where the stage contained in the change attribute is visible (in this case, StEa):

Screenshot 2020-06-24 14 07 55

Here is where the stages available in the project are listed:

Screenshot 2020-06-24 14 24 09
  1. We need a control, probably a select menu, at the top of the transcription page next to the Diplomatic/Base tabs (example), to allow the user to select one of the available stages, which are defined in [this config file.](Here's where the stages available to the Crane project are stored: https://github.com/performant-software/textlab/blob/master/tl_config/crane.js#L28-L32).
  2. Upon select, the application should visually highlight (change the appearance of) only parts of the diplomatic version of the text which are marked using a change attribute value that matches the selected stage value from the menu. Here's how some text is marked up when a stage is selected: <add place="above" rend="no-caret ink" hand="#SC" change="dStA" facs="" >Text</add>
  3. Since this only makes sense on the diplomatic tab, either we should switch to that tab upon select, and before highlighting, or we should only show the stage selection menu on the diplomatic tab.
Screenshot 2020-06-24 14 47 22
jamiefolsom commented 4 years ago

@timdunn22: couple of comments about this so far. Whitespace in the menu should be improved -- the width of the menu is insufficient for the full description -- it should be wide enough to show the whole line item.

There should also be whitespace to the left and right of the select option, to increase legibility.

Also, once selected, the full version of the value selected should shown, maybe above the tabs, so we know what we're looking at.

Screenshot 2020-06-27 10 35 52
timdunn22 commented 4 years ago

What this issue does?

  1. Shows different transcriptions for different stages of a given document.

How to test?

  1. Login and go to https://mel-textlab.herokuapp.com/transcriptions/16903
  2. Click on the Diplomatic tab and select the first item.
  3. Make sure the you are able to see transcriptions on the document that are different from the transcriptions you see when you click on the other menu item under the Diplomatic tab (scroll down to see the transcriptions for the second item)
SteveMarvin commented 4 years ago

Looks great!

jamiefolsom commented 4 years ago

The client has provided some feedback on this issue. We need to make the following changes:

  1. Each stage in the menu, when selected, should cause all changes which match that stage value to be displayed, as well as all of the changes which belong to any previous stage, that is: any stage with a lower array index in the config file.
  2. The effect should be a "cumulative view" of all changes up to and including those from the selected revision stage.
  3. The last stage value from the project config (eg this line for the Crane MS project) should be the default value selected from the filter menu when loading the transcription view: ie, the stage which would cause all changes to be displayed.

@timdunn22 @dleadbetter -- this is the specific part of this feature which is not working yet.

timdunn22 commented 4 years ago

What does this issue do?

  1. Shows different transcriptions for different stages of a given document.

    How to test?

  2. Login and go to https://mel-textlab.herokuapp.com/transcriptions/16903
  3. Make sure the you are able to see transcriptions on the document that are different from the transcriptions you see when you click on the other menu item under the Diplomatic tab (scroll down to see the transcriptions for the second item). You should see more changes for items that appear later on the menu.