CDR Tickets

Issue Number 3956
Summary [Media/Summaries] Allow CitationLinks in Image Captions
Created 2015-08-13 13:00:32
Issue Type Improvement
Submitted By Juthe, Robin (NIH/NCI) [E]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2016-03-30 14:39:44
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.167488
Description

We would like to allow citation links in image captions. Many publishers require that the reference be provided in the caption (sometimes with additional text) and this can make for a lengthy caption when it is all written out.

Comment entered 2015-11-17 12:05:01 by Kline, Bob (NIH/NCI) [C]

As you can see from the screen shot, it looks like this is already allowed.

Comment entered 2016-02-18 10:55:10 by Learn, Blair (NIH/NCI) [C]

Needs investigation, what remains to be done? Has this gone through IA for the CancerGov front end? How does this work on the front end?

Comment entered 2016-02-19 15:38:07 by Juthe, Robin (NIH/NCI) [E]

I'm checking with Sharon on this since this was her request. We use CitationLink elements, as opposed to CitationRefs (as in the screenshot), but those are allowed too. Sharon may have meant in the media doc itself (where CitationLink elements are allowed in the caption but aren't formatted correctly), but I'm checking on that.

Comment entered 2016-03-01 09:58:32 by Juthe, Robin (NIH/NCI) [E]

Here's some clarification. I think this is in part a Cancer.gov issue.

When a CitationLink element is added to the caption element in a summary doc (I'm not talking about the caption element in the media doc), the following things happen.

1. In the RLSO and Bold/Underline QC reports, the full text of the citation is expanded in the caption.

2. In Pub Preview, the citation is represented as a # in brackets, like our other citations. However, the link from the citation number to the citation in the reference list is not working.

3. On Cancer.gov, I think that the same thing happens as in Pub Preview, but I need to test this to confirm.

I mocked up CDR517309 on DEV as an example. The first media link element in that summary includes a CitationLink within the caption element in the summary.

Here's what should happen:

The citation should be converted to a number AND should be clickable as are other references in the summary. So, it looks like we may need changes to the QC reports, Pub Preview, and Cancer.gov. It was reported that this first became a problem with NVCG last year.

Comment entered 2016-03-01 10:03:22 by Kline, Bob (NIH/NCI) [C]

... this first became a problem with NVCG last year.

Does that mean that the the QC reports were working correctly before NVCG?

Comment entered 2016-03-01 10:05:47 by Juthe, Robin (NIH/NCI) [E]

I think that was just in reference to the link not working on Cancer.gov and in PP.

Comment entered 2016-03-02 12:30:22 by Kline, Bob (NIH/NCI) [C]

Please create a publishable version of 517309 on DEV with your CitationLink inside the Caption element (I'd do it myself, but you've got the document locked).

Thanks.

Comment entered 2016-03-02 14:00:17 by Englisch, Volker (NIH/NCI) [C]

I see the problem now. The link that's created inside the caption has the format of

...#cit.N

where N is the value of the refidx attribute of the reference but the format for the link should be

...#cit/section_S.N

where S is the number of the section, i.e. #cit/section_1.1 for the first citation of the first section.

This is not a CDR issue but a WCMS issue. The link inside a caption isn't formatted correctly.

Comment entered 2016-03-02 14:04:02 by Kline, Bob (NIH/NCI) [C]

We could probably insert a fix for publish preview, but that wouldn't help on the live cancer.gov, which we suspect is also broken (I'm waiting for Robin to create a publishable version of her test document on DEV).

Comment entered 2016-03-02 14:27:30 by Englisch, Volker (NIH/NCI) [C]

I prepared CDR350260 and ran a hot-fix to BLUE. Please see the figure caption, it's the same result as we see for PP.
http://www-blue-dev.cancer.gov/types/small-intestine/patient/small-intestine-treatment-pdq

Comment entered 2016-03-02 14:27:31 by Juthe, Robin (NIH/NCI) [E]

It looks like Volker has it checked out now. 🙂

Remember there's also an issue with the QC reports - RLSO and B/U. The title of the citation is appearing in the image captions rather than the citation #.

Comment entered 2016-03-02 14:30:23 by Englisch, Volker (NIH/NCI) [C]

