CDR Tickets

Issue Number 4228
Summary XMetaL CSS Changes for Video
Created 2017-02-06 14:36:58
Issue Type Improvement
Submitted By Englisch, Volker (NIH/NCI) [C]
Assigned To Englisch, Volker (NIH/NCI) [C]
Status Closed
Resolved 2017-03-02 13:26:40
Resolution Fixed
Path /home/bkline/backups/jira/ocecdr/issue.202573
Description

We need to adjust the CSS for the new EmbeddedVideo element and its children

Comment entered 2017-02-06 14:39:26 by Englisch, Volker (NIH/NCI) [C]

I've made a few initial modifications to the CSS:

  • Summary.ctm

  • CdrCommonSchema.css

  • Summary.css

Additional changes are still necessary.

Comment entered 2017-02-14 14:41:11 by Englisch, Volker (NIH/NCI) [C]

reminded me that the Media document itself still needs to be updated.

Comment entered 2017-02-15 14:01:40 by Englisch, Volker (NIH/NCI) [C]

The following files have been updated to adjust the XMetaL display for the newly created element EmbeddedVideo and its child elements:

  • R14626: Display\CdrCommonSchema.css

  • R14626: Display\CdrCommonSchema_structure.css

  • R14626: Display\DrugInformationSummary.css

  • R14626: Display\GlossaryTermConcept_structure.css

  • R14626: Display\Media.css

  • R14626: Display\Media_Structure.css

  • R14626: Display\Summary.css

  • R14626: Display\Summary_structure.css

  • R14626: Rules\DrugInformationSummary.ctm

  • R14626: Rules\GlossaryTermConcept.ctm

  • R14626: Rules\Summary.ctm

This is ready for review on DEV.

Comment entered 2017-02-15 14:24:29 by Osei-Poku, William (NIH/NCI) [C]

Please revise the instructional text in the VideoType field. There seems to be an extra "an" in the text.

Comment entered 2017-02-15 14:57:26 by Englisch, Volker (NIH/NCI) [C]

Minor template rule changes (not related to the current set of changes):

  • R14630: Media.ctm

Comment entered 2017-02-15 15:06:51 by Osei-Poku, William (NIH/NCI) [C]

The instructions in the color field says " Select the color for this image (required) ". Should it say "video" instead of "image" ?

Comment entered 2017-02-15 15:08:24 by Osei-Poku, William (NIH/NCI) [C]

Verified. Thanks!

Comment entered 2017-02-15 16:10:08 by Englisch, Volker (NIH/NCI) [C]

I would think this should be a schema change. I can not imagine what the Color field for a video would be used for except maybe to indicate if the video is in black/white or color. In that case the entire text string is incorrect.
The element comes up because it's a mandatory child element for the ImageData and VideoData blocks but should - in my opinion - only be mandatory for ImageData.

Let's discuss at our meeting tomorrow.

Comment entered 2017-02-16 10:59:17 by Englisch, Volker (NIH/NCI) [C]

I'm adding as a watcher so that he can see the last comment regarding the Color element for videos.

Comment entered 2017-02-16 14:12:27 by Juthe, Robin (NIH/NCI) [E]

Please make the default value for the "Color" element Color.

Comment entered 2017-02-16 16:08:15 by Englisch, Volker (NIH/NCI) [C]

I've updated the template rules on DEV:

  • R14638: Media.ctm

Comment entered 2017-02-20 11:11:01 by Osei-Poku, William (NIH/NCI) [C]

I can confirm that the "color" value is displayed by default. However, the VideoHosting and HostingID elements are not added to the Media template by default when (VideoData) selected from the element's list. Is this intentional?

Comment entered 2017-02-20 11:36:08 by Englisch, Volker (NIH/NCI) [C]

the VideoHosting and HostingID elements are not added to the Media template by default

It hadn't been mentioned as an issue before. By default only mandatory child elements are included when inserting a wrapper element unless that's modified by the template rules.

Could you take a look and see if anything else needs changing so that I don't have to touch that file controlling the display multiple times for additional modifications?

