Issue Number | 3371 |
---|---|
Summary | [Media] Modify Vendor DTD to Process Audio Files |
Created | 2011-05-24 15:06:37 |
Issue Type | Improvement |
Submitted By | Englisch, Volker (NIH/NCI) [C] |
Assigned To | Englisch, Volker (NIH/NCI) [C] |
Status | Closed |
Resolved | 2011-07-27 18:13:27 |
Resolution | Fixed |
Path | /home/bkline/backups/jira/ocecdr/issue.107699 |
BZISSUE::5064
BZDATETIME::2011-05-24 15:06:37
BZCREATOR::Volker Englisch
BZASSIGNEE::Volker Englisch
BZQACONTACT::William Osei-Poku
The vendor DTD and the Cancer.gov DTD files need to be
modified.
Cancer.gov will need the updated DTD in order for the publish preview
report, which performs a DTD validation, to work.
BZDATETIME::2011-05-24 15:41:26
BZCOMMENTOR::Volker Englisch
BZCOMMENT::1
I've added the 'type' attribute to the MediaLink element and forwarded a copy of the DTD to Blair and Prasad.
pdqCG.dtd - R10093
BZDATETIME::2011-05-27 14:03:00
BZCOMMENTOR::Volker Englisch
BZCOMMENT::2
After Blair received the DTD changes he realized that the current implementation of Gatekeeper doesn't allow him to retrieve the Media information - which is only available indirectly via the GlossaryLink. In order to spare him from rewriting Gatekeeper completely we need to denormalize the Media information for him and put the MediaLink elements directly into the DIS documents.
I spoke to Lakshmi about this change and she felt that it would make sense to use a new element as a container for the pronunciation key and the MediaLinks. In case there might be any images included in the future, these should get attached to the element for which the illustration is for.
The new changes are as follows:
a) Add a new element 'PronunciationInfo' and remove
'TermPronunciation':
<!ELEMENT DrugInfoMetaData
( DrugInfoType,
DrugInfoAudience,
DrugInfoDescription,
DrugInfoURL,
Manufacturers?,
FDAApproved?,
TerminologyLink,
GlossaryLink,
USBrandNames?,
Synonyms?,
PronunciationInfo?,
FDAExternalRef? )>
b) Define the optional PronunciationInfo container to hold the TermPronunciation and MediaLink:
<!– Only MediaLink elements of type="audio/mpeg" are allowed here
-->
<!ELEMENT PronunciationInfo ( TermPronunciation?,
MediaLink* )>
BZDATETIME::2011-05-27 14:09:02
BZCOMMENTOR::Volker Englisch
BZCOMMENT::3
DTD updates to include MediaLink elements as part of DrugInfo's MetaData section.
Attachment pdqCG.dtd has been added with description: DTD updates for DrugInfo Summaries
BZDATETIME::2011-06-15 12:44:20
BZCOMMENTOR::Volker Englisch
BZCOMMENT::4
Attachment pdq.dtd has been added with description: New Vendor DTD Including Changes for Audio Files
BZDATETIME::2011-06-15 12:45:14
BZCOMMENTOR::Volker Englisch
BZCOMMENT::5
Attachment pdqCG.dtd has been added with description: New Cancer.gov DTD Including Changes for Audio Files
BZDATETIME::2011-06-15 12:57:08
BZCOMMENTOR::Volker Englisch
BZCOMMENT::6
Both, the vendor DTD and the DTD for Cancer.gov have been updated and have been tested.
Diff for pdq.dtd:
=================
MAHLER😃:\home\venglisch\CDR\Licensee>svn diff pdq.dtd
Index: pdq.dtd
===================================================================
pdq.dtd (revision 9838)
+++ pdq.dtd (working copy)
@@ -9,14 +9,7 @@
BZIssue::4629 - Vendor filter changes for GenProf publishing
BZIssue::4881 - Include DrugInfoSummary document type
Preliminary version
-
Revision 1.73 2008/04/02 22:09:55 venglisc
Reverting the change of v1.72.
Revision 1.72 2008/02/06 22:25:55 venglisc
Making DateFirstPublished optional element
-
-->
<!–
=============================================================
@@ -313,6 +306,7 @@
<!ELEMENT MediaLink (Caption*)>
<!ATTLIST MediaLink ref CDATA #REQUIRED
+ type CDATA #IMPLIED
alt CDATA #REQUIRED
inline (Yes|No) "No"
MinWidth CDATA #IMPLIED
@@ -510,6 +504,7 @@
===============================================================
-->
<!ELEMENT Protocol (ProtocolIDs,
+ UrlInfo,
FundingInfo?,
ProtocolSponsor*,
PDQProtocolTitle+,
@@ -1264,7 +1259,9 @@
TerminologyLink,
GlossaryLink,
USBrandNames?,
Synonyms? )>
+ Synonyms?,
+ PronunciationInfo?,
+ FDAExternalRef? )>
<!ELEMENT DrugInfoType (#PCDATA)>
<!– Types of DrugInfoType
@@ -1306,6 +1303,13 @@
<!ELEMENT Synonym (#PCDATA)>
+<!– Only MediaLink elements of type="audio/mpeg" are allowed here
-->
+<!ELEMENT PronunciationInfo ( TermPronunciation?,
+ MediaLink* )>
+
+<!ELEMENT FDAExternalRef (#PCDATA)>
+<!ATTLIST FDAExternalRef xref CDATA #REQUIRED>
+
<!ELEMENT DrugInfoTitle (#PCDATA)>
<!ELEMENT DrugInfoDisclaimer (%TextSectionElements😉*>
Diff for pdqCG.dtd (please note there are many comments
included):
==================================================================
MAHLER😃:\home\venglisch\CDR\Licensee>svn diff -r9607
pdqCG.dtd
Index: pdqCG.dtd
===================================================================
pdqCG.dtd (revision 9607)
+++ pdqCG.dtd (working copy)
@@ -9,6 +9,7 @@
BZIssue::4707
BZIssue::4629 - Vendor filter changes for Genetics Professionals
+ BZIssue::4949 - Changes for Display of DIS information
-->
@@ -304,8 +305,15 @@
<!ELEMENT Note (%TextElements😉*>
+<!– Making the type attribute mandatory
+ The type attribute needs to exist for Gatekeeper to being able
+ and properly process the MediaLink elements. This attribute is
+ optional in the vendor DTD but we want to ensure that it exists
+ when the documents are being pushed to Gatekeeper
+ ===============================================================
-->
<!ELEMENT MediaLink (Caption*)>
<!ATTLIST MediaLink ref CDATA #REQUIRED
+ type CDATA #REQUIRED
alt CDATA #REQUIRED
inline (Yes|No) "No"
MinWidth CDATA #IMPLIED
@@ -502,9 +510,9 @@
Protocols Start element Protocol.
===============================================================
-->
<!- For Internal use only:
+<!– [@@INTERNAL] For Internal use only:
RegulatoryInformation
OfficialProtocolTitle -->
+ OfficialProtocolTitle [INTERNAL@@] -->
<!ELEMENT Protocol (ProtocolIDs,
UrlInfo,
@@ -555,6 +563,8 @@
<!ELEMENT ProtocolSponsor (#PCDATA)>
+<!– [@@INTERNAL] For Internal use only:
RegulatoryInformation,
+ OfficialProtocolTitle -->
<!ELEMENT RegulatoryInformation (FDARegulated,
Section801?,
DelayedPosting?,
@@ -589,6 +599,7 @@
<!ELEMENT ResponsibleOrganizationName (#PCDATA)>
<!ATTLIST ResponsibleOrganizationName ref CDATA #IMPLIED>
+<!– End: For internal use only [INTERNAL@@] -->
<!ELEMENT PDQProtocolTitle (%TitleData😉*>
<!ATTLIST PDQProtocolTitle Audience (Professional | Patient)
#REQUIRED>
@@ -596,12 +607,14 @@
<!ELEMENT ProtocolTitle (%TitleData😉*>
<!ATTLIST ProtocolTitle Type (Official | Short) #REQUIRED>
+<!– [@@INTERNAL] For Internal use only -->
<!ELEMENT OfficialProtocolTitle (%TitleData😉*>
+<!– End: For internal use only [INTERNAL@@] -->
<!ELEMENT ProtocolAbstract (Professional, Patient)>
<!- For internal use only
ArmsOrGroups -->
+<!– [@@INTERNAL] For internal use only
+ ArmsOrGroups [INTERNAL@@] -->
<!ELEMENT Professional (Objectives,
Outcome*,
@@ -625,8 +638,7 @@
<!ELEMENT Outline (%TextSectionElements😉*>
<!- ArmsOrGroups is for internal use only -->
<!- ===================================== -->
+<!– [@@INTERNAL] ArmsOrGroups is for internal use only -->
<!ELEMENT ArmsOrGroups (ArmOrGroup*)>
<!ATTLIST ArmsOrGroups SingleArmOrGroupStudy (Yes | No)
#IMPLIED>
@@ -640,6 +652,7 @@
<!ELEMENT ArmOrGroupType (#PCDATA)>
<!ELEMENT ArmOrGroupDescription (#PCDATA)>
+<!– End: For internal use only [INTERNAL@@] -->
<!ELEMENT ArmOrGroupDescription (#PCDATA)>
+<!– End: For internal use only [INTERNAL@@] -->
<!ELEMENT EntryCriteria (DiseaseCharacteristics?,
PatientCharacteristics?,
@@ -973,6 +986,8 @@
Terminology Start element Term.
========================================= -->
+<!– [@@INTERNAL] For Internal Use Only: CTGovInterventionType [INTERNAL@@] -->
+
<!ELEMENT Term (PreferredName,
OtherName*,
Definition*,
@@ -1010,7 +1025,9 @@
<!ELEMENT SemanticType (#PCDATA)>
<!ATTLIST SemanticType ref CDATA #IMPLIED>
+<!– [@@INTERNAL] For Internal Use Only -->
<!ELEMENT CTGovInterventionType (#PCDATA)>
+<!– End: For Internal Use Only [INTERNAL@@] -->
<!ELEMENT TermRelationship (ParentTerm | RelatedTerm)+>
@@ -1193,6 +1210,8 @@
PhoneExt?,
Email?">
+<!– [@@INTERNAL] For Internal Use Only: UrlInfo [INTERNAL@@]
-->
+
<!ELEMENT CTGovProtocol (RequiredHeader,
IDInfo,
UrlInfo,
@@ -1298,10 +1317,6 @@
<!– End CTGovProtocol -->
<!- [@@INTERNAL]
=======================-
-->
<!- Begin DTD for Internal Use Only -->
<!-
=============================
-->
-
<!– ===========================================================
DrugInformationSummary start element DrugInformationSummary
=========================================================== -->
@@ -1314,6 +1329,7 @@
DateFirstPublished,
DateLastModified?)>
<!ATTLIST DrugInformationSummary id CDATA #REQUIRED>
+
<!– Note: The CDR Vendor Filter will ensure that the Section
elements
used within a DrugInformationSummary will not contain these
elements: AltTitle, KeyPoints, nested Section elements -->
@@ -1328,7 +1344,9 @@
TerminologyLink,
GlossaryLink,
USBrandNames?,
Synonyms? )>
+ Synonyms?,
+ PronunciationInfo?,
+ FDAExternalRef? )>
<!ELEMENT DrugInfoType (#PCDATA)>
<!– Types of DrugInfoType
@@ -1338,6 +1356,7 @@
<!ATTLIST DrugInfoType Combination (Yes) #IMPLIED>
<!ELEMENT DrugInfoAudience (#PCDATA)>
+
<!– Types of DrugInfoAudience
Possible values are:
Patients
@@ -1369,6 +1388,13 @@
<!ELEMENT Synonym (#PCDATA)>
+<!– Only MediaLink elements of type="audio/mpeg" are allowed here
-->
+<!ELEMENT PronunciationInfo ( TermPronunciation?,
+ MediaLink* )>
+
+<!ELEMENT FDAExternalRef (#PCDATA)>
+<!ATTLIST FDAExternalRef xref CDATA #REQUIRED>
+
<!ELEMENT DrugInfoTitle (#PCDATA)>
<!ELEMENT DrugInfoDisclaimer (%TextSectionElements😉*>
@@ -1376,6 +1402,10 @@
<!– End DrugInformationSummary -->
+<!– [@@INTERNAL]
=======================-
-->
+<!– Begin DTD for Internal Use Only -->
+<!–
=============================
-->
+
<!– Media element requested by Cancer.gov -->
<!ELEMENT Media (#PCDATA)>
<!ATTLIST Media Type CDATA #REQUIRED
BZDATETIME::2011-07-17 21:52:05
BZCOMMENTOR::Volker Englisch
BZCOMMENT::7
I noticed that the element UrlInfo was mandatory in the vendor DTD
despite the fact that the element is being removed from the vendor
output.
I made the element optional in the
pdq.dtd - R10122
prior to copying the DTD to production.
BZDATETIME::2011-07-17 23:38:47
BZCOMMENTOR::Volker Englisch
BZCOMMENT::8
The vendor and Cancer.gov DTDs have been copied to BACH:
pdq.dtd - R10122
pdqCG.dtd - R10114
BZDATETIME::2011-07-20 18:41:18
BZCOMMENTOR::Volker Englisch
BZCOMMENT::9
All of the changes are in production since Sunday night.
After we've gone through Friday's regular weekly publishing job without problems we should probably be able to close these issues.
BZDATETIME::2011-07-27 18:13:27
BZCOMMENTOR::Volker Englisch
BZCOMMENT::10
We encountered no problems during last weeks publishing jobs.
Closing issue.
File Name | Posted | User |
---|---|---|
pdq.dtd | 2011-06-15 12:44:20 | Englisch, Volker (NIH/NCI) [C] |
pdqCG.dtd | 2011-06-15 12:45:14 | Englisch, Volker (NIH/NCI) [C] |
pdqCG.dtd | 2011-05-27 14:09:02 | Englisch, Volker (NIH/NCI) [C] |
Elapsed: 0:00:00.000572