CDR Tickets

Issue Number 4276
Summary [Summaries] Display Module Content in different font color in summaries QC reports
Created 2017-06-13 16:40:40
Issue Type Improvement
Submitted By Osei-Poku, William (NIH/NCI) [C]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2018-04-05 13:34:31
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.210016
Description

It is important to differentiate content coming from a summary versus content from a module when reviewing summaries QC reports (BU and RLSO) that have been copied for editing in MS Word. The document usually gets passed around a few times and it becomes impossible to recognize text from the two sources. This sometimes makes it difficult to clearly identify which document to correct/update because there is no clear distinction in QC report and for that matter the Word document.

Would you please modify the summaries QC reports so that module text can be displayed differently from text coming from the summary document itself. Grey text or its equivalent for the module document is preferred.

Comment entered 2017-06-13 17:18:09 by Englisch, Volker (NIH/NCI) [C]

There are a few points we should discuss.

  • I think the request makes sense but I'm not certain everybody will agree with the change request.

  • I'm not certain if the goal is to have the QC report displayed differently or if the goal is to have the Word document display the module data differently. Our past experience has shown that not all CSS is being properly copied to the Word document. So it's possible we're adjusting the QC report but the change will get lost when copying the text to Word.

  • Before starting with the report changes I would like to have the formatting agreed on - different color background, different font style, different text color, etc. Would it be OK to loose some of the formatting for the module section?
    Let's first markup a document as a sample. What (hopefully short) summary could I use as a good sample?

Comment entered 2017-08-08 13:30:01 by Kline, Bob (NIH/NCI) [C]

: should we discuss Volker's questions in Thursday's meeting, so they don't fall through the cracks?

: can this go into the release-independent pile?

Comment entered 2017-08-08 13:47:41 by Englisch, Volker (NIH/NCI) [C]

We had already discussed this ticket but I forgot some of the answers:

  • Should the change be visible in the Word document?

  • How should the module text be displayed?
    We agreed not to use a grey background and I already started updating the filters on DEV to create a black border around module content, so I'm assuming this type of mark-up was in the running.

, yes I do believe this is just a filter change unless we want to be able to include an option to turn the new mark-up on/off.

Comment entered 2017-08-08 13:59:24 by Englisch, Volker (NIH/NCI) [C]

For my information:

  • CDR380958: Module: STYLE QC Summary
    The changes are in my trunk sandbox.

Comment entered 2017-08-08 14:12:30 by Kline, Bob (NIH/NCI) [C]

... unless we want to be able to include an option...

I'm moving the ticket into the Release Independent sprint since the ticket doesn't mention such a requirement.

Comment entered 2017-08-09 11:23:29 by Osei-Poku, William (NIH/NCI) [C]

◾Should the change be visible in the Word document?

Yes, it should be visible in a Word document.

◾How should the module text be displayed?
We agreed not to use a grey background and I already started updating the filters on DEV to create a black border around module content, so I'm assuming this type of mark-up was in the running.

Users prefer a change in text/font color rather than a border around the text. You may use this Hex color code B4ADAC for the font so we can review to see how it distinguishes the module text from the summary text.

Comment entered 2017-08-09 11:40:36 by Juthe, Robin (NIH/NCI) [E]

Can this be an option on the report interface? I don't think we will want the module text to always display differently. We try to make those kinds of things transparent to our Board members.

Comment entered 2017-08-09 12:02:32 by Kline, Bob (NIH/NCI) [C]

Moving this back into Gauss, then.

Comment entered 2017-08-09 12:49:28 by Englisch, Volker (NIH/NCI) [C]

Users prefer a change in text/font color rather than a border around the text.

Is the idea to still display red insertion markup red in modules? I'm asking because the requirement to have the module text color change also available in Word presents an additional challenge since this copy/paste process doesn't handle all CSS properly.

Comment entered 2017-08-09 13:26:24 by Osei-Poku, William (NIH/NCI) [C]

Yes. We do not expect anything to change in terms of existing markup colors.

Comment entered 2017-08-17 15:18:31 by Juthe, Robin (NIH/NCI) [E]

We talked about the possibility of adding text above and below module text to say "[Module Starts Here]" and "[Module Ends Here]", possibly with the name of the module built in. There will be an option of whether to include this text on the QC report interface.

Comment entered 2018-02-16 07:37:51 by Kline, Bob (NIH/NCI) [C]

: please assign story points for this ticket.

Comment entered 2018-02-16 17:53:59 by Englisch, Volker (NIH/NCI) [C]

I'm setting the story points to 5 mainly because the requirements aren't written in stone yet.

Comment entered 2018-03-15 14:16:13 by Juthe, Robin (NIH/NCI) [E]

We refined the requirements as follows:

1) We will add an option to the QC report interface to display this new module CSS change (see #2). The default will be NOT to display these changes.

2) The optional CSS change will add a box with a broken-line outline around the module text.

