Issue Number | 4486 |
---|---|
Summary | [Summaries] Line Breaks Between Comments on QC Reports |
Created | 2018-05-25 15:54:01 |
Issue Type | Improvement |
Submitted By | Juthe, Robin (NIH/NCI) [E] |
Assigned To | Englisch, Volker (NIH/NCI) [C] |
Status | Closed |
Resolved | 2018-06-22 18:39:44 |
Resolution | Fixed |
Path | /home/bkline/backups/jira/ocecdr/issue.226725 |
If possible, we would like there to be a line break between comments that run together on RLSO and B/U QC reports.
Ideally, we would like responses to comments to be on the same line as the comment that precedes them, but I understand this may not be feasible. 🙂
When you say Line Breaks Between Comments are you thinking about having line breaks between two comments whenever you have those comments next to each other as in this example:
<para>This is some text <Comment source="editorial">An editorial board comment</Comment> <Comment source="advisory">An advisory board comment</Comment> More text following ...<Comment source="editorial">Another comment</Comment></para>
or would you like to have every comment start on its
new line (not thinking about the responses at the moment)?
The first option would display the example like this:
This is some text [Comment: An editorial board comment]
[AB-Comment: An advisory board comment] More text following...[Comment: Another comment]
The second option would display the same example like this:
This is some text
[Comment: An editorial board comment]
[AB-Comment: An advisory board comment]
More text following...
[Comment: Another comment]
Good question, and it points out something I should have mentioned in the requirements. We'd like there to be a line break between all comments and responses to comments that appear next to each other such that each comment appears on a new line EXCEPT when they are inside a para-level element, such as a table, para, list, etc. For example, we often add comments at the beginning of a summary section below the title and above the first paragraph. Those comments should ideally have a line break between them so that the comments are easier to read. Conversely, the comments in your example above, which are within a para element, should remain as is so as not to break up the paragraph on the QC report. Does that make sense?
Question about responses: You indicated not to add the line break for
the Response.
Is this true regardless of how many Response elements may be
following a comment?
I'm sure there will be exceptions, but I think that's fine as a general rule (and we'll manually add a line break if needed between multiple responses). Chances are the responses will also be associated with the same comment though if they are next to one another. Thanks for checking.
I've modified the rules to display the Comment and ResponseToComment elements with a line break if they are entered as a para-level element.
Ideally, we would like responses to comments to be on the same line as the comment that precedes them, but I understand this may not be feasible.
I've spend a significant amount of time to look into this request. As expected, it is not possible to keep the ResponseToComment on the same line without rewriting large parts of one of the filters. The problem is that both, the Comment and ResponseToComment will have to be grouped within a DIV element in order to setup the CSS to style this group. I think it would be possible to make these changes but I am questioning if the effort is worth it because the situation of a para-level Comment/ResponseToComment pair is not an extremely common occurrence from what I can see. However, I only looked at a few summaries as a sample.
Rewriting the filter could take up to a day followed by extensive testing. All 36 possible combination of comments display options will need to be tested after the rewrite.
~mbeckwit, ~vshields, how important is the request to display the response on the same line as the comment?
The following filters have been updated:
CDR0000335166.xml: Module: Checkbox Formatter
CDR0000380956.xml: Module: STYLE BU Insertion Deletion
CDR0000380957.xml: Module: STYLE RS Insertion Deletion
We discussed my question to ~mbeckwit at our status meeting and decided to leave the display of the comments and responses as it's currently implemented on DEV. Both, the section level Comment and the ResponseToComment elements will be be displayed on a separate line.
I think this looks okay on Dev. I looked at the Comments and Responses you put in at the beginning of 62902 under Incidence and Mortality, which are all on new lines.
QA verified.
These changes are now on PROD.
Closing ticket.
Elapsed: 0:00:00.001570