Yes, the QC report is a different issue and that one we can fix at our end. I'm pretty sure it's a filter issue, so Bob, you may want to reassign this ticket to me.

Comment entered 2016-03-02 14:34:07 by Kline, Bob (NIH/NCI) [C]

I've already started digging into the QC filters. If I get stuck I'll reassign the ticket. Maybe to you. Maybe to Blair or Artii. :-)

Comment entered 2016-03-21 15:49:05 by Kline, Bob (NIH/NCI) [C]

Reassigned to Volker. Feel free to use this ticket for showing Aarti and/or Blair how the filters work.

Comment entered 2016-03-25 16:08:28 by Englisch, Volker (NIH/NCI) [C]

I'd like to clarify what needs to be done for this issue because the discussion is mentioning Cancer.gov, PublishPreview, and QC reports.

If I understand correctly, this ticket relates to the fact that a citation link within a caption isn't working properly. Since this type of link isn't working on Cancer.gov, the link also isn't working in PublishPreview.
This problem must be addressed in the Gatekeeper code as the CDR filters are doing the right thing and providing the necessary data. Therefore it's a GK fix.

The problem related to the QC reports, I think, was referring to the broken links within modules. We discussed this yesterday in our meeting but I don't think we have a ticket for this in JIRA.

Unlesss I'm wrong with my assumptions I will add the WCMS Dependency tag to this ticket.

Comment entered 2016-03-25 16:25:22 by Juthe, Robin (NIH/NCI) [E]

Sure, I'll try to clarify what I think is needed.

CDR issue:
Right not, in the RLSO and Bold/Underline QC reports, the full text of the citation is expanded in the caption. This is not right. Instead, the citation within a caption should be displayed as a linked citation number and the reference should appear in the reference list.

WCMS issue:
In PP and on Cancer.gov, citations within captions are converted to a # but the citation # is not a clickable link to the reference in the reference list, as it should be.

Comment entered 2016-03-25 17:06:32 by Englisch, Volker (NIH/NCI) [C]

OK, I will address the issue of the QC report.

Did you want me to enter a ticket for the links in captions on Cancer.gov or does such a ticket already exist?

Comment entered 2016-03-25 17:28:02 by Juthe, Robin (NIH/NCI) [E]

Thanks. I don't think there's such a ticket (I have not entered one) - that would be great if you could add one.

Comment entered 2016-03-30 14:39:16 by Englisch, Volker (NIH/NCI) [C]

The following filter has been modified to allow proper display of citations within figure captions:

  • R13828: CDR339576.xml - Module: InLine Markup Formatter

Comment entered 2016-04-07 17:28:07 by Englisch, Volker (NIH/NCI) [C]

Robin noticed a debugging message that was left in the code:

  • R13864: CDR339576.xml - Module: InLine Markup Formatter

Comment entered 2016-04-11 11:33:19 by Juthe, Robin (NIH/NCI) [E]

The rogue A's are gone. 🙂

This looks good on DEV. This issue refers to the QC reports only. Thanks!

Comment entered 2016-04-15 09:50:05 by Osei-Poku, William (NIH/NCI) [C]

It looks like we talked briefly about this yesterday in the status meeting. Is there currently a ticket to take care of the Cancer.gov issue? I just wanted to know the extent of testing that needs to be done for this issue. I assume currently on QC reports needs testing?

Comment entered 2016-04-15 13:04:37 by Englisch, Volker (NIH/NCI) [C]

Is there currently a ticket to take care of the Cancer.gov issue?

Yes, I've entered WCMSGK-46.

Only the QC reports have been addressed. The PP/Cancer.gov issue requires a Gatekeeper release which is not part of Darwin.

Comment entered 2016-04-15 18:10:17 by Osei-Poku, William (NIH/NCI) [C]

On QA, PP does have a clickable link. The only problem is that when you click on the link it does not take you to the list of citations within the summary. It rather takes you to the beginning of the summary. I assume this would be the same on PRODUCTION as well. The QC reports don't have clickable links at all on QA.

On DEV, PP does have a clickable link as well but the problem remains the same, clicking on the link doesn't take you to the list of citations. However, the QC reports are working correctly as they have clickable links and they also take you to the list of citations within the summary.