3) The CSS of this change should be preserved when users convert the document from the browser (IE) into Word using the "Edit with MS Word" option.

Comment entered 2018-03-19 17:15:52 by Englisch, Volker (NIH/NCI) [C]

Items (1) and (2) have been setup on DEV. However, figuring out exactly what styles Word will honor once the document has been pasted in is taking some time. Currently, I'm unable to paste the document into Word and keep the style to display the dashed border.

At the moment, the following filters have been modified:

  • CDR339576.xml: Module: InLine Markup Formatter

  • CDR335166.xml: Module: Checkbox Formatter

  • CDR335169.xml: Module: STYLE Default

In addition, the following program has been modified:

  • QcReport.py

Comment entered 2018-03-20 10:45:15 by Englisch, Volker (NIH/NCI) [C]

I'm unable to paste the document into Word and keep the style to display the dashed border.

, please markup a Word document to display the module in the way you'd like it to come out. I'm sure I will be able to replicate that look with CSS in the browser. I'm certain this approach will be easier than trying to find an appropriate style in HTML that's preserved when copied to Word.

Comment entered 2018-03-20 11:19:46 by Osei-Poku, William (NIH/NCI) [C]

I used Edit with Word function in IE to convert the Unusual Cancers summary QC report (please see attached). I don't see any major problems with that. It actually looks pretty good to me. I can see that tables do not have same consistent background as the the text only sections. Do you expect me to still markup a document or this should be good enough? My opinion is that if the Edit with Word function preservers the module display changes (and it does), then we can always use that function if we want to see the changes in Word.

Comment entered 2018-03-20 11:40:17 by Englisch, Volker (NIH/NCI) [C]

I don't believe this! I've been trying to convert the document all day yesterday but the dashed line was never preserved for me. We may have different versions of IE or Word. This make me worry that this solution won't last. :-( The next patch of either application might change the outcome.

I did not use the Edit with Word function. Could you please try to copy/paste and let me know if the dashed line is preserved?
If this looks good for you now I'd say we keep it.

Comment entered 2018-03-20 13:30:22 by Osei-Poku, William (NIH/NCI) [C]

Manually copying into Word did not preserve the dashed-lines for me too. However, since it works with when we use Edit with Word, it is okay with us. Thank you!

Comment entered 2018-03-20 14:06:55 by Englisch, Volker (NIH/NCI) [C]

Thanks for the confirmation, . I always thought copying and using the Edit with Word option were the same. We now have another variable to consider. :-)

Comment entered 2018-03-20 16:54:49 by Englisch, Volker (NIH/NCI) [C]

The following files have been updated in git:

  • CDR339576.xml: Module: InLine Markup Formatter

  • CDR335166.xml: Module: Checkbox Formatter

  • CDR335169.xml: Module: STYLE Default

https://github.com/NCIOCPL/cdr-server/commit/e1127ab [ hawking ]

In addition, the following program has been modified:

  • QcReport.py

https://github.com/NCIOCPL/cdr-admin/commit/3d9ba7b [ hawking ]

Comment entered 2018-03-20 17:07:38 by Englisch, Volker (NIH/NCI) [C]

By the way, I don't have that option Edit with Word and I'm assuming that none of us here at Shady Grove have that option enabled.

Comment entered 2018-03-20 17:25:32 by Kline, Bob (NIH/NCI) [C]
Comment entered 2018-03-20 17:43:06 by Englisch, Volker (NIH/NCI) [C]

Thanks , but the problem is not that a link to a Word document isn't opening the document in MS-Word but the fact that I don't have the option in IE to Edit this document in Word.

Comment entered 2018-03-20 18:35:38 by Kline, Bob (NIH/NCI) [C]
Comment entered 2018-03-21 11:56:48 by Englisch, Volker (NIH/NCI) [C]

Yes, that's how you would change the default editor for IE if Word were part of the drop-down list of available editors. I believe I could go into the registry to add Word as another editor option but I'm not certain other users would have the rights to do so. I will submit a ticket to find out why Word isn't currently available.

Comment entered 2018-04-04 16:03:45 by Osei-Poku, William (NIH/NCI) [C]

Are these changes on QA yet? The changes do not show in QC reports.

Comment entered 2018-04-05 13:26:04 by Englisch, Volker (NIH/NCI) [C]

Sorry, I had forgotten to pass the display module parameter:

Comment entered 2018-04-06 15:57:15 by Osei-Poku, William (NIH/NCI) [C]

Verified on QA. Thanks!

Comment entered 2018-05-10 12:43:01 by Osei-Poku, William (NIH/NCI) [C]

Verified on PROD. Thanks!

Attachments
File Name Posted User
Unusuals Module Markup.docx 2018-03-20 11:22:33 Osei-Poku, William (NIH/NCI) [C]

Elapsed: 0:00:00.001355