CDR Tickets

Issue Number 4482
Summary [Summaries] Remove Gray Background and Underlining from All Comments in QC Reports
Created 2018-05-25 15:32:57
Issue Type Improvement
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2018-06-14 18:10:16
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.226720
Description

Some comments display on RLSO or B/U QC reports with a gray background. This makes them more difficult to read, and it appears to be inconsistent. We haven't been able to identify the pattern of when the gray background appears and when it doesn't appear, but we'd like to remove the gray background from all comments. Additionally, some comments are underlined (I think when they are within insertion elements?). We would like to remove this underlining too. Thanks!

Comment entered 2018-06-05 15:05:27 by Englisch, Volker (NIH/NCI) [C]

Would you have a sample document including a comment with grey background?

Comment entered 2018-06-06 16:47:41 by Englisch, Volker (NIH/NCI) [C]

We haven't been able to identify the pattern of when the gray background appears and when it doesn't appear

Internal comments are displayed with a gray background.

Comment entered 2018-06-06 17:00:11 by Englisch, Volker (NIH/NCI) [C]

Additionally, some comments are underlined (I think when they are within insertion elements?). We would like to remove this underlining too.

That's correct! Comments within insertion markup are underlined and comments within deletion markup are strikethrough (or is it struckthrough?).

Do you only want the underline removed from the underlined comments as listed in your description or also the strikethrough removed from the comments within deleted sections, ?

Comment entered 2018-06-06 17:34:52 by Juthe, Robin (NIH/NCI) [E]

I don't think it's just internal comments. I will post an example of a summary that includes an external comment with a gray background. (CDR62863 on PROD) See page 38 for example. There are several external comments on that page and the next several pages that have a gray background (I think because they are within an insertion element?).

Comment entered 2018-06-06 17:35:32 by Juthe, Robin (NIH/NCI) [E]

Let's just remove the underlining. Chances are if the comment is within the deleted section, it should also be deleted. Thanks.

Comment entered 2018-06-06 17:41:39 by Englisch, Volker (NIH/NCI) [C]

I have the feeling we're going to have fun with this ticket. :-)

Comment entered 2018-06-08 12:26:13 by Englisch, Volker (NIH/NCI) [C]

On which server did you create this report? DEV, QA, or PROD?

Comment entered 2018-06-08 12:37:41 by Juthe, Robin (NIH/NCI) [E]

on PROD

Comment entered 2018-06-08 12:55:35 by Englisch, Volker (NIH/NCI) [C]

I see. You're trying to make things difficult. :-)

I was trying to recreate the report but now I see the comment you're referring to is within proposed text and I didn't include proposed markup in my QC report.

Comment entered 2018-06-08 13:06:15 by Englisch, Volker (NIH/NCI) [C]

I see now that we've used gray background for two types of comments:

  • Internal comments and

  • Proposed comments

Since both, comments and proposed text are displayed bold in the BU reports we added the gray background to have the comments stand out. The green in XMetaL stands out enough to quickly identify a comment but that's harder to do without color.

Comment entered 2018-06-12 10:37:16 by Englisch, Volker (NIH/NCI) [C]

The underline and gray background have been removed from the comments. The following files have been updated:

  • CDR380956: Module: STYLE RS Insertion Deletion

  • CDR380957: Module: STYLE BU Insertion Deletion

Committed to local repository: [ising 3f71eda5]

This is ready for review on DEV.

Comment entered 2018-06-13 16:09:54 by Juthe, Robin (NIH/NCI) [E]

This looks pretty good, although comments located within approved markup are still underlined. Would it be possible to remove the underlining from those comments and responses to comments? thanks.

Comment entered 2018-06-13 16:45:16 by Englisch, Volker (NIH/NCI) [C]

Could you let me know which document(s) you were looking at on DEV? I don't think I was seeing any publish markup.

Comment entered 2018-06-13 16:47:11 by Juthe, Robin (NIH/NCI) [E]

I wasn't looking at any publish markup either but there's approved markup (with comments inside it) in the Genetics of CRC summary (CDR62863).

Comment entered 2018-06-13 16:53:48 by Englisch, Volker (NIH/NCI) [C]

RS or BU report?

Comment entered 2018-06-13 17:08:31 by Englisch, Volker (NIH/NCI) [C]

Adjusting story points since this ticket will need some filter changes rather than a few simple CSS modifications.

Comment entered 2018-06-14 18:10:05 by Englisch, Volker (NIH/NCI) [C]

I've adjusted the display of comments within Insertion markup.

  • CDR0000380956.xml: Module: STYLE BU Insertion Deletion

https://github.com/NCIOCPL/cdr-server/commit/1eb7795

Comment entered 2018-06-21 15:14:35 by Juthe, Robin (NIH/NCI) [E]

We're getting close. 🙂 However, comments within approved insertion elements that have an Advisory Board source are still underlined (and also displayed with expanded character spacing). We'd like the text of these comments to appear just like other comments - no underlining, italicized, but not expanded character spacing. Sorry to be so picky! thank you. There's a sample marked up in the first paragraph of the Genetics of CRC summary on DEV (CDR62863).

Comment entered 2018-06-21 18:41:28 by Englisch, Volker (NIH/NCI) [C]

We never talked about the font style (italics) or font spacing. You still want comments to be displayed bolded everywhere and in addition struck when it's within deletion markup and this should be the same for every revision level and source, right?

Comment entered 2018-06-21 18:54:16 by Juthe, Robin (NIH/NCI) [E]

Yes, that's right. All comments should be italicized and bold with regular spacing for every source. But the ones in deletion markup should be struck through. Clear as mud? ;-)

Comment entered 2018-06-21 19:03:13 by Englisch, Volker (NIH/NCI) [C]

Good thing I'm asking. I understood from your last comment that you wanted to eliminate italics, too, but that's not the case.

This should be the same for the RS reports with the difference of red text color for comments within inserted text, correct?

Comment entered 2018-06-21 19:08:13 by Juthe, Robin (NIH/NCI) [E]

That's correct!

Comment entered 2018-06-22 14:25:59 by Englisch, Volker (NIH/NCI) [C]

The comments have been adjusted according to your specifications, . The two style filters have been updated:

  • CDR380956: Module: STYLE RS Insertion Deletion

  • CDR380957: Module: STYLE BU Insertion Deletion

https://github.com/NCIOCPL/cdr-server/commit/9d631ca

This is ready for review on DEV.
I have prepared CDR62902 with all possible combinations of comments to display; with, without markup, Insertion/Deletion markup, editorial board/advisory board comments, proposed/approved text, etc.

Comment entered 2018-07-06 18:03:37 by Englisch, Volker (NIH/NCI) [C]

, did you have a chance to look at these changes on DEV before we're finishing up development for Ising?

Comment entered 2018-07-10 11:06:58 by Shields, Victoria (NIH/NCI) [E]

Margaret and I looked at these changes on DEV and think they look good. Thanks!!

Comment entered 2018-07-18 15:36:22 by Beckwith, Margaret (NIH/NCI) [E]

QA verified.

Attachments
File Name Posted User
Genetics of Colorectal Cancer for WG 6_1_18.docx 2018-06-06 17:36:45 Juthe, Robin (NIH/NCI) [E]

Elapsed: 0:00:00.001389