| Issue Number | 3465 |
|---|---|
| Summary | [Summaries] Changes to HP & Patient QC Report Interfaces and Display Options |
| Created | 2011-12-19 11:58:38 |
| Issue Type | Improvement |
| Submitted By | Juthe, Robin (NIH/NCI) [E] |
| Assigned To | Englisch, Volker (NIH/NCI) [C] |
| Status | Closed |
| Resolved | 2012-03-15 10:15:26 |
| Resolution | Fixed |
| Path | /home/bkline/backups/jira/ocecdr/issue.107793 |
BZISSUE::5159
BZDATETIME::2011-12-19 11:58:38
BZCREATOR::Robin Juthe
BZASSIGNEE::Volker Englisch
BZQACONTACT::William Osei-Poku
OCCM and CIAT have agreed on the following changes to the Patient & HP QC Report Interface and Display options:
Patient & HP summary QC reports:
-Do NOT display images by default. (show placeholder instead.)
-Hide the image caption as well as the image when the image is replaced
with a placeholder. (The image caption can look like summary text rather
than in image caption when the image does not appear above it.)
-Please list all display options under the heading, “Misc. Print
Options” rather than separating out Go Green options from other print
options. Please revise each action to begin with “Display…” so that each
checkbox selection results in a parallel action to the other selections.
(It’s confusing to have some options for displaying content and others
for hiding content.)
Patient summary QC reports only:
-Display To Learn More sections by default. (No change)
-Display Key Point boxes by default. (No change)
-Remove the “Check All” selection box. (This is not very helpful for the
3 GoGreen options now that they are being combined with other misc.
print options and some options will be selected by default and some will
not.)
-Remove the option to display level of evidence terms since this is not
applicable to patient summaries.
-Modify the interface display to bring up the misc. print options “above
the fold” and move the comment options down since those are rarely
altered from the default setting.
BZDATETIME::2012-01-04 16:07:02
BZCOMMENTOR::Volker Englisch
BZCOMMENT::1
(In reply to comment #0)
> -Display To Learn More sections by default. (No change)
> -Display Key Point boxes by default. (No change)
I just want to make sure:
You're saying here "no change" and I'm assuming the "no change" relates
to the output of the report since we will have to change the default of
the check-box from not checked to checked when we're changing the
wording from 'Replace' to 'Display'.
Am I correct?
BZDATETIME::2012-01-04 16:10:31
BZCOMMENTOR::Robin Juthe
BZCOMMENT::2
(In reply to comment #1)
> (In reply to comment #0)
> > -Display To Learn More sections by default. (No change)
> > -Display Key Point boxes by default. (No change)
> I just want to make sure:
> You're saying here "no change" and I'm assuming the "no change"
relates to the
> output of the report since we will have to change the default of
the check-box
> from not checked to checked when we're changing the wording from
'Replace' to
> 'Display'.
> Am I correct?
Correct! "No change" refers to the default output (but not the selection).
BZDATETIME::2012-01-04 16:55:23
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3
How about the sort order for the options? Is an alpha-sort OK?
[ ] Display glossary terms at end of report
[x] Display HP Reference Section
[x] Display images with placeholders
[x] Display Key Point boxes with placeholders
[ ] Display standard wording with mark-up
[x] Display To Learn More section with placeholder
BZDATETIME::2012-01-04 17:38:30
BZCOMMENTOR::Robin Juthe
BZCOMMENT::4
(In reply to comment #3)
> How about the sort order for the options? Is an alpha-sort OK?
Alphabetical is fine.
BZDATETIME::2012-01-05 09:23:09
BZCOMMENTOR::Robin Juthe
BZCOMMENT::5
We'd like to request one more minor change to the patient QC report interface. Could the "HP" be dropped from the option to “Display HP reference section” for the patient QC report options?
(Some CAM patient summaries have had references and at least one summary currently has references.)
BZDATETIME::2012-01-05 09:42:55
BZCOMMENTOR::Volker Englisch
BZCOMMENT::6
(In reply to comment #5)
> Could the "HP" be dropped from the option to “Display HP reference
section” for
> the patient QC report options?
Should we drop the "HP" completely or do you only want it to be dropped for patient QC reports?
BZDATETIME::2012-01-05 09:43:45
BZCOMMENTOR::Robin Juthe
BZCOMMENT::7
(In reply to comment #6)
> (In reply to comment #5)
> > Could the "HP" be dropped from the option to “Display HP
reference section” for
> > the patient QC report options?
> Should we drop the "HP" completely or do you only want it to be
dropped for
> patient QC reports?
Only on the patient QC report interfaces. Thanks.
BZDATETIME::2012-01-05 11:20:22
BZCOMMENTOR::Volker Englisch
BZCOMMENT::8
(In reply to comment #0)
> -Hide the image caption as well as the image when the image is
replaced with a
> placeholder. (The image caption can look like summary text rather
than
> in image caption when the image does not appear above it.)
I have addressed all items related to the display options on MAHLER
in the program
QcReports.py
However, the item above (suppressing captions in addition to images) requires a change of the related QC filters and will need to be handled separately.
BZDATETIME::2012-01-10 17:33:14
BZCOMMENTOR::Volker Englisch
BZCOMMENT::9
I just noticed a problem with the DIS QC report due to these
changes.
These need to be fixed and I don't want to forget it.
BZDATETIME::2012-01-18 13:53:20
BZCOMMENTOR::Volker Englisch
BZCOMMENT::10
(In reply to comment #0)
> -Hide the image caption as well as the image when the image is
replaced with a
> placeholder. (The image caption can look like summary text rather
than in
> image caption when the image does not appear above it.)
I talked to Robin about this and I feel that we should not hide the
image caption anymore. Given the fact that we are now implementing
automated table and figure numbering it may be hard to identify possible
problems with the numbering if the captions aren't displayed.
Since the main reason is that the captions can appear as part of the
regular text rather than the caption I will display the caption with the
same background as the caption placeholder box.
BZDATETIME::2012-01-23 17:02:06
BZCOMMENTOR::Volker Englisch
BZCOMMENT::11
I've included the Caption data to the replacement box but I'm not
certain if the caption had been displayed before when the image are
being displayed.
Please let me know if captions did display and I will need to tweak the
filter a little.
I've updated the filter
CDR339576 - Module: InLine Markup Formatter
This is ready for review on MAHLER.
BZDATETIME::2012-01-25 16:17:58
BZCOMMENTOR::Robin Juthe
BZCOMMENT::12
(In reply to comment #11)
> I've included the Caption data to the replacement box but I'm not
certain if
> the caption had been displayed before when the image are being
displayed.
> Please let me know if captions did display and I will need to tweak
the filter
> a little.
> I've updated the filter
> CDR339576 - Module: InLine Markup Formatter
> This is ready for review on MAHLER.
It appears the captions were displayed before only when they "lived" in the summary document itself (that is how it currently behaves on Bach). The captions are not displaying in either case on Mahler right now, so I think it should be tweaked to display the captions when they live in the summary doc, as on Bach. Thanks.
I noticed a few options that need to be changed on the QC report interfaces.
On the patient QC report interfaces:
1. Please change "Display images with placeholders" to "Display images" and uncheck the box since images should not be displayed by default.
2. Please change "Display Key Point boxes with placeholders" to "Display Key Point boxes".
3. Please change "Display To Learn More section with placeholders" to "Display To Learn More section".
On the HP QC report interfaces:
1. Please change "Display images with placeholders" to "Display images" and uncheck the box since images should not be displayed by default.
2. Please move the Misc. Print options block to be in between the comment types and the 911 option. We only wanted to move up the Misc. Print options on the Patient QC reports since the patient QC report users rarely adjust the comment types to be displayed.
BZDATETIME::2012-01-25 18:46:12
BZCOMMENTOR::Volker Englisch
BZCOMMENT::13
(In reply to comment #12)
> The captions are not displaying in either case on Mahler right
now,
I used the sample CDR62955 (first image) and here the captions do display in the 'Display Placeholder' version.
> 1. Please change "Display images with placeholders" to "Display images"
Done.
> 2. Please change "Display Key Point boxes with placeholders"
Done.
> 3. Please change "Display To Learn More section with placeholders"
Done.
> On the HP QC report interfaces:
> 1. Please change "Display images with placeholders" to "Display
images"
Done.
> 2. Please move the Misc. Print options block
Done.
BZDATETIME::2012-01-26 12:15:23
BZCOMMENTOR::Robin Juthe
BZCOMMENT::14
(In reply to comment #13)
> (In reply to comment #12)
> > The captions are not displaying in either case on Mahler right
now,
> I used the sample CDR62955 (first image) and here the captions do
display in
> the 'Display Placeholder' version.
You're right. The captions that live inside the summary document are displayed when the "display images" option is NOT selected and placeholders are shown. This looks good. However, when the "display images" option IS selected, captions that live in the summary doc do not display beneath the image on any of the QC reports - Patient or HP.
BZDATETIME::2012-01-26 12:20:21
BZCOMMENTOR::Robin Juthe
BZCOMMENT::15
(In reply to comment #13)
> > 1. Please change "Display images with placeholders" to
"Display images"
> Done.
> > 2. Please change "Display Key Point boxes with
placeholders"
> Done.
> > 3. Please change "Display To Learn More section with
placeholders"
> Done.
> > On the HP QC report interfaces:
> > 1. Please change "Display images with placeholders" to
"Display images"
> Done.
> > 2. Please move the Misc. Print options block
> Done.
Some of these options are not behaving as they should. At least one of these is probably a function of the most recent wording change.
For example, on the patient QC report:
checking off the "display key point boxes" results in the boxes NOT being shown. Unchecking the option displays the boxes.
To Learn More sections appear to always be displayed regardless of whether the option is checked.
I tried checking "display glossary terms at end of report" for a patient summary (CDR258119), and didn't see anything after the changes section.
BZDATETIME::2012-01-26 18:14:00
BZCOMMENTOR::Volker Englisch
BZCOMMENT::16
(In reply to comment #14)
> However, when the "display images" option IS selected,
> captions that live in the summary doc do not display beneath the
image on any
> of the QC reports - Patient or HP.
While I am looking at this I am realizing that the statement from
your original comment:
"The image caption can look like summary text rather than in image
caption"
is also true when the image is displayed. Since we're already making
changes I might suggest to change the display of the captions also when
the images are displayed. I could print the captions with the same
background as the images or I could display it in italics or centered
underneath the image or within the image box or any combination of
this.
If you don't like that idea (or think this change isn't really that helpful I'll just restore the display of the caption when the Display Images option has been selected.
BZDATETIME::2012-01-26 18:50:30
BZCOMMENTOR::Volker Englisch
BZCOMMENT::17
(In reply to comment #15)
> Some of these options are not behaving as they should.
I had a good talking to these options and they promised to behave from now on. Let's give them another chance.
BZDATETIME::2012-01-27 20:11:35
BZCOMMENTOR::Volker Englisch
BZCOMMENT::18
The image captions are now displayed for both options, when the
images are suppressed as well as when they are displayed. I've modified
the following filter:
CDR339576 - Module: InLine Markup Formatter
BZDATETIME::2012-02-02 16:54:50
BZCOMMENTOR::Volker Englisch
BZCOMMENT::19
The captions are now displayed without a background color but indented and centered in italic font.
Please have a look on MAHLER.
BZDATETIME::2012-02-10 12:15:44
BZCOMMENTOR::Volker Englisch
BZCOMMENT::20
I've updated the following filters to display the image captions for
both, the version with the images and the version with the image
replacement box, centered in italics:
CDR339576 - Module: InLine Markup Formatter
CDR380958 - Module: STYLE QC Summary
This is ready for review on MAHLER.
BZDATETIME::2012-02-16 10:38:01
BZCOMMENTOR::Robin Juthe
BZCOMMENT::21
(In reply to comment #20)
> I've updated the following filters to display the image captions
for both, the
> version with the images and the version with the image replacement
box,
> centered in italics:
> CDR339576 - Module: InLine Markup Formatter
> CDR380958 - Module: STYLE QC Summary
> This is ready for review on MAHLER.
This looks very good. I have just a couple minor tweaks:
1. Could you please remove the extra white space in between the image (or the image placeholder) and its caption?
2. Could you please add a little white space below the key point box placeholder?
3. Please make the "s" lowercase in the option to "Display Reference [S]ection" on the patient QC report interfaces and also in the option to "Display HP Reference [S]ections" on the HP QC report interfaces. (Just for consistency with the other options in the list)
Thanks! Let's talk about a good time to promote these changes. I'd like to be sure we give everyone a heads up before they are pushed to Bach.
BZDATETIME::2012-02-16 11:34:46
BZCOMMENTOR::Volker Englisch
BZCOMMENT::22
(In reply to comment #21)
> 1. Could you please remove the extra white space in between the
image (or the
> image placeholder) and its caption?
I had tried to adjust the white space for the version with the
placeholders to be nearly identical to the version with the
images.
What would you consider to be "extra" white space? Do you want no white
space at all between the colored box and the caption?
> 2. Could you please add a little white space below the key point
box
> placeholder?
Can I recycle the white space from the image captions? :-)
BZDATETIME::2012-02-16 11:38:16
BZCOMMENTOR::Robin Juthe
BZCOMMENT::23
(In reply to comment #22)
> (In reply to comment #21)
> > 1. Could you please remove the extra white space in between
the image (or the
> > image placeholder) and its caption?
> I had tried to adjust the white space for the version with the
placeholders to
> be nearly identical to the version with the images.
> What would you consider to be "extra" white space? Do you want no
white space
> at all between the colored box and the caption?
Ha- good question. No white space at all, please. I want it to be very clear that the text beneath the image is a caption for that image. However, I want to preserve the white space in between the placeholder and summary text that comes after it when a caption is not present, and also in between the caption and the summary text that follows.
> > 2. Could you please add a little white space below the key
point box
> > placeholder?
> Can I recycle the white space from the image captions? :-)
Sounds good. Way to be resourceful. :-)
BZDATETIME::2012-02-16 14:21:40
BZCOMMENTOR::Volker Englisch
BZCOMMENT::24
White space recycled, Ss lowered. I hope you'll like it.
This is ready for review on MAHLER.
BZDATETIME::2012-02-17 15:54:13
BZCOMMENTOR::Robin Juthe
BZCOMMENT::25
(In reply to comment #24)
> White space recycled, Ss lowered. I hope you'll like it.
> This is ready for review on MAHLER.
The white space and lack of white space both look lovely. :-)
I know we talked about promoting these changes today but I think it would be worth waiting to promote them to Bach until next week since some of us are publishing this afternoon and I don't want to throw anything off in the QC reports.
BZDATETIME::2012-02-17 16:22:34
BZCOMMENTOR::Volker Englisch
BZCOMMENT::26
(In reply to comment #25)
> I know we talked about promoting these changes today but I think it
would be
> worth waiting to promote them to Bach until next week
No problem. It only takes about 30 minutes to move everything to BACH. I can do that any time.
BZDATETIME::2012-02-22 13:46:24
BZCOMMENTOR::Volker Englisch
BZCOMMENT::27
On Friday Robin had said I should hold off to copy these changes until this week but since Robin is out this week I'm not certain if she wanted me to copy the changes without her being here or better wait?
I'll wait until Robin comes back or tells me to go ahead.
BZDATETIME::2012-03-01 09:02:38
BZCOMMENTOR::Robin Juthe
BZCOMMENT::28
(In reply to comment #27)
> On Friday Robin had said I should hold off to copy these changes
until this
> week but since Robin is out this week I'm not certain if she wanted
me to copy
> the changes without her being here or better wait?
> I'll wait until Robin comes back or tells me to go ahead.
Please promote these changes to Bach. Thanks.
BZDATETIME::2012-03-01 10:34:35
BZCOMMENTOR::Volker Englisch
BZCOMMENT::29
The following program and filters have been copied to FRANCK and
BACH:
QcReports.py - R10336
CDR339576 - Module: InLine Markup Formatter - R10337
CDR380958 - Module: STYLE QC Summary - R10337
Please verify on BACH and close this bug.
BZDATETIME::2012-03-15 10:15:26
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::30
(In reply to comment #29)
> The following program and filters have been copied to FRANCK and
BACH:
> QcReports.py - R10336
> CDR339576 - Module: InLine Markup Formatter - R10337
> CDR380958 - Module: STYLE QC Summary - R10337
>
> Please verify on BACH and close this bug.
No issues have been reported for this change so I am closing it. Thanks!
Elapsed: 0:00:00.001722