Issue Number | 5297 |
---|---|
Summary | [Summary] Vendor Filter Change to Allow Multiple Editorial Boards |
Created | 2023-11-09 13:27:42 |
Issue Type | Improvement |
Submitted By | Englisch, Volker (NIH/NCI) [C] |
Assigned To | Englisch, Volker (NIH/NCI) [C] |
Status | QA Verified |
Resolved | 2024-02-02 18:46:46 |
Resolution | Fixed |
Path | /home/bkline/backups/jira/ocecdr/issue.367546 |
Adjust the vendor filter(s) to allow the use of multiple editorial boards for a single summary.
Currently, the text presented in the "About this PDQ Summary" section is:
This summary is reviewed regularly and updated as necessary by the <PlaceHolder name="BoardNameLink"/>, which is editorially independent ...
How do we want to handle the wording in the case of multiple boards? The text is coming from the misc. document. Therefore the portion of the text that says "... which is ..." cannot stay as is for summaries with more than one board. We could possibly modify the text in the misc. doc to be more general and write "... which is/are ..." or we remove the text from the misc. document altogether and have the filter handle this portion in addition to the board name itself or another option could be that we introduce another Placeholder element to be replaced with "is" or "are" or a completely different approach.
Follow-up question: Are we limiting us to 2 editorial boards or could we have 2 or more? How would the text change in that case of more boards?
Just wanted to raise awareness that the last paragraph of the "Changes" section and the second paragraph of the "About This Summary" section are nearly identical:
This summary is written and maintained by the PDQ Adult Treatment Editorial Board, which is editorially independent of NCI. The summary reflects an independent review of the literature and does not represent a policy statement of NCI or NIH.
vs
This summary is reviewed regularly and updated as necessary by the PDQ Adult Treatment Editorial Board, which is editorially independent of the National Cancer Institute (NCI). The summary reflects an independent review of the literature and does not represent a policy statement of NCI or the National Institutes of Health (NIH).
We have the same issue in the paragraph about Levels of Evidence:
The PDQ Adult Treatment Editorial Board uses ...
Another place to think about possibly rewording is in the paragraph listing the preferred citation of the summary:
The preferred citation for this PDQ summary is:
PDQ® Adult Treatment Editorial Board. PDQ Breast Cancer Treatment. Bethesda, MD: National Cancer Institute.
I have another question for ~juther and ~vshields : Should we expect to include 3 (or more) editorial boards for a single summary?
Currently I'm listing two boards using the conjunction "and". If we can have more than 2 boards we may need to adjust this.
Last note: I'm currently listing all board members from both boards in a single list. If we want to display multiple lists by board or sort the list by board I would need implement additional changes to account for that.
The following filters have been modified:
CDR000157.xml - Vendor Filter: Summary
CDR335424.xml - Denormalization Filter: Summary
Just a quick reminder for you, ~oseipokuw , that I'm waiting for the Spanish translation for this ticket to finish up the filter changes.
Hi ~volker It is not very clear what needs to be translated. Is it text you have in the vendor filters or misc. documents? Could you please let me know?
~oseipokuw , when you look at the misc document "About This PDQ Summary" (for HP - CDR684055) you see the following text:
"This summary is reviewed regularly and updated as necessary by the <PlaceHolder name="BoardNameLink"/>, which is editorially independent of ..."
The filter process will convert the <PlaceHolder> to display the board name(s) but the following word "is" only makes sense for a single board name. This needs to be changed in the case of 2 boards and I modified the misc. document along with the filters to the following:
"This summary is reviewed regularly and updated as necessary by the <PlaceHolder name="BoardNameLink"/>, which <PlaceHolder name="is-or-are"/> editorially independent of ..."
This change will result in the correct output to list either:
"This summary is reviewed regularly and updated as necessary by the PDQ Adult Treatment Editorial Board, which is editorially independent of ..."
or
"This summary is reviewed regularly and updated as necessary by the PDQ Adult Treatment Editorial Board and PDQ Pediatric Treatment Editorial Board, which are editorially independent of ..."
I have done the same in the paragraph for "Level of Evidence" with the PlaceHolder "uses-or-use":
"The <PlaceHolder name="BoardName"/> <PlaceHolder name="uses-or-use"/> a ..."
What I would need you to do is to repeat this process of adding these placeholders to the Spanish version of the misc. document and then provide me with the correct translation to be inserted into the filter, so that the PlaceHolder can be appropriately be replaced for the output.
Hi ~volker Linda and I looked at the changes and it looks like it is more complicated for the Spanish than it is for the English because the Spanish articles change depending on the name (and order) of the board (one with "and" in it like the screening "and" prevention board) or one without any conjunction. At this time, we know which two boards we are working with (Peds and Genetics) but if any other combination of boards is used, the Spanish text would need to be revised (this is just an FYI). Also, as mentioned above, the order of the way the boards are listed would affect the Spanish translation. This shouldn't be a problem since I believe we can change the order of the boards in the summaries.
I am attaching a document Linda and I worked on with examples for you to take a look at before she makes any changes in the CDR. Please let me know if you have any questions. About This PDQ Summary_MiscDoc_ES.docx
~volker Does this change require a release. The first English summary is ready to publish but I am not sure if this change will be ready for when we want to publish it.
We have this ticket included in our Riemann release but so far there were only filter changes needed which could be copied outside of a release.
I made changes to the filter to account for the changes to the Spanish text. For this I modified the summary CDR256708 as well as the Misc. Doc CDR684064 on our DEV server. I have only focused on the text for the adult and pediatric treatment board. If you, ~oseipokuw , could maybe take a look at these changes with Linda and let me know what will still need to be addressed? I will then look at additional changes that may be required based on other editorial board combinations.
Linda and I looked at the example and generally, it looks good in pub preview. Just a couple of changes is needed.
When, "Los" or "El" is used, the "consejos" should start with a lower case since it is not starting the sentence.
"Consejos" was listed with a capital "C" because that's what I found in the Word document as the language to use.
It's been fixed in the filter now.
The "C" is also capitalized in PROD for the single version. We may need to have a bigger discussion about this because the text for the singular version is coming from the text provided as Spanish translation for the English board name.
Note: The text in the "Disclaimer for HP", which gets attached to the "Latest Updates" section also needs to be ajusted.
We have discussed that ~oseipokuw will prepare a test document on DEV using the pediatric and genetics boards. The filter changes have all been made using the adult and pediatric treatment boards. We will then take a look at the Spanish and English text for the correct board combination and tweak the filters if necessary.
Are you using the board URL from the Organization document, or it is hardcoded into the filter code? When I generate pub preview for say - CDR0000589150, the links to the board all go to one URL, the Pediatric board even though one of the linked boards is the Genetics board.
I see! This may be another issue that needs to be discussed.
The code is creating the URLs based on the SummaryType. The document you prepared has the type "Treatment". For treatment summaries there are two options: adult and pediatric. Since the editorial board isn't marked as the adult board it must be pediatric - for both boards listed.
If you were to mark the summary with a type of "Genetics" both links would go to the Genetics Board page.
Looks like we cannot use the SummaryType as a distinguishing indicator for the type of URL to create.
~oseipokuw , please have another look at the links. The links should now be going to the right place.
They look good. Please install the changes on QA so we can continue testing. Thanks!
The filter changes have been copied to the QA server.
It doesn't seem to be working on QA after copying the Misc. Doc from DEV to QA. Can you please confirm that it is really on QA ?
Could you please give me a little more detail of what you did, i.e. which documents you modified, and what it is that isn't working? Are you getting an error message when you run the filters or are you not seeing the changes you expect?
Sure. We are testing with this summary - 62890. I have modified this Misc Doc CDR0000684055 (with changes you made on DEV). However, pub preview for 62890 shows the two board combined.
You're correct, ~oseipokuw! Something had gone wrong with my git repository. I have updated the filters again on QA and the issue should be fixed now.
Thanks! The English looks good. But it looks like we will need additional changes to the Spanish which we failed to let you know earlier. Since the Spanish summary is not even translated yet, should I create another ticket to take care of the Spanish changes so we can proceed with the English first? Or you would rather make the changes in this ticket? Here are the changes needed for the Spanish:
1 . The first letter in "el" or "los" should be capitalized, "El" or "Los" because the article is at the beginning of the sentence.
2. The following should be lower cases:
~oseipokuw, you did already report this and I did already correct the capitalization. I remember it because I had told you the text with the capital "C" was coming from the Word document you provided.
I believe, this is one of the changes that were destroyed but the git issues I reported. I will take care of this minor change in this ticket and copy the changes to QA.
~oseipokuw, you posted the comment for this issue of the "lower case C" this morning. Did you run the filter this morning? I'm asking because I updated the filter last night around 7:30pm which should have fixed that issue. Currently it looks fine for me on QA.
That is right. Everything looks good for both English and Spanish at this time. Please install the changes on PROD. Thank you!
I spoke too soon. We are realizing that for the Spanish summaries that do not have multiple boards, the About This PDQ section is being altered as well. Example: 256715 - it should read "El consejo editorial...." It seems that the text for multiples boards also was applied for the rest of the summaries.
I have a question regarding our PlaceHolder filter templates. We have a PlaceHolder[name="BoardName"] which displays the name of a board and we have a PlaceHolder[name="BoardNameLink"] which displays the board name with a link to the board.
We also have a PlaceHolder[name="Adult_Treatment"] which does exactly the same as the BoardNameLink placeholder. Does anyone remember why we had two different templates or why these two are now identical? I would suggest to replace the Adult_Treatment placeholders with the BoardNameLink.
~oseipokuw , there were several issues with the filter and the misc. documents that affected the output but I think I have everything setup correctly now. Please go ahead and check out the output on QA.
There seems to still be a problem with Spanish summaries where the board is one. That is, the one with the two boards is displaying correctly but not the ones with one board. If you run pub preview for this summary 256715 on QA, you will notice the plurals highlighted in the following screenshot which shouldn't be in the ones with one board.
You can compare that with the same summary on cancer.gov
I'm sorry but I don't know Spanish at all. It's difficult for me since I can't distinguish a singular from a plural term.
Are you sure that the letter "N" needs to be deleted from "resumen" instead of "revisan"? If so, please update the misc. document accordingly.
The filter has been updated on QA.
Sorry, it needs to be updated from "mantienen", "revisan" and "actualizan". Thanks!
This means the output is correct now, right?
Yes, please install the changes on PROD. Thanks!
There are multiple filter change tickets related to the summaries in the Riemann sprint and it wasn't clear from the outset that some of these changes were supposed to go to PROD outside of the release. I therefore had to copy multiple filters to PROD with changes not directly related to the multiple editorial boards. Those changes should not affect the summaries filter output because those changes address the removal of unused code. However, I felt it necessary to do some additional testing (on QA and STAGE) after copying all filter changes.
The following filters have been copied to STAGE and PROD:
CDR000157 - Vendor Filter: Summary
CDR271370 - Module: Vendor Filter Templates
CDR335424 - Denormalization Filter: Summary
CDR609947 - Vendor Filter: Convert CG to Public Data
CDR797103 - Cancer Information Summary for Drupal CMS
~oseipokuw , please review on PROD and don't forget to adjust the misc. documents as needed.
The first summary has been published to cancer.gov and it looks good. Thanks ~volker
https://www.cancer.gov/publications/pdq/information-summaries/genetics/rtps1-hp-pdq
File Name | Posted | User |
---|---|---|
About This PDQ Summary_MiscDoc_ES.docx | 2024-01-18 12:43:58 | Osei-Poku, William (NIH/NCI) [C] |
image-2024-02-23-16-12-13-868.png | 2024-02-23 16:12:14 | Osei-Poku, William (NIH/NCI) [C] |
MicrosoftTeams-image (13).png | 2024-01-30 14:04:26 | Osei-Poku, William (NIH/NCI) [C] |
MicrosoftTeams-image (14).png | 2024-01-30 14:04:48 | Osei-Poku, William (NIH/NCI) [C] |
MicrosoftTeams-image (15).png | 2024-02-14 09:31:08 | Osei-Poku, William (NIH/NCI) [C] |
MicrosoftTeams-image (16).png | 2024-02-14 09:32:50 | Osei-Poku, William (NIH/NCI) [C] |
MicrosoftTeams-image (17).png | 2024-02-15 09:05:53 | Osei-Poku, William (NIH/NCI) [C] |
MicrosoftTeams-image (18).png | 2024-02-23 16:09:06 | Osei-Poku, William (NIH/NCI) [C] |
Multipble boards.PNG | 2024-02-13 15:03:01 | Osei-Poku, William (NIH/NCI) [C] |
Elapsed: 0:00:00.001310