CDR Tickets

Here's what I've found. The comments appear as they should when the RLSO or B/U QC report is run in my browser (Chrome); however, once I copy the report into Word, the formatting of comments within insertion elements (with either proposed or approved revision level) is thrown off. This happens upon copy/paste, before I run the macro. Here are the formatting issues:

1. The brackets around the comment and the word comment appear in regular text (not bold, not italicized).
2. The text of the comment itself matches the surrounding text of the inserted element - (i.e., bold for proposed insertions on the B/U QC report, bold and underlined for approved insertions on the same report). This text should also be bold and italicized.

CDR517309 (Cancer Genetics Overview) on QA contains some examples of inserted comments within the first paragraph of the summary.

I don't think the Background issue is related to this. I'm wondering if the older ticket related to advisory comments has something to do with it.
I'll take a look.

This does appear to be a problem with the CSS and probably the filters. However, I am surprised this issue wasn't caught during testing and hasn't been reported earlier.

Can you see how we missed you, ~juther? :-)

A little poking reveals that this specific problem is browser specific:

• IE: The [Comment: label displays without color and the insertion text isn't bold/italic

• Chrome: Looking good (in terms of comments inside insertion tags) but has other problems

• FF: It displays all comment text/labels as regular text.

I will now have to investigate if it's possible to modify the CSS in a way that Word will understand but - as you can see from the fact that the comments are displayed correctly in the QC reports - there's nothing wrong with the way the filters are creating the reports.

Thanks, Volker. I had been using IE (the default for QC reports, as you know), but I'll try Chrome and see if its problems are any less annoying. 🙂

I noticed the image captions are centered instead of being aligned and the TOC entries are underlined (which can easily be changed). That's the only things I noticed glancing over the document.

It'll still be annoying, not sure if it's less though.

While comments do look better in the Chrome version, tables unfortunately run off the page so I'd better stick with IE. 🙂

I found another work-around that might be useful but involves several (possibly too many) steps. There exists an online service allowing you to convert all HTML styles into inline styles. The user would need to

• save the QC report as a HTML document

• open the saved HTML document

• copy/paste the document into the webpage provided by the the project called juice

• save the output to a HTML document

• open the new document using Word.

The output in Word appears to look good. However, the text in tables is using a different font and font-size.

As Bob had suggested, in order for Word to process styles correctly those styles should be presented as inline styles. I was hoping to be able and preserve our styles and filters for the QC reports since those are working as expected but create a JavaScript tool to only modify Comment styles. This is how I stumbled across the tool juice listed above.

I found another work-around that might be useful but involves several (possibly too many) steps. There exists an online service allowing you to convert all HTML styles into inline styles. The user would need to

• save the QC report as a HTML document

• open the saved HTML document

• copy/paste the document into the webpage provided by the the project called juice

• save the output to a HTML document

• open the new document using Word.

The output in Word appears to look good. However, the text in tables is using a different font and font-size.

As Bob had suggested, in order for Word to process styles correctly those styles should be presented as inline styles. I was hoping to be able and preserve our styles and filters for the QC reports since those are working as expected but create a JavaScript tool to only modify Comment styles. This is how I stumbled across the tool juice listed above.

In case you'd like to try it out here is the link to the tool juice:
http://automattic.github.io/juice/

Volker and I reviewed the Juice tool together and unfortunately, tables run off the page with this output as well.

We discussed reverting the changes made in OCECDR-4482 on DEV in order to determine whether that caused the problem with the display of comments. If not, it might be a Word bug.

I've also noticed that additional white space appears on the QC report in place of comments that are not selected to be displayed. This might be related to the line breaks issue (OCECDR-4486).

We could use the following summary as an example: Genetics of Colorectal Cancer (CDR62863)

Increased the priority on this as discussed in our status meeting.

~juther, since I have a new computer I'm trying to recreate the original problem first. I've modified CDR62902 on DEV adding regular and inserted comments for editorial board and advisory board. With the default settings for the QC report I see the internal comments suppressed and the external comments displayed. However, I see both, the editorial and advisory, external comments displayed when I expected only to see the external editorial board comment.

Do we have additional problems with the display of comments?

I made some additional changes to 62902 on DEV to add comments within proposed and approved insertion elements in the first para. When you view the QC report in the browser, the comments look fine, but the formatting changes upon copy/paste into Word (see my first comment above). The display "takes on" the display of the surrounding text.

I am not seeing the Advisory Board comments with the default comment options selected (external, not advisory) so I think this is working as it should...

I am using the CWD and I'm using all default options for the QC report. When you're saying "the comments look fine" for the QC report you mean "the comments are not displayed", right? You've entered Internal comments which are not displayed for the default QC report settings.

When I copy this QC report to Word is shows exactly as in the QC report - the comments aren't displayed.

I do see a problem in my test cases underneath the table when the comment is loosing Italics and bold and the string "[Comment" is displayed without the red color after the copy/paste to Word.

QC Report Output

Word Display

QC Report Output

Word Display

Robin and I were looking at the different QC reports we were seeing and it turned out that the QC report I'm creating on the DEV-VM looks different from the appearance when Robin runs the report. However, I was able to reproduce Robin's behavior when running the QC report on Windows 10 using Parallels on my laptop.
I believe the problem is that the JavaScript for the report is not running in IE on the DEV-VM. There may be a specific setting on the DEV-VM preventing JS from running.

I still have questions about the different combinations of how Comment elements may be displayed in each of the different permutations of options.  However, I have rewritten how the CSS gets applied to the comment elements which preserves the formatting of the QC report when the text is copy/pasted into Word.

I followed ~bkline's suggestion of using inline CSS to markup these elements.

Once I've talked with ~juther about the color palette of comments, these changes could be tested on DEV.

I've reviewed the changes on DEV (CDR62902) and I think we should avoid using different colors for comments in insertion/deletion markup. If we use colors, then we would need to treat them differently for RLSO and B/U QC reports; it also makes some comments stand out more than others, which could be misleading or cause us to miss some of them. I think we should have all comments appear in black bold, italicized text and not be concerned with what markup elements are around it. I also tested copying/pasting the summaries into Word and the CSS was preserved. Yay!

I've made the changes on DEV to set the CSS as discussed and ran a couple of QC reports with a bunch of Comments (OCECDR-4624 coming in handy).  So far everything is looking good for both, the QC output as well as the pasted display in MS-Word.

If you're happy with this, ~juther, we can push this change to the other tiers.

We're getting close 🙂. Comments inside proposed insertion/deletion elements are still green. They should be black. Other comments including those inside approved insertions look good! Thanks.

I've made additional changes to the filters

• CDR335166: Module: Checkbox Formatter

• CDR380957: Module: STYLE RS Insertion Deletion

Please verify on DEV.

Note: I will probably need to re-install these filters since Bob is in the process of setting up Joule on DEV.

Checking this on DEV but inserted comments are displaying in green/red on the RLSO QC report so I'm guessing these filters may need to be reinstalled. I'll stay tuned! Thanks.

I've re-installed the two modified filters.  Please give it another try.

Looks great on DEV. Thank you!

If Jira allowed me I would now add a Dancing Banana but I'll have to leave it at a simple: WooHoo!!!

The filters have been installed on QA and are ready for your review.

Verified on QA. Thank you!

The filter changes have been copied to STAGE and PROD:

• CDR335166: Module: Checkbox Formatter

• CDR380957: Module: STYLE RS Insertion Deletion

The following commits are including these changes:
https://github.com/NCIOCPL/cdr-server/commit/fbc47dbd0

Please verify on PROD.

Verified on PROD. Thank you!!