search

suttacentral / bilara

Our Computer Aided Translation software
10 stars 8 forks source link

notifications #152

Open sujato opened 1 year ago

sujato commented 1 year ago

background

Currently translators have no way of knowing when something happens on Bilara that they need to know about. We should have one simple system for notifying translators.

overall UI

On the Home page, when a translator logs in, there is a notice at the top of the page:

Notifications: you have XYZ notifications

Click on that, it takes you to /notifications.

There you have a list of all notifications, similar to https://github.com/notifications

Notifications may be of several types. Each type should be visually distinct. For now, we can just put

for every notification, include the segment number

Each notification should display the segment number. This is similar to the current search results in Bilara:

Screenshot from 2024-08-01 19-16-52

The segment number is linked to the appropriate page:

<a href="/translation/an4.122_translation-en-sujato#an4.122:3.1" title="Go to an4.122:3.1">an4.122:3.1</a>

This is used for all kinds of notifications, because sometimes the translator needs to see the text in the context of the whole page.

remarks

Remarks (or suggestions) are recommendations made by a proofreader. They are stored in the DB and are not committed to Github.

The original issue for this is here:

https://github.com/suttacentral/bilara/issues/14

This has a fairly detailed UI for remarks.

UI

Each remarked segment presents:

  1. your translation
  2. the root text
  3. proofreader’s suggested new translation
  4. any remarks by proofreaders (I am not sure if we have a separate field for this. Anyway, just work with whatever is there.)

The translator has three options:

  1. Click "accept" to replace the old string with the proofreader’s suggestion.
  2. Edit the string in place.
  3. Click to open the text at the segment.

changes to underlying texts

Translators typically work from both a root text (eg. Pali) and a translation (eg. English) into their language (eg. German). In such cases they will usually want to receive notifications to:

Note that this is notification per text. You only get a notification if you have made a translation of that specific sutta, not if there any change to the collection as a whole.

choose underlying notifications

There are no underlying texts by default.

Let us give each translator the option of choosing whatever they want to be notified of.

On the Home page, we can put a setting icon ⚙️ next to the notifications notice.

⚙️ Notifications: you have XYZ notifications

Click it, it gives a list of all projects. You can choose to be notified of changes to whatever you want.

UI

Each segment with underlying changes presents:

  1. your translation
  2. the root text
  3. the old underlying translation (mark with <del>)
  4. the new underlying translation (mark with <ins>)

The translator has two options:

  1. Edit the string in place.
  2. Click to open the text at the segment.

Here there is no option to "accept" changes.

split/merge

Any split or merged segments should be notified.

UI

Each split or merged segment presents:

  1. your translation
  2. the root text

The only difference is that:

The translator has three options:

  1. Click "accept" to confirm the change.
  2. Edit the string(s) in place.
  3. Click to open the text at the segment.