So, it seems to me that what needs to be addressed in PP (and Cancer.gov for that matter) is for the links to take you to the list of citations within the summary just as the the QC reports are currently doing correctly.

Comment entered 2016-04-15 18:20:03 by Englisch, Volker (NIH/NCI) [C]

That's correct. The problem with the PP report (and Cancer.gov) will not be resolved until the GK task has been put in production.

The QC reports don't have clickable links at all on QA.

Once Darwin IT-2 has been put on the QA server the QC reports will work just like on DEV.

Comment entered 2016-04-19 17:21:33 by Osei-Poku, William (NIH/NCI) [C]

When citation links are added to captions within a Media doc, the Media QC report does not show the citation link. The citation title is displayed just like it used to be in the summaries QC report before it was fixed. It will be good to fix this so that the link is displayed in the Media QC report. The PP display is the same as what has been identified above so it looks like it will be fixed when the PP problem is fixed.

When citation links are added to the captions within the Media doc and the media docs are added to a summary, the caption does not display at all in summaries QC reports. I think users are okay with this. If not, I will create another issue for a later CDR release.

Comment entered 2016-04-20 11:25:19 by Englisch, Volker (NIH/NCI) [C]

When citation links are added to captions within a Media doc, the Media QC report does not show the citation link.

If we need to have the citation shown in Media QC reports we should create a separate ticket to address the problem. I was under the assumption that this ticket was to address summaries only.
We should also decide how to handle a citation link within the Media QC report. In the Summary QC report we have a reference section and clicking the link will bring you to that citation. However, there are no citations displayed in a Media QC report.

Comment entered 2016-04-20 11:30:38 by Juthe, Robin (NIH/NCI) [E]

Yes, this issue is just related to the summary QC reports now that we have a separate ticket for PP/Gatekeeper.

William, do we use citations in media captions in the media doc? To my knowledge, we've only been using them in the captions of images in the HP summaries, where the caption is always added as a separate element in the summary doc.

Comment entered 2016-04-20 11:45:44 by Osei-Poku, William (NIH/NCI) [C]

I think it is okay to not make changes to the Media QC report giving the issue raised by Volker, which means the citations link has to always be added to the summary and it appears that is what is currently done. I tested the citations link in the Media QC report because captions could be stored in both the summary and the media report and the citation links are allowed in both places. Meanwhile, the Media QC report behaves the same as the summaries QC reports behaved until they were fixed in this issue.

Comment entered 2016-04-20 12:23:20 by Osei-Poku, William (NIH/NCI) [C]

I should mention however, that the other issue I found while testing was that when an image is added to a summary, the caption does not show in the summaries QC reports if the caption is only in the media doc. The caption does display in PP. I asked around and it looks like this is something that needs to be addressed. The caption should show in the summaries QC reports when the image is selected in the QC report interface. It looks like the problem is, which caption needs to display in the QC reports when there are captions in both the summary document and media document. I can put in an issue for discussion later.

Comment entered 2016-04-27 15:50:23 by Osei-Poku, William (NIH/NCI) [C]

Verified on QA. Thanks!

Robin, I am not changing the status of this issue since I am not the reporter. However, we have completed testing on QA.

Comment entered 2016-04-28 13:28:28 by Juthe, Robin (NIH/NCI) [E]

Verified on QA.

Comment entered 2016-05-16 09:37:16 by Osei-Poku, William (NIH/NCI) [C]

Verified on PROD.

Comment entered 2016-06-15 09:40:05 by Juthe, Robin (NIH/NCI) [E]

Closing this for now but we may need to revisit this issue as links are currently prohibited from image captions by Cancer.gov.

Attachments
File Name Posted User
2015-11-17 12_02_19-CDR Editor (DEV).png 2015-11-17 12:05:01 Kline, Bob (NIH/NCI) [C]
Caption Citation in BU QC Report.doc 2016-03-01 10:10:42 Juthe, Robin (NIH/NCI) [E]
Caption Citation in PP.doc 2016-03-01 10:10:55 Juthe, Robin (NIH/NCI) [E]

Elapsed: 0:00:00.001289