| Issue Number | 5044 |
|---|---|
| Summary | Modify publishing software to make CDR required top-level section title optional for intro text |
| Created | 2021-10-15 13:03:07 |
| Issue Type | New Feature |
| Submitted By | Osei-Poku, William (NIH/NCI) [C] |
| Assigned To | Englisch, Volker (NIH/NCI) [C] |
| Status | Closed |
| Resolved | 2021-10-28 12:44:00 |
| Resolution | Fixed |
| Path | /home/bkline/backups/jira/ocecdr/issue.300651 |
As a CDR summary editor, I want the ability to add intro text to a SVPC summary that does not require a section title that is normally required for top level sections, so that the content can support SEO best practices for the SVPC initiative.
Currently the CDR does not allow for top-level sections to be designated as intro text at the start of a page without requiring a top-level section title. At least one of the SVPC liver treatment summaries will require an intro text without a section title. We need to be able to add introductory text at the start of the page without displaying a section title. Essentially, this is a requirement for body sections that don’t need a title.
Given: I am a CDR patient summary editor
And I have permissions to create summaries in the CDR
And I have permissions to edit summaries in the CDR
And I create or edit a new SVPC summary
When I add a new top-level summary section element to the SVPC summary
Then the CDR should allow me to mark the top-level section title as optional
(Or: Then the CDR has the ability to add a body section without filling in the title text)
Given: I am a CDR patient summary editor
And I have permissions to create new summaries in the CDR
And I have permissions to edit summaries in the CDR
And I create or edit a SVPC summary
And I add a new top-level summary section element to the SVPC summary
When I make the section title element optional
Then the CDR should not make the summary invalid
Would it make sense to add a value of "Info Text" (or something like that) to the LOV for SectionType? The filter and validation could use this value to identify if it's OK for the Title element to be missing or not. A SVPC summary template could have this information pre-populated.
From a user perspective, I don't see any problem with it as we are already familiar with the section type and this sounds like a true section type.
This isn't handled by the schemas, but by the filters. I have modified the title and the category for the ticket, and reassigned it to ~volker.
The schemas allow a section without title and so do the filters. It is cdrpub.py that's enforcing the "must have H2 tag" rule.
Back to you, ~bkline.
Modification installed on CDR DEV.
Verified on DEV. Thanks!
~volker Can you please confirm that the publishing filters changes have been completed for this ticket? I was checking pup preview for this doc CDR0000805700 on DEV but the intro text feature does not appear to be working in pp.
Yes, I can confirm that the XML created by the Vendor Filter Summary Set includes the Intro Text summary section without a Title element.
I am guessing that the Intro Text is missing because CDR-DEV is
pointing to the Drupal-DEV server but the Intro Text changes to Drupal
are implemented on a different Drupal test server, so the PublishPreview
process does not see these changes yet. You may remember that Bryan had
asked not to treat the Intro Text section as a regular summary section
but create its own intro text element within Drupal.
Am I on the right track, ~bkline?
Yes, if you point CDR DEV (temporarily — you'll want to remember to switch it back after the ODE has been repurposed) at the ODE whose URL I posted in the chat for this morning's meeting, I think you'll get better results.
It will be good to have it point to the right server as we test these changes. It makes it hard to keep up with things if you're not seeing what you expect.
I totally agree with you, ~oseipokuw. However, we also need to keep in mind that we're currently working on tickets in Ohm, Oersted, and Oppenheimer and for some of the testing we need to coordinate to ensure the environment is properly prepared.
I have updated the config file to point to the ODE that includes Bob's changes.
Thanks! It would be good to keep it there until I get all SVPC the documents ready by next week.
The intro text function is working now. However, the navigation is still missing but I assume that should be expected, right?
If you're referring to the left navigation I remember that we talked about this with Lindsay. The navigation is missing because the URL doesn't follow the correct hierarchy.
I'm not sure why this ticket is still open and assigned to me. The requested "Introductory Text" section without mandatory Title element has already been implemented and tested.
I'm setting the status to "Fixed" unless I hear of additional changes required for this ticket.
I re-opened this ticket because of the issue I was having with pub preview when CDR-DEV was not pointing to the correct server for the right pub preview to be generated for the SVPC summaries. That issue is fixed now so I will mark this ticket as DEV verified again.
Verified on QA and PROD. Thanks!
Elapsed: 0:00:00.001465