Bug 31923 - 'Ignore' tab description is misleading
Summary: 'Ignore' tab description is misleading
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: System Administration (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Caroline Cyr La Rose
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2022-10-21 18:21 UTC by Caroline Cyr La Rose
Modified: 2023-12-28 20:42 UTC (History)
3 users (show)

See Also:
Change sponsored?: ---
Patch complexity: String patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
This enhancement modifies the description of the 'Ignore' tab in MARC bibliographic and authority framework administration to add that not only does the 'ignored' subfield not appear in the editor, but the subfield will also be deleted from the record. This is the normal behavior of the 'Ignore' tab, it has not changed. Only the description was updated to reflect it's actual behavior.
Version(s) released in:
22.11.00


Attachments
Bug 31923: 'Ignore' tab description is misleading (3.24 KB, patch)
2022-10-21 18:42 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 31923: 'Ignore' tab description is misleading (3.35 KB, patch)
2022-10-21 21:35 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 31923: 'Ignore' tab description is misleading (2.80 KB, patch)
2022-10-21 21:40 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 31923: 'Ignore' tab description is misleading (2.88 KB, patch)
2022-10-21 21:46 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 31923: 'Ignore' tab description is misleading (3.24 KB, patch)
2022-10-21 21:52 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 31923: 'Ignore' tab description is misleading (2.80 KB, patch)
2022-10-21 21:52 UTC, Caroline Cyr La Rose
Details | Diff | Splinter Review
Bug 31923: 'Ignore' tab description is misleading (3.29 KB, patch)
2022-10-23 20:21 UTC, David Nind
Details | Diff | Splinter Review
Bug 31923: Add warning sign and span (2.84 KB, patch)
2022-10-23 20:22 UTC, David Nind
Details | Diff | Splinter Review
Bug 31923: 'Ignore' tab description is misleading (3.35 KB, patch)
2022-10-24 20:17 UTC, Katrin Fischer
Details | Diff | Splinter Review
Bug 31923: Add warning sign and span (2.89 KB, patch)
2022-10-24 20:17 UTC, Katrin Fischer
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Caroline Cyr La Rose 2022-10-21 18:21:36 UTC
When you are modifying a MARC bibliographic framework, you can choose in which tab a particular subfield appears, or 'ignore' it. 

The description under this choice is
'Ignore means that the subfield does not display in the record editor'

Which is true, but it doesn't mention that the subfield is completely removed from the record. This can cause data loss.

If you're not aware of this, the 'Ignore' description is a bit misleading.

I always instruct system administrators to use the 'Editor' checkbox if they do not want to see a particular subfield in the editor, and use only 'Ignore' if they really want to flush that subfield completely.

I think the description could be improved to add that values will be deleted from the subfield as well.

Maybe
'Ignore means that the subfield does not display in the record editor and that it's value, if any, is deleted from the record'
Comment 1 Caroline Cyr La Rose 2022-10-21 18:30:36 UTC
To see the Ignore tab in action,
1. Catalog a record with, for example, a value in 020$a
2. Save the record in MARCXML and view it in a text editor
--> The 020$a subfield is there
3. Go to Administration > MARC bibliographic framework
4. Edit 020$a and put it in the 'Ignore' tab
5. Edit the record
--> The 020$a field is not there anymore, which is normal and what the current description says
6. Don't change anything and save the record
7. Save the record in MARCXML and view it in a text editor
--> The 020$a subfield is gone completely
Comment 2 Caroline Cyr La Rose 2022-10-21 18:42:10 UTC
Created attachment 142440 [details] [review]
Bug 31923: 'Ignore' tab description is misleading

This patch modifies the description of the 'Ignore' tab in
MARC bibliographic and authority framework administration
to add that not only does the 'ignored' subfield not appear
in the editor, but the subfield will also be deleted from the
record.

To test:
1. Go to Administration > MARC bibliographic framework
2. Click 'Actions' next to any framework and choose 'MARC structure'
3. Click 'Actions' next to any field and choose 'Edit subfields'
4. Check the hint/description under 'Managed in tab' and make sure it
   - makes sense
   - is written in correct english (syntax and spelling)
   - mentions that the subfield's value will be deleted from the record
5. Go to Administration > Authority types
6. Redo steps 2-4 for authority frameworks
Comment 3 David Nind 2022-10-21 20:14:03 UTC
Hi Caroline.

Everything works as per the test plan.

For the grammar, "..it's.." should be "..its..". This is one of English's idiosyncrasies - would read as "..it is.." if expanded out, rather than the possessive! https://www.grammarly.com/blog/its-vs-its/

I was thinking, if possible, it may be useful to add a warning symbol before the text (the triangle icon with an exclamation mark), similar to what is on the Tools > Log viewer page.

I've also changed the assignee to you.

Thanks for creating the bug and fix from the IRC conversation (http://irc.koha-community.org/koha/2022-10-20#i_2457304).

I think that the option "Managed in tab: ignore" is quite misleading (but I can't think of a better option name that makes sense), as:
- there is no "ignore" tab, and
- it removes any values if the record is saved!

Testing notes (using koha-testing-docker):
- Record used for testing bibliographic record: 262 (Programming Perl), has an 020$a value
- Record used for testing an authority record: 1525 (Perl (Computer language)), used 040$c

David
Comment 4 Caroline Cyr La Rose 2022-10-21 21:35:28 UTC
Created attachment 142444 [details] [review]
Bug 31923: 'Ignore' tab description is misleading

This patch modifies the description of the 'Ignore' tab in
MARC bibliographic and authority framework administration
to add that not only does the 'ignored' subfield not appear
in the editor, but the subfield will also be deleted from the
record.

To test:
1. Go to Administration > MARC bibliographic framework
2. Click 'Actions' next to any framework and choose 'MARC structure'
3. Click 'Actions' next to any field and choose 'Edit subfields'
4. Check the hint/description under 'Managed in tab' and make sure it
   - makes sense
   - is written in correct english (syntax and spelling)
   - mentions that the subfield's value will be deleted from the record
5. Go to Administration > Authority types
6. Redo steps 2-4 for authority frameworks
Comment 5 Caroline Cyr La Rose 2022-10-21 21:40:08 UTC
Created attachment 142445 [details] [review]
Bug 31923: 'Ignore' tab description is misleading

This patch adds a small warning sign before the sentence and also puts
the sentence inside a span.
Comment 6 Caroline Cyr La Rose 2022-10-21 21:43:32 UTC
Hi David! Thanks for testing!

I corrected the "its". I also added a second commit with the warning sign.

I wasn't sure how to put a space between the warning sign and the sentence... Maybe someone could help?

Thanks!

Caroline
Comment 7 Caroline Cyr La Rose 2022-10-21 21:46:40 UTC
Created attachment 142446 [details] [review]
Bug 31923: 'Ignore' tab description is misleading

This patch adds a small warning sign before the sentence and also puts
the sentence inside a span.
Comment 8 Caroline Cyr La Rose 2022-10-21 21:52:25 UTC
Created attachment 142447 [details] [review]
Bug 31923: 'Ignore' tab description is misleading

This patch modifies the description of the 'Ignore' tab in
MARC bibliographic and authority framework administration
to add that not only does the 'ignored' subfield not appear
in the editor, but the subfield will also be deleted from the
record.

To test:
1. Go to Administration > MARC bibliographic framework
2. Click 'Actions' next to any framework and choose 'MARC structure'
3. Click 'Actions' next to any field and choose 'Edit subfields'
4. Check the hint/description under 'Managed in tab' and make sure it
   - makes sense
   - is written in correct english (syntax and spelling)
   - mentions that the subfield's value will be deleted from the record
5. Go to Administration > Authority types
6. Redo steps 2-4 for authority frameworks
Comment 9 Caroline Cyr La Rose 2022-10-21 21:52:29 UTC
Created attachment 142448 [details] [review]
Bug 31923: 'Ignore' tab description is misleading

This patch adds a small warning sign before the sentence and also puts
the sentence inside a span.
Comment 10 Caroline Cyr La Rose 2022-10-21 21:54:52 UTC
I think I managed the space, but I'm not sure if it is the right way to do it... Also I had to flex my (teeny tiny) git muscles quite a lot so I hope my submissions are OK!
Comment 11 David Nind 2022-10-23 20:21:55 UTC
Created attachment 142466 [details] [review]
Bug 31923: 'Ignore' tab description is misleading

This patch modifies the description of the 'Ignore' tab in
MARC bibliographic and authority framework administration
to add that not only does the 'ignored' subfield not appear
in the editor, but the subfield will also be deleted from the
record.

To test:
1. Go to Administration > MARC bibliographic framework
2. Click 'Actions' next to any framework and choose 'MARC structure'
3. Click 'Actions' next to any field and choose 'Edit subfields'
4. Check the hint/description under 'Managed in tab' and make sure it
   - makes sense
   - is written in correct english (syntax and spelling)
   - mentions that the subfield's value will be deleted from the record
5. Go to Administration > Authority types
6. Redo steps 2-4 for authority frameworks

Signed-off-by: David Nind <david@davidnind.com>
Comment 12 David Nind 2022-10-23 20:22:00 UTC
Created attachment 142467 [details] [review]
Bug 31923: Add warning sign and span

This patch adds a small warning sign before the sentence and also puts
the sentence inside a span.

Signed-off-by: David Nind <david@davidnind.com>
Comment 13 David Nind 2022-10-23 20:34:30 UTC
(In reply to Caroline Cyr La Rose from comment #10)
> I think I managed the space, but I'm not sure if it is the right way to do
> it... Also I had to flex my (teeny tiny) git muscles quite a lot so I hope
> my submissions are OK!

It looks OK to me, and the patch applied cleanly.

I changed the title of the commit message for the second patch so that it is different from the main patch.
Comment 14 Katrin Fischer 2022-10-24 20:17:50 UTC
Created attachment 142565 [details] [review]
Bug 31923: 'Ignore' tab description is misleading

This patch modifies the description of the 'Ignore' tab in
MARC bibliographic and authority framework administration
to add that not only does the 'ignored' subfield not appear
in the editor, but the subfield will also be deleted from the
record.

To test:
1. Go to Administration > MARC bibliographic framework
2. Click 'Actions' next to any framework and choose 'MARC structure'
3. Click 'Actions' next to any field and choose 'Edit subfields'
4. Check the hint/description under 'Managed in tab' and make sure it
   - makes sense
   - is written in correct english (syntax and spelling)
   - mentions that the subfield's value will be deleted from the record
5. Go to Administration > Authority types
6. Redo steps 2-4 for authority frameworks

Signed-off-by: David Nind <david@davidnind.com>

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 15 Katrin Fischer 2022-10-24 20:17:55 UTC
Created attachment 142566 [details] [review]
Bug 31923: Add warning sign and span

This patch adds a small warning sign before the sentence and also puts
the sentence inside a span.

Signed-off-by: David Nind <david@davidnind.com>

Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 16 Tomás Cohen Arazi 2022-10-24 20:26:53 UTC
Pushed to master for 22.11.

Nice work everyone, thanks!