CDR Tickets

Issue Number 3443
Summary [Deep-linking] Schema changes to include element for deep-linking to PDQ summaries
Created 2011-11-02 10:45:25
Issue Type Improvement
Submitted By Beckwith, Margaret (NIH/NCI) [E]
Assigned To Kline, Bob (NIH/NCI) [C]
Status Closed
Resolved 2012-07-26 14:42:01
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.107771
Description

BZISSUE::5137
BZDATETIME::2011-11-02 10:45:25
BZCREATOR::Margaret Beckwith
BZASSIGNEE::Bob Kline
BZQACONTACT::William Osei-Poku

We need to add elements to allow for deep-linking to PDQ summaries from other Cancer.gov content.

From document that Bryan handed out, it looks like these elements need to include: 1. PDQ CIS Deep Link Target Title (PDQ Cancer Info Summary Title + Permanent Link Target), 2. PDQ CIS Deep Link Target ID (value = Permanent Link Title ID), and 3. PDQ CIS Deep Link Target url.

I am not sure I totally understand where these elements should go in the schema, or whether I have it right, so we will need more discussion about it.

Comment entered 2011-11-02 11:07:36 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-11-02 11:07:36
BZCOMMENTOR::Bob Kline
BZCOMMENT::1

Four possible approaches come to mind. Perhaps I'll think of more after I've had more caffeine.

1. Use attributes instead of elements; e.g.:

<Para cdr:id="_1" PermaTargTitle="..." PermaTargId="..." PermaTargUrl="...">
:
:
</Para>

2. PermaTarg children of linkable elements:

<Table cdr:id="_2">
<PermaTarg>
<PermaTargTitle>...</PermaTargTitle>
<PermaTargId>...</PermaTargId>
<PermaTargUrl>...</PermaTargUrl>
</PermaTarg>
:
:
</Table>

3. PermaTargs block at top of Summary:

<Summary>
<PermaTargs>
<PermaTarg FragmentId="_3">
<PermaTargTitle>...</PermaTargTitle>
<PermaTargId>...</PermaTargId>
<PermaTargUrl>...</PermaTargUrl>
</PermaTarg>
<PermaTarg FragmentId="_4">
<PermaTargTitle>...</PermaTargTitle>
<PermaTargId>...</PermaTargId>
<PermaTargUrl>...</PermaTargUrl>
</PermaTarg>
:
:
</PermaTargs>
:
:
<SummarySection cdr:id="_3">...</SummarySection>
:
:
<Para cdr:id="_4">...</Para>

4. PermaTarg sibling elements:

<PermaTarg FragmentId="_5">
<PermaTargTitle>...</PermaTargTitle>
<PermaTargId>...</PermaTargId>
<PermaTargUrl>...</PermaTargUrl>
</PermaTarg>
<Para cdr:id="_5">...</Para>

This last option (as do #1 and #3) avoids the ugliness of having a structural child element in what is otherwise a mixed-content element (as would be the case for Para). Another way to avoid that ugliness would be to permanently forbid deep linking to such elements. The first option is in some ways the cleanest, but doesn't allow for inline markup of the values (e.g., couldn't have a superscript in the target title).

Let's discuss.

Comment entered 2011-11-08 12:22:04 by Beckwith, Margaret (NIH/NCI) [E]

BZDATETIME::2011-11-08 12:22:04
BZCOMMENTOR::Margaret Beckwith
BZCOMMENT::2

I am not sure I am going to be much help in sorting this out. I was hoping that this had all gotten worked out in those technical meetings that you and Alan attended with Bryan. Anyway, we can talk about it this Thursday.

Comment entered 2011-11-17 09:58:08 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-11-17 09:58:08
BZCOMMENTOR::Bob Kline
BZCOMMENT::3

Off-line email discussions with Bryan P. indicate that the purpose of the deep link target title is to identify the target within Percussion, not to provide the text which the reader of the linking page will see (that will generally be provided by the author of the linking document), so there is no need for multiple titles for a given target in our own documents. Therefore, the use of attributes should be OK. Next steps for this issue might be:

[ ] users identify one or more elements which can be targets
[ ] schema on Mahler is modified
[ ] publishing DTD on Mahler is modified
[ ] publishing filter on Mahler is modified
[ ] test summaries are modified, adding perma-targ attributes
[ ] test summaries are published and made available for testing

Comment entered 2011-11-22 08:57:13 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2011-11-22 08:57:13
BZCOMMENTOR::Bob Kline
BZCOMMENT::4

The users decided we'd start with just SummarySection elements.

[X] users identify one or more elements which can be targets
[X] schema on Mahler is modified
[ ] publishing DTD on Mahler is modified
[ ] publishing filter on Mahler is modified
[ ] test summaries are modified, adding perma-targ attributes
[ ] test summaries are published and made available for testing

Comment entered 2012-01-27 11:47:57 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2012-01-27 11:47:57
BZCOMMENTOR::Bob Kline
BZCOMMENT::5

See http://verdi.nci.nih.gov/tracker/show_bug.cgi?id=5089#c18

Comment entered 2012-01-30 11:56:18 by Kline, Bob (NIH/NCI) [C]

BZDATETIME::2012-01-30 11:56:18
BZCOMMENTOR::Bob Kline
BZCOMMENT::6

The schema changes are now in production, as part of the mobile support rollout, even though deep linking was dropped from the 6.4 release. Users should not make use of the new features until they have been tested further and the filter support for them is in place.

Comment entered 2012-07-26 14:41:43 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2012-07-26 14:41:43
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::7

(In reply to comment #6)
> The schema changes are now in production, as part of the mobile support
> rollout, even though deep linking was dropped from the 6.4 release. Users
> should not make use of the new features until they have been tested further and
> the filter support for them is in place.

We decided in today's CDR Meeting to close this issue.

Comment entered 2012-07-26 14:42:01 by Osei-Poku, William (NIH/NCI) [C]

BZDATETIME::2012-07-26 14:42:01
BZCOMMENTOR::William Osei-Poku
BZCOMMENT::8

Closing issue.

Elapsed: 0:00:00.000864