Comment entered 2017-02-20 11:57:04 by Osei-Poku, William (NIH/NCI) [C]

The only other element that is not included in the default template is the DefaultVideoPresentationTemplate. I am not sure how that needs to be used so I am not sure if that needs to be included in the default template or not.

Comment entered 2017-02-20 12:02:29 by Kline, Bob (NIH/NCI) [C]

It's not required. You would use it to optionally specify the default rendering for the video (which could be overridden in turn by the EmbeddedVideo block in the linking document).

Comment entered 2017-02-20 12:05:41 by Osei-Poku, William (NIH/NCI) [C]

In that case, we can leave it out of the default template and let the user add it when appropriate.

Comment entered 2017-02-20 15:07:13 by Englisch, Volker (NIH/NCI) [C]

Just to clarify: You'd like me to include the VideoHosting and the HostingID elements in the template but not the DefaultVideoPresentationTemplate element, right?

Comment entered 2017-02-20 15:33:01 by Osei-Poku, William (NIH/NCI) [C]

That is right.

Comment entered 2017-02-20 16:18:22 by Englisch, Volker (NIH/NCI) [C]

The Media.ctm rules file has been updated and is ready for review on DEV:

  • R14642: Media.ctm

Comment entered 2017-02-20 17:12:48 by Osei-Poku, William (NIH/NCI) [C]

Since "youtube" is the only option for Video Hosting, please make it the default selection. Apart from that, everything else looks great.

Comment entered 2017-02-20 18:44:47 by Osei-Poku, William (NIH/NCI) [C]

Do you mean it is not required for the Media Doc Schema or by the DTD? When I choose to exclude the template element from both the media document and the summary document, I get the following error message. So, I assume we have to enter the element for at least one of the document types.

CDRPreview web service error: Xml data validation error,The 'template' attribute has an invalid value according to its data type.Validation error occurred when validating the instance document.,142,7

Comment entered 2017-02-20 18:52:16 by Osei-Poku, William (NIH/NCI) [C]

The Content Description block in the media document is required and won't let you validate the media doc without it. However, it doesn't look like that content is used for anything video. Unless there is a plan to use the block for video/animation purposes, could you make the block a non-required block when we drop in the video data block?

Comment entered 2017-02-21 11:11:10 by Englisch, Volker (NIH/NCI) [C]

youtube has been added as the default for the VideoHosting value:

  • R14648: Media.ctm

Comment entered 2017-02-21 11:14:20 by Englisch, Volker (NIH/NCI) [C]

Since the CSS changes are complete I'm reassigning the issue to for the additionally requested schema changes.

Comment entered 2017-02-21 11:30:10 by Kline, Bob (NIH/NCI) [C]

First of all, this is the wrong ticket for schema changes. Second, we need to stop changing the requirements, or Einstein will never get out the door. Third, having a description (however brief) is a good thing. It was added to the schema for accessibility requirements, and the fact that we don't have a place to publish the information for video doesn't mean that we'll never be required to use it for 508 compliance. The description is separate from the blocks for the specific media, so making it optional would remove the safety measure you have which prevents you from ending up with unpublishable image documents. This is one of the prices paid for the decision to use the existing Media document type instead of creating a separate document type for the video.

Comment entered 2017-02-21 11:47:35 by Englisch, Volker (NIH/NCI) [C]

Setting status to Resolved and Fixed for the CSS.

Comment entered 2017-02-21 11:59:59 by Osei-Poku, William (NIH/NCI) [C]

Verified. Thanks!

Comment entered 2017-02-21 12:08:37 by Osei-Poku, William (NIH/NCI) [C]

Verified on DEV. Thanks!

Comment entered 2017-02-21 16:34:35 by Osei-Poku, William (NIH/NCI) [C]

Could you please clarify the following? I asked a similar question above but didn't get an answer. When no value is selected for the DefaultVideoPresentationTemplate in the media doc, and no value is selected for the SpecificVideoPresentationTemplate in the summary, a python script error is displayed when trying to get PP for the summary. However, it appears that in both doc types, the elements are optional. Is there a requirement in the DTD for this value?

Comment entered 2017-02-21 16:42:24 by Englisch, Volker (NIH/NCI) [C]

Yes, the DTD requires a display template to exist.

Comment entered 2017-02-21 17:06:15 by Kline, Bob (NIH/NCI) [C]

(Shouldn't questions about the DTD be in OCECDR-3558?)

I'm looking at the DTD in version control, and it looks to me like it's optional. If you're going to change that, Volker (that is, the downstream consumers of the documents won't have a default for the layout as I thought they would), please have the export filter insert a reasonable default. Thanks.

Comment entered 2017-02-21 17:16:43 by Englisch, Volker (NIH/NCI) [C]

, could you please let me know what default value you'd like me to use?

, I won't be able to change this until tomorrow since I have to leave work now.

Comment entered 2017-02-21 17:21:18 by Kline, Bob (NIH/NCI) [C]

Are we sure there's not a default already in place for the videos currently displayed on the web site? If there is, let's give some consideration to being consistent with the rest of the site.

Comment entered 2017-02-22 11:37:25 by Englisch, Volker (NIH/NCI) [C]

I've added the display template Video75NoTitle as a default presentation template if none has been specified.

  • R14651: CDR271370.xml (Module: Vendor Filter Templates)

Comment entered 2017-02-22 11:39:43 by Kline, Bob (NIH/NCI) [C]

Who's the best person to check with to see if there's already a default for video layout on the web site?

Comment entered 2017-02-22 11:43:00 by Englisch, Volker (NIH/NCI) [C]

Why are you asking? Would you like to ask Michelle again? :-)

Comment entered 2017-02-22 11:53:38 by Kline, Bob (NIH/NCI) [C]

It thought perhaps there might be some interest in consistency with the rest of the web site, but if I'm the only one who was thinking along those lines, I'm happy to go with the dartboard method. :-)

Comment entered 2017-02-22 12:02:34 by Englisch, Volker (NIH/NCI) [C]

It sounds like you're thinking I came up with the choice I implemented without consulting anybody. I did ask Victoria and Michelle which template I should be using as a default and their answer was to use Video75NoTitle.
Am I missing any additional steps I should be taking?

Comment entered 2017-02-22 12:42:37 by Osei-Poku, William (NIH/NCI) [C]

Verified on DEV. Thanks!

Comment entered 2017-02-22 13:21:52 by Kline, Bob (NIH/NCI) [C]

Nope. Thanks for following up.

Comment entered 2017-02-28 10:15:01 by Juthe, Robin (NIH/NCI) [E]

Hi Volker, could you please add some CSS for the new ExternalRef element in the media document schema? (See OCECDR-3558). Thanks!

Comment entered 2017-03-01 13:21:47 by Englisch, Volker (NIH/NCI) [C]

Should this element be included in the Media template? Should it always be displayed or only when added manually?
Is the label ExternalRef OK or would you prefer something shorter? URL, Ext. URL, XRef, ...?

Comment entered 2017-03-01 13:38:15 by Juthe, Robin (NIH/NCI) [E]

No, it should only be added manually. We expect that we'll only be using this for animations for the time being anyway. The label "ExternalRef" is fine - we're used to that label from summaries anyway. thanks.

Comment entered 2017-03-01 14:28:23 by Englisch, Volker (NIH/NCI) [C]

The following style files have been updated on DEV and QA:

  • R14663: Display\Media.css

  • R14663: Display\Media_Structure.css

  • R14663: Rules\Media.ctm

Comment entered 2017-03-02 13:26:47 by Juthe, Robin (NIH/NCI) [E]

Verified on QA.

Comment entered 2017-03-03 13:39:46 by Englisch, Volker (NIH/NCI) [C]

, please keep in mind that the latest build you had installed with the updated CDRLoader did not include the additional CSS changes for this ticket.

Comment entered 2017-03-03 13:50:32 by Kline, Bob (NIH/NCI) [C]

As long as they're checked into SVN they'll be picked for the deployment to stage.

Elapsed: 0:00:00